aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Vandenberg2011-05-30 21:34:42 -0700
committerAdam Vandenberg2011-05-30 21:34:42 -0700
commit57c61bb9c19cf016f58c84ade3c51b1f718f4c56 (patch)
treea793ee79c42f54ba92a4a6d1951af258ac28ca53
parentc893c3aec9cc12127ede7f24b63282473de68113 (diff)
downloadbrew-57c61bb9c19cf016f58c84ade3c51b1f718f4c56.tar.bz2
Add 'essential commands' section to man page.
-rw-r--r--Library/Contributions/manpages/brew.1.md21
-rw-r--r--share/man/man1/brew.123
2 files changed, 44 insertions, 0 deletions
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md
index 9b9a28382..c7fcc6835 100644
--- a/Library/Contributions/manpages/brew.1.md
+++ b/Library/Contributions/manpages/brew.1.md
@@ -16,6 +16,27 @@ didn't include with OS X.
Prints extra, command-specific debugging information.
Note that `brew -v` by itself is the same as `brew --version`.
+## ESSENTIAL COMMANDS
+
+For the full command list, see the COMMANDS section.
+
+ * `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`, `-S` <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.
+
## COMMANDS
* `-v`, `--version`:
diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1
index 1a811bd22..c2fd97f19 100644
--- a/share/man/man1/brew.1
+++ b/share/man/man1/brew.1
@@ -21,6 +21,29 @@ Homebrew is the easiest and most flexible way to install the UNIX tools Apple di
\fB\-v\fR, \fB\-\-verbose\fR command [options] [formula] \.\.\.
Prints extra, command\-specific debugging information\. Note that \fBbrew \-v\fR by itself is the same as \fBbrew \-\-version\fR\.
.
+.SH "ESSENTIAL COMMANDS"
+For the full command list, see the COMMANDS section\.
+.
+.TP
+\fBinstall\fR \fIformula\fR
+Install \fIformula\fR\.
+.
+.TP
+\fBremove\fR \fIformula\fR
+Uninstall \fIformula\fR\.
+.
+.TP
+\fBupdate\fR
+Fetch the newest version of Homebrew from GitHub using \fBgit\fR(1)\.
+.
+.TP
+\fBlist\fR
+List all installed formulae\.
+.
+.TP
+\fBsearch\fR, \fB\-S\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\.
+.
.SH "COMMANDS"
.
.TP