aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Vandenberg2010-08-20 10:18:03 -0700
committerAdam Vandenberg2010-08-20 10:18:03 -0700
commit22aad1a1f07c6936351657cdd76f4013616b1381 (patch)
tree4c70b070e2fe1abd7abdd437c0fc9220d969d1e6
parentbefa3c852ba5299e89b5b576aad29a8eb2c64091 (diff)
downloadhomebrew-22aad1a1f07c6936351657cdd76f4013616b1381.tar.bz2
Document 'brew man' and add links to gems.
-rw-r--r--Library/Contributions/manpages/brew.1.md16
-rw-r--r--share/man/man1/brew.110
2 files changed, 25 insertions, 1 deletions
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md
index 9cc55170d..777f90cde 100644
--- a/Library/Contributions/manpages/brew.1.md
+++ b/Library/Contributions/manpages/brew.1.md
@@ -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
tarballs, also prints MD5 and SHA1 checksums.
+ * `man`:
+ Regenerates this man page from source.
+
+ *NOTE*: Requires [`ronn`][ronn].
+
* `missing`:
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
formulae, similar to `gem server`.
+ *NOTE*: 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
@@ -187,6 +194,13 @@ Some external commands are shipped with Homebrew, and enabled by default.
Example: `brew install jruby && brew test jruby`
+[ronn]: http://rtomayko.github.com/ronn/
+ "Ronn"
+
+[sinatra]: http://www.sinatrarb.com/
+ "Sinatra"
+
+
## ENVIRONMENT
* HOMEBREW\_DEBUG:
@@ -238,7 +252,7 @@ Some external commands are shipped with Homebrew, and enabled by default.
## SEE ALSO
- Homebrew Wiki: http://wiki.github.com/mxcl/homebrew/
+Homebrew Wiki: http://wiki.github.com/mxcl/homebrew/
## AUTHORS
diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1
index 6bcd379e9..85e2e7dea 100644
--- a/share/man/man1/brew.1
+++ b/share/man/man1/brew.1
@@ -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\.
.
.TP
+\fBman\fR
+Regenerates this man page from source\.
+.
+.IP
+\fINOTE\fR: Requires \fBronn\fR \fIhttp://rtomayko\.github\.com/ronn/\fR\.
+.
+.TP
\fBmissing\fR
Checks all installed formuale for missing dependencies\.
.
@@ -189,6 +196,9 @@ Checks all installed formuale for missing dependencies\.
\fBserver\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
\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\.