brew-cask.1 11.3 KB
Newer Older
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
1
2
3
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
Rui Chen's avatar
Rui Chen committed
4
.TH "BREW\-CASK" "1" "September 2019" "Homebrew" "brew-cask"
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
5
6
7
8
9
10
11
12
.
.SH "NAME"
\fBbrew\-cask\fR \- a friendly binary installer for macOS
.
.SH "SYNOPSIS"
\fBbrew cask\fR command [options] [ \fItoken\fR \.\.\. ]
.
.SH "DESCRIPTION"
13
Homebrew Cask is a tool for installing precompiled macOS binaries (such as Applications) from the command line\. The user is never required to use the graphical user interface\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
14
15
16
17
.
.SH "FREQUENTLY USED COMMANDS"
.
.TP
18
\fBinstall\fR [\-\-force] [\-\-skip\-cask\-deps] [\-\-require\-sha] [\-\-no\-quarantine] [\-\-language=\fIiso\-language\fR[,\fIiso\-language\fR \.\.\. ]] \fItoken\fR [ \fItoken\fR \.\.\. ]
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
19
20
21
Install Cask identified by \fItoken\fR\.
.
.TP
Markus Reiter's avatar
Markus Reiter committed
22
\fBuninstall\fR [\-\-force] \fItoken\fR [ \fItoken\fR \.\.\. ]
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
23
24
25
26
Uninstall Cask identified by \fItoken\fR\.
.
.SH "COMMANDS"
.
27
.TP
28
29
30
31
\fB\-\-cache\fR \fItoken\fR [ \fItoken\fR \.\.\. ]
Display the file used to cache the Cask identified by \fItoken\fR\.
.
.TP
32
\fBaudit\fR [\-\-language=\fIiso\-language\fR[,\fIiso\-language\fR \.\.\. ]] [ \fItoken\fR \.\.\. ]
33
Check the given Casks for installability\. If no tokens are given on the command line, all Casks are audited\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
34
.
35
36
37
.TP
\fBcat\fR \fItoken\fR [ \fItoken\fR \.\.\. ]
Dump the given Cask definition file to the standard output\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
38
.
39
40
41
.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\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
42
.
43
44
45
.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\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
46
.
47
48
49
.TP
\fBedit\fR \fItoken\fR
Open the given Cask definition file for editing\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
50
.
51
.TP
52
53
\fBfetch\fR [\-\-force] [\-\-no\-quarantine] \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\. \fB\-\-no\-quarantine\fR will prevent Gatekeeper from enforcing its security restrictions on the Cask\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
54
.
55
56
57
.TP
\fBhome\fR or \fBhomepage\fR [ \fItoken\fR \.\.\. ]
Display the homepage associated with a given Cask in a browser\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
58
59
.
.IP
60
With no arguments, display the project page \fIhttps://brew\.sh/\fR\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
61
.
62
63
64
.TP
\fBinfo\fR or \fBabv\fR \fItoken\fR [ \fItoken\fR \.\.\. ]
Display information about the given Cask\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
65
.
66
.TP
67
68
\fBinstall\fR [\-\-force] [\-\-skip\-cask\-deps] [\-\-require\-sha] [\-\-no\-quarantine] \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\. \fB\-\-no\-quarantine\fR will prevent Gatekeeper from enforcing its security restrictions on the Cask\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
69
70
.
.IP
71
\fItoken\fR is usually the ID of a Cask, but see \fIOTHER WAYS TO SPECIFY A CASK\fR for variations\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
72
.
73
74
75
.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\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
76
77
78
79
.
.IP
If \fItoken\fR is given, summarize the staged files associated with the given Cask\.
.
80
.TP
commitay's avatar
commitay committed
81
\fBoutdated\fR [\-\-greedy] [\-\-verbose|\-\-quiet] [ \fItoken\fR \.\.\. ]
82
83
84
85
86
87
88
89
90
Without token arguments, display all the installed Casks that have newer versions available in the tap; otherwise check only the tokens given in the command line\. If \fB\-\-greedy\fR is given then also include in the output the Casks having \fBauto_updates true\fR or \fBversion :latest\fR\. Otherwise they are skipped because there is no reliable way to know when updates are available for them\.
.
.br
\fB\-\-verbose\fR forces the display of the outdated and latest version\.
.
.br
\fB\-\-quiet\fR suppresses the display of versions\.
.
.TP
91
\fBreinstall\fR [\-\-no\-quarantine] \fItoken\fR [ \fItoken\fR \.\.\. ]
92
Reinstall the given Cask\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
93
.
94
95
.TP
\fBstyle\fR [\-\-fix] [ \fItoken\fR \.\.\. ]
96
Check the given Casks for correct style using RuboCop (with custom Cask cops)\. If no tokens are given on the command line, all Casks are checked\. With \fB\-\-fix\fR, auto\-correct any style errors if possible\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
97
.
98
99
100
.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\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
101
.
102
.TP
103
\fBupgrade\fR [\-\-force] [\-\-greedy] [\-\-dry\-run] \fItoken\fR [ \fItoken\fR \.\.\. ]
commitay's avatar
commitay committed
104
Without token arguments, upgrade all the installed Casks that have newer versions available in the tap; otherwise update the tokens given in the command line\. If \fB\-\-greedy\fR is given then also upgrade the Casks having \fBauto_updates true\fR or \fBversion :latest\fR\.
105
.
Doug Hogan's avatar
Doug Hogan committed
106
107
108
.IP
If \fB\-\-dry\-run\fR is given, show what would be upgraded, but do not actually upgrade anything\.
.
109
.TP
commitay's avatar
commitay committed
110
111
\fBzap\fR [\-\-force] \fItoken\fR [ \fItoken\fR \.\.\. ]
Unconditionally remove \fIall\fR files associated with the given Cask\. With \fB\-\-force\fR, zap even if the Cask does not appear to be currently installed\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
112
113
.
.IP
commitay's avatar
commitay committed
114
Implicitly performs all actions associated with \fBuninstall\fR\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
115
116
.
.IP
117
Removes all staged versions of the Cask distribution found under \fB<Caskroom_path>/\fR\fItoken\fR\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
118
119
120
121
122
123
124
.
.IP
If the Cask definition contains a \fBzap\fR stanza, performs additional \fBzap\fR actions as defined there, such as removing local preference files\. \fBzap\fR actions are variable, depending on the level of detail defined by the Cask author\.
.
.IP
\fB\fBzap\fR may remove files which are shared between applications\.\fR
.
125
126
127
.SH "INTERNAL COMMANDS"
.
.TP
128
129
\fB_stanza\fR \fIstanza_name\fR [ \-\-table | \-\-yaml | \-\-inspect | \-\-quiet ] [ \fItoken\fR \.\.\. ]
Given a \fIstanza_name\fR and a \fItoken\fR, returns the current stanza for a given Cask\. If no \fItoken\fR is given, then data for all Casks is returned\.
Miccal Matthews's avatar
Miccal Matthews committed
130
.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
131
.SH "OPTIONS"
132
To make these options persistent, see the \fIENVIRONMENT\fR section, below\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
.
.P
Some of these (such as \fB\-\-prefpanedir\fR) may be subject to removal in a future version\.
.
.TP
\fB\-\-force\fR
Force an install to proceed even when a previously\-existing install is detected\.
.
.TP
\fB\-\-skip\-cask\-deps\fR
Skip Cask dependencies when installing\.
.
.TP
\fB\-\-require\-sha\fR
Abort Cask installation if the Cask does not have a checksum defined\.
.
.TP
150
151
152
153
\fB\-\-no\-quarantine\fR
Prevent Gatekeeper from enforcing its security restrictions on the Cask\. This will let you run it straightaway\.
.
.TP
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
154
155
156
157
158
159
160
161
\fB\-\-verbose\fR
Give additional feedback during installation\.
.
.TP
\fB\-\-appdir=<path>\fR
Target location for Applications\. The default value is \fB/Applications\fR\.
.
.TP
162
163
164
165
\fB\-\-language=<iso\-language>[,<iso\-language> \.\.\. ]]\fR
Set language of the Cask to install\. The first matching language is used, otherwise the default language on the Cask\. The default value is the \fBlanguage of your system\fR\.
.
.TP
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
166
167
168
169
170
171
172
173
174
175
176
177
\fB\-\-colorpickerdir=<path>\fR
Target location for Color Pickers\. The default value is \fB~/Library/ColorPickers\fR\.
.
.TP
\fB\-\-prefpanedir=<path>\fR
Target location for Preference Panes\. The default value is \fB~/Library/PreferencePanes\fR\.
.
.TP
\fB\-\-qlplugindir=<path>\fR
Target location for QuickLook Plugins\. The default value is \fB~/Library/QuickLook\fR\.
.
.TP
Eitot's avatar
Eitot committed
178
179
180
181
\fB\-\-dictionarydir=<path>\fR
Target location for Dictionaries\. The default value is \fB~/Library/Dictionaries\fR\.
.
.TP
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
\fB\-\-fontdir=<path>\fR
Target location for Fonts\. The default value is \fB~/Library/Fonts\fR\.
.
.TP
\fB\-\-servicedir=<path>\fR
Target location for Services\. The default value is \fB~/Library/Services\fR\.
.
.TP
\fB\-\-input_methoddir=<path>\fR
Target location for Input Methods\. The default value is \fB~/Library/Input Methods\fR\.
.
.TP
\fB\-\-internet_plugindir=<path>\fR
Target location for Internet Plugins\. The default value is \fB~/Library/Internet Plug\-Ins\fR\.
.
.TP
\fB\-\-audio_unit_plugindir=<path>\fR
Target location for Audio Unit Plugins\. The default value is \fB~/Library/Audio/Plug\-Ins/Components\fR\.
.
.TP
\fB\-\-vst_plugindir=<path>\fR
Target location for VST Plugins\. The default value is \fB~/Library/Audio/Plug\-Ins/VST\fR\.
.
.TP
\fB\-\-vst3_plugindir=<path>\fR
Target location for VST3 Plugins\. The default value is \fB~/Library/Audio/Plug\-Ins/VST3\fR\.
.
.TP
\fB\-\-screen_saverdir=<path>\fR
Target location for Screen Savers\. The default value is \fB~/Library/Screen Savers\fR\.
.
.TP
\fB\-\-no\-binaries\fR
Do not link "helper" executables to \fB/usr/local/bin\fR\.
.
.TP
\fB\-\-debug\fR
Output debugging information of use to Cask authors and developers\.
.
.SH "INTERACTION WITH HOMEBREW"
222
Homebrew Cask is implemented as a external command for Homebrew\. That means this project is entirely built upon the Homebrew infrastructure\. For example, upgrades to the Homebrew Cask tool are received through Homebrew:
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
223
224
225
226
227
.
.IP "" 4
.
.nf

Markus Reiter's avatar
Markus Reiter committed
228
brew update; brew cask upgrade; brew cleanup
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
.
.fi
.
.IP "" 0
.
.P
And updates to individual Cask definitions are received whenever you issue the Homebrew command:
.
.IP "" 4
.
.nf

brew update
.
.fi
.
.IP "" 0
.
.SH "OTHER WAYS TO SPECIFY A CASK"
248
Most Homebrew Cask commands can accept a Cask token as an argument\. As described above, the argument can take the form of:
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
249
250
.
.IP "\(bu" 4
251
A simple token, e\.g\. \fBgoogle\-chrome\fR
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
252
253
254
255
.
.IP "" 0
.
.P
256
Homebrew Cask also accepts three other forms in place of plain tokens:
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
257
258
.
.IP "\(bu" 4
259
A fully\-qualified token which includes the Tap name, e\.g\. \fBhomebrew/cask\-fonts/font\-symbola\fR
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
260
261
.
.IP "\(bu" 4
262
A fully\-qualified pathname to a Cask file, e\.g\. \fB/usr/local/Library/Taps/homebrew/homebrew\-cask/Casks/google\-chrome\.rb\fR
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
263
264
.
.IP "\(bu" 4
265
A \fBcurl\fR\-retrievable URI to a Cask file, e\.g\. \fBhttps://raw\.githubusercontent\.com/Homebrew/homebrew\-cask/f25b6babcd398abf48e33af3d887b2d00de1d661/Casks/google\-chrome\.rb\fR
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
266
267
268
269
.
.IP "" 0
.
.SH "ENVIRONMENT"
270
Homebrew Cask respects many of the environment variables used by the parent command \fBbrew\fR\. Please refer to the \fBbrew\fR(1) man page for more information\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
271
272
.
.P
273
Environment variables specific to Homebrew Cask:
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
274
275
.
.TP
276
277
278
279
280
281
282
\fBHOMEBREW_CASK_OPTS\fR
This variable may contain any arguments normally used as options on the command\-line\. This is particularly useful to make options persistent\. For example, you might add to your \.bash_profile or \.zshenv something like:
.
.IP "" 4
.
.nf

Markus Reiter's avatar
Markus Reiter committed
283
       export HOMEBREW_CASK_OPTS=\'\-\-appdir=~/Applications \-\-fontdir=/Library/Fonts\'
284
285
286
287
288
.
.fi
.
.IP "" 0

289
290
291
292
293
294
.
.P
Other environment variables:
.
.TP
\fBSUDO_ASKPASS\fR
295
When this variable is set, Homebrew Cask will call \fBsudo\fR(8) with the \fB\-A\fR option\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
296
297
.
.SH "SEE ALSO"
298
The Homebrew home page: \fIhttps://brew\.sh/\fR
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
299
300
.
.P
301
The Homebrew Cask GitHub page: \fIhttps://github\.com/Homebrew/homebrew\-cask\fR
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
302
303
304
305
306
307
308
309
310
311
312
.
.P
\fBbrew\fR(1), \fBcurl\fR(1)
.
.SH "AUTHORS"
Paul Hinze and Contributors\.
.
.P
Man page format based on \fBbrew\.1\.md\fR from Homebrew\.
.
.SH "BUGS"
313
We still have bugs \- and we are busy fixing them! If you have a problem, don\'t be shy about reporting it on our GitHub issues page \fIhttps://github\.com/Homebrew/homebrew\-cask/issues?state=open\fR\.
AnastasiaSulyagina's avatar
init  
AnastasiaSulyagina committed
314
315
.
.P
316
When reporting bugs, remember that Homebrew Cask is an separate repository within Homebrew\. Do your best to direct bug reports to the appropriate repository\. If your command\-line started with \fBbrew cask\fR, bring the bug to us first!