diff options
| -rw-r--r-- | Library/Contributions/manpages/brew.1.md | 78 | ||||
| -rw-r--r-- | share/man/man1/brew.1 | 73 |
2 files changed, 85 insertions, 66 deletions
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md index 742495d3e..36e774c71 100644 --- a/Library/Contributions/manpages/brew.1.md +++ b/Library/Contributions/manpages/brew.1.md @@ -65,7 +65,7 @@ didn't include with OS X. Search for <text> on the MacPorts or Fink package search page. * `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 all installed formulae. @@ -74,11 +74,13 @@ didn't include with OS X. List the installed files for <formula>. * `info` <formula>: - Give all available information for <formula>. + Display information about <formula>. * `info --github` <formula>: Open a browser to the GitHub History page for formula <formula>. + To view formula history locally: `brew log -p <formula>`. + * `info` <URL>: Print the name and version that will be detected for <URL>. @@ -92,7 +94,7 @@ didn't include with OS X. Uninstall <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>: 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. + * `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`: 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 @@ -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 to recognize `brew cmdname`. -These external commands are shipped with Homebrew. - - * `audit [--warn]`: - 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>. +Some sample commands ship with Homebrew and are enabled by default. - * `man`: - Regenerate this man page using [`ronn`][ronn]. See `man brew-man` for details. + $ ls `brew --repository`/Lirary/Contributes/examples - * `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 @@ -314,3 +313,10 @@ Max Howell, a splendid chap. ## BUGS See Issues on GitHub: <http://github.com/mxcl/homebrew/issues> + + +[ronn]: http://rtomayko.github.com/ronn/ + "Ronn" + +[sinatra]: http://www.sinatrarb.com/ + "Sinatra" diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index 5929ffaa4..373a241fd 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -69,7 +69,7 @@ Search for \fItext\fR on the MacPorts or Fink package search page\. . .TP \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 \fBlist\fR @@ -81,12 +81,15 @@ List the installed files for \fIformula\fR\. . .TP \fBinfo\fR \fIformula\fR -Give all available information for \fIformula\fR\. +Display information about \fIformula\fR\. . .TP \fBinfo \-\-github\fR \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 \fBinfo\fR \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\. . .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 \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\. . .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 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\. . .P -These external commands are shipped with Homebrew\. +Some sample commands ship with Homebrew and are enabled by default\. . -.TP -\fBaudit [\-\-warn]\fR -Check all 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 -\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\. +.IP "" 4 . -.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\. +.nf + +$ ls `brew \-\-repository`/Lirary/Contributes/examples . -.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\. +.fi . -.IP -Example: \fBbrew install jruby && brew test jruby\fR +.IP "" 0 . .SH "ENVIRONMENT" . |