brew.1 55.4 KB
Newer Older
Adam Vandenberg's avatar
Adam Vandenberg committed
1
2
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
Christopher Sexton's avatar
Christopher Sexton committed
3
.
Rui Chen's avatar
Rui Chen committed
4
.TH "BREW" "1" "September 2019" "Homebrew" "brew"
Christopher Sexton's avatar
Christopher Sexton committed
5
6
.
.SH "NAME"
7
\fBbrew\fR \- The missing package manager for macOS
Christopher Sexton's avatar
Christopher Sexton committed
8
9
.
.SH "SYNOPSIS"
Andrew Janke's avatar
Andrew Janke committed
10
\fBbrew\fR \fB\-\-version\fR
Jack Nagel's avatar
Jack Nagel committed
11
12
.
.br
Andrew Janke's avatar
Andrew Janke committed
13
\fBbrew\fR \fIcommand\fR [\fB\-\-verbose\fR|\fB\-v\fR] [\fIoptions\fR] [\fIformula\fR] \.\.\.
Christopher Sexton's avatar
Christopher Sexton committed
14
15
.
.SH "DESCRIPTION"
16
Homebrew is the easiest and most flexible way to install the UNIX tools Apple didn\'t include with macOS\.
Christopher Sexton's avatar
Christopher Sexton committed
17
.
18
.SH "ESSENTIAL COMMANDS"
Andrew Janke's avatar
Andrew Janke committed
19
For the full command list, see the \fICOMMANDS\fR section\.
20
.
21
.P
22
With \fB\-\-verbose\fR or \fB\-\-debug\fR, many commands print extra debugging information\. Note that these options should only appear after a command\.
23
.
Mike McQuaid's avatar
Mike McQuaid committed
24
.SS "\fBinstall\fR \fIformula\fR:"
25
26
Install \fIformula\fR\.
.
27
28
29
.P
\fIformula\fR is usually the name of the formula to install, but it has other syntaxes which are listed in the \fISPECIFYING FORMULAE\fR section\.
.
Mike McQuaid's avatar
Mike McQuaid committed
30
.SS "\fBuninstall\fR \fIformula\fR:"
31
32
Uninstall \fIformula\fR\.
.
Mike McQuaid's avatar
Mike McQuaid committed
33
.SS "\fBlist\fR:"
34
35
List all installed formulae\.
.
Mike McQuaid's avatar
Mike McQuaid committed
36
.SS "\fBsearch\fR (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR):"
37
Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\. The search for \fItext\fR is extended online to \fBhomebrew/core\fR and \fBhomebrew/cask\fR\. If no search term is provided, all locally available formulae are listed\.
38
.
Christopher Sexton's avatar
Christopher Sexton committed
39
40
.SH "COMMANDS"
.
41
.SS "\fBanalytics\fR [\fIsubcommand\fR]"
42
If \fBon\fR or \fBoff\fR is passed, turn Homebrew\'s analytics on or off respectively\.
Xu Cheng's avatar
Xu Cheng committed
43
.
Mike McQuaid's avatar
Mike McQuaid committed
44
.P
45
If \fBstate\fR is passed, display the current anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\.
Xu Cheng's avatar
Xu Cheng committed
46
.
Mike McQuaid's avatar
Mike McQuaid committed
47
.P
48
If \fBregenerate\-uuid\fR is passed, regenerate the UUID used in Homebrew\'s analytics\.
Xu Cheng's avatar
Xu Cheng committed
49
.
Mike McQuaid's avatar
Mike McQuaid committed
50
.SS "\fBcat\fR \fIformula\fR"
Mike McQuaid's avatar
Mike McQuaid committed
51
Display the source of \fIformula\fR\.
52
.
Mike McQuaid's avatar
Mike McQuaid committed
53
.SS "\fBcleanup\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]"
54
Remove stale lock files and outdated downloads for all formulae and casks, and remove old versions of installed formulae\. If arguments are specified, only do this for the given formulae and casks\.
Adam Vandenberg's avatar
Adam Vandenberg committed
55
.
Mike McQuaid's avatar
Mike McQuaid committed
56
57
58
.TP
\fB\-\-prune\fR
Remove all cache files older than specified \fIdays\fR\.
59
.
Mike McQuaid's avatar
Mike McQuaid committed
60
61
62
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Show what would be removed, but do not actually remove anything\.
63
.
64
.TP
Mike McQuaid's avatar
Mike McQuaid committed
65
66
67
\fB\-s\fR
Scrub the cache, including downloads for even the latest versions\. Note downloads for any installed formula or cask will still not be deleted\. If you want to delete those too: \fBrm \-rf "$(brew \-\-cache)"\fR
.
68
69
70
71
.TP
\fB\-\-prune\-prefix\fR
Only prune the symlinks and directories from the prefix and remove no other files\.
.
Mike McQuaid's avatar
Mike McQuaid committed
72
.SS "\fBcommand\fR \fIcmd\fR"
73
Display the path to the file being used when invoking \fBbrew\fR \fIcmd\fR\.
Xu Cheng's avatar
Xu Cheng committed
74
.
Mike McQuaid's avatar
Mike McQuaid committed
75
.SS "\fBcommands\fR [\fIoptions\fR]"
76
Show lists of built\-in and external commands\.
77
.
78
.TP
79
80
81
82
\fB\-q\fR, \fB\-\-quiet\fR
List only the names of commands without category headers\.
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
83
\fB\-\-include\-aliases\fR
84
Include aliases of internal commands\.
Mike McQuaid's avatar
Mike McQuaid committed
85
86
.
.SS "\fBconfig\fR"
87
Show Homebrew and system configuration info useful for debugging\. If you file a bug report, you will be required to provide this information\.
Adam Vandenberg's avatar
Adam Vandenberg committed
88
.
89
.SS "\fBdeps\fR [\fIoptions\fR] [\fIformula\fR]"
90
Show dependencies for \fIformula\fR\. Additional options specific to \fIformula\fR may be appended to the command\. When given multiple formula arguments, show the intersection of dependencies for each formula\.
Christopher Sexton's avatar
Christopher Sexton committed
91
.
Mike McQuaid's avatar
Mike McQuaid committed
92
93
.TP
\fB\-n\fR
94
Sort dependencies in topological order\.
95
.
Mike McQuaid's avatar
Mike McQuaid committed
96
.TP
97
98
99
100
\fB\-\-1\fR
Only show dependencies one level down, instead of recursing\.
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
101
\fB\-\-union\fR
102
Show the union of dependencies for multiple \fIformula\fR, instead of the intersection\.
103
.
Mike McQuaid's avatar
Mike McQuaid committed
104
105
106
.TP
\fB\-\-full\-name\fR
List dependencies by their full name\.
107
.
Mike McQuaid's avatar
Mike McQuaid committed
108
109
.TP
\fB\-\-include\-build\fR
110
Include \fB:build\fR dependencies for \fIformula\fR\.
Adam Vandenberg's avatar
Adam Vandenberg committed
111
.
Mike McQuaid's avatar
Mike McQuaid committed
112
113
.TP
\fB\-\-include\-optional\fR
114
Include \fB:optional\fR dependencies for \fIformula\fR\.
115
.
Mike McQuaid's avatar
Mike McQuaid committed
116
117
.TP
\fB\-\-include\-test\fR
118
Include \fB:test\fR dependencies for \fIformula\fR (non\-recursive)\.
Jack Nagel's avatar
Jack Nagel committed
119
.
Mike McQuaid's avatar
Mike McQuaid committed
120
121
.TP
\fB\-\-skip\-recommended\fR
122
Skip \fB:recommended\fR dependencies for \fIformula\fR\.
123
.
Mike McQuaid's avatar
Mike McQuaid committed
124
125
126
.TP
\fB\-\-include\-requirements\fR
Include requirements in addition to dependencies for \fIformula\fR\.
127
.
128
.TP
Mike McQuaid's avatar
Mike McQuaid committed
129
\fB\-\-tree\fR
130
Show dependencies as a tree\. When given multiple formula arguments, show individual trees for each formula\.
131
.
Mike McQuaid's avatar
Mike McQuaid committed
132
.TP
133
134
135
136
\fB\-\-annotate\fR
Mark any build, test, optional, or recommended dependencies as such in the output\.
.
.TP
137
138
139
140
141
142
143
144
\fB\-\-installed\fR
List dependencies for formulae that are currently installed\. If \fIformula\fR is specified, list only its dependencies that are currently installed\.
.
.TP
\fB\-\-all\fR
List dependencies for all available formulae\.
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
145
\fB\-\-for\-each\fR
146
Switch into the mode used by the \fB\-\-all\fR option, but only list dependencies for each provided \fIformula\fR, one formula per line\. This is used for debugging the \fB\-\-installed\fR/\fB\-\-all\fR display mode\.
Xu Cheng's avatar
Xu Cheng committed
147
.
Mike McQuaid's avatar
Mike McQuaid committed
148
149
.SS "\fBdesc\fR [\fIoptions\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR|\fIformula\fR)"
Display \fIformula\fR\'s name and one\-line description\. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones\.
Mike McQuaid's avatar
Mike McQuaid committed
150
.
151
.TP
Mike McQuaid's avatar
Mike McQuaid committed
152
\fB\-s\fR, \fB\-\-search\fR
153
Search both names and descriptions for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
154
.
155
.TP
Mike McQuaid's avatar
Mike McQuaid committed
156
\fB\-n\fR, \fB\-\-name\fR
157
Search just names for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
158
.
159
.TP
Mike McQuaid's avatar
Mike McQuaid committed
160
\fB\-d\fR, \fB\-\-description\fR
161
Search just descriptions for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
162
.
Mike McQuaid's avatar
Mike McQuaid committed
163
164
.SS "\fBdiy\fR [\fIoptions\fR]"
Automatically determine the installation prefix for non\-Homebrew software\. Using the output from this command, you can install your own software into the Cellar and then link it into Homebrew\'s prefix with \fBbrew link\fR\.
165
.
Mike McQuaid's avatar
Mike McQuaid committed
166
167
.TP
\fB\-\-name\fR
168
Explicitly set the \fIname\fR of the package being installed\.
169
.
170
.TP
Mike McQuaid's avatar
Mike McQuaid committed
171
\fB\-\-version\fR
172
Explicitly set the \fIversion\fR of the package being installed\.
Mike McQuaid's avatar
Mike McQuaid committed
173
174
.
.SS "\fBdoctor\fR [\fIoptions\fR]"
175
Check your system for potential problems\. Will exit with a non\-zero status if any potential problems are found\. Please note that these warnings are just used to help the Homebrew maintainers with debugging if you file an issue\. If everything you use Homebrew for is working fine: please don\'t worry or file an issue; just ignore this\.
176
.
177
.TP
Mike McQuaid's avatar
Mike McQuaid committed
178
179
\fB\-\-list\-checks\fR
List all audit methods\.
Adam Vandenberg's avatar
Adam Vandenberg committed
180
.
Mike McQuaid's avatar
Mike McQuaid committed
181
182
183
.TP
\fB\-D\fR, \fB\-\-audit\-debug\fR
Enable debugging and profiling of audit methods\.
184
.
Mike McQuaid's avatar
Mike McQuaid committed
185
.SS "\fBfetch\fR [\fIoptions\fR] \fIformula\fR"
186
Download a bottle (if available) or source packages for \fIformula\fR\. For tarballs, also print SHA\-256 checksums\.
187
.
Mike McQuaid's avatar
Mike McQuaid committed
188
189
190
.TP
\fB\-\-HEAD\fR
Fetch HEAD version instead of stable version\.
191
.
Mike McQuaid's avatar
Mike McQuaid committed
192
193
194
.TP
\fB\-\-devel\fR
Fetch development version instead of stable version\.
Christopher Sexton's avatar
Christopher Sexton committed
195
.
Mike McQuaid's avatar
Mike McQuaid committed
196
.TP
197
198
199
200
201
202
203
204
\fB\-f\fR, \fB\-\-force\fR
Remove a previously cached version and re\-fetch\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Do a verbose VCS checkout, if the URL represents a VCS\. This is useful for seeing if an existing VCS cache has been updated\.
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
205
\fB\-\-retry\fR
206
Retry if downloading fails or re\-download if the checksum of a previously cached version no longer matches\.
207
.
Mike McQuaid's avatar
Mike McQuaid committed
208
209
.TP
\fB\-\-deps\fR
210
Also download dependencies for any listed \fIformula\fR\.
211
.
212
.TP
Mike McQuaid's avatar
Mike McQuaid committed
213
\fB\-s\fR, \fB\-\-build\-from\-source\fR
214
Download source packages rather than a bottle\.
215
.
Mike McQuaid's avatar
Mike McQuaid committed
216
217
.TP
\fB\-\-build\-bottle\fR
218
Download source packages (for eventual bottling) rather than a bottle\.
219
.
Mike McQuaid's avatar
Mike McQuaid committed
220
221
222
.TP
\fB\-\-force\-bottle\fR
Download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation\.
223
.
Mike McQuaid's avatar
Mike McQuaid committed
224
.SS "\fBgist\-logs\fR [\fIoptions\fR] \fIformula\fR"
225
Upload logs for a failed build of \fIformula\fR to a new Gist\. Presents an error message if no logs are found\.
226
.
227
.TP
Mike McQuaid's avatar
Mike McQuaid committed
228
229
\fB\-\-with\-hostname\fR
Include the hostname in the Gist\.
230
.
231
.TP
Mike McQuaid's avatar
Mike McQuaid committed
232
\fB\-n\fR, \fB\-\-new\-issue\fR
233
Automatically create a new issue in the appropriate GitHub repository after creating the Gist\.
Christopher Sexton's avatar
Christopher Sexton committed
234
.
235
.TP
Mike McQuaid's avatar
Mike McQuaid committed
236
\fB\-p\fR, \fB\-\-private\fR
237
The Gist will be marked private and will not appear in listings but will be accessible with its link\.
Mike McQuaid's avatar
Mike McQuaid committed
238
239
.
.SS "\fBhome\fR [\fIformula\fR]"
240
Open \fIformula\fR\'s homepage in a browser, or open Homebrew\'s own homepage if no formula is provided\.
Mike McQuaid's avatar
Mike McQuaid committed
241
.
EricFromCanada's avatar
EricFromCanada committed
242
.SS "\fBinfo\fR [\fIoptions\fR] [\fIformula\fR]"
243
Display brief statistics for your Homebrew installation\.
244
.
EricFromCanada's avatar
EricFromCanada committed
245
.P
246
If \fIformula\fR is provided, show summary of information about \fIformula\fR\.
EricFromCanada's avatar
EricFromCanada committed
247
.
248
.TP
Mike McQuaid's avatar
Mike McQuaid committed
249
\fB\-\-analytics\fR
250
List global Homebrew analytics data or, if specified, installation and build error data for \fIformula\fR (provided neither \fBHOMEBREW_NO_ANALYTICS\fR nor \fBHOMEBREW_NO_GITHUB_API\fR are set)\.
251
.
Mike McQuaid's avatar
Mike McQuaid committed
252
253
.TP
\fB\-\-days\fR
EricFromCanada's avatar
EricFromCanada committed
254
How many days of global analytics data to retrieve\. The value for \fIdays\fR must be \fB30\fR, \fB90\fR or \fB365\fR\. The default is \fB30\fR\.
255
.
Mike McQuaid's avatar
Mike McQuaid committed
256
257
.TP
\fB\-\-category\fR
EricFromCanada's avatar
EricFromCanada committed
258
Which type of global analytics data to retrieve\. The value for \fIcategory\fR must be \fBinstall\fR, \fBinstall\-on\-request\fR, \fBcask\-install\fR, \fBbuild\-error\fR or \fBos\-version\fR\. The default is \fBinstall\fR\.
259
260
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
261
\fB\-\-github\fR
262
Open the GitHub source page for \fIformula\fR in a browser\. To view formula history locally: \fBbrew log \-p\fR \fIformula\fR
Christopher Sexton's avatar
Christopher Sexton committed
263
.
264
.TP
Mike McQuaid's avatar
Mike McQuaid committed
265
266
\fB\-\-json\fR
Print a JSON representation of \fIformula\fR\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
Adam Vandenberg's avatar
Adam Vandenberg committed
267
.
268
.TP
EricFromCanada's avatar
EricFromCanada committed
269
270
\fB\-\-installed\fR
Print JSON of formulae that are currently installed\.
271
.
272
.TP
EricFromCanada's avatar
EricFromCanada committed
273
274
\fB\-\-all\fR
Print JSON of all available formulae\.
Mike McQuaid's avatar
Mike McQuaid committed
275
.
276
277
278
279
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Show more verbose analytics data for \fIformula\fR\.
.
Mike McQuaid's avatar
Mike McQuaid committed
280
.SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR"
281
Install \fIformula\fR\. Additional options specific to \fIformula\fR may be appended to the command\.
Adam Vandenberg's avatar
Adam Vandenberg committed
282
.
Mike McQuaid's avatar
Mike McQuaid committed
283
.P
284
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will then be run for the installed formulae or, every 30 days, for all formulae\.
285
.
Mike McQuaid's avatar
Mike McQuaid committed
286
.TP
287
288
289
290
\fB\-d\fR, \fB\-\-debug\fR
If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\.
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
291
\fB\-\-env\fR
292
If \fBstd\fR is passed, use the standard build environment instead of superenv\. If \fBsuper\fR is passed, use superenv even if the formula specifies the standard build environment\.
Jack Nagel's avatar
Jack Nagel committed
293
.
Mike McQuaid's avatar
Mike McQuaid committed
294
295
.TP
\fB\-\-ignore\-dependencies\fR
296
An unsupported Homebrew development flag to skip installing any dependencies of any kind\. If the dependencies are not already present, the formula will have issues\. If you\'re not developing Homebrew, consider adjusting your PATH rather than using this flag\.
Jack Nagel's avatar
Jack Nagel committed
297
.
Mike McQuaid's avatar
Mike McQuaid committed
298
299
.TP
\fB\-\-only\-dependencies\fR
300
Install the dependencies with specified options but do not install the formula itself\.
Christopher Sexton's avatar
Christopher Sexton committed
301
.
Mike McQuaid's avatar
Mike McQuaid committed
302
303
.TP
\fB\-\-cc\fR
304
Attempt to compile using the specified \fIcompiler\fR, which should be the name of the compiler\'s executable, e\.g\. \fBgcc\-7\fR for GCC 7\. In order to use LLVM\'s clang, specify \fBllvm_clang\fR\. To use the Apple\-provided clang, specify \fBclang\fR\. This option will only accept compilers that are provided by Homebrew or bundled with macOS\. Please do not file issues if you encounter errors while using this option\.
Christopher Sexton's avatar
Christopher Sexton committed
305
.
Mike McQuaid's avatar
Mike McQuaid committed
306
307
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
308
Compile \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\.
309
.
Mike McQuaid's avatar
Mike McQuaid committed
310
311
312
.TP
\fB\-\-force\-bottle\fR
Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation\.
313
.
Mike McQuaid's avatar
Mike McQuaid committed
314
315
.TP
\fB\-\-include\-test\fR
316
Install testing dependencies required to run \fBbrew test\fR \fIformula\fR\.
317
.
Mike McQuaid's avatar
Mike McQuaid committed
318
319
320
.TP
\fB\-\-devel\fR
If \fIformula\fR defines it, install the development version\.
321
.
Mike McQuaid's avatar
Mike McQuaid committed
322
323
324
.TP
\fB\-\-HEAD\fR
If \fIformula\fR defines it, install the HEAD version, aka\. master, trunk, unstable\.
325
.
Mike McQuaid's avatar
Mike McQuaid committed
326
327
.TP
\fB\-\-fetch\-HEAD\fR
328
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will only be checked for updates when a new stable or development version has been released\.
Jack Nagel's avatar
Jack Nagel committed
329
.
Mike McQuaid's avatar
Mike McQuaid committed
330
331
.TP
\fB\-\-keep\-tmp\fR
332
Retain the temporary files created during installation\.
Christopher Sexton's avatar
Christopher Sexton committed
333
.
Mike McQuaid's avatar
Mike McQuaid committed
334
335
.TP
\fB\-\-build\-bottle\fR
336
Prepare the formula for eventual bottling during installation, skipping any post\-install steps\.
337
.
Mike McQuaid's avatar
Mike McQuaid committed
338
.TP
Mike McQuaid's avatar
Mike McQuaid committed
339
\fB\-\-bottle\-arch\fR
340
Optimise bottles for the specified architecture rather than the oldest architecture supported by the version of macOS the bottles are built on\.
Mike McQuaid's avatar
Mike McQuaid committed
341
342
.
.TP
343
344
345
346
347
348
349
350
\fB\-f\fR, \fB\-\-force\fR
Install without checking for previously installed keg\-only or non\-migrated versions\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print the verification and postinstall steps\.
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
351
352
\fB\-\-display\-times\fR
Print install times for each formula at the end of the run\.
353
.
Mike McQuaid's avatar
Mike McQuaid committed
354
355
356
.TP
\fB\-i\fR, \fB\-\-interactive\fR
Download and patch \fIformula\fR, then open a shell\. This allows the user to run \fB\./configure \-\-help\fR and otherwise determine how to turn the software package into a Homebrew package\.
357
.
Mike McQuaid's avatar
Mike McQuaid committed
358
359
360
.TP
\fB\-g\fR, \fB\-\-git\fR
Create a Git repository, useful for creating patches to the software\.
361
.
Mike McQuaid's avatar
Mike McQuaid committed
362
.SS "\fBleaves\fR"
363
List installed formulae that are not dependencies of another installed formula\.
364
.
365
366
.SS "\fBlink\fR, \fBln\fR [\fIoptions\fR] \fIformula\fR"
Symlink all of \fIformula\fR\'s installed files into Homebrew\'s prefix\. This is done automatically when you install formulae but can be useful for DIY installations\.
VonUniGE's avatar
VonUniGE committed
367
.
368
.TP
Mike McQuaid's avatar
Mike McQuaid committed
369
\fB\-\-overwrite\fR
370
Delete files that already exist in the prefix while linking\.
Christopher Sexton's avatar
Christopher Sexton committed
371
.
Mike McQuaid's avatar
Mike McQuaid committed
372
373
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
374
List files which would be linked or deleted by \fBbrew link \-\-overwrite\fR without actually linking or deleting any files\.
Mike McQuaid's avatar
Mike McQuaid committed
375
.
376
377
378
379
.TP
\fB\-f\fR, \fB\-\-force\fR
Allow keg\-only formulae to be linked\.
.
380
.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR] [\fIformula\fR]"
Mike McQuaid's avatar
Mike McQuaid committed
381
List all installed formulae\.
Adam Vandenberg's avatar
Adam Vandenberg committed
382
.
383
384
385
.P
If \fIformula\fR is provided, summarize the paths within its current keg\.
.
386
.TP
Mike McQuaid's avatar
Mike McQuaid committed
387
\fB\-\-full\-name\fR
388
Print formulae with fully\-qualified names\. If \fB\-\-full\-name\fR is not passed, other options (i\.e\. \fB\-1\fR, \fB\-l\fR, \fB\-r\fR and \fB\-t\fR) are passed to \fBls\fR(1) which produces the actual output\.
Jack Nagel's avatar
Jack Nagel committed
389
.
390
.TP
Mike McQuaid's avatar
Mike McQuaid committed
391
\fB\-\-unbrewed\fR
392
List files in Homebrew\'s prefix not installed by Homebrew\.
Christopher Sexton's avatar
Christopher Sexton committed
393
.
Mike McQuaid's avatar
Mike McQuaid committed
394
395
.TP
\fB\-\-versions\fR
396
Show the version number for installed formulae, or only the specified formulae if \fIformula\fR are provided\.
397
.
Mike McQuaid's avatar
Mike McQuaid committed
398
399
400
.TP
\fB\-\-multiple\fR
Only show formulae with multiple versions installed\.
401
.
Mike McQuaid's avatar
Mike McQuaid committed
402
403
.TP
\fB\-\-pinned\fR
404
Show the versions of pinned formulae, or only the specified (pinned) formulae if \fIformula\fR are provided\. See also \fBpin\fR, \fBunpin\fR\.
Jack Nagel's avatar
Jack Nagel committed
405
.
406
.TP
Mike McQuaid's avatar
Mike McQuaid committed
407
408
\fB\-1\fR
Force output to be one entry per line\. This is the default when output is not to a terminal\.
Christopher Sexton's avatar
Christopher Sexton committed
409
.
410
.TP
Mike McQuaid's avatar
Mike McQuaid committed
411
\fB\-l\fR
412
List in long format\. If the output is to a terminal, a total sum for all the file sizes is printed before the long listing\.
413
.
414
.TP
Mike McQuaid's avatar
Mike McQuaid committed
415
\fB\-r\fR
416
Reverse the order of the sort to list the oldest entries first\.
Jack Nagel's avatar
Jack Nagel committed
417
.
Mike McQuaid's avatar
Mike McQuaid committed
418
419
.TP
\fB\-t\fR
420
Sort by time modified, listing most recently modified first\.
Christopher Sexton's avatar
Christopher Sexton committed
421
.
422
423
.SS "\fBlog\fR [\fIoptions\fR] [\fIformula\fR]"
Show the \fBgit log\fR for \fIformula\fR, or show the log for the Homebrew repository if no formula is provided\.
424
.
425
.TP
Mike McQuaid's avatar
Mike McQuaid committed
426
\fB\-p\fR, \fB\-\-patch\fR
427
Also print patch from commit\.
Adam Vandenberg's avatar
Adam Vandenberg committed
428
.
429
.TP
Mike McQuaid's avatar
Mike McQuaid committed
430
\fB\-\-stat\fR
431
Also print diffstat from commit\.
432
.
Mike McQuaid's avatar
Mike McQuaid committed
433
434
.TP
\fB\-\-oneline\fR
435
Print only one line per commit\.
436
.
437
.TP
Mike McQuaid's avatar
Mike McQuaid committed
438
\fB\-1\fR, \fB\-\-max\-count\fR
439
Print only one or a specified number of commits\.
Vlad Shablinsky's avatar
Vlad Shablinsky committed
440
.
Mike McQuaid's avatar
Mike McQuaid committed
441
.SS "\fBmigrate\fR [\fIoptions\fR] \fIformula\fR"
442
Migrate renamed packages to new names, where \fIformula\fR are old names of packages\.
443
.
444
445
446
447
.TP
\fB\-f\fR, \fB\-\-force\fR
Treat installed \fIformula\fR and provided \fIformula\fR as if they are from the same taps and migrate them anyway\.
.
448
449
.SS "\fBmissing\fR [\fIoptions\fR] [\fIformula\fR]"
Check the given \fIformula\fR kegs for missing dependencies\. If no \fIformula\fR are provided, check all kegs\. Will exit with a non\-zero status if any kegs are found to be missing dependencies\.
450
.
451
.TP
Mike McQuaid's avatar
Mike McQuaid committed
452
\fB\-\-hide\fR
453
Act as if none of the specified \fIhidden\fR are installed\. \fIhidden\fR should be a comma\-separated list of formulae\.
Adam Vandenberg's avatar
Adam Vandenberg committed
454
.
455
456
.SS "\fBoptions\fR [\fIoptions\fR] [\fIformula\fR]"
Show install options specific to \fIformula\fR\.
457
.
Mike McQuaid's avatar
Mike McQuaid committed
458
459
460
.TP
\fB\-\-compact\fR
Show all options on a single line separated by spaces\.
461
.
Mike McQuaid's avatar
Mike McQuaid committed
462
.TP
463
464
\fB\-\-installed\fR
Show options for formulae that are currently installed\.
465
.
466
.TP
467
468
\fB\-\-all\fR
Show options for all available formulae\.
Mike McQuaid's avatar
Mike McQuaid committed
469
470
.
.SS "\fBoutdated\fR [\fIoptions\fR]"
471
List installed formulae that have an updated version available\. By default, version information is displayed in interactive shells, and suppressed otherwise\.
472
.
473
.TP
474
475
476
477
478
479
480
481
\fB\-q\fR, \fB\-\-quiet\fR
List only the names of outdated kegs (takes precedence over \fB\-\-verbose\fR)\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Include detailed version information\.
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
482
\fB\-\-json\fR
483
Print output in JSON format\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
484
.
485
.TP
Mike McQuaid's avatar
Mike McQuaid committed
486
\fB\-\-fetch\-HEAD\fR
487
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will only be checked for updates when a new stable or development version has been released\.
488
.
Mike McQuaid's avatar
Mike McQuaid committed
489
490
.SS "\fBpin\fR \fIformula\fR"
Pin the specified \fIformula\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR \fIformula\fR command\. See also \fBunpin\fR\.
491
.
Mike McQuaid's avatar
Mike McQuaid committed
492
493
.SS "\fBpostinstall\fR \fIformula\fR"
Rerun the post\-install steps for \fIformula\fR\.
494
.
Mike McQuaid's avatar
Mike McQuaid committed
495
.SS "\fBreadall\fR [\fIoptions\fR] [\fItap\fR]"
496
Import all formulae from the specified \fItap\fR, or from all installed taps if none is provided\. This can be useful for debugging issues across all formulae when making significant changes to \fBformula\.rb\fR, testing the performance of loading all formulae or to determine if any current formulae have Ruby issues\.
497
.
Mike McQuaid's avatar
Mike McQuaid committed
498
499
500
.TP
\fB\-\-aliases\fR
Verify any alias symlinks in each tap\.
501
.
502
.TP
Mike McQuaid's avatar
Mike McQuaid committed
503
504
505
506
\fB\-\-syntax\fR
Syntax\-check all of Homebrew\'s Ruby files\.
.
.SS "\fBreinstall\fR [\fIoptions\fR] \fIformula\fR"
507
Uninstall and then install \fIformula\fR using the same options it was originally installed with, plus any appended brew formula options\.
508
.
509
.P
510
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will then be run for the reinstalled formulae or, every 30 days, for all formulae\.
511
.
Mike McQuaid's avatar
Mike McQuaid committed
512
.TP
513
514
515
516
\fB\-d\fR, \fB\-\-debug\fR
If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\.
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
517
518
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile \fIformula\fR from source even if a bottle is available\.
519
.
Mike McQuaid's avatar
Mike McQuaid committed
520
521
522
.TP
\fB\-\-force\-bottle\fR
Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation\.
523
.
Mike McQuaid's avatar
Mike McQuaid committed
524
525
.TP
\fB\-\-keep\-tmp\fR
526
Retain the temporary files created during installation\.
527
.
Mike McQuaid's avatar
Mike McQuaid committed
528
.TP
529
530
531
532
533
534
535
536
\fB\-f\fR, \fB\-\-force\fR
Install without checking for previously installed keg\-only or non\-migrated versions\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print the verification and postinstall steps\.
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
537
538
\fB\-\-display\-times\fR
Print install times for each formula at the end of the run\.
539
.
Mike McQuaid's avatar
Mike McQuaid committed
540
.SS "\fBsearch\fR [\fIoptions\fR] [\fItext\fR|\fB/\fR\fItext\fR\fB/\fR]"
541
Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\. The search for \fItext\fR is extended online to \fBhomebrew/core\fR and \fBhomebrew/cask\fR\.
542
.
Mike McQuaid's avatar
Mike McQuaid committed
543
.P
544
If no \fItext\fR is provided, list all locally available formulae (including tapped ones)\. No online search is performed\.
545
.
Mike McQuaid's avatar
Mike McQuaid committed
546
547
.TP
\fB\-\-casks\fR
548
List all locally available casks (including tapped ones)\. No online search is performed\.
Mike McQuaid's avatar
Mike McQuaid committed
549
.
Mike McQuaid's avatar
Mike McQuaid committed
550
551
.TP
\fB\-\-desc\fR
552
Search for formulae with a description matching \fItext\fR and casks with a name matching \fItext\fR\.
553
.
554
.TP
Mike McQuaid's avatar
Mike McQuaid committed
555
556
\fB\-\-macports\fR
Search for \fItext\fR in the given package manager\'s list\.
557
.
558
.TP
Mike McQuaid's avatar
Mike McQuaid committed
559
560
\fB\-\-fink\fR
Search for \fItext\fR in the given package manager\'s list\.
561
.
562
.TP
Mike McQuaid's avatar
Mike McQuaid committed
563
564
\fB\-\-opensuse\fR
Search for \fItext\fR in the given package manager\'s list\.
Adam Vandenberg's avatar
Adam Vandenberg committed
565
.
Mike McQuaid's avatar
Mike McQuaid committed
566
567
568
.TP
\fB\-\-fedora\fR
Search for \fItext\fR in the given package manager\'s list\.
Joe Gallo's avatar
Joe Gallo committed
569
.
570
.TP
Mike McQuaid's avatar
Mike McQuaid committed
571
\fB\-\-debian\fR
572
Search for \fItext\fR in the given package manager\'s list\.
Max Howell's avatar
Max Howell committed
573
.
574
.TP
Mike McQuaid's avatar
Mike McQuaid committed
575
576
\fB\-\-ubuntu\fR
Search for \fItext\fR in the given package manager\'s list\.
577
.
Mike McQuaid's avatar
Mike McQuaid committed
578
.SS "\fBsh\fR [\fIoptions\fR]"
579
Start a Homebrew build environment shell\. Uses our years\-battle\-hardened Homebrew build logic to help your \fB\./configure && make && make install\fR or even your \fBgem install\fR succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fR to your \fBPATH\fR which build systems would not find otherwise\.
Xu Cheng's avatar
Xu Cheng committed
580
.
581
.TP
Mike McQuaid's avatar
Mike McQuaid committed
582
\fB\-\-env\fR
583
Use the standard \fBPATH\fR instead of superenv\'s when \fBstd\fR is passed\.
584
.
Mike McQuaid's avatar
Mike McQuaid committed
585
.SS "\fBshellenv\fR"
586
Print export statements\. When run in a shell, this installation of Homebrew will be added to your \fBPATH\fR, \fBMANPATH\fR, and \fBINFOPATH\fR\.
587
.
Mike McQuaid's avatar
Mike McQuaid committed
588
.P
589
The variables \fBHOMEBREW_PREFIX\fR, \fBHOMEBREW_CELLAR\fR and \fBHOMEBREW_REPOSITORY\fR are also exported to avoid querying them multiple times\. Consider adding evaluation of this command\'s output to your dotfiles (e\.g\. \fB~/\.profile\fR or \fB~/\.zprofile\fR) with: \fBeval $(brew shellenv)\fR
590
.
Mike McQuaid's avatar
Mike McQuaid committed
591
.SS "\fBstyle\fR [\fIoptions\fR] [\fIfile\fR|\fItap\fR|\fIformula\fR]"
592
Check formulae or files for conformance to Homebrew style guidelines\.
593
.
Mike McQuaid's avatar
Mike McQuaid committed
594
595
.P
Lists of \fIfile\fR, \fItap\fR and \fIformula\fR may not be combined\. If none are provided, \fBstyle\fR will run style checks on the whole Homebrew library, including core code and all formulae\.
596
.
Mike McQuaid's avatar
Mike McQuaid committed
597
598
599
.TP
\fB\-\-fix\fR
Fix style violations automatically using RuboCop\'s auto\-correct feature\.
600
.
601
.TP
Mike McQuaid's avatar
Mike McQuaid committed
602
603
\fB\-\-display\-cop\-names\fR
Include the RuboCop cop name for each violation in the output\.
Jack Nagel's avatar
Jack Nagel committed
604
.
605
.TP
Mike McQuaid's avatar
Mike McQuaid committed
606
607
\fB\-\-only\-cops\fR
Specify a comma\-separated \fIcops\fR list to check for violations of only the listed RuboCop cops\.
608
.
609
.TP
Mike McQuaid's avatar
Mike McQuaid committed
610
611
\fB\-\-except\-cops\fR
Specify a comma\-separated \fIcops\fR list to skip checking for violations of the listed RuboCop cops\.
612
.
Mike McQuaid's avatar
Mike McQuaid committed
613
.SS "\fBswitch\fR \fIformula\fR \fIversion\fR"
614
Symlink all of the specified \fIversion\fR of \fIformula\fR\'s installation into Homebrew\'s prefix\.
615
.
Mike McQuaid's avatar
Mike McQuaid committed
616
617
.SS "\fBtap\fR [\fIoptions\fR] \fIuser\fR\fB/\fR\fIrepo\fR [\fIURL\fR]"
Tap a formula repository\.
Xu Cheng's avatar
Xu Cheng committed
618
.
Mike McQuaid's avatar
Mike McQuaid committed
619
.P
620
If no arguments are provided, list all installed taps\.
Xu Cheng's avatar
Xu Cheng committed
621
.
Mike McQuaid's avatar
Mike McQuaid committed
622
.P
623
With \fIURL\fR unspecified, tap a formula repository from GitHub using HTTPS\. Since so many taps are hosted on GitHub, this command is a shortcut for \fBbrew tap\fR \fIuser\fR\fB/\fR\fIrepo\fR \fBhttps://github\.com/\fR\fIuser\fR\fB/homebrew\-\fR\fIrepo\fR\.
Xu Cheng's avatar
Xu Cheng committed
624
.
Mike McQuaid's avatar
Mike McQuaid committed
625
.P
626
With \fIURL\fR specified, tap a formula repository from anywhere, using any transport protocol that \fBgit\fR(1) handles\. The one\-argument form of \fBtap\fR simplifies but also limits\. This two\-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e\.g\. SSH, GIT, HTTP, FTP(S), RSYNC\.
Xu Cheng's avatar
Xu Cheng committed
627
.
628
.TP
Mike McQuaid's avatar
Mike McQuaid committed
629
\fB\-\-full\fR
630
Use a full clone when tapping a repository\. By default, the repository is cloned as a shallow copy (\fB\-\-depth=1\fR)\. To convert a shallow copy to a full copy, you can retap by passing \fB\-\-full\fR without first untapping\.
CNA-Bld's avatar
CNA-Bld committed
631
.
632
.TP
Mike McQuaid's avatar
Mike McQuaid committed
633
634
\fB\-\-force\-auto\-update\fR
Auto\-update tap even if it is not hosted on GitHub\. By default, only taps hosted on GitHub are auto\-updated (for performance reasons)\.
CNA-Bld's avatar
CNA-Bld committed
635
.
636
.TP
Mike McQuaid's avatar
Mike McQuaid committed
637
638
\fB\-\-repair\fR
Migrate tapped formulae from symlink\-based to directory\-based structure\.
639
640
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
641
642
\fB\-\-list\-pinned\fR
List all pinned taps\.
643
644
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
645
646
\fB\-q\fR, \fB\-\-quieter\fR
Suppress any warnings\.
647
.
Mike McQuaid's avatar
Mike McQuaid committed
648
.SS "\fBtap\-info\fR [\fIoptions\fR] [\fItap\fR]"
649
650
651
652
Show detailed information about one or more \fItap\fRs\.
.
.P
If no \fItap\fR names are provided, display brief statistics for all installed taps\.
653
654
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
655
\fB\-\-installed\fR
656
Show information on each installed tap\.
657
658
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
659
\fB\-\-json\fR
660
Print a JSON representation of \fItap\fR\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
661
.
Mike McQuaid's avatar
Mike McQuaid committed
662
663
.SS "\fBuninstall\fR, \fBrm\fR, \fBremove\fR [\fIoptions\fR] \fIformula\fR"
Uninstall \fIformula\fR\.
664
.
665
.TP
666
667
668
669
\fB\-f\fR, \fB\-\-force\fR
Delete all installed versions of \fIformula\fR\.
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
670
671
\fB\-\-ignore\-dependencies\fR
Don\'t fail uninstall, even if \fIformula\fR is a dependency of any installed formulae\.
Xu Cheng's avatar
Xu Cheng committed
672
.
Mike McQuaid's avatar
Mike McQuaid committed
673
.SS "\fBunlink\fR [\fIoptions\fR] \fIformula\fR"
674
Remove symlinks for \fIformula\fR from Homebrew\'s prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink\fR \fIformula\fR \fB&&\fR \fIcommands\fR \fB&& brew link\fR \fIformula\fR
Adam Vandenberg's avatar
Adam Vandenberg committed
675
.
676
.TP
Mike McQuaid's avatar
Mike McQuaid committed
677
\fB\-n\fR, \fB\-\-dry\-run\fR
678
List files which would be unlinked without actually unlinking or deleting any files\.
Jack Nagel's avatar
Jack Nagel committed
679
.
Mike McQuaid's avatar
Mike McQuaid committed
680
681
.SS "\fBunpack\fR [\fIoptions\fR] \fIformula\fR"
Unpack the source files for \fIformula\fR into subdirectories of the current working directory\.
Jack Nagel's avatar
Jack Nagel committed
682
.
683
.TP
Mike McQuaid's avatar
Mike McQuaid committed
684
685
\fB\-\-destdir\fR
Create subdirectories in the directory named by \fIpath\fR instead\.
686
.
687
.TP
Mike McQuaid's avatar
Mike McQuaid committed
688
689
\fB\-\-patch\fR
Patches for \fIformula\fR will be applied to the unpacked source\.
Jack Nagel's avatar
Jack Nagel committed
690
.
691
.TP
Mike McQuaid's avatar
Mike McQuaid committed
692
693
\fB\-g\fR, \fB\-\-git\fR
Initialise a Git repository in the unpacked source\. This is useful for creating patches for the software\.
694
.
Mike McQuaid's avatar
Mike McQuaid committed
695
696
.SS "\fBunpin\fR \fIformula\fR"
Unpin \fIformula\fR, allowing them to be upgraded by \fBbrew upgrade\fR \fIformula\fR\. See also \fBpin\fR\.
697
.
Mike McQuaid's avatar
Mike McQuaid committed
698
.SS "\fBuntap\fR \fItap\fR"
699
Remove a tapped formula repository\.
Mike McQuaid's avatar
Mike McQuaid committed
700
.
701
.SS "\fBupdate\fR, \fBup\fR [\fIoptions\fR]"
Mike McQuaid's avatar
Mike McQuaid committed
702
Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1) and perform any necessary migrations\.
703
704
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
705
\fB\-\-merge\fR
706
Use \fBgit merge\fR to apply updates (rather than \fBgit rebase\fR)\.
707
.
Mike McQuaid's avatar
Mike McQuaid committed
708
.SS "\fBupdate\-reset\fR [\fIrepository\fR]"
709
Fetch and reset Homebrew and all tap repositories (or any specified \fIrepository\fR) using \fBgit\fR(1) to their latest \fBorigin/master\fR\.
710
.
Mike McQuaid's avatar
Mike McQuaid committed
711
.P
712
713
714
715
\fINote:\fR this will destroy all your uncommitted or committed changes\.
.
.SS "\fBupgrade\fR [\fIoptions\fR] [\fIformula\fR]"
Upgrade outdated, unpinned formulae using the same options they were originally installed with, plus any appended brew formula options\. If \fIformula\fR are specified, upgrade only the given \fIformula\fR kegs (unless they are pinned; see \fBpin\fR, \fBunpin\fR)\.
716
.
717
.P
718
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will then be run for the upgraded formulae or, every 30 days, for all formulae\.
719
.
Mike McQuaid's avatar
Mike McQuaid committed
720
.TP
721
722
723
724
\fB\-d\fR, \fB\-\-debug\fR
If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\.
.
.TP
Mike McQuaid's avatar
Mike McQuaid committed
725
726
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile \fIformula\fR from source even if a bottle is available\.
Jack Nagel's avatar
Jack Nagel committed
727
.
Mike McQuaid's avatar
Mike McQuaid committed
728
729
730
.TP
\fB\-\-force\-bottle\fR
Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation\.
731
.
Mike McQuaid's avatar
Mike McQuaid committed
732
733
.TP
\fB\-\-fetch\-HEAD\fR
734
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will only be checked for updates when a new stable or development version has been released\.
735
.
Mike McQuaid's avatar
Mike McQuaid committed
736
737
.TP
\fB\-\-ignore\-pinned\fR
738
Set a successful exit status even if pinned formulae are not upgraded\.
739
.
Mike McQuaid's avatar
Mike McQuaid committed
740
741
.TP
\fB\-\-keep\-tmp\fR
742
Retain the temporary files created during installation\.
743
.