Add documentation for cask reinstall command
This commit is contained in:
		
							parent
							
								
									31fb996800
								
							
						
					
					
						commit
						32dc78835d
					
				@ -86,6 +86,12 @@ names, and other aspects of this manual are still subject to change.
 | 
			
		||||
    If <token> is given, summarize the staged files associated with the
 | 
			
		||||
    given Cask.
 | 
			
		||||
 | 
			
		||||
  * `reinstall` <token> [ <token> ...]
 | 
			
		||||
    Reinstall the given Cask.
 | 
			
		||||
 | 
			
		||||
    <token> is usually the ID of a Cask as returned by `brew cask search`,
 | 
			
		||||
    but see [OTHER WAYS TO SPECIFY A CASK][] for variations.
 | 
			
		||||
 | 
			
		||||
  * `search` or `-S` [<text> | /<regexp>/]:
 | 
			
		||||
    Without argument, display all Casks available for install, otherwise
 | 
			
		||||
    perform a substring search of known Cask tokens for <text> or, if the
 | 
			
		||||
 | 
			
		||||
@ -34,78 +34,68 @@ The tokens returned by \fBsearch\fR are suitable as arguments for most other com
 | 
			
		||||
.
 | 
			
		||||
.SH "COMMANDS"
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\fBaudit\fR [ \fItoken\fR \.\.\. ]
 | 
			
		||||
Check the given Casks for installability\. If no tokens are given on the command line, all Casks are audited\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBaudit\fR [ \fItoken\fR \.\.\. ]: Check the given Casks for installability\. If no tokens are given on the command line, all Casks are audited\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\fBcat\fR \fItoken\fR [ \fItoken\fR \.\.\. ]
 | 
			
		||||
Dump the given Cask definition file to the standard output\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBcat\fR \fItoken\fR [ \fItoken\fR \.\.\. ]: Dump the given Cask definition file to the standard output\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\fBcleanup\fR [\-\-outdated]
 | 
			
		||||
Clean up cached downloads and tracker symlinks\. With \fB\-\-outdated\fR, only clean up cached downloads older than 10 days old\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBcleanup\fR [\-\-outdated]: Clean up cached downloads and tracker symlinks\. With \fB\-\-outdated\fR, only clean up cached downloads older than 10 days old\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\fBcreate\fR \fItoken\fR
 | 
			
		||||
Generate a Cask definition file for the Cask identified by \fItoken\fR and open a template for it in your favorite editor\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBcreate\fR \fItoken\fR: Generate a Cask definition file for the Cask identified by \fItoken\fR and open a template for it in your favorite editor\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\fBdoctor\fR or \fBdr\fR
 | 
			
		||||
Check for configuration issues\. Can be useful to upload as a gist for developers along with a bug report\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBdoctor\fR or \fBdr\fR: Check for configuration issues\. Can be useful to upload as a gist for developers along with a bug report\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\fBedit\fR \fItoken\fR
 | 
			
		||||
Open the given Cask definition file for editing\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBedit\fR \fItoken\fR: Open the given Cask definition file for editing\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\fBfetch\fR [\-\-force] \fItoken\fR [ \fItoken\fR \.\.\. ]
 | 
			
		||||
Download remote application files for the given Cask to the local cache\. With \fB\-\-force\fR, force re\-download even if the files are already cached\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBfetch\fR [\-\-force] \fItoken\fR [ \fItoken\fR \.\.\. ]: Download remote application files for the given Cask to the local cache\. With \fB\-\-force\fR, force re\-download even if the files are already cached\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\fBhome\fR or \fBhomepage\fR [ \fItoken\fR \.\.\. ]
 | 
			
		||||
Display the homepage associated with a given Cask in a browser\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBhome\fR or \fBhomepage\fR [ \fItoken\fR \.\.\. ]: Display the homepage associated with a given Cask in a browser\.
 | 
			
		||||
.
 | 
			
		||||
.IP
 | 
			
		||||
With no arguments, display the project page \fIhttp://caskroom\.io\fR\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\fBinfo\fR or \fBabv\fR \fItoken\fR [ \fItoken\fR \.\.\. ]
 | 
			
		||||
Display information about the given Cask\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBinfo\fR or \fBabv\fR \fItoken\fR [ \fItoken\fR \.\.\. ]: Display information about the given Cask\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\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\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\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\.
 | 
			
		||||
.
 | 
			
		||||
.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\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\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\-\-versions\fR, show all installed versions\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\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\-\-versions\fR, show all installed versions\.
 | 
			
		||||
.
 | 
			
		||||
.IP
 | 
			
		||||
If \fItoken\fR is given, summarize the staged files associated with the given Cask\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\fBsearch\fR or \fB\-S\fR [\fItext\fR | /\fIregexp\fR/]
 | 
			
		||||
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\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBreinstall\fR \fItoken\fR [ \fItoken\fR \.\.\.] Reinstall the given Cask\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\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\.
 | 
			
		||||
.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\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\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\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBsearch\fR or \fB\-S\fR [\fItext\fR | /\fIregexp\fR/]: 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
 | 
			
		||||
\fBupdate\fR
 | 
			
		||||
For convenience\. \fBbrew cask update\fR is a synonym for \fBbrew update\fR\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\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\.
 | 
			
		||||
.
 | 
			
		||||
.TP
 | 
			
		||||
\fBzap\fR \fItoken\fR [ \fItoken\fR \.\.\. ]
 | 
			
		||||
Unconditionally remove \fIall\fR files associated with the given Cask\.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\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\.
 | 
			
		||||
.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBupdate\fR: For convenience\. \fBbrew cask update\fR is a synonym for \fBbrew update\fR\.
 | 
			
		||||
.
 | 
			
		||||
.IP "\(bu" 4
 | 
			
		||||
\fBzap\fR \fItoken\fR [ \fItoken\fR \.\.\. ]: Unconditionally remove \fIall\fR files associated with the given Cask\.
 | 
			
		||||
.
 | 
			
		||||
.IP
 | 
			
		||||
Implicitly performs all actions associated with \fBuninstall\fR, even if the Cask does not appear to be currently installed\.
 | 
			
		||||
@ -119,6 +109,8 @@ If the Cask definition contains a \fBzap\fR stanza, performs additional \fBzap\f
 | 
			
		||||
.IP
 | 
			
		||||
\fB\fBzap\fR may remove files which are shared between applications\.\fR
 | 
			
		||||
.
 | 
			
		||||
.IP "" 0
 | 
			
		||||
.
 | 
			
		||||
.SH "OPTIONS"
 | 
			
		||||
To make these options persistent, see the ENVIRONMENT section, below\.
 | 
			
		||||
.
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user