Document all short flags.

Library/Homebrew/cmd/fetch.rb

@@ -8,14 +8,14 @@
 #:    If `-v` is passed, do a verbose VCS checkout, if the URL represents a VCS.
 #:    This is useful for seeing if an existing VCS cache has been updated.
 #:
-#:    If `--force` is passed, remove a previously cached version and re-fetch.
+#:    If `--force` (or `-f`) is passed, remove a previously cached version and re-fetch.
 #:
 #:    If `--retry` is passed, retry if a download fails or re-download if the
 #:    checksum of a previously cached version no longer matches.
 #:
 #:    If `--deps` is passed, also download dependencies for any listed <formulae>.
 #:
-#:    If `--build-from-source` is passed, download the source rather than a
+#:    If `--build-from-source` (or `-s`) is passed, download the source rather than a
 #:    bottle.
 #:
 #:    If `--force-bottle` is passed, download a bottle if it exists for the

Library/Homebrew/cmd/install.rb

@@ -4,7 +4,7 @@
 #:    <formula> is usually the name of the formula to install, but it can be specified
 #:    in several different ways. See [SPECIFYING FORMULAE][].
 #:
-#:    If `--debug` is passed and brewing fails, open an interactive debugging
+#:    If `--debug` (or `-d`) is passed and brewing fails, open an interactive debugging
 #:    session with access to IRB or a shell inside the temporary build directory.
 #:
 #:    If `--env=std` is passed, use the standard build environment instead of superenv.
@@ -24,7 +24,7 @@
 #:    `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC
 #:    4.9.
 #:
-#:    If `--build-from-source` or `-s` is passed, compile the specified <formula> from
+#:    If `--build-from-source` (or `-s`) is passed, compile the specified <formula> from
 #:    source even if a bottle is provided. Dependencies will still be installed
 #:    from bottles if they are available.
 #:
@@ -48,11 +48,12 @@
 #:    during installation.
 #:
 #:  * `install` `--interactive` [`--git`] <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 `--interactive` (or `-i`) is passed, 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
+#:    If `--git` (or `-g`) is passed, Homebrew will create a Git repository, useful for
 #:    creating patches to the software.
 
 require "missing_formula"

Library/Homebrew/cmd/link.rb

@@ -10,7 +10,7 @@
 #:    be linked or which would be deleted by `brew link --overwrite`, but will not
 #:    actually link or delete any files.
 #:
-#:    If `--force` is passed, Homebrew will allow keg-only formulae to be linked.
+#:    If `--force` (or `-f`) is passed, Homebrew will allow keg-only formulae to be linked.
 
 require "ostruct"
 

Library/Homebrew/cmd/migrate.rb

@@ -2,7 +2,7 @@
 #:    Migrate renamed packages to new name, where <formulae> are old names of
 #:    packages.
 #:
-#:    If `--force` is passed, then treat installed <formulae> and passed <formulae>
+#:    If `--force` (or `-f`) is passed, then treat installed <formulae> and passed <formulae>
 #:    like if they are from same taps and migrate them anyway.
 
 require "migrator"

Library/Homebrew/cmd/outdated.rb

@@ -7,7 +7,7 @@
 #:    If `--quiet` is passed, list only the names of outdated brews (takes
 #:    precedence over `--verbose`).
 #:
-#:    If `--verbose` is passed, display detailed version information.
+#:    If `--verbose` (or `-v`) is passed, display detailed version information.
 #:
 #:    If `--json=`<version> is passed, the output will be in JSON format. The only
 #:    valid version is `v1`.

Library/Homebrew/cmd/uninstall.rb

 #:  * `uninstall`, `rm`, `remove` [`--force`] [`--ignore-dependencies`] <formula>:
 #:    Uninstall <formula>.
 #:
-#:    If `--force` is passed, and there are multiple versions of <formula>
+#:    If `--force` (or `-f`) is passed, and there are multiple versions of <formula>
 #:    installed, delete all installed versions.
 #:
 #:    If `--ignore-dependencies` is passed, uninstalling won't fail, even if

Library/Homebrew/cmd/unpack.rb

@@ -6,7 +6,7 @@
 #:    If `--patch` is passed, patches for <formulae> will be applied to the
 #:    unpacked source.
 #:
-#:    If `--git` is passed, a Git repository will be initialized in the unpacked
+#:    If `--git` (or `-g`) is passed, a Git repository will be initialized in the unpacked
 #:    source. This is useful for creating patches for the software.
 
 require "stringio"

Library/Homebrew/cmd/update.sh

@@ -5,7 +5,7 @@
 #:    If `--merge` is specified then `git merge` is used to include updates
 #:    (rather than `git rebase`).
 #:
-#:    If `--force` is specified then always do a slower, full update check even
+#:    If `--force` (or `-f`) is specified then always do a slower, full update check even
 #:    if unnecessary.
 
 # Hide shellcheck complaint:

Library/Homebrew/dev-cmd/bottle.rb

@@ -6,7 +6,7 @@
 #:    generated DSL. Passing `--keep-old` will attempt to keep it at its
 #:    original value, while `--no-rebuild` will remove it.
 #:
-#:    If `--verbose` is passed, print the bottling commands and any warnings
+#:    If `--verbose` (or `-v`) is passed, print the bottling commands and any warnings
 #:    encountered.
 #:
 #:    If `--skip-relocation` is passed, do not check if the bottle can be marked

Library/Homebrew/dev-cmd/test.rb

@@ -7,7 +7,7 @@
 #:    To test the development or head version of a formula, use `--devel` or
 #:    `--HEAD`.
 #:
-#:    If `--debug` is passed and the test fails, an interactive debugger will be
+#:    If `--debug` (or `-d`) is passed and the test fails, an interactive debugger will be
 #:    launched with access to IRB or a shell inside the temporary test directory.
 #:
 #:    If `--keep-tmp` is passed, the temporary files created for the test are

Library/Homebrew/dev-cmd/tests.rb

@@ -3,7 +3,7 @@
 #:    `--only=`<test_script> runs only <test_script>_spec.rb, and `--seed`
 #:    randomizes tests with the provided value instead of a random seed.
 #:
-#:    If `--verbose` is passed, print the command that runs the tests.
+#:    If `--verbose` (or `-v`) is passed, print the command that runs the tests.
 #:
 #:    If `--coverage` is passed, also generate code coverage reports.
 #:

manpages/brew-cask.1

 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "BREW\-CASK" "1" "March 2017" "Homebrew" "brew-cask"
+.TH "BREW\-CASK" "1" "April 2017" "Homebrew" "brew-cask"
 .
 .SH "NAME"
 \fBbrew\-cask\fR \- a friendly binary installer for macOS

manpages/brew.1

 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "BREW" "1" "March 2017" "Homebrew" "brew"
+.TH "BREW" "1" "April 2017" "Homebrew" "brew"
 .
 .SH "NAME"
 \fBbrew\fR \- The missing package manager for macOS
@@ -159,7 +159,7 @@ If \fB\-\-HEAD\fR or \fB\-\-devel\fR is passed, fetch that version instead of th
 If \fB\-v\fR is passed, do a verbose VCS checkout, if the URL represents a VCS\. This is useful for seeing if an existing VCS cache has been updated\.
 .
 .IP
-If \fB\-\-force\fR is passed, remove a previously cached version and re\-fetch\.
+If \fB\-\-force\fR (or \fB\-f\fR) is passed, remove a previously cached version and re\-fetch\.
 .
 .IP
 If \fB\-\-retry\fR is passed, retry if a download fails or re\-download if the checksum of a previously cached version no longer matches\.
@@ -168,7 +168,7 @@ If \fB\-\-retry\fR is passed, retry if a download fails or re\-download if the c
 If \fB\-\-deps\fR is passed, also download dependencies for any listed \fIformulae\fR\.
 .
 .IP
-If \fB\-\-build\-from\-source\fR is passed, download the source rather than a bottle\.
+If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) is passed, download the source rather than a bottle\.
 .
 .IP
 If \fB\-\-force\-bottle\fR is passed, download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation\.
@@ -223,7 +223,7 @@ Install \fIformula\fR\.
 \fIformula\fR is usually the name of the formula to install, but it can be specified in several different ways\. See \fISPECIFYING FORMULAE\fR\.
 .
 .IP
-If \fB\-\-debug\fR is passed and brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\.
+If \fB\-\-debug\fR (or \fB\-d\fR) is passed and brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\.
 .
 .IP
 If \fB\-\-env=std\fR is passed, use the standard build environment instead of superenv\.
@@ -241,7 +241,7 @@ If \fB\-\-only\-dependencies\fR is passed, install the dependencies with specifi
 If \fB\-\-cc=\fR\fIcompiler\fR is passed, attempt to compile using \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-4\.2\fR for Apple\'s GCC 4\.2, or \fBgcc\-4\.9\fR for a Homebrew\-provided GCC 4\.9\.
 .
 .IP
-If \fB\-\-build\-from\-source\fR or \fB\-s\fR is passed, compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\.
+If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) is passed, compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\.
 .
 .IP
 If \fBHOMEBREW_BUILD_FROM_SOURCE\fR is set, regardless of whether \fB\-\-build\-from\-source\fR was passed, then both \fIformula\fR and the dependencies installed as part of this process are built from source even if bottles are available\.
@@ -263,10 +263,10 @@ If \fB\-\-build\-bottle\fR is passed, prepare the formula for eventual bottling
 .
 .TP
 \fBinstall\fR \fB\-\-interactive\fR [\fB\-\-git\fR] \fIformula\fR
-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\.
+If \fB\-\-interactive\fR (or \fB\-i\fR) is passed, 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\.
+If \fB\-\-git\fR (or \fB\-g\fR) is passed, Homebrew will create a Git repository, useful for creating patches to the software\.
 .
 .TP
 \fBirb\fR [\fB\-\-examples\fR]
@@ -290,7 +290,7 @@ If \fB\-\-overwrite\fR is passed, Homebrew will delete files which already exist
 If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, Homebrew will list all files which would be linked or which would be deleted by \fBbrew link \-\-overwrite\fR, but will not actually link or delete any files\.
 .
 .IP
-If \fB\-\-force\fR is passed, Homebrew will allow keg\-only formulae to be linked\.
+If \fB\-\-force\fR (or \fB\-f\fR) is passed, Homebrew will allow keg\-only formulae to be linked\.
 .
 .TP
 \fBlinkapps\fR [\fB\-\-local\fR] [\fIformulae\fR]
@@ -332,7 +332,7 @@ Show the git log for the given formulae\. Options that \fBgit\-log\fR(1) recogni
 Migrate renamed packages to new name, where \fIformulae\fR are old names of packages\.
 .
 .IP
-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\.
+If \fB\-\-force\fR (or \fB\-f\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 [\fB\-\-hide=\fR\fIhidden\fR] [\fIformulae\fR]
@@ -365,7 +365,7 @@ By default, version information is displayed in interactive shells, and suppress
 If \fB\-\-quiet\fR is passed, list only the names of outdated brews (takes precedence over \fB\-\-verbose\fR)\.
 .
 .IP
-If \fB\-\-verbose\fR is passed, display detailed version information\.
+If \fB\-\-verbose\fR (or \fB\-v\fR) is passed, display detailed version information\.
 .
 .IP
 If \fB\-\-json=\fR\fIversion\fR is passed, the output will be in JSON format\. The only valid version is \fBv1\fR\.
@@ -500,7 +500,7 @@ Unpin \fItap\fR so its formulae are no longer prioritized\. See also \fBtap\-pin
 Uninstall \fIformula\fR\.
 .
 .IP
-If \fB\-\-force\fR is passed, and there are multiple versions of \fIformula\fR installed, delete all installed versions\.
+If \fB\-\-force\fR (or \fB\-f\fR) is passed, and there are multiple versions of \fIformula\fR installed, delete all installed versions\.
 .
 .IP
 If \fB\-\-ignore\-dependencies\fR is passed, uninstalling won\'t fail, even if formulae depending on \fIformula\fR would still be installed\.
@@ -536,7 +536,7 @@ Unpack the source files for \fIformulae\fR into subdirectories of the current wo
 If \fB\-\-patch\fR is passed, patches for \fIformulae\fR will be applied to the unpacked source\.
 .
 .IP
-If \fB\-\-git\fR is passed, a Git repository will be initialized in the unpacked source\. This is useful for creating patches for the software\.
+If \fB\-\-git\fR (or \fB\-g\fR) is passed, a Git repository will be initialized in the unpacked source\. This is useful for creating patches for the software\.
 .
 .TP
 \fBunpin\fR \fIformulae\fR
@@ -554,7 +554,7 @@ Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\f
 If \fB\-\-merge\fR is specified then \fBgit merge\fR is used to include updates (rather than \fBgit rebase\fR)\.
 .
 .IP
-If \fB\-\-force\fR is specified then always do a slower, full update check even if unnecessary\.
+If \fB\-\-force\fR (or \fB\-f\fR) is specified then always do a slower, full update check even if unnecessary\.
 .
 .TP
 \fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fB\-\-fetch\-HEAD\fR] [\fIformulae\fR]
@@ -666,7 +666,7 @@ Generate a bottle (binary package) from a formula installed with \fB\-\-build\-b
 If the formula specifies a rebuild version, it will be incremented in the generated DSL\. Passing \fB\-\-keep\-old\fR will attempt to keep it at its original value, while \fB\-\-no\-rebuild\fR will remove it\.
 .
 .IP
-If \fB\-\-verbose\fR is passed, print the bottling commands and any warnings encountered\.
+If \fB\-\-verbose\fR (or \fB\-v\fR) is passed, print the bottling commands and any warnings encountered\.
 .
 .IP
 If \fB\-\-skip\-relocation\fR is passed, do not check if the bottle can be marked as relocatable\.
@@ -836,7 +836,7 @@ Most formulae provide a test method\. \fBbrew test\fR \fIformula\fR runs this te
 To test the development or head version of a formula, use \fB\-\-devel\fR or \fB\-\-HEAD\fR\.
 .
 .IP
-If \fB\-\-debug\fR is passed and the test fails, an interactive debugger will be launched with access to IRB or a shell inside the temporary test directory\.
+If \fB\-\-debug\fR (or \fB\-d\fR) is passed and the test fails, an interactive debugger will be launched with access to IRB or a shell inside the temporary test directory\.
 .
 .IP
 If \fB\-\-keep\-tmp\fR is passed, the temporary files created for the test are not deleted\.
@@ -849,7 +849,7 @@ Example: \fBbrew install jruby && brew test jruby\fR
 Run Homebrew\'s unit and integration tests\. If provided, \fB\-\-only=\fR\fItest_script\fR runs only \fItest_script\fR_spec\.rb, and \fB\-\-seed\fR randomizes tests with the provided value instead of a random seed\.
 .
 .IP
-If \fB\-\-verbose\fR is passed, print the command that runs the tests\.
+If \fB\-\-verbose\fR (or \fB\-v\fR) is passed, print the command that runs the tests\.
 .
 .IP
 If \fB\-\-coverage\fR is passed, also generate code coverage reports\.