admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Update `brew-cask man page.

Browse Source
This commit is contained in:
Markus Reiter 2016-09-20 09:08:26 +02:00
parent 5b9a43a370
commit 598b303e3a
2 changed files with 20 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Library/Homebrew/manpages/brew-cask.1.md
View File

@ -19,10 +19,10 @@ names, and other aspects of this manual are still subject to change.
## FREQUENTLY USED COMMANDS ## FREQUENTLY USED COMMANDS
* `install [--force] [--skip-cask-deps] [--require-sha]` <token> [ <token> ... ]: * `install` [--force] [--skip-cask-deps] [--require-sha] <token> [ <token> ... ]:
Install Cask identified by <token>. Install Cask identified by <token>.
* `uninstall [--force]` <token> [ <token> ... ]: * `uninstall` [--force] <token> [ <token> ... ]:
Uninstall Cask identified by <token>. Uninstall Cask identified by <token>.
* `search` <text> | /<regexp>/: * `search` <text> | /<regexp>/:
@ -69,7 +69,7 @@ names, and other aspects of this manual are still subject to change.
* `info` or `abv` <token> [ <token> ... ]: * `info` or `abv` <token> [ <token> ... ]:
Display information about the given Cask. Display information about the given Cask.
* `install [--force] [--skip-cask-deps] [--require-sha]` <token> [ <token> ... ]: * `install` [--force] [--skip-cask-deps] [--require-sha] <token> [ <token> ... ]:
Install the given Cask. With `--force`, re-install even if the Cask Install the given Cask. With `--force`, re-install even if the Cask
appears to be already present. With `--skip-cask-deps`, skip any Cask appears to be already present. With `--skip-cask-deps`, skip any Cask
dependencies. `--require-sha` will abort installation if the Cask does not dependencies. `--require-sha` will abort installation if the Cask does not
@ -78,42 +78,29 @@ names, and other aspects of this manual are still subject to change.
<token> is usually the ID of a Cask as returned by `brew cask search`, <token> is usually the ID of a Cask as returned by `brew cask search`,
but see [OTHER WAYS TO SPECIFY A CASK][] for variations. but see [OTHER WAYS TO SPECIFY A CASK][] for variations.
* `list` or `ls` [-1 | -l] [ <token> ... ]: * `list` or `ls` [-1] [--versions] [ <token> ... ]:
Without any arguments, list all installed Casks. With `-1`, always Without any arguments, list all installed Casks. With `-1`, always
format the output in a single column. With `-l`, give a more detailed format the output in a single column. With `--versions`, show all installed
listing. versions.
If <token> is given, summarize the staged files associated with the If <token> is given, summarize the staged files associated with the
given Cask. given Cask.
* `search` or `-S`: * `search` or `-S` [<text> | /<regexp>/]:
Display all Casks available for install. Without argument, display all Casks available for install, otherwise
perform a substring search of known Cask tokens for <text> or, if the
* `search` or `-S` <text> | /<regexp>/: text is delimited by slashes (/<regexp>/), it is interpreted as a
Perform a substring search of known Cask tokens for <text>. If the text Ruby regular expression.
is delimited by slashes, it is interpreted as a Ruby regular expression.
* `style` [--fix] [ <token> ... ]: * `style` [--fix] [ <token> ... ]:
Check the given Casks for correct style using [RuboCop Cask](https://github.com/caskroom/rubocop-cask). Check the given Casks for correct style using [RuboCop Cask](https://github.com/caskroom/rubocop-cask).
If no tokens are given on the command line, all Casks are checked. If no tokens are given on the command line, all Casks are checked.
With `--fix`, auto-correct any style errors if possible. With `--fix`, auto-correct any style errors if possible.
* `uninstall [--force]` or `rm` or `remove` <token> [ <token> ... ]: * `uninstall` or `rm` or `remove` [--force] <token> [ <token> ... ]:
Uninstall the given Cask. With `--force`, uninstall even if the Cask Uninstall the given Cask. With `--force`, uninstall even if the Cask
does not appear to be present. does not appear to be present.
Note that `uninstall --force` is currently imperfect. It will follow
the `uninstall` instructions from *newest* Cask definition, even if
the given Cask has changed since you installed it. The result is that
`uninstall --force` will always succeed in removing relevant files
under `<Caskroom_path>`, but will sometimes fail to remove relevant
installed files outside of it. This issue is being
addressed.
`uninstall` without `--force` is also imperfect. It may be unable to
perform an `uninstall` operation if the given Cask has changed since you
installed it. This issue is being addressed.
* `update`: * `update`:
For convenience. `brew cask update` is a synonym for `brew update`. For convenience. `brew cask update` is a synonym for `brew update`.

26
manpages/brew-cask.1
View File

@ -18,11 +18,11 @@ Homebrew\-Cask works robustly enough that we welcome new users, but the project
.SH "FREQUENTLY USED COMMANDS" .SH "FREQUENTLY USED COMMANDS"
. .
.TP .TP
\fBinstall [\-\-force] [\-\-skip\-cask\-deps] [\-\-require\-sha]\fR \fItoken\fR [ \fItoken\fR \.\.\. ] \fBinstall\fR [\-\-force] [\-\-skip\-cask\-deps] [\-\-require\-sha] \fItoken\fR [ \fItoken\fR \.\.\. ]
Install Cask identified by \fItoken\fR\. Install Cask identified by \fItoken\fR\.
. .
.TP .TP
\fBuninstall [\-\-force]\fR \fItoken\fR [ \fItoken\fR \.\.\. ] \fBuninstall\fR [\-\-force] \fItoken\fR [ \fItoken\fR \.\.\. ]
Uninstall Cask identified by \fItoken\fR\. Uninstall Cask identified by \fItoken\fR\.
. .
.TP .TP
@ -74,41 +74,31 @@ With no arguments, display the project page \fIhttp://caskroom\.io\fR\.
Display information about the given Cask\. Display information about the given Cask\.
. .
.TP .TP
\fBinstall [\-\-force] [\-\-skip\-cask\-deps] [\-\-require\-sha]\fR \fItoken\fR [ \fItoken\fR \.\.\. ] \fBinstall\fR [\-\-force] [\-\-skip\-cask\-deps] [\-\-require\-sha] \fItoken\fR [ \fItoken\fR \.\.\. ]
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\. 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 .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 as returned by \fBbrew cask search\fR, but see \fIOTHER WAYS TO SPECIFY A CASK\fR for variations\.
. .
.TP .TP
\fBlist\fR or \fBls\fR [\-1 | \-l] [ \fItoken\fR \.\.\. ] \fBlist\fR or \fBls\fR [\-1] [\-\-versions] [ \fItoken\fR \.\.\. ]
Without any arguments, list all installed Casks\. With \fB\-1\fR, always format the output in a single column\. With \fB\-l\fR, give a more detailed listing\. Without any arguments, list all installed Casks\. With \fB\-1\fR, always format the output in a single column\. With \fB\-\-versions\fR, show all installed versions\.
. .
.IP .IP
If \fItoken\fR is given, summarize the staged files associated with the given Cask\. If \fItoken\fR is given, summarize the staged files associated with the given Cask\.
. .
.TP .TP
\fBsearch\fR or \fB\-S\fR \fBsearch\fR or \fB\-S\fR [\fItext\fR | /\fIregexp\fR/]
Display all Casks available for install\. Without argument, display all Casks available for install, otherwise perform a substring search of known Cask tokens for \fItext\fR or, if the text is delimited by slashes (/\fIregexp\fR/), it is interpreted as a Ruby regular expression\.
.
.TP
\fBsearch\fR or \fB\-S\fR \fItext\fR | /\fIregexp\fR/
Perform a substring search of known Cask tokens for \fItext\fR\. If the text is delimited by slashes, it is interpreted as a Ruby regular expression\.
. .
.TP .TP
\fBstyle\fR [\-\-fix] [ \fItoken\fR \.\.\. ] \fBstyle\fR [\-\-fix] [ \fItoken\fR \.\.\. ]
Check the given Casks for correct style using RuboCop Cask \fIhttps://github\.com/caskroom/rubocop\-cask\fR\. If no tokens are given on the command line, all Casks are checked\. With \fB\-\-fix\fR, auto\-correct any style errors if possible\. Check the given Casks for correct style using RuboCop Cask \fIhttps://github\.com/caskroom/rubocop\-cask\fR\. If no tokens are given on the command line, all Casks are checked\. With \fB\-\-fix\fR, auto\-correct any style errors if possible\.
. .
.TP .TP
\fBuninstall [\-\-force]\fR or \fBrm\fR or \fBremove\fR \fItoken\fR [ \fItoken\fR \.\.\. ] \fBuninstall\fR or \fBrm\fR or \fBremove\fR [\-\-force] \fItoken\fR [ \fItoken\fR \.\.\. ]
Uninstall the given Cask\. With \fB\-\-force\fR, uninstall even if the Cask does not appear to be present\. Uninstall the given Cask\. With \fB\-\-force\fR, uninstall even if the Cask does not appear to be present\.
. .
.IP
Note that \fBuninstall \-\-force\fR is currently imperfect\. It will follow the \fBuninstall\fR instructions from \fInewest\fR Cask definition, even if the given Cask has changed since you installed it\. The result is that \fBuninstall \-\-force\fR will always succeed in removing relevant files under \fB<Caskroom_path>\fR, but will sometimes fail to remove relevant installed files outside of it\. This issue is being addressed\.
.
.IP
\fBuninstall\fR without \fB\-\-force\fR is also imperfect\. It may be unable to perform an \fBuninstall\fR operation if the given Cask has changed since you installed it\. This issue is being addressed\.
.
.TP .TP
\fBupdate\fR \fBupdate\fR
For convenience\. \fBbrew cask update\fR is a synonym for \fBbrew update\fR\. For convenience\. \fBbrew cask update\fR is a synonym for \fBbrew update\fR\.