Skip to content

Commit

Permalink
Merge pull request #4356 from reitermarkus/brew-cask-search-docs
Browse files Browse the repository at this point in the history
Update `search` docs.
  • Loading branch information
reitermarkus authored Jun 20, 2018
2 parents ca892f8 + fcd7587 commit 1d1ca77
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions Library/Homebrew/cmd/search.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
#: * `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 official taps.
#:
#: If `--desc` is passed, browse available packages matching <text> including a
#: description for each.
#: If `--desc` is passed, search formulae with a description matching <text> and
#: casks with a name matching <text>.
#:
#: * `search` (`--debian`|`--fedora`|`--fink`|`--macports`|`--opensuse`|`--ubuntu`) <text>:
#: Search for <text> in the given package manager's list.
Expand Down
4 changes: 2 additions & 2 deletions Library/Homebrew/manpages/brew-cask.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ names, and other aspects of this manual are still subject to change.
dependencies. `--require-sha` will abort installation if the Cask does not
have a checksum defined.

<token> is usually the ID of a Cask as returned by `brew cask search`,
<token> is usually the ID of a Cask,
but see [OTHER WAYS TO SPECIFY A CASK][] for variations.

* `list` or `ls` [-1] [--versions] [ <token> ... ]:
Expand Down Expand Up @@ -231,7 +231,7 @@ the Homebrew command:
Most Homebrew-Cask commands can accept a Cask token as an argument. As
described above, the argument can take the form of:

* A token as returned by `brew cask search`, e.g. `google-chrome`
* A simple token, e.g. `google-chrome`

Homebrew-Cask also accepts three other forms in place of plain tokens:

Expand Down
6 changes: 3 additions & 3 deletions docs/Manpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -406,10 +406,10 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
* `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 official taps.

If `--desc` is passed, browse available packages matching `text` including a
description for each.
If `--desc` is passed, search formulae with a description matching `text` and
casks with a name matching `text`.

* `search` (`--debian`|`--fedora`|`--fink`|`--macports`|`--opensuse`|`--ubuntu`) `text`:
Search for `text` in the given package manager's list.
Expand Down
4 changes: 2 additions & 2 deletions manpages/brew-cask.1
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Display information about the given Cask\.
Install the given Cask\. With \fB\-\-force\fR, re\-install even if the Cask appears to be already present\. With \fB\-\-skip\-cask\-deps\fR, skip any Cask dependencies\. \fB\-\-require\-sha\fR will abort installation if the Cask does not have a checksum defined\.
.
.IP
\fItoken\fR is usually the ID of a Cask as returned by \fBbrew cask search\fR, but see \fIOTHER WAYS TO SPECIFY A CASK\fR for variations\.
\fItoken\fR is usually the ID of a Cask, but see \fIOTHER WAYS TO SPECIFY A CASK\fR for variations\.
.
.TP
\fBlist\fR or \fBls\fR [\-1] [\-\-versions] [ \fItoken\fR \.\.\. ]
Expand Down Expand Up @@ -255,7 +255,7 @@ brew update
Most Homebrew\-Cask commands can accept a Cask token as an argument\. As described above, the argument can take the form of:
.
.IP "\(bu" 4
A token as returned by \fBbrew cask search\fR, e\.g\. \fBgoogle\-chrome\fR
A simple token, e\.g\. \fBgoogle\-chrome\fR
.
.IP "" 0
.
Expand Down
4 changes: 2 additions & 2 deletions manpages/brew.1
Original file line number Diff line number Diff line change
Expand Up @@ -419,10 +419,10 @@ Display all locally available formulae for brewing (including tapped ones)\. No
.
.TP
\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\.
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 official taps\.
.
.IP
If \fB\-\-desc\fR is passed, browse available packages matching \fItext\fR including a description for each\.
If \fB\-\-desc\fR is passed, search formulae with a description matching \fItext\fR and casks with a name matching \fItext\fR\.
.
.TP
\fBsearch\fR (\fB\-\-debian\fR|\fB\-\-fedora\fR|\fB\-\-fink\fR|\fB\-\-macports\fR|\fB\-\-opensuse\fR|\fB\-\-ubuntu\fR) \fItext\fR
Expand Down

0 comments on commit 1d1ca77

Please sign in to comment.