From 320889933dac627f97b5628084143723a1429be9 Mon Sep 17 00:00:00 2001
From: Adam Vandenberg <flangy@gmail.com>
Date: Sat, 6 Nov 2010 14:18:15 -0700
Subject: [PATCH] Separate man page for brew-man
Also, revise main man page, and update brew-man command to handle
multiple input files.
---
Library/Contributions/examples/brew-man | 30 +++-
Library/Contributions/manpages/brew-man.1.md | 43 +++++
Library/Contributions/manpages/brew.1.md | 173 ++++++++++---------
share/man/man1/brew-man.1 | 48 +++++
share/man/man1/brew.1 | 161 +++++++++--------
5 files changed, 289 insertions(+), 166 deletions(-)
create mode 100644 Library/Contributions/manpages/brew-man.1.md
create mode 100644 share/man/man1/brew-man.1
diff --git a/Library/Contributions/examples/brew-man b/Library/Contributions/examples/brew-man
index 9bc34be4a0..a017d9206c 100755
--- a/Library/Contributions/examples/brew-man
+++ b/Library/Contributions/examples/brew-man
@@ -1,10 +1,11 @@
#!/bin/bash
set -e
+shopt -s nullglob
-man1_suffix="share/man/man1/brew.1"
-source_path="$HOMEBREW_REPOSITORY/Library/Contributions/manpages"
-target_file="$HOMEBREW_REPOSITORY/$man1_suffix"
+SOURCE_PATH="$HOMEBREW_REPOSITORY/Library/Contributions/manpages"
+TARGET_PATH="$HOMEBREW_REPOSITORY/share/man/man1"
+LINKED_PATH="$HOMEBREW_PREFIX/share/man/man1"
die (){
@@ -14,7 +15,12 @@ die (){
test "$1" = '--link' || \
test "$1" = '-l' && {
- ln -s "$target_file" "$HOMEBREW_PREFIX/$man1_suffix"
+ [[ $TARGET_PATH == $LINKED_PATH ]] && exit 0
+
+ for page in "$TARGET_PATH"/*.1
+ do
+ ln -s $page $LINKED_PATH
+ done
exit 0
}
@@ -22,14 +28,22 @@ test "$1" = '-l' && {
test "$1" = '--server' || \
test "$1" = '-s' && {
- echo "Manpage test server: http://localhost:1207/"
+ echo "Man page test server: http://localhost:1207/"
echo "Control-C to exit."
- ronn --server $source_path/*
+ ronn --server $SOURCE_PATH/*
exit 0
}
-echo "Writing manpage to $target_file"
-ronn --roff --pipe --organization='Homebrew' --manual='brew' $source_path/brew.1.md > $target_file
+echo "Writing manpages to $TARGET_PATH"
+
+for i in "$SOURCE_PATH"/*.md
+do
+ # Get the filename only, without the .md extension
+ j=`basename $i`
+ target_file="$TARGET_PATH/${j%\.md}"
+
+ ronn --roff --pipe --organization='Homebrew' --manual='brew' $i > $target_file
+done
test "$1" = '--verbose' || \
test "$1" = '-v' && {
diff --git a/Library/Contributions/manpages/brew-man.1.md b/Library/Contributions/manpages/brew-man.1.md
new file mode 100644
index 0000000000..0fef335345
--- /dev/null
+++ b/Library/Contributions/manpages/brew-man.1.md
@@ -0,0 +1,43 @@
+brew-man(1) -- Generate man pages for Homebrew
+==============================================
+
+## SYNOPSIS
+
+`brew man` [--verbose]
+`brew man` --link
+`brew man` --server
+
+## DESCRIPTION
+
+Generates man pages for Homebrew using [`ronn`][ronn].
+
+`brew man` by itself updates the man pages from the source files.
+
+With `--link`, symlinks generated man pages to `share/man` under
+the Homebrew Prefix.
+
+With `--server`, starts ronn's dev server.
+
+
+[ronn]: http://rtomayko.github.com/ronn/
+ "Ronn"
+
+## OPTIONS
+ * `-v`, `--verbose`:
+ Run `man brew` after generating man pages.
+
+ * `-l`, `--link`:
+ Creates symlinks from the generated man pages to the Homebrew Prefix,
+ typically `/usr/local`. Useful when Homebrew itself is not installed
+ directly into `/usr/local`.
+
+ * `-s`, `--server`:
+ Starts ronn's test server.
+
+## SEE ALSO
+
+`brew`(1)
+
+## BUGS
+
+See Issues on GitHub: <http://github.com/mxcl/homebrew/issues>
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md
index be7c168c8a..742495d3e9 100644
--- a/Library/Contributions/manpages/brew.1.md
+++ b/Library/Contributions/manpages/brew.1.md
@@ -19,30 +19,10 @@ didn't include with OS X.
## COMMANDS
* `-v`, `--version`:
- Prints the version number of brew to standard error and exits.
-
- * `--prefix` [<formula>]:
- Displays the install path for Homebrew.
- If <formula> is given, display location in the cellar where that package
- is or would be installed.
-
- * `--cache` [<formula>]:
- Displays the path Homebrew uses to cache downloads.
- If <formula> is given, display the file or folder used to cache that
- specific package.
-
- * `--config`:
- Shows 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.
-
- * `-S`, `search` <text>|/<text>/:
- Performs a substring search of formula names for <text>. If <text> is
- surrounded with slashes, then it is interpreted as a regular expression.
- If no search term is given, all available formula are displayed.
+ Print the version number of brew to standard error and exit.
* `install [--force] [--debug] [--use-llvm] [--ignore-dependencies] [--HEAD]` <formula>:
- Installs <formula>.
+ Install <formula>.
<formula> is usually the name of the formula to install, but may also be
the URL for an arbitrary formula.
@@ -51,7 +31,7 @@ didn't include with OS X.
installed. This can be used to re-install a formula without removing
it first.
- If `--debug` is passed and brewing fails, opens a shell inside the
+ If `--debug` is passed and brewing fails, open a shell inside the
temporary folder used for compiling.
If `--use-llvm` is passed, attempt to compile using the LLVM front-end to GCC.
@@ -69,47 +49,53 @@ didn't include with OS X.
or `brew --force --HEAD <foo>`.
* `install --interactive [--git]` <formula>:
- Downloads and patches <formula>, then opens a shell. This allows the user
- to run `./configure --help` and otherwise determine how to turn the
- software package into a Homebrew formula.
+ Download and patch <formula>, then open a shell. This allows the user to
+ run `./configure --help` and otherwise determine how to turn the software
+ package into a Homebrew formula.
If `--git` is passed, Homebrew will create a Git repository, useful for
creating patches to the software.
+ * `-S`, `search` <text>|/<text>/:
+ Perform a substring search of formula names for <text>. If <text> is
+ surrounded with slashes, then it is interpreted as a regular expression.
+ If no search term is given, all available formula are displayed.
+
+ * `-S --macports`|`--fink` <text>:
+ Search for <text> on the MacPorts or Fink package search page.
+
+ * `update`:
+ Using `git`(1), fetch the newest version of Homebrew from GitHub.
+
* `list`:
- Lists all installed formulae.
+ List all installed formulae.
* `list` <formula>:
- Lists the installed files for <formula>.
+ List the installed files for <formula>.
* `info` <formula>:
- Gives all available information for <formula>.
+ Give all available information for <formula>.
* `info --github` <formula>:
- Opens a browser to the GitHub History page for formula <formula>.
-
- * `info --all`:
- Summarises all installed packages; this is intended to be used by
- higher-level tools.
+ Open a browser to the GitHub History page for formula <formula>.
* `info` <URL>:
- Prints the name and version that will be detected for <URL>; only http://
- URLs supported for now.
+ Print the name and version that will be detected for <URL>.
* `home`:
- Opens a browser to Homebrew's own homepage.
+ Open Homebrew's own homepage in a browser.
* `home` <formula>:
- Opens a browser to <formula>'s homepage.
+ Open <formula>'s homepage in a browser.
- * `rm`, `remove [--force]` <formula>:
- Uninstalls <formula>.
+ * `rm`, `remove`, `uninstall [--force]` <formula>:
+ Uninstall <formula>.
If `--force` is passed, and there are multiple versions of <formula>
installed, deletes all installed versions.
* `create [--cache]` <URL>:
- Generates 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
$EDITOR. Homebrew will attempt to automatically derive the formula name
and version, if it fails, you'll have to make your own template. I suggest
copying wget's.
@@ -117,65 +103,58 @@ didn't include with OS X.
If `--cache` is passed, Homebrew will download the <URL> to the cache and
add the MD5 to the formula for you.
- * `create --macports`|`--fink` <formula>:
- Opens a browser to the MacPorts or Fink package search page, so you can
- see how they do <formula>.
-
* `edit` <formula>:
- Opens the formula in $EDITOR.
+ Open <formula> in $EDITOR.
* `edit`:
- Opens all of Homebrew for editing in TextMate.
+ Open all of Homebrew for editing in TextMate.
* `ln`, `link` <formula>:
- Symlinks all of <formula>'s installed files into the Homebrew prefix. This
+ Symlink all of <formula>'s installed files into the Homebrew prefix. This
is done automatically when you install formula. It is useful for DIY
installation, or in cases where you want to swap out different versions of
the same package that you have installed at the same time.
* `unlink` <formula>:
- Unsymlinks <formula> from the Homebrew prefix.
+ Unsymlink <formula> from the Homebrew prefix. This can be useful for
+ temporarily disabling a formula: `brew unlink foo && commands && brew link foo`.
* `prune`:
- Removes dead symlinks from the Homebrew prefix. This is generally not
- needed. However, it can be useful if you are doing DIY installations.
+ Remove dead symlinks from the Homebrew prefix. This is generally not
+ needed, but can be useful when doing DIY installations.
* `outdated`:
- Shows formula that have an updated version available.
+ Show formula that have an updated version available.
* `deps [--1]` <formula>:
- Shows <formula>'s dependencies.
+ Show <formula>'s dependencies.
If `--1` is passed, only show dependencies one level down, instead of
recursing.
* `uses [--installed]` <formula>:
- Shows the formulas that specify <formula> as a dependency. The list is
+ Show the formulas that specify <formula> as a dependency. The list is
not recursive; only one level of dependencies is resolved.
If `--installed` is passed, only lists installed formulae.
* `doctor`:
- Checks your system for potential problems.
+ Check your system for potential problems.
* `cat` <formula>:
- Displays the source to <formula>.
+ Display the source to <formula>.
* `cleanup` [<formula>]:
For all installed or specific formulae, remove any older versions from the
cellar.
- * `update`:
- Using Git, fetches the newest version of Homebrew from the GitHub
- repository.
-
- * `log [git-options]` <formula> ...:
- Shows the git log for the given formulae. Options that `git log`
+ * `log [git-log-options]` <formula> ...:
+ Show the git log for the given formulae. Options that `git-log`(1)
recognizes can be passed before the formula list.
* `fetch [--force] [-v] [--HEAD]` <formula>:
- Downloads the tarball or checks out from VCS for the given <formula>. For
- tarballs, also prints MD5 and SHA1 checksums.
+ Download the source package for the given <formula>. For tarballs, also
+ prints MD5 and SHA1 checksums.
If `--HEAD` is passed, download the HEAD version of <formula> instead. `-v`
may also be passed to make the VCS checkout verbose, useful for seeing if
@@ -183,37 +162,61 @@ didn't include with OS X.
If `--force` is passed, remove a previously cached version and re-fetch.
+ * `--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
+ provide it.
+
+ * `--prefix`:
+ Display Homebrew's install path. *Default:* `/usr/local`
+
+ * `--prefix` <formula>:
+ Display the location in the cellar where <formula> is or would be installed.
+
+ * `--cellar`:
+ Display Homebrew's Cellar path. *Default:* `/usr/local/Cellar`
+
+ * `--cellar`:
+ Display the location in the cellar where <formula> would be installed,
+ without any sort of versioned folder as the last path.
+
+ * `--cache`:
+ Display Homebrew's download cache. *Default:* `~/Library/Cache/Homebrew`
+
+ * `--cache` <formula>:
+ Display the file or folder used to cache <formula>.
+
+ * `--repository`:
+ Display where Homebrew's `.git` folder is located. For standard installs,
+ the `prefix` and `repository` are the same folder.
+
## EXTERNAL COMMANDS
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`.
-Some external commands are shipped with Homebrew, and enabled by default.
+These external commands are shipped with Homebrew.
* `audit [--warn]`:
- Checks all formulae for Homebrew coding style violations. This should be
+ Check all formulae for Homebrew coding style violations. This should be
run before submitting a new formula for inclusion.
- If `--warn` is passed, performs additional stricter checks that may not need
+ If `--warn` is passed, perform additional stricter checks that may not need
to be fixed before submitting.
* `options` <formula>:
- Displays install options specific to <formula>.
+ Display install options specific to <formula>.
* `man`:
- Regenerates this man page from source.
-
- *NOTE*: Requires [`ronn`][ronn].
+ Regenerate this man page using [`ronn`][ronn]. See `man brew-man` for details.
* `missing`:
- Checks all installed formuale for missing dependencies.
+ Check all installed formuale for missing dependencies.
* `server`:
- Starts a local webserver with an app that lets you browse available
- formulae, similar to `gem server`.
-
- *NOTE*: Requires [`sinatra`][sinatra].
+ 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
@@ -243,7 +246,7 @@ Some external commands are shipped with Homebrew, and enabled by default.
* HOMEBREW\_DEBUG\_PREFIX:
When `brew install -d` or `brew install -i` drops into a shell,
- `HOMEBREW_DEBUG__PREFIX` will be set to the target prefix in the Cellar
+ `HOMEBREW_DEBUG_PREFIX` will be set to the target prefix in the Cellar
of the formula being brewed.
* HOMEBREW\_EDITOR:
@@ -255,8 +258,8 @@ Some external commands are shipped with Homebrew, and enabled by default.
editors will do strange things in this case.
* HOMEBREW\_KEEP\_INFO:
- If set, Homebrew will not remove files from share/info, allowing them to
- be linked from the Cellar.
+ If set, Homebrew will not remove files from `share/info`, allowing them
+ to be linked from the Cellar.
* HOMEBREW\_SVN:
When exporting from Subversion, Homebrew will use `HOMEBREW_SVN` if set,
@@ -270,14 +273,14 @@ Some external commands are shipped with Homebrew, and enabled by default.
Homebrew Prefix are on different volumes, as OS X has trouble moving
symlinks across volumes when the target does not yet exist.
- This issue typically occurs when using FileVault (or certain custom SSD
- configurations.)
+ This issue typically occurs when using FileVault or custom SSD
+ configurations.
* HOMEBREW\_USE\_LLVM:
If set, instructs Homebrew to use the LLVM front-ends to the GCC
compilers.
- *NOTE*: Not all formulae will build correctly under LLVM.
+ *NOTE*: Not all formulae build correctly with LLVM.
* HOMEBREW\_VERBOSE:
If set, instructs Homebrew to always assume `--verbose` when running
@@ -300,7 +303,9 @@ If your proxy requires authentication:
## SEE ALSO
-Homebrew Wiki: http://wiki.github.com/mxcl/homebrew/
+Homebrew Wiki: <http://wiki.github.com/mxcl/homebrew/>
+
+`git`(1), `git-log`(1)
## AUTHORS
@@ -308,4 +313,4 @@ Max Howell, a splendid chap.
## BUGS
-See Issues on GitHub: http://github.com/mxcl/homebrew/issues
+See Issues on GitHub: <http://github.com/mxcl/homebrew/issues>
diff --git a/share/man/man1/brew-man.1 b/share/man/man1/brew-man.1
new file mode 100644
index 0000000000..729b260a56
--- /dev/null
+++ b/share/man/man1/brew-man.1
@@ -0,0 +1,48 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "BREW\-MAN" "1" "November 2010" "Homebrew" "brew"
+.
+.SH "NAME"
+\fBbrew\-man\fR \- Generate man pages for Homebrew
+.
+.SH "SYNOPSIS"
+\fBbrew man\fR [\-\-verbose]
+.
+.br
+\fBbrew man\fR \-\-link
+.
+.br
+\fBbrew man\fR \-\-server
+.
+.SH "DESCRIPTION"
+Generates man pages for Homebrew using \fBronn\fR \fIhttp://rtomayko\.github\.com/ronn/\fR\.
+.
+.P
+\fBbrew man\fR by itself updates the man pages from the source files\.
+.
+.P
+With \fB\-\-link\fR, symlinks generated man pages to \fBshare/man\fR under the Homebrew Prefix\.
+.
+.P
+With \fB\-\-server\fR, starts ronn\'s dev server\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Run \fBman brew\fR after generating man pages\.
+.
+.TP
+\fB\-l\fR, \fB\-\-link\fR
+Creates symlinks from the generated man pages to the Homebrew Prefix, typically \fB/usr/local\fR\. Useful when Homebrew itself is not installed directly into \fB/usr/local\fR\.
+.
+.TP
+\fB\-s\fR, \fB\-\-server\fR
+Starts ronn\'s test server\.
+.
+.SH "SEE ALSO"
+\fBbrew\fR(1)
+.
+.SH "BUGS"
+See Issues on GitHub: \fIhttp://github\.com/mxcl/homebrew/issues\fR
diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1
index c2a0247244..5929ffaa44 100644
--- a/share/man/man1/brew.1
+++ b/share/man/man1/brew.1
@@ -25,27 +25,11 @@ Prints extra, comand\-specific debugging information\. Note that \fBbrew \-v\fR
.
.TP
\fB\-v\fR, \fB\-\-version\fR
-Prints the version number of brew to standard error and exits\.
-.
-.TP
-\fB\-\-prefix\fR [\fIformula\fR]
-Displays the install path for Homebrew\. If \fIformula\fR is given, display location in the cellar where that package is or would be installed\.
-.
-.TP
-\fB\-\-cache\fR [\fIformula\fR]
-Displays the path Homebrew uses to cache downloads\. If \fIformula\fR is given, display the file or folder used to cache that specific package\.
-.
-.TP
-\fB\-\-config\fR
-Shows 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\.
-.
-.TP
-\fB\-S\fR, \fBsearch\fR \fItext\fR|/\fItext\fR/
-Performs a substring search of formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. If no search term is given, all available formula are displayed\.
+Print the version number of brew to standard error and exit\.
.
.TP
\fBinstall [\-\-force] [\-\-debug] [\-\-use\-llvm] [\-\-ignore\-dependencies] [\-\-HEAD]\fR \fIformula\fR
-Installs \fIformula\fR\.
+Install \fIformula\fR\.
.
.IP
\fIformula\fR is usually the name of the formula to install, but may also be the URL for an arbitrary formula\.
@@ -54,7 +38,7 @@ Installs \fIformula\fR\.
If \fB\-\-force\fR is passed, will install \fIformula\fR even if it is already installed\. This can be used to re\-install a formula without removing it first\.
.
.IP
-If \fB\-\-debug\fR is passed and brewing fails, opens a shell inside the temporary folder used for compiling\.
+If \fB\-\-debug\fR is passed and brewing fails, open a shell inside the temporary folder used for compiling\.
.
.IP
If \fB\-\-use\-llvm\fR is passed, attempt to compile using the LLVM front\-end to GCC\. \fINOTE\fR: Not all formulae will build with LLVM\.
@@ -70,122 +54,122 @@ To install a newer version of HEAD use \fBbrew rm <foo> && brew install \-\-HEAD
.
.TP
\fBinstall \-\-interactive [\-\-git]\fR \fIformula\fR
-Downloads and patches \fIformula\fR, then opens a shell\. This allows the user to run \fB\./configure \-\-help\fR and otherwise determine how to turn the software package into a Homebrew formula\.
+Download and patch \fIformula\fR, then open a shell\. This allows the user to run \fB\./configure \-\-help\fR and otherwise determine how to turn the software package into a Homebrew formula\.
.
.IP
If \fB\-\-git\fR is passed, Homebrew will create a Git repository, useful for creating patches to the software\.
.
.TP
+\fB\-S\fR, \fBsearch\fR \fItext\fR|/\fItext\fR/
+Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. If no search term is given, all available formula are displayed\.
+.
+.TP
+\fB\-S \-\-macports\fR|\fB\-\-fink\fR \fItext\fR
+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\.
+.
+.TP
\fBlist\fR
-Lists all installed formulae\.
+List all installed formulae\.
.
.TP
\fBlist\fR \fIformula\fR
-Lists the installed files for \fIformula\fR\.
+List the installed files for \fIformula\fR\.
.
.TP
\fBinfo\fR \fIformula\fR
-Gives all available information for \fIformula\fR\.
+Give all available information for \fIformula\fR\.
.
.TP
\fBinfo \-\-github\fR \fIformula\fR
-Opens a browser to the GitHub History page for formula \fIformula\fR\.
-.
-.TP
-\fBinfo \-\-all\fR
-Summarises all installed packages; this is intended to be used by higher\-level tools\.
+Open a browser to the GitHub History page for formula \fIformula\fR\.
.
.TP
\fBinfo\fR \fIURL\fR
-Prints the name and version that will be detected for \fIURL\fR; only http:// URLs supported for now\.
+Print the name and version that will be detected for \fIURL\fR\.
.
.TP
\fBhome\fR
-Opens a browser to Homebrew\'s own homepage\.
+Open Homebrew\'s own homepage in a browser\.
.
.TP
\fBhome\fR \fIformula\fR
-Opens a browser to \fIformula\fR\'s homepage\.
+Open \fIformula\fR\'s homepage in a browser\.
.
.TP
-\fBrm\fR, \fBremove [\-\-force]\fR \fIformula\fR
-Uninstalls \fIformula\fR\.
+\fBrm\fR, \fBremove\fR, \fBuninstall [\-\-force]\fR \fIformula\fR
+Uninstall \fIformula\fR\.
.
.IP
If \fB\-\-force\fR is passed, and there are multiple versions of \fIformula\fR installed, deletes all installed versions\.
.
.TP
\fBcreate [\-\-cache]\fR \fIURL\fR
-Generates a formula for the downloadable file at \fIURL\fR and opens it in $EDITOR\. Homebrew will attempt to automatically derive the formula name and version, if it fails, you\'ll have to make your own template\. I suggest copying wget\'s\.
+Generate a formula for the downloadable file at \fIURL\fR and opens it in $EDITOR\. Homebrew will attempt to automatically derive the formula name and version, if it fails, you\'ll have to make your own template\. I suggest copying wget\'s\.
.
.IP
If \fB\-\-cache\fR is passed, Homebrew will download the \fIURL\fR to the cache and add the MD5 to the formula for you\.
.
.TP
-\fBcreate \-\-macports\fR|\fB\-\-fink\fR \fIformula\fR
-Opens a browser to the MacPorts or Fink package search page, so you can see how they do \fIformula\fR\.
-.
-.TP
\fBedit\fR \fIformula\fR
-Opens the formula in $EDITOR\.
+Open \fIformula\fR in $EDITOR\.
.
.TP
\fBedit\fR
-Opens all of Homebrew for editing in TextMate\.
+Open all of Homebrew for editing in TextMate\.
.
.TP
\fBln\fR, \fBlink\fR \fIformula\fR
-Symlinks all of \fIformula\fR\'s installed files into the Homebrew prefix\. This is done automatically when you install formula\. It is useful for DIY installation, or in cases where you want to swap out different versions of the same package that you have installed at the same time\.
+Symlink all of \fIformula\fR\'s installed files into the Homebrew prefix\. This is done automatically when you install formula\. It is useful for DIY installation, or in cases where you want to swap out different versions of the same package that you have installed at the same time\.
.
.TP
\fBunlink\fR \fIformula\fR
-Unsymlinks \fIformula\fR from the Homebrew prefix\.
+Unsymlink \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink foo && commands && brew link foo\fR\.
.
.TP
\fBprune\fR
-Removes dead symlinks from the Homebrew prefix\. This is generally not needed\. However, it can be useful if you are doing DIY installations\.
+Remove dead symlinks from the Homebrew prefix\. This is generally not needed, but can be useful when doing DIY installations\.
.
.TP
\fBoutdated\fR
-Shows formula that have an updated version available\.
+Show formula that have an updated version available\.
.
.TP
\fBdeps [\-\-1]\fR \fIformula\fR
-Shows \fIformula\fR\'s dependencies\.
+Show \fIformula\fR\'s dependencies\.
.
.IP
If \fB\-\-1\fR is passed, only show dependencies one level down, instead of recursing\.
.
.TP
\fBuses [\-\-installed]\fR \fIformula\fR
-Shows the formulas that specify \fIformula\fR as a dependency\. The list is not recursive; only one level of dependencies is resolved\.
+Show the formulas that specify \fIformula\fR as a dependency\. The list is not recursive; only one level of dependencies is resolved\.
.
.IP
If \fB\-\-installed\fR is passed, only lists installed formulae\.
.
.TP
\fBdoctor\fR
-Checks your system for potential problems\.
+Check your system for potential problems\.
.
.TP
\fBcat\fR \fIformula\fR
-Displays the source to \fIformula\fR\.
+Display the source to \fIformula\fR\.
.
.TP
\fBcleanup\fR [\fIformula\fR]
For all installed or specific formulae, remove any older versions from the cellar\.
.
.TP
-\fBupdate\fR
-Using Git, fetches the newest version of Homebrew from the GitHub repository\.
-.
-.TP
-\fBlog [git\-options]\fR \fIformula\fR \.\.\.
-Shows the git log for the given formulae\. Options that \fBgit log\fR recognizes can be passed before the formula list\.
+\fBlog [git\-log\-options]\fR \fIformula\fR \.\.\.
+Show the git log for the given formulae\. Options that \fBgit\-log\fR(1) recognizes can be passed before the formula list\.
.
.TP
\fBfetch [\-\-force] [\-v] [\-\-HEAD]\fR \fIformula\fR
-Downloads the tarball or checks out from VCS for the given \fIformula\fR\. For tarballs, also prints MD5 and SHA1 checksums\.
+Download the source package for the given \fIformula\fR\. For tarballs, also prints MD5 and SHA1 checksums\.
.
.IP
If \fB\-\-HEAD\fR is passed, download the HEAD version of \fIformula\fR instead\. \fB\-v\fR may also be passed to make the VCS checkout verbose, useful for seeing if an existing HEAD cache has been updated\.
@@ -193,40 +177,66 @@ If \fB\-\-HEAD\fR is passed, download the HEAD version of \fIformula\fR instead\
.IP
If \fB\-\-force\fR is passed, remove a previously cached version and re\-fetch\.
.
+.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\.
+.
+.TP
+\fB\-\-prefix\fR
+Display Homebrew\'s install path\. \fIDefault:\fR \fB/usr/local\fR
+.
+.TP
+\fB\-\-prefix\fR \fIformula\fR
+Display the location in the cellar where \fIformula\fR is or would be installed\.
+.
+.TP
+\fB\-\-cellar\fR
+Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB/usr/local/Cellar\fR
+.
+.TP
+\fB\-\-cellar\fR
+Display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned folder as the last path\.
+.
+.TP
+\fB\-\-cache\fR
+Display Homebrew\'s download cache\. \fIDefault:\fR \fB~/Library/Cache/Homebrew\fR
+.
+.TP
+\fB\-\-cache\fR \fIformula\fR
+Display the file or folder used to cache \fIformula\fR\.
+.
+.TP
+\fB\-\-repository\fR
+Display where Homebrew\'s \fB\.git\fR folder is located\. For standard installs, the \fBprefix\fR and \fBrepository\fR are the same folder\.
+.
.SH "EXTERNAL COMMANDS"
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
-Some external commands are shipped with Homebrew, and enabled by default\.
+These external commands are shipped with Homebrew\.
.
.TP
\fBaudit [\-\-warn]\fR
-Checks all formulae for Homebrew coding style violations\. This should be run before submitting a new formula for inclusion\.
+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, performs additional stricter checks that may not need to be fixed before submitting\.
+If \fB\-\-warn\fR is passed, perform additional stricter checks that may not need to be fixed before submitting\.
.
.TP
\fBoptions\fR \fIformula\fR
-Displays install options specific to \fIformula\fR\.
+Display install options specific to \fIformula\fR\.
.
.TP
\fBman\fR
-Regenerates this man page from source\.
-.
-.IP
-\fINOTE\fR: Requires \fBronn\fR \fIhttp://rtomayko\.github\.com/ronn/\fR\.
+Regenerate this man page using \fBronn\fR \fIhttp://rtomayko\.github\.com/ronn/\fR\. See \fBman brew\-man\fR for details\.
.
.TP
\fBmissing\fR
-Checks all installed formuale for missing dependencies\.
+Check all installed formuale for missing dependencies\.
.
.TP
\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\.
+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
@@ -247,7 +257,7 @@ When \fBbrew install \-d\fR or \fBbrew install \-i\fR drops into a shell, \fBHOM
.
.TP
HOMEBREW_DEBUG_PREFIX
-When \fBbrew install \-d\fR or \fBbrew install \-i\fR drops into a shell, \fBHOMEBREW_DEBUG__PREFIX\fR will be set to the target prefix in the Cellar of the formula being brewed\.
+When \fBbrew install \-d\fR or \fBbrew install \-i\fR drops into a shell, \fBHOMEBREW_DEBUG_PREFIX\fR will be set to the target prefix in the Cellar of the formula being brewed\.
.
.TP
HOMEBREW_EDITOR
@@ -258,7 +268,7 @@ If set, Homebrew will use this editor when editing a single formula, or several
.
.TP
HOMEBREW_KEEP_INFO
-If set, Homebrew will not remove files from share/info, allowing them to be linked from the Cellar\.
+If set, Homebrew will not remove files from \fBshare/info\fR, allowing them to be linked from the Cellar\.
.
.TP
HOMEBREW_SVN
@@ -272,14 +282,14 @@ HOMEBREW_TEMP
If set, instructs Homebrew to use \fBHOMEBREW_TEMP\fR as the temporary folder for building packages\. This may be needed if your system temp folder and Homebrew Prefix are on different volumes, as OS X has trouble moving symlinks across volumes when the target does not yet exist\.
.
.IP
-This issue typically occurs when using FileVault (or certain custom SSD configurations\.)
+This issue typically occurs when using FileVault or custom SSD configurations\.
.
.TP
HOMEBREW_USE_LLVM
If set, instructs Homebrew to use the LLVM front\-ends to the GCC compilers\.
.
.IP
-\fINOTE\fR: Not all formulae will build correctly under LLVM\.
+\fINOTE\fR: Not all formulae build correctly with LLVM\.
.
.TP
HOMEBREW_VERBOSE
@@ -315,10 +325,13 @@ http_proxy=http://<user>:<password>@<host>:<port> brew install foo
.IP "" 0
.
.SH "SEE ALSO"
-Homebrew Wiki: http://wiki\.github\.com/mxcl/homebrew/
+Homebrew Wiki: \fIhttp://wiki\.github\.com/mxcl/homebrew/\fR
+.
+.P
+\fBgit\fR(1), \fBgit\-log\fR(1)
.
.SH "AUTHORS"
Max Howell, a splendid chap\.
.
.SH "BUGS"
-See Issues on GitHub: http://github\.com/mxcl/homebrew/issues
+See Issues on GitHub: \fIhttp://github\.com/mxcl/homebrew/issues\fR
--
GitLab