From 203b0df5967061062208449d1ed65082391478f8 Mon Sep 17 00:00:00 2001
From: Jack Nagel <jacknagel@gmail.com>
Date: Wed, 12 Oct 2011 02:20:07 -0500
Subject: [PATCH] man page: add some undocumented options
While updating the bash completion script, I encountered some options
that were previously undocumented.
I purposely did not document the --macports and --fink flags for `brew
create`, because the exact same functionality exists in `brew search`.
Perhaps we should remove it from create.
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
---
Library/Contributions/manpages/brew.1.md | 33 +++++++++++++++++-------
share/man/man1/brew.1 | 30 ++++++++++++++-------
2 files changed, 44 insertions(+), 19 deletions(-)
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md
index 21a5f07032..cdef84a23b 100644
--- a/Library/Contributions/manpages/brew.1.md
+++ b/Library/Contributions/manpages/brew.1.md
@@ -61,25 +61,31 @@ For the full command list, see the COMMANDS section.
If `--force` is passed, remove out-of-date keg-only brews as well.
- * `create [--no-fetch]` <URL>:
- Generate a formula for the downloadable file at <URL> and opens it in
+ * `create [--autotools|--cmake] [--no-fetch]` <URL>:
+ Generate a formula for the downloadable file at <URL> and open 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.
+ and version, but if it fails, you'll have to make your own template. The wget
+ formula serves as a simple example.
+
+ If `--autotools` is passed, create a basic template for an Autotools-style build.
+ If `--cmake` is passed, create a basic template for a CMake-style build.
If `--no-fetch` is passed, Homebrew will not download <URL> to the cache and
will thus not add the MD5 to the formula for you.
- * `deps [--1] [-n]` <formula>:
+ * `deps [--1] [-n] [--all]` <formula>:
Show <formula>'s dependencies.
If `--1` is passed, only show dependencies one level down, instead of
recursing.
- If `-n` is passed, shows dependencies in topological order.
+ If `-n` is passed, show dependencies in topological order.
+
+ If `--all` is passed, show dependencies for all formulae.
* `doctor`:
- Check your system for potential problems.
+ Check your system for potential problems. Doctor exits with a non-zero status
+ if any problems are found.
* `edit`:
Open all of Homebrew for editing in TextMate.
@@ -105,9 +111,11 @@ For the full command list, see the COMMANDS section.
* `home` <formula>:
Open <formula>'s homepage in a browser.
- * `info` <formula>:
+ * `info [--all]` <formula>:
Display information about <formula>.
+ If `--all` is passed, show info for all formulae.
+
* `info --github` <formula>:
Open a browser to the GitHub History page for formula <formula>.
@@ -164,10 +172,15 @@ For the full command list, see the COMMANDS section.
is done automatically when you install formula, but can be useful for DIY
installations.
- * `list [--versions]` [<formulae>]:
+ * `ls, list [--unbrewed] [--versions]` [<formulae>]:
Without any arguments, list all installed formulae.
If <formulae> are given, list the installed files for <formulae>.
+ Combined with `--verbose`, recursively list the contents of all subdirectories
+ in each <formula>'s keg.
+
+ If `--unbrewed` is passed, list all files in the Homebrew prefix not installed
+ by Homebrew.
If `--versions` is passed, show the version number for installed formulae,
or only the specified formulae if <formulae> are given.
@@ -237,7 +250,7 @@ For the full command list, see the COMMANDS section.
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.
+ If `--installed` is passed, only list installed formulae.
* `versions` <formulae>:
List previous versions of <formulae>, along with a command to checkout
diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1
index 7bfdd62a3c..56aa21b060 100644
--- a/share/man/man1/brew.1
+++ b/share/man/man1/brew.1
@@ -71,25 +71,31 @@ For all installed or specific formulae, remove any older versions from the cella
If \fB\-\-force\fR is passed, remove out\-of\-date keg\-only brews as well\.
.
.TP
-\fBcreate [\-\-no\-fetch]\fR \fIURL\fR
-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\.
+\fBcreate [\-\-autotools|\-\-cmake] [\-\-no\-fetch]\fR \fIURL\fR
+Generate a formula for the downloadable file at \fIURL\fR and open it in $EDITOR\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The wget formula serves as a simple example\.
+.
+.IP
+If \fB\-\-autotools\fR is passed, create a basic template for an Autotools\-style build\. If \fB\-\-cmake\fR is passed, create a basic template for a CMake\-style build\.
.
.IP
If \fB\-\-no\-fetch\fR is passed, Homebrew will not download \fIURL\fR to the cache and will thus not add the MD5 to the formula for you\.
.
.TP
-\fBdeps [\-\-1] [\-n]\fR \fIformula\fR
+\fBdeps [\-\-1] [\-n] [\-\-all]\fR \fIformula\fR
Show \fIformula\fR\'s dependencies\.
.
.IP
If \fB\-\-1\fR is passed, only show dependencies one level down, instead of recursing\.
.
.IP
-If \fB\-n\fR is passed, shows dependencies in topological order\.
+If \fB\-n\fR is passed, show dependencies in topological order\.
+.
+.IP
+If \fB\-\-all\fR is passed, show dependencies for all formulae\.
.
.TP
\fBdoctor\fR
-Check your system for potential problems\.
+Check your system for potential problems\. Doctor exits with a non\-zero status if any problems are found\.
.
.TP
\fBedit\fR
@@ -121,9 +127,12 @@ Open Homebrew\'s own homepage in a browser\.
Open \fIformula\fR\'s homepage in a browser\.
.
.TP
-\fBinfo\fR \fIformula\fR
+\fBinfo [\-\-all]\fR \fIformula\fR
Display information about \fIformula\fR\.
.
+.IP
+If \fB\-\-all\fR is passed, show info for all formulae\.
+.
.TP
\fBinfo \-\-github\fR \fIformula\fR
Open a browser to the GitHub History page for formula \fIformula\fR\.
@@ -181,11 +190,14 @@ If \fB\-\-git\fR is passed, Homebrew will create a Git repository, useful for cr
Symlink all of \fIformula\fR\'s installed files into the Homebrew prefix\. This is done automatically when you install formula, but can be useful for DIY installations\.
.
.TP
-\fBlist [\-\-versions]\fR [\fIformulae\fR]
+\fBls, list [\-\-unbrewed] [\-\-versions]\fR [\fIformulae\fR]
Without any arguments, list all installed formulae\.
.
.IP
-If \fIformulae\fR are given, list the installed files for \fIformulae\fR\.
+If \fIformulae\fR are given, 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
+If \fB\-\-unbrewed\fR is passed, list all files in the Homebrew prefix not installed by Homebrew\.
.
.IP
If \fB\-\-versions\fR is passed, show the version number for installed formulae, or only the specified formulae if \fIformulae\fR are given\.
@@ -263,7 +275,7 @@ If \fIformulae\fR are given, upgrade only the specified brews\.
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\.
+If \fB\-\-installed\fR is passed, only list installed formulae\.
.
.TP
\fBversions\fR \fIformulae\fR
--
GitLab