diff options
| author | Joe Gallo | 2016-05-26 07:45:25 -0700 |
|---|---|---|
| committer | Martin Afanasjew | 2016-05-26 16:45:25 +0200 |
| commit | 132ada2b0ebb3751c0f8f42ca83bb257b55a50fd (patch) | |
| tree | b9123cb48575890d31f5393c9bb8647c0d67268c /share | |
| parent | e517e2e41d2166d967a5ca8a71d4e178804a360c (diff) | |
| download | brew-132ada2b0ebb3751c0f8f42ca83bb257b55a50fd.tar.bz2 | |
Clarify brew search usage. (#270)
* Include --desc in brew search help text.
* Update brew search --desc text in README.
* Remove mention of alias in brew search help text to avoid any
confusion.
Diffstat (limited to 'share')
| -rw-r--r-- | share/doc/homebrew/brew.1.html | 9 | ||||
| -rw-r--r-- | share/man/man1/brew.1 | 7 |
2 files changed, 11 insertions, 5 deletions
diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html index 2a6b4c849..dd8eed900 100644 --- a/share/doc/homebrew/brew.1.html +++ b/share/doc/homebrew/brew.1.html @@ -314,11 +314,14 @@ 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>search</code>, <code>-S</code></dt><dd><p>Display all locally available formulae for brewing (including tapped ones). +<dt class="flush"><code>search</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 +<dt><code>search</code> [<code>--desc</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 surrounded with slashes, then it is interpreted as a regular expression. -The search for <var>text</var> is extended online to some popular taps.</p></dd> +The search for <var>text</var> is extended online to some popular taps.</p> + +<p>If <code>--desc</code> is passed, browse available packages matching <var>text</var> including a +description for each.</p></dd> <dt><code>search</code> (<code>--debian</code>|<code>--fedora</code>|<code>--fink</code>|<code>--macports</code>|<code>--opensuse</code>|<code>--ubuntu</code>) <var>text</var></dt><dd><p>Search for <var>text</var> in the given package manager's list.</p></dd> <dt><code>sh</code> [<code>--env=std</code>]</dt><dd><p>Instantiate a Homebrew build environment. Uses our years-battle-hardened Homebrew build logic to help your <code>./configure && make && make install</code> diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index c10ce50a0..fde5387ef 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -426,13 +426,16 @@ If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, show what would be removed, but do Uninstall then install \fIformula\fR . .TP -\fBsearch\fR, \fB\-S\fR +\fBsearch\fR Display all locally available formulae for brewing (including tapped ones)\. No online search is performed if called without arguments\. . .TP -\fBsearch\fR, \fB\-S\fR \fItext\fR|\fB/\fR\fItext\fR\fB/\fR +\fBsearch\fR [\fB\-\-desc\fR] \fItext\fR|\fB/\fR\fItext\fR\fB/\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\. The search for \fItext\fR is extended online to some popular taps\. . +.IP +If \fB\-\-desc\fR is passed, browse available packages matching \fItext\fR including a description for each\. +. .TP \fBsearch\fR (\fB\-\-debian\fR|\fB\-\-fedora\fR|\fB\-\-fink\fR|\fB\-\-macports\fR|\fB\-\-opensuse\fR|\fB\-\-ubuntu\fR) \fItext\fR Search for \fItext\fR in the given package manager\'s list\. |