From 132ada2b0ebb3751c0f8f42ca83bb257b55a50fd Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Thu, 26 May 2016 07:45:25 -0700 Subject: 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 c15331cd7..33aa8ae9f 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` |`/``/`: +#: * `search` [`--desc`] |`/``/`: #: Perform a substring search of formula names for . If is #: surrounded with slashes, then it is interpreted as a regular expression. #: The search for is extended online to some popular taps. #: +#: If `--desc` is passed, browse available packages matching including a +#: description for each. +#: #: * `search` (`--debian`|`--fedora`|`--fink`|`--macports`|`--opensuse`|`--ubuntu`) : #: Search for in the given package manager's list. diff --git a/README.md b/README.md index 0d990abdc..86848f330 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 ` 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 2a6b4c849..dd8eed900 100644 --- a/share/doc/homebrew/brew.1.html +++ b/share/doc/homebrew/brew.1.html @@ -314,11 +314,14 @@ created by brew linkapps.

If --dry-run or -n is passed, show what would be removed, but do not actually remove anything.

reinstall formula

Uninstall then install formula

-
search, -S

Display all locally available formulae for brewing (including tapped ones). +

search

Display all locally available formulae for brewing (including tapped ones). No online search is performed if called without arguments.

-
search, -S text|/text/

Perform a substring search of formula names for text. If text is +

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.

+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.

sh [--env=std]

Instantiate a Homebrew build environment. Uses our years-battle-hardened Homebrew build logic to help your ./configure && make && make install 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\. -- cgit v1.2.3