aboutsummaryrefslogtreecommitdiffstats
path: root/share/doc
diff options
context:
space:
mode:
authorJoe Gallo2016-05-26 07:45:25 -0700
committerMartin Afanasjew2016-05-26 16:45:25 +0200
commit132ada2b0ebb3751c0f8f42ca83bb257b55a50fd (patch)
treeb9123cb48575890d31f5393c9bb8647c0d67268c /share/doc
parente517e2e41d2166d967a5ca8a71d4e178804a360c (diff)
downloadbrew-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/doc')
-rw-r--r--share/doc/homebrew/brew.1.html9
1 files changed, 6 insertions, 3 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 &amp;&amp; make &amp;&amp; make install</code>