Generate the new man page

Library/Homebrew/manpages/brew.1.md

@@ -275,14 +275,14 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
     If provided, `--local` will symlink them into the user's `~/Applications`
     directory instead of the system directory.
 
-  * `ls`, `list` [`--full-name`]:
+  * `list`, `ls` [`--full-name`]:
     List all installed formulae. If `--full-name` is passed, print formulae with
     full-qualified names.
 
-  * `ls`, `list` `--unbrewed`:
+  * `list`, `ls` `--unbrewed`:
     List all files in the Homebrew prefix not installed by Homebrew.
 
-  * `ls`, `list` [`--versions` [`--multiple`]] [`--pinned`] [<formulae>]:
+  * `list`, `ls` [`--versions` [`--multiple`]] [`--pinned`] [<formulae>]:
     List the installed files for <formulae>. Combined with `--verbose`, recursively
     list the contents of all subdirectories in each <formula>'s keg.
 
@@ -298,11 +298,6 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
     Show the git log for the given formulae. Options that `git-log`(1)
     recognizes can be passed before the formula list.
 
-  * `missing` [<formulae>]:
-    Check the given <formulae> for missing dependencies.
-
-    If no <formulae> are given, check all installed brews.
-
   * `migrate` [`--force`] <formulae>:
     Migrate renamed packages to new name, where <formulae> are old names of
     packages.
@@ -310,6 +305,11 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
     If `--force` is passed, then treat installed <formulae> and passed <formulae>
     like if they are from same taps and migrate them anyway.
 
+  * `missing` [<formulae>]:
+    Check the given <formulae> for missing dependencies.
+
+    If no <formulae> are given, check all installed brews.
+
   * `options` [`--compact`] (`--all`|`--installed`|<formulae>):
     Display install options specific to <formulae>.
 
@@ -350,12 +350,6 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
   * `reinstall` <formula>:
     Uninstall then install <formula>
 
-  * `rm`, `remove`, `uninstall` [`--force`] <formula>:
-    Uninstall <formula>.
-
-    If `--force` is passed, and there are multiple versions of <formula>
-    installed, delete all installed versions.
-
   * `search`, `-S`:
     Display all locally available formulae for brewing (including tapped ones).
     No online search is performed if called without arguments.
@@ -444,6 +438,12 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
 
     Example: `brew install jruby && brew test jruby`
 
+  * `uninstall`, `rm`, `remove` [`--force`] <formula>:
+    Uninstall <formula>.
+
+    If `--force` is passed, and there are multiple versions of <formula>
+    installed, delete all installed versions.
+
   * `unlink` [`--dry-run`] <formula>:
     Remove symlinks for <formula> from the Homebrew prefix. This can be useful
     for temporarily disabling a formula:

Library/Homebrew/manpages/footer.1.md

@@ -0,0 +1,231 @@
+
+
+  * `--cache`:
+    Display Homebrew's download cache. See also `HOMEBREW_CACHE`.
+
+  * `--cache` <formula>:
+    Display the file or directory used to cache <formula>.
+
+  * `--cellar`:
+    Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if
+    that directory doesn't exist, `$(brew --repository)/Cellar`.
+
+  * `--cellar` <formula>:
+    Display the location in the cellar where <formula> would be installed,
+    without any sort of versioned directory as the last path.
+
+  * `--env`:
+    Show a summary of the Homebrew build environment.
+
+  * `--prefix`:
+    Display Homebrew's install path. *Default:* `/usr/local`
+
+  * `--prefix` <formula>:
+    Display the location in the cellar where <formula> is or would be installed.
+
+  * `--repository`:
+    Display where Homebrew's `.git` directory is located. For standard installs,
+    the `prefix` and `repository` are the same directory.
+
+  * `--repository` <user>`/`<repo>:
+    Display where tap <user>`/`<repo>'s directory is located.
+
+  * `--version`:
+    Print the version number of brew to standard error and exit.
+
+## EXTERNAL COMMANDS
+
+Homebrew, like `git`(1), supports external commands. These are executable
+scripts that reside somewhere in the `PATH`, named `brew-`<cmdname> or
+`brew-`<cmdname>`.rb`, which can be invoked like `brew` <cmdname>. This allows you
+to create your own commands without modifying Homebrew's internals.
+
+Instructions for creating your own commands can be found in the docs:
+<https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/External-Commands.md>
+
+## SPECIFYING FORMULAE
+
+Many Homebrew commands accept one or more <formula> arguments. These arguments
+can take several different forms:
+
+  * The name of a formula:
+    e.g. `git`, `node`, `wget`.
+
+  * The fully-qualified name of a tapped formula:
+    Sometimes a formula from a tapped repository may conflict with one in `Homebrew/homebrew`.
+    You can still access these formulae by using a special syntax, e.g.
+    `homebrew/dupes/vim` or `homebrew/versions/node4`.
+
+  * An arbitrary URL:
+    Homebrew can install formulae via URL, e.g.
+    `https://raw.github.com/Homebrew/homebrew-core/master/Formula/git.rb`.
+    The formula file will be cached for later use.
+
+## ENVIRONMENT
+
+  * `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`:
+    When using the `S3` download strategy, Homebrew will look in
+    these variables for access credentials (see
+    <https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-environment>
+    to retrieve these access credentials from AWS).  If they are not set,
+    the `S3` download strategy will download with a public
+    (unsigned) URL.
+
+  * `BROWSER`:
+    If set, and `HOMEBREW_BROWSER` is not, use `BROWSER` as the web browser
+    when opening project homepages.
+
+  * `EDITOR`:
+    If set, and `HOMEBREW_EDITOR` and `VISUAL` are not, use `EDITOR` as the text editor.
+
+  * `GIT`:
+    When using Git, Homebrew will use `GIT` if set,
+    a Homebrew-built Git if installed, or the system-provided binary.
+
+    Set this to force Homebrew to use a particular git binary.
+
+  * `HOMEBREW_BOTTLE_DOMAIN`:
+    If set, instructs Homebrew to use the given URL as a download mirror for bottles.
+
+  * `HOMEBREW_BROWSER`:
+    If set, uses this setting as the browser when opening project homepages,
+    instead of the OS default browser.
+
+  * `HOMEBREW_BUILD_FROM_SOURCE`:
+    If set, instructs Homebrew to compile from source even when a formula
+    provides a bottle. This environment variable is intended for use by
+    Homebrew developers. Please do not file issues if you encounter errors when
+    using this environment variable.
+
+  * `HOMEBREW_CACHE`:
+    If set, instructs Homebrew to use the given directory as the download cache.
+
+    *Default:* `~/Library/Caches/Homebrew` if it exists; otherwise,
+    `/Library/Caches/Homebrew`.
+
+  * `HOMEBREW_CURL_VERBOSE`:
+    If set, Homebrew will pass `--verbose` when invoking `curl`(1).
+
+  * `HOMEBREW_DEBUG`:
+    If set, any commands that can emit debugging information will do so.
+
+  * `HOMEBREW_DEBUG_INSTALL`:
+    When `brew install -d` or `brew install -i` drops into a shell,
+    `HOMEBREW_DEBUG_INSTALL` will be set to the name of the formula being
+    brewed.
+
+  * `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
+    of the formula being brewed.
+
+  * `HOMEBREW_DEVELOPER`:
+    If set, Homebrew will print warnings that are only relevant to Homebrew
+    developers (active or budding).
+
+  * `HOMEBREW_EDITOR`:
+    If set, Homebrew will use this editor when editing a single formula, or
+    several formulae in the same directory.
+
+    *NOTE*: `brew edit` will open all of Homebrew as discontinuous files and
+    directories. TextMate can handle this correctly in project mode, but many
+    editors will do strange things in this case.
+
+  * `HOMEBREW_GITHUB_API_TOKEN`:
+    A personal access token for the GitHub API, which you can create at
+    <https://github.com/settings/tokens>. If set, GitHub will allow you a
+    greater number of API requests. See
+    <https://developer.github.com/v3/#rate-limiting> for more information.
+    Homebrew uses the GitHub API for features such as `brew search`.
+
+    *NOTE*: Homebrew doesn't require permissions for any of the scopes.
+
+  * `HOMEBREW_LOGS`:
+    If set, Homebrew will use the given directory to store log files.
+
+  * `HOMEBREW_MAKE_JOBS`:
+    If set, instructs Homebrew to use the value of `HOMEBREW_MAKE_JOBS` as
+    the number of parallel jobs to run when building with `make`(1).
+
+    *Default:* the number of available CPU cores.
+
+  * `HOMEBREW_NO_EMOJI`:
+    If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a
+    successful build.
+
+    *Note:* Homebrew will only try to print emoji on Lion or newer.
+
+  * `HOMEBREW_NO_INSECURE_REDIRECT`:
+    If set, Homebrew will not permit redirects from secure HTTPS
+    to insecure HTTP.
+
+    While ensuring your downloads are fully secure, this is likely
+    to cause from-source Sourceforge & GNOME based formulae
+    to fail to download.
+
+    Apache formulae are currently unaffected by this variable and
+    can redirect to plaintext.
+
+  * `HOMEBREW_NO_GITHUB_API`:
+    If set, Homebrew will not use the GitHub API for e.g searches or
+    fetching relevant issues on a failed install.
+
+  * `HOMEBREW_INSTALL_BADGE`:
+    Text printed before the installation summary of each successful build.
+    Defaults to the beer emoji.
+
+  * `HOMEBREW_SVN`:
+    When exporting from Subversion, Homebrew will use `HOMEBREW_SVN` if set,
+    a Homebrew-built Subversion if installed, or the system-provided binary.
+
+    Set this to force Homebrew to use a particular `svn` binary.
+
+  * `HOMEBREW_TEMP`:
+    If set, instructs Homebrew to use `HOMEBREW_TEMP` as the temporary directory
+    for building packages. This may be needed if your system temp directory and
+    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 custom SSD
+    configurations.
+
+  * `HOMEBREW_VERBOSE`:
+    If set, Homebrew always assumes `--verbose` when running commands.
+
+  * `VISUAL`:
+    If set, and `HOMEBREW_EDITOR` is not, use `VISUAL` as the text editor.
+
+## USING HOMEBREW BEHIND A PROXY
+
+Homebrew uses several commands for downloading files (e.g. `curl`, `git`, `svn`).
+Many of these tools can download via a proxy. It's common for these tools
+to read proxy parameters from environment variables.
+
+For the majority of cases setting `http_proxy` is enough. You can set this in
+your shell profile, or you can use it before a brew command:
+
+    http_proxy=http://<host>:<port> brew install foo
+
+If your proxy requires authentication:
+
+    http_proxy=http://<user>:<password>@<host>:<port> brew install foo
+
+## SEE ALSO
+
+Homebrew Documentation: <https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/>
+
+`git`(1), `git-log`(1)
+
+## AUTHORS
+
+Homebrew's current maintainers are Misty De Meo, Andrew Janke, Xu Cheng, Mike McQuaid, Baptiste Fontaine, Brett Koonce, Martin Afanasjew, Dominyk Tiller, Tim Smith and Alex Dunn.
+
+Former maintainers with significant contributions include Jack Nagel, Adam Vandenberg and Homebrew's creator: Max Howell.
+
+## BUGS
+
+See our issues on GitHub:
+
+ * Homebrew/brew <https://github.com/Homebrew/brew/issues>
+
+ * Homebrew/homebrew-core <https://github.com/Homebrew/homebrew-core/issues>

Library/Homebrew/manpages/header.1.md

@@ -0,0 +1,38 @@
+brew(1) -- The missing package manager for OS X
+===============================================
+
+## SYNOPSIS
+
+`brew` `--version`<br>
+`brew` <command> [`--verbose`|`-v`] [<options>] [<formula>] ...
+
+## DESCRIPTION
+
+Homebrew is the easiest and most flexible way to install the UNIX tools Apple
+didn't include with OS X.
+
+## ESSENTIAL COMMANDS
+
+For the full command list, see the [COMMANDS][] section.
+
+With `--verbose` or `-v`, many commands print extra debugging information. Note that these flags should only appear after a command.
+
+  * `install` <formula>:
+    Install <formula>.
+
+  * `remove` <formula>:
+    Uninstall <formula>.
+
+  * `update`:
+    Fetch the newest version of Homebrew from GitHub using `git`(1).
+
+  * `list`:
+    List all installed formulae.
+
+  * `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.
+    The search for <text> is extended online to some popular taps.
+    If no search term is given, all locally available formulae are listed.
+
+## COMMANDS

share/doc/homebrew/brew.1.html

@@ -221,10 +221,10 @@ into <code>/Applications</code>, allowing for easier access.</p>
 
 <p>If provided, <code>--local</code> will symlink them into the user's <code>~/Applications</code>
 directory instead of the system directory.</p></dd>
-<dt><code>ls</code>, <code>list</code> [<code>--full-name</code>]</dt><dd><p>List all installed formulae. If <code>--full-name</code> is passed, print formulae with
+<dt><code>list</code>, <code>ls</code> [<code>--full-name</code>]</dt><dd><p>List all installed formulae. If <code>--full-name</code> is passed, print formulae with
 full-qualified names.</p></dd>
-<dt><code>ls</code>, <code>list</code> <code>--unbrewed</code></dt><dd><p>List all files in the Homebrew prefix not installed by Homebrew.</p></dd>
+<dt><code>list</code>, <code>ls</code> <code>--unbrewed</code></dt><dd><p>List all files in the Homebrew prefix not installed by Homebrew.</p></dd>
-<dt><code>ls</code>, <code>list</code> [<code>--versions</code> [<code>--multiple</code>]] [<code>--pinned</code>] [<var>formulae</var>]</dt><dd><p>List the installed files for <var>formulae</var>. Combined with <code>--verbose</code>, recursively
+<dt><code>list</code>, <code>ls</code> [<code>--versions</code> [<code>--multiple</code>]] [<code>--pinned</code>] [<var>formulae</var>]</dt><dd><p>List the installed files for <var>formulae</var>. Combined with <code>--verbose</code>, recursively
 list the contents of all subdirectories in each <var>formula</var>'s keg.</p>
 
 <p>If <code>--versions</code> is passed, show the version number for installed formulae,
@@ -236,14 +236,14 @@ specified (pinned) formulae if <var>formulae</var> are given.
 See also <code>pin</code>, <code>unpin</code>.</p></dd>
 <dt><code>log</code> [<code>git-log-options</code>] <var>formula</var> ...</dt><dd><p>Show the git log for the given formulae. Options that <code>git-log</code>(1)
 recognizes can be passed before the formula list.</p></dd>
-<dt><code>missing</code> [<var>formulae</var>]</dt><dd><p>Check the given <var>formulae</var> for missing dependencies.</p>
-
-<p>If no <var>formulae</var> are given, check all installed brews.</p></dd>
 <dt><code>migrate</code> [<code>--force</code>] <var>formulae</var></dt><dd><p>Migrate renamed packages to new name, where <var>formulae</var> are old names of
 packages.</p>
 
 <p>If <code>--force</code> is passed, then treat installed <var>formulae</var> and passed <var>formulae</var>
 like if they are from same taps and migrate them anyway.</p></dd>
+<dt><code>missing</code> [<var>formulae</var>]</dt><dd><p>Check the given <var>formulae</var> for missing dependencies.</p>
+
+<p>If no <var>formulae</var> are given, check all installed brews.</p></dd>
 <dt><code>options</code> [<code>--compact</code>] (<code>--all</code>|<code>--installed</code>|<var>formulae</var>)</dt><dd><p>Display install options specific to <var>formulae</var>.</p>
 
 <p>If <code>--compact</code> is passed, show all options on a single line separated by
@@ -274,10 +274,6 @@ created by <code>brew linkapps</code>.</p>
 <p>If <code>--dry-run</code> or <code>-n</code> is passed, show what would be removed, but do not
 actually remove anything.</p></dd>
 <dt><code>reinstall</code> <var>formula</var></dt><dd><p>Uninstall then install <var>formula</var></p></dd>
-<dt><code>rm</code>, <code>remove</code>, <code>uninstall</code> [<code>--force</code>] <var>formula</var></dt><dd><p>Uninstall <var>formula</var>.</p>
-
-<p>If <code>--force</code> is passed, and there are multiple versions of <var>formula</var>
-installed, delete all installed versions.</p></dd>
 <dt><code>search</code>, <code>-S</code></dt><dd><p>Display all locally available formulae for brewing (including tapped ones).
 No online search is performed if called without arguments.</p></dd>
 <dt><code>search</code>, <code>-S</code> <var>text</var>|<code>/</code><var>text</var><code>/</code></dt><dd><p>Perform a substring search of formula names for <var>text</var>. If <var>text</var> is
@@ -336,6 +332,10 @@ formula.</p>
 launched with access to IRB or a shell inside the temporary test directory.</p>
 
 <p>Example: <code>brew install jruby &amp;&amp; brew test jruby</code></p></dd>
+<dt><code>uninstall</code>, <code>rm</code>, <code>remove</code> [<code>--force</code>] <var>formula</var></dt><dd><p>Uninstall <var>formula</var>.</p>
+
+<p>If <code>--force</code> is passed, and there are multiple versions of <var>formula</var>
+installed, delete all installed versions.</p></dd>
 <dt><code>unlink</code> [<code>--dry-run</code>] <var>formula</var></dt><dd><p>Remove symlinks for <var>formula</var> from the Homebrew prefix. This can be useful
 for temporarily disabling a formula:
 <code>brew unlink foo &amp;&amp; commands &amp;&amp; brew link foo</code>.</p>

share/man/man1/brew.1

@@ -295,15 +295,15 @@ If no \fIformulae\fR are provided, all of them will have their apps symlinked\.
 If provided, \fB\-\-local\fR will symlink them into the user\'s \fB~/Applications\fR directory instead of the system directory\.
 .
 .TP
-\fBls\fR, \fBlist\fR [\fB\-\-full\-name\fR]
+\fBlist\fR, \fBls\fR [\fB\-\-full\-name\fR]
 List all installed formulae\. If \fB\-\-full\-name\fR is passed, print formulae with full\-qualified names\.
 .
 .TP
-\fBls\fR, \fBlist\fR \fB\-\-unbrewed\fR
+\fBlist\fR, \fBls\fR \fB\-\-unbrewed\fR
 List all files in the Homebrew prefix not installed by Homebrew\.
 .
 .TP
-\fBls\fR, \fBlist\fR [\fB\-\-versions\fR [\fB\-\-multiple\fR]] [\fB\-\-pinned\fR] [\fIformulae\fR]
+\fBlist\fR, \fBls\fR [\fB\-\-versions\fR [\fB\-\-multiple\fR]] [\fB\-\-pinned\fR] [\fIformulae\fR]
 List the installed files for \fIformulae\fR\. Combined with \fB\-\-verbose\fR, recursively list the contents of all subdirectories in each \fIformula\fR\'s keg\.
 .
 .IP
@@ -317,13 +317,6 @@ If \fB\-\-pinned\fR is passed, show the versions of pinned formulae, or only the
 Show the git log for the given formulae\. Options that \fBgit\-log\fR(1) recognizes can be passed before the formula list\.
 .
 .TP
-\fBmissing\fR [\fIformulae\fR]
-Check the given \fIformulae\fR for missing dependencies\.
-.
-.IP
-If no \fIformulae\fR are given, check all installed brews\.
-.
-.TP
 \fBmigrate\fR [\fB\-\-force\fR] \fIformulae\fR
 Migrate renamed packages to new name, where \fIformulae\fR are old names of packages\.
 .
@@ -331,6 +324,13 @@ Migrate renamed packages to new name, where \fIformulae\fR are old names of pack
 If \fB\-\-force\fR is passed, then treat installed \fIformulae\fR and passed \fIformulae\fR like if they are from same taps and migrate them anyway\.
 .
 .TP
+\fBmissing\fR [\fIformulae\fR]
+Check the given \fIformulae\fR for missing dependencies\.
+.
+.IP
+If no \fIformulae\fR are given, check all installed brews\.
+.
+.TP
 \fBoptions\fR [\fB\-\-compact\fR] (\fB\-\-all\fR|\fB\-\-installed\fR|\fIformulae\fR)
 Display install options specific to \fIformulae\fR\.
 .
@@ -375,13 +375,6 @@ If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, show what would be removed, but do
 Uninstall then install \fIformula\fR
 .
 .TP
-\fBrm\fR, \fBremove\fR, \fBuninstall\fR [\fB\-\-force\fR] \fIformula\fR
-Uninstall \fIformula\fR\.
-.
-.IP
-If \fB\-\-force\fR is passed, and there are multiple versions of \fIformula\fR installed, delete all installed versions\.
-.
-.TP
 \fBsearch\fR, \fB\-S\fR
 Display all locally available formulae for brewing (including tapped ones)\. No online search is performed if called without arguments\.
 .
@@ -469,6 +462,13 @@ If \fB\-\-debug\fR is passed and the test fails, an interactive debugger will be
 Example: \fBbrew install jruby && brew test jruby\fR
 .
 .TP
+\fBuninstall\fR, \fBrm\fR, \fBremove\fR [\fB\-\-force\fR] \fIformula\fR
+Uninstall \fIformula\fR\.
+.
+.IP
+If \fB\-\-force\fR is passed, and there are multiple versions of \fIformula\fR installed, delete all installed versions\.
+.
+.TP
 \fBunlink\fR [\fB\-\-dry\-run\fR] \fIformula\fR
 Remove symlinks for \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink foo && commands && brew link foo\fR\.
 .