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

Update man page

Browse Source 
Move all documented "external commands" up with the resto f the commands,
as these will all be built-in commands after the next code re-org.
This commit is contained in:
Adam Vandenberg 2010-11-07 07:36:34 -08:00
parent 320889933d
commit 7d44a389f7
2 changed files with 85 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -65,7 +65,7 @@ didn't include with OS X.
Search for <text> on the MacPorts or Fink package search page. Search for <text> on the MacPorts or Fink package search page.
* `update`: * `update`:
Using `git`(1), fetch the newest version of Homebrew from GitHub. Fetch the newest version of Homebrew from GitHub using `git`(1).
* `list`: * `list`:
List all installed formulae. List all installed formulae.
@ -74,11 +74,13 @@ didn't include with OS X.
List the installed files for <formula>. List the installed files for <formula>.
* `info` <formula>: * `info` <formula>:
Give all available information for <formula>. Display information about <formula>.
* `info --github` <formula>: * `info --github` <formula>:
Open a browser to the GitHub History page for formula <formula>. Open a browser to the GitHub History page for formula <formula>.
To view formula history locally: `brew log -p <formula>`.
* `info` <URL>: * `info` <URL>:
Print the name and version that will be detected for <URL>. Print the name and version that will be detected for <URL>.
@ -92,7 +94,7 @@ didn't include with OS X.
Uninstall <formula>. Uninstall <formula>.
If `--force` is passed, and there are multiple versions of <formula> If `--force` is passed, and there are multiple versions of <formula>
installed, deletes all installed versions. installed, delete all installed versions.
* `create [--cache]` <URL>: * `create [--cache]` <URL>:
Generate a formula for the downloadable file at <URL> and opens it in Generate a formula for the downloadable file at <URL> and opens it in
@ -162,6 +164,34 @@ didn't include with OS X.
If `--force` is passed, remove a previously cached version and re-fetch. If `--force` is passed, remove a previously cached version and re-fetch.
* `audit [--warn]`:
Check formulae for Homebrew coding style violations. This should be
run before submitting a new formula for inclusion.
If `--warn` is passed, perform additional stricter checks that may not need
to be fixed before submitting.
* `options` <formula>:
Display install options specific to <formula>.
* `missing`:
Check all installed formuale for missing dependencies.
* `server`:
Start a local web app that lets you browse available formulae, similar
to `gem server`. Requires [`sinatra`][sinatra].
* `test` <formula>:
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
generally indicate to the user if something is wrong with the installed
formula.
Example: `brew install jruby && brew test jruby`
* `man`:
Regenerate this man page using [`ronn`][ronn]. See `man brew-man` for details.
* `--config`: * `--config`:
Show Homebrew and system configuration useful for debugging. If you file Show Homebrew and system configuration useful for debugging. If you file
a bug report, you will likely be asked for this information if you do not a bug report, you will likely be asked for this information if you do not
@ -196,41 +226,10 @@ Homebrew allows external commands to be defined by putting a +x file named
`brew-<cmdname>` or `brew-<cmdname>.rb` on the PATH. This will cause Homebrew `brew-<cmdname>` or `brew-<cmdname>.rb` on the PATH. This will cause Homebrew
to recognize `brew cmdname`. to recognize `brew cmdname`.
These external commands are shipped with Homebrew. Some sample commands ship with Homebrew and are enabled by default.
* `audit [--warn]`: $ ls `brew --repository`/Lirary/Contributes/examples
Check all formulae for Homebrew coding style violations. This should be
run before submitting a new formula for inclusion.
If `--warn` is passed, perform additional stricter checks that may not need
to be fixed before submitting.
* `options` <formula>:
Display install options specific to <formula>.
* `man`:
Regenerate this man page using [`ronn`][ronn]. See `man brew-man` for details.
* `missing`:
Check all installed formuale for missing dependencies.
* `server`:
Start a local web app that lets you browse available formulae, similar
to `gem server`. Requires [`sinatra`][sinatra].
* `test` <formula>:
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
generally indicate to the user if something is wrong with the installed
formula.
Example: `brew install jruby && brew test jruby`
[ronn]: http://rtomayko.github.com/ronn/
"Ronn"
[sinatra]: http://www.sinatrarb.com/
"Sinatra"
## ENVIRONMENT ## ENVIRONMENT
@ -314,3 +313,10 @@ Max Howell, a splendid chap.
## BUGS ## BUGS
See Issues on GitHub: <http://github.com/mxcl/homebrew/issues> See Issues on GitHub: <http://github.com/mxcl/homebrew/issues>
[ronn]: http://rtomayko.github.com/ronn/
"Ronn"
[sinatra]: http://www.sinatrarb.com/
"Sinatra"

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

@ -69,7 +69,7 @@ Search for \fItext\fR on the MacPorts or Fink package search page\.
. .
.TP .TP
\fBupdate\fR \fBupdate\fR
Using \fBgit\fR(1), fetch the newest version of Homebrew from GitHub\. Fetch the newest version of Homebrew from GitHub using \fBgit\fR(1)\.
. .
.TP .TP
\fBlist\fR \fBlist\fR
@ -81,12 +81,15 @@ List the installed files for \fIformula\fR\.
. .
.TP .TP
\fBinfo\fR \fIformula\fR \fBinfo\fR \fIformula\fR
Give all available information for \fIformula\fR\. Display information about \fIformula\fR\.
. .
.TP .TP
\fBinfo \-\-github\fR \fIformula\fR \fBinfo \-\-github\fR \fIformula\fR
Open a browser to the GitHub History page for formula \fIformula\fR\. Open a browser to the GitHub History page for formula \fIformula\fR\.
. .
.IP
To view formula history locally: \fBbrew log \-p <formula>\fR\.
.
.TP .TP
\fBinfo\fR \fIURL\fR \fBinfo\fR \fIURL\fR
Print the name and version that will be detected for \fIURL\fR\. Print the name and version that will be detected for \fIURL\fR\.
@ -104,7 +107,7 @@ Open \fIformula\fR\'s homepage in a browser\.
Uninstall \fIformula\fR\. Uninstall \fIformula\fR\.
. .
.IP .IP
If \fB\-\-force\fR is passed, and there are multiple versions of \fIformula\fR installed, deletes all installed versions\. If \fB\-\-force\fR is passed, and there are multiple versions of \fIformula\fR installed, delete all installed versions\.
. .
.TP .TP
\fBcreate [\-\-cache]\fR \fIURL\fR \fBcreate [\-\-cache]\fR \fIURL\fR
@ -178,6 +181,36 @@ If \fB\-\-HEAD\fR is passed, download the HEAD version of \fIformula\fR instead\
If \fB\-\-force\fR is passed, remove a previously cached version and re\-fetch\. If \fB\-\-force\fR is passed, remove a previously cached version and re\-fetch\.
. .
.TP .TP
\fBaudit [\-\-warn]\fR
Check formulae for Homebrew coding style violations\. This should be run before submitting a new formula for inclusion\.
.
.IP
If \fB\-\-warn\fR is passed, perform additional stricter checks that may not need to be fixed before submitting\.
.
.TP
\fBoptions\fR \fIformula\fR
Display install options specific to \fIformula\fR\.
.
.TP
\fBmissing\fR
Check all installed formuale for missing dependencies\.
.
.TP
\fBserver\fR
Start a local web app that lets you browse available formulae, similar to \fBgem server\fR\. Requires \fBsinatra\fR \fIhttp://www\.sinatrarb\.com/\fR\.
.
.TP
\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\.
.
.IP
Example: \fBbrew install jruby && brew test jruby\fR
.
.TP
\fBman\fR
Regenerate this man page using \fBronn\fR \fIhttp://rtomayko\.github\.com/ronn/\fR\. See \fBman brew\-man\fR for details\.
.
.TP
\fB\-\-config\fR \fB\-\-config\fR
Show Homebrew and system configuration useful for debugging\. If you file a bug report, you will likely be asked for this information if you do not provide it\. Show Homebrew and system configuration useful for debugging\. If you file a bug report, you will likely be asked for this information if you do not provide it\.
. .
@ -213,37 +246,17 @@ Display where Homebrew\'s \fB\.git\fR folder is located\. For standard installs,
Homebrew allows external commands to be defined by putting a +x file named \fBbrew\-<cmdname>\fR or \fBbrew\-<cmdname>\.rb\fR on the PATH\. This will cause Homebrew to recognize \fBbrew cmdname\fR\. Homebrew allows external commands to be defined by putting a +x file named \fBbrew\-<cmdname>\fR or \fBbrew\-<cmdname>\.rb\fR on the PATH\. This will cause Homebrew to recognize \fBbrew cmdname\fR\.
. .
.P .P
These external commands are shipped with Homebrew\. Some sample commands ship with Homebrew and are enabled by default\.
. .
.TP .IP "" 4
\fBaudit [\-\-warn]\fR
Check all formulae for Homebrew coding style violations\. This should be run before submitting a new formula for inclusion\.
. .
.IP .nf
If \fB\-\-warn\fR is passed, perform additional stricter checks that may not need to be fixed before submitting\.
$ ls `brew \-\-repository`/Lirary/Contributes/examples
. .
.TP .fi
\fBoptions\fR \fIformula\fR
Display install options specific to \fIformula\fR\.
. .
.TP .IP "" 0
\fBman\fR
Regenerate this man page using \fBronn\fR \fIhttp://rtomayko\.github\.com/ronn/\fR\. See \fBman brew\-man\fR for details\.
.
.TP
\fBmissing\fR
Check all installed formuale for missing dependencies\.
.
.TP
\fBserver\fR
Start a local web app that lets you browse available formulae, similar to \fBgem server\fR\. Requires \fBsinatra\fR \fIhttp://www\.sinatrarb\.com/\fR\.
.
.TP
\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\.
.
.IP
Example: \fBbrew install jruby && brew test jruby\fR
. .
.SH "ENVIRONMENT" .SH "ENVIRONMENT"
. .