admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Document 'brew man' and add links to gems.

Browse Source
This commit is contained in:
Adam Vandenberg 2010-08-20 10:18:03 -07:00
parent 44f1d0917d
commit eecddb356d
2 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Library/Contributions/manpages/brew.1.md
View File

@ -172,6 +172,11 @@ Some external commands are shipped with Homebrew, and enabled by default.
Downloads the tarball or checks out from VCS for the given <formula>. For Downloads the tarball or checks out from VCS for the given <formula>. For
tarballs, also prints MD5 and SHA1 checksums. tarballs, also prints MD5 and SHA1 checksums.
* `man`:
Regenerates this man page from source.
*NOTE*: Requires [`ronn`][ronn].
* `missing`: * `missing`:
Checks all installed formuale for missing dependencies. Checks all installed formuale for missing dependencies.
@ -179,6 +184,8 @@ Some external commands are shipped with Homebrew, and enabled by default.
Starts a local webserver with an app that lets you browse available Starts a local webserver with an app that lets you browse available
formulae, similar to `gem server`. formulae, similar to `gem server`.
*NOTE*: Requires [`sinatra`][sinatra].
* `test` <formula>: * `test` <formula>:
A few formulae provide a test method. `brew test <formula>` runs this A few formulae provide a test method. `brew test <formula>` runs this
test method. There is no standard output or return code, but it should test method. There is no standard output or return code, but it should
@ -187,6 +194,13 @@ Some external commands are shipped with Homebrew, and enabled by default.
Example: `brew install jruby && brew test jruby` Example: `brew install jruby && brew test jruby`
[ronn]: http://rtomayko.github.com/ronn/
"Ronn"
[sinatra]: http://www.sinatrarb.com/
"Sinatra"
## ENVIRONMENT ## ENVIRONMENT
* HOMEBREW\_DEBUG: * HOMEBREW\_DEBUG:
@ -238,7 +252,7 @@ Some external commands are shipped with Homebrew, and enabled by default.
## SEE ALSO ## SEE ALSO
Homebrew Wiki: http://wiki.github.com/mxcl/homebrew/ Homebrew Wiki: http://wiki.github.com/mxcl/homebrew/
## AUTHORS ## AUTHORS

10
share/man/man1/brew.1
View File

@ -182,6 +182,13 @@ Checks all formulae for Homebrew coding style violations\. This should be run be
Downloads the tarball or checks out from VCS for the given \fIformula\fR\. For tarballs, also prints MD5 and SHA1 checksums\. Downloads the tarball or checks out from VCS for the given \fIformula\fR\. For tarballs, also prints MD5 and SHA1 checksums\.
. .
.TP .TP
\fBman\fR
Regenerates this man page from source\.
.
.IP
\fINOTE\fR: Requires \fBronn\fR \fIhttp://rtomayko\.github\.com/ronn/\fR\.
.
.TP
\fBmissing\fR \fBmissing\fR
Checks all installed formuale for missing dependencies\. Checks all installed formuale for missing dependencies\.
. .
@ -189,6 +196,9 @@ Checks all installed formuale for missing dependencies\.
\fBserver\fR \fBserver\fR
Starts a local webserver with an app that lets you browse available formulae, similar to \fBgem server\fR\. Starts a local webserver with an app that lets you browse available formulae, similar to \fBgem server\fR\.
. .
.IP
\fINOTE\fR: Requires \fBsinatra\fR \fIhttp://www\.sinatrarb\.com/\fR\.
.
.TP .TP
\fBtest\fR \fIformula\fR \fBtest\fR \fIformula\fR
A few formulae provide a test method\. \fBbrew test <formula>\fR runs this test method\. There is no standard output or return code, but it should generally indicate to the user if something is wrong with the installed formula\. A few formulae provide a test method\. \fBbrew test <formula>\fR runs this test method\. There is no standard output or return code, but it should generally indicate to the user if something is wrong with the installed formula\.