From 132ada2b0ebb3751c0f8f42ca83bb257b55a50fd Mon Sep 17 00:00:00 2001 From: Joe Gallo <kaizensoze@users.noreply.github.com> Date: Thu, 26 May 2016 07:45:25 -0700 Subject: [PATCH] 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. --- Library/Homebrew/cmd/search.rb | 7 +++++-- README.md | 2 +- share/doc/homebrew/brew.1.html | 9 ++++++--- share/man/man1/brew.1 | 7 +++++-- 4 files changed, 17 insertions(+), 8 deletions(-) diff --git a/Library/Homebrew/cmd/search.rb b/Library/Homebrew/cmd/search.rb index c15331cd73..33aa8ae9f7 100644 --- a/Library/Homebrew/cmd/search.rb +++ b/Library/Homebrew/cmd/search.rb @@ -1,12 +1,15 @@ -#: * `search`, `-S`: +#: * `search`: #: Display all locally available formulae for brewing (including tapped ones). #: No online search is performed if called without arguments. #: -#: * `search`, `-S` <text>|`/`<text>`/`: +#: * `search` [`--desc`] <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. #: The search for <text> is extended online to some popular taps. #: +#: If `--desc` is passed, browse available packages matching <text> including a +#: description for each. +#: #: * `search` (`--debian`|`--fedora`|`--fink`|`--macports`|`--opensuse`|`--ubuntu`) <text>: #: Search for <text> in the given package manager's list. diff --git a/README.md b/README.md index 0d990abdcd..86848f330d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Features, usage and installation instructions are [summarised on the homepage](h ## What Packages Are Available? 1. Type `brew search` for a list. 2. Or visit [braumeister.org](http://braumeister.org) to browse packages online. -3. Or use `brew search --desc` to browse packages from the command line. +3. Or use `brew search --desc <keyword>` to browse packages from the command line. ## More Documentation `brew help`, `man brew` or check [our documentation](https://github.com/Homebrew/brew/tree/master/share/doc/homebrew#readme). diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html index 2a6b4c849e..dd8eed9009 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 c10ce50a01..fde5387efe 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\. -- GitLab