-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
brew.1
3623 lines (3619 loc) 路 113 KB
/
brew.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "BREW" "1" "September 2022" "Homebrew" "brew"
.
.SH "NAME"
\fBbrew\fR \- The Missing Package Manager for macOS (or Linux)
.
.SH "SYNOPSIS"
\fBbrew\fR \fB\-\-version\fR
.
.br
\fBbrew\fR \fIcommand\fR [\fB\-\-verbose\fR|\fB\-v\fR] [\fIoptions\fR] [\fIformula\fR] \.\.\.
.
.SH "DESCRIPTION"
Homebrew is the easiest and most flexible way to install the UNIX tools Apple didn\'t include with macOS\. It can also install software not packaged for your Linux distribution without requiring \fBsudo\fR\.
.
.SH "TERMINOLOGY"
\fBformula\fR
Homebrew package definition that builds from upstream sources
.
.P
\fBcask\fR
Homebrew package definition that installs macOS native applications
.
.P
\fBprefix\fR
path in which Homebrew is installed, e\.g\. \fB/usr/local\fR
.
.P
\fBkeg\fR
installation destination directory of a given \fBformula\fR version, e\.g\. \fB/usr/local/Cellar/foo/0\.1\fR
.
.P
\fBrack\fR
directory containing one or more versioned \fBkegs\fR, e\.g\. \fB/usr/local/Cellar/foo\fR
.
.P
\fBkeg\-only\fR
a \fBformula\fR is \fIkeg\-only\fR if it is not symlinked into Homebrew\'s prefix
.
.P
\fBopt prefix\fR
a symlink to the active version of a \fBkeg\fR, e\.g\. \fB/usr/local/opt/foo\fR
.
.P
\fBCellar\fR
directory containing one or more named \fBracks\fR, e\.g\. \fB/usr/local/Cellar\fR
.
.P
\fBCaskroom\fR
directory containing one or more named \fBcasks\fR, e\.g\. \fB/usr/local/Caskroom\fR
.
.P
\fBexternal command\fR
\fBbrew\fR subcommand defined outside of the Homebrew/brew GitHub repository
.
.P
\fBtap\fR
directory (and usually Git repository) of \fBformulae\fR, \fBcasks\fR and/or \fBexternal commands\fR
.
.P
\fBbottle\fR
pre\-built \fBkeg\fR poured into a \fBrack\fR of the \fBCellar\fR instead of building from upstream sources
.
.SH "ESSENTIAL COMMANDS"
For the full command list, see the \fICOMMANDS\fR section\.
.
.P
With \fB\-\-verbose\fR or \fB\-\-debug\fR, many commands print extra debugging information\. Note that these options should only appear after a command\.
.
.P
Some command behaviour can be customised with environment variables; see the \fIENVIRONMENT\fR section\.
.
.SS "\fBinstall\fR \fIformula\fR"
Install \fIformula\fR\.
.
.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\.
.
.SS "\fBuninstall\fR \fIformula\fR"
Uninstall \fIformula\fR\.
.
.SS "\fBlist\fR"
List all installed formulae\.
.
.SS "\fBsearch\fR [\fItext\fR|\fB/\fR\fItext\fR\fB/\fR]"
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\.
.
.SH "COMMANDS"
.
.SS "\fBanalytics\fR [\fIsubcommand\fR]"
Control Homebrew\'s anonymous aggregate user behaviour analytics\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\.
.
.P
\fBbrew analytics\fR [\fBstate\fR]
Display the current state of Homebrew\'s analytics\.
.
.P
\fBbrew analytics\fR (\fBon\fR|\fBoff\fR)
Turn Homebrew\'s analytics on or off respectively\.
.
.SS "\fBautoremove\fR [\fB\-\-dry\-run\fR]"
Uninstall formulae that were only installed as a dependency of another formula and are now no longer needed\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
List what would be uninstalled, but do not actually uninstall anything\.
.
.SS "\fBcasks\fR"
List all locally installable casks including short names\.
.
.SS "\fBcleanup\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
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\. Removes all downloads more than 120 days old\. This can be adjusted with \fBHOMEBREW_CLEANUP_MAX_AGE_DAYS\fR\.
.
.TP
\fB\-\-prune\fR
Remove all cache files older than specified \fIdays\fR\. If you want to remove everything, use \fB\-\-prune=all\fR\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Show what would be removed, but do not actually remove anything\.
.
.TP
\fB\-s\fR
Scrub the cache, including downloads for even the latest versions\. Note that downloads for any installed formulae or casks will still not be deleted\. If you want to delete those too: \fBrm \-rf "$(brew \-\-cache)"\fR
.
.TP
\fB\-\-prune\-prefix\fR
Only prune the symlinks and directories from the prefix and remove no other files\.
.
.SS "\fBcommands\fR [\fB\-\-quiet\fR] [\fB\-\-include\-aliases\fR]"
Show lists of built\-in and external commands\.
.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
List only the names of commands without category headers\.
.
.TP
\fB\-\-include\-aliases\fR
Include aliases of internal commands\.
.
.SS "\fBcompletions\fR [\fIsubcommand\fR]"
Control whether Homebrew automatically links external tap shell completion files\. Read more at \fIhttps://docs\.brew\.sh/Shell\-Completion\fR\.
.
.P
\fBbrew completions\fR [\fBstate\fR]
Display the current state of Homebrew\'s completions\.
.
.P
\fBbrew completions\fR (\fBlink\fR|\fBunlink\fR)
Link or unlink Homebrew\'s completions\.
.
.SS "\fBconfig\fR, \fB\-\-config\fR"
Show Homebrew and system configuration info useful for debugging\. If you file a bug report, you will be required to provide this information\.
.
.SS "\fBdeps\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Show dependencies for \fIformula\fR\. When given multiple formula arguments, show the intersection of dependencies for each formula\. By default, \fBdeps\fR shows all required and recommended dependencies\.
.
.P
If any version of each formula argument is installed and no other options are passed, this command displays their actual runtime dependencies (similar to \fBbrew linkage\fR), which may differ from the current versons\' stated dependencies if the installed versions are outdated\.
.
.P
\fINote:\fR \fB\-\-missing\fR and \fB\-\-skip\-recommended\fR have precedence over \fB\-\-include\-*\fR\.
.
.TP
\fB\-n\fR, \fB\-\-topological\fR
Sort dependencies in topological order\.
.
.TP
\fB\-1\fR, \fB\-\-direct\fR
Show only the direct dependencies declared in the formula\.
.
.TP
\fB\-\-union\fR
Show the union of dependencies for multiple \fIformula\fR, instead of the intersection\.
.
.TP
\fB\-\-full\-name\fR
List dependencies by their full name\.
.
.TP
\fB\-\-include\-build\fR
Include \fB:build\fR dependencies for \fIformula\fR\.
.
.TP
\fB\-\-include\-optional\fR
Include \fB:optional\fR dependencies for \fIformula\fR\.
.
.TP
\fB\-\-include\-test\fR
Include \fB:test\fR dependencies for \fIformula\fR (non\-recursive)\.
.
.TP
\fB\-\-skip\-recommended\fR
Skip \fB:recommended\fR dependencies for \fIformula\fR\.
.
.TP
\fB\-\-include\-requirements\fR
Include requirements in addition to dependencies for \fIformula\fR\.
.
.TP
\fB\-\-tree\fR
Show dependencies as a tree\. When given multiple formula arguments, show individual trees for each formula\.
.
.TP
\fB\-\-graph\fR
Show dependencies as a directed graph\.
.
.TP
\fB\-\-dot\fR
Show text\-based graph description in DOT format\.
.
.TP
\fB\-\-annotate\fR
Mark any build, test, optional, or recommended dependencies as such in the output\.
.
.TP
\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\-\-missing\fR
Show only missing dependencies\.
.
.TP
\fB\-\-eval\-all\fR
Evaluate all available formulae and casks, whether installed or not, to list their dependencies\.
.
.TP
\fB\-\-for\-each\fR
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\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBdesc\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR|\fItext\fR|\fB/\fR\fIregex\fR\fB/\fR [\.\.\.]"
Display \fIformula\fR\'s name and one\-line description\. The cache is created on the first search, making that search slower than subsequent ones\.
.
.TP
\fB\-s\fR, \fB\-\-search\fR
Search both names and descriptions for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
.
.TP
\fB\-n\fR, \fB\-\-name\fR
Search just names for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
.
.TP
\fB\-d\fR, \fB\-\-description\fR
Search just descriptions for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
.
.TP
\fB\-\-eval\-all\fR
Evaluate all available formulae and casks, whether installed or not, to search their descriptions\. Implied if \fBHOMEBREW_EVAL_ALL\fR is set\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBdeveloper\fR [\fIsubcommand\fR]"
Control Homebrew\'s developer mode\. When developer mode is enabled, \fBbrew update\fR will update Homebrew to the latest commit on the \fBmaster\fR branch instead of the latest stable version along with some other behaviour changes\.
.
.P
\fBbrew developer\fR [\fBstate\fR]
Display the current state of Homebrew\'s developer mode\.
.
.P
\fBbrew developer\fR (\fBon\fR|\fBoff\fR)
Turn Homebrew\'s developer mode on or off respectively\.
.
.SS "\fBdocs\fR"
Open Homebrew\'s online documentation at \fIhttps://docs\.brew\.sh\fR in a browser\.
.
.SS "\fBdoctor\fR, \fBdr\fR [\fB\-\-list\-checks\fR] [\fB\-\-audit\-debug\fR] [\fIdiagnostic_check\fR \.\.\.]"
Check your system for potential problems\. Will exit with a non\-zero status if any potential problems are found\.
.
.P
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\.
.
.TP
\fB\-\-list\-checks\fR
List all audit methods, which can be run individually if provided as arguments\.
.
.TP
\fB\-D\fR, \fB\-\-audit\-debug\fR
Enable debugging and profiling of audit methods\.
.
.SS "\fBfetch\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR [\.\.\.]"
Download a bottle (if available) or source packages for \fIformula\fRe and binaries for \fIcask\fRs\. For files, also print SHA\-256 checksums\.
.
.TP
\fB\-\-os\fR
Download for the given operating system\.(Pass \fBall\fR to download for all operating systems\.)
.
.TP
\fB\-\-arch\fR
Download for the given CPU architecture\.(Pass \fBall\fR to download for all architectures\.)
.
.TP
\fB\-\-bottle\-tag\fR
Download a bottle for given tag\.
.
.TP
\fB\-\-HEAD\fR
Fetch HEAD version instead of stable version\.
.
.TP
\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
\fB\-\-retry\fR
Retry if downloading fails or re\-download if the checksum of a previously cached version no longer matches\. Tries at most 5 times with exponential backoff\.
.
.TP
\fB\-\-deps\fR
Also download dependencies for any listed \fIformula\fR\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Download source packages rather than a bottle\.
.
.TP
\fB\-\-build\-bottle\fR
Download source packages (for eventual bottling) rather than a bottle\.
.
.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\.
.
.TP
\fB\-\-[no\-]quarantine\fR
Disable/enable quarantining of downloads (default: enabled)\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBformulae\fR"
List all locally installable formulae including short names\.
.
.SS "\fBgist\-logs\fR [\fIoptions\fR] \fIformula\fR"
Upload logs for a failed build of \fIformula\fR to a new Gist\. Presents an error message if no logs are found\.
.
.TP
\fB\-\-with\-hostname\fR
Include the hostname in the Gist\.
.
.TP
\fB\-n\fR, \fB\-\-new\-issue\fR
Automatically create a new issue in the appropriate GitHub repository after creating the Gist\.
.
.TP
\fB\-p\fR, \fB\-\-private\fR
The Gist will be marked private and will not appear in listings but will be accessible with its link\.
.
.SS "\fBhome\fR, \fBhomepage\fR [\fB\-\-formula\fR] [\fB\-\-cask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Open a \fIformula\fR or \fIcask\fR\'s homepage in a browser, or open Homebrew\'s own homepage if no argument is provided\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBinfo\fR, \fBabv\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Display brief statistics for your Homebrew installation\. If a \fIformula\fR or \fIcask\fR is provided, show summary of information about it\.
.
.TP
\fB\-\-analytics\fR
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)\.
.
.TP
\fB\-\-days\fR
How many days of analytics data to retrieve\. The value for \fIdays\fR must be \fB30\fR, \fB90\fR or \fB365\fR\. The default is \fB30\fR\.
.
.TP
\fB\-\-category\fR
Which type of analytics data to retrieve\. The value for \fIcategory\fR must be \fBinstall\fR, \fBinstall\-on\-request\fR or \fBbuild\-error\fR; \fBcask\-install\fR or \fBos\-version\fR may be specified if \fIformula\fR is not\. The default is \fBinstall\fR\.
.
.TP
\fB\-\-github\fR
Open the GitHub source page for \fIformula\fR and \fIcask\fR in a browser\. To view the history locally: \fBbrew log \-p\fR \fIformula\fR or \fIcask\fR
.
.TP
\fB\-\-json\fR
Print a JSON representation\. Currently the default value for \fIversion\fR is \fBv1\fR for \fIformula\fR\. For \fIformula\fR and \fIcask\fR use \fBv2\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
.
.TP
\fB\-\-installed\fR
Print JSON of formulae that are currently installed\.
.
.TP
\fB\-\-eval\-all\fR
Evaluate all available formulae and casks, whether installed or not, to print their JSON\. Implied if \fBHOMEBREW_EVAL_ALL\fR is set\.
.
.TP
\fB\-\-variations\fR
Include the variations hash in each formula\'s JSON output\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Show more verbose analytics data for \fIformula\fR\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR [\.\.\.]"
Install a \fIformula\fR or \fIcask\fR\. Additional options specific to a \fIformula\fR may be appended to the command\.
.
.P
Unless \fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fR is set, \fBbrew upgrade\fR or \fBbrew reinstall\fR will be run for outdated dependents and dependents with broken linkage, respectively\.
.
.P
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\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_UPGRADE\fR is set, \fBbrew install\fR \fIformula\fR will upgrade \fIformula\fR if it is already installed but outdated\.
.
.TP
\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
\fB\-f\fR, \fB\-\-force\fR
Install formulae without checking for previously installed keg\-only or non\-migrated versions\. When installing casks, overwrite existing files (binaries and symlinks are excluded, unless originally from the same cask)\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print the verification and post\-install steps\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Show what would be installed, but do not actually install anything\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-ignore\-dependencies\fR
An unsupported Homebrew development option 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 option\.
.
.TP
\fB\-\-only\-dependencies\fR
Install the dependencies with specified options but do not install the formula itself\.
.
.TP
\fB\-\-cc\fR
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\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\.
.
.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\.
.
.TP
\fB\-\-include\-test\fR
Install testing dependencies required to run \fBbrew test\fR \fIformula\fR\.
.
.TP
\fB\-\-HEAD\fR
If \fIformula\fR defines it, install the HEAD version, aka\. main, trunk, unstable, master\.
.
.TP
\fB\-\-fetch\-HEAD\fR
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\.
.
.TP
\fB\-\-keep\-tmp\fR
Retain the temporary files created during installation\.
.
.TP
\fB\-\-debug\-symbols\fR
Generate debug symbols on build\. Source will be retained in a cache directory\.
.
.TP
\fB\-\-build\-bottle\fR
Prepare the formula for eventual bottling during installation, skipping any post\-install steps\.
.
.TP
\fB\-\-skip\-post\-install\fR
Install but skip any post\-install steps\.
.
.TP
\fB\-\-bottle\-arch\fR
Optimise bottles for the specified architecture rather than the oldest architecture supported by the version of macOS the bottles are built on\.
.
.TP
\fB\-\-display\-times\fR
Print install times for each package at the end of the run\.
.
.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\.
.
.TP
\fB\-g\fR, \fB\-\-git\fR
Create a Git repository, useful for creating patches to the software\.
.
.TP
\fB\-\-overwrite\fR
Delete files that already exist in the prefix while linking\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.TP
\fB\-\-[no\-]binaries\fR
Disable/enable linking of helper executables (default: enabled)\.
.
.TP
\fB\-\-require\-sha\fR
Require all casks to have a checksum\.
.
.TP
\fB\-\-[no\-]quarantine\fR
Disable/enable quarantining of downloads (default: enabled)\.
.
.TP
\fB\-\-adopt\fR
Adopt existing artifacts in the destination that are identical to those being installed\. Cannot be combined with \-\-force\.
.
.TP
\fB\-\-skip\-cask\-deps\fR
Skip installing cask dependencies\.
.
.TP
\fB\-\-zap\fR
For use with \fBbrew reinstall \-\-cask\fR\. Remove all files associated with a cask\. \fIMay remove files which are shared between applications\.\fR
.
.SS "\fBleaves\fR [\fB\-\-installed\-on\-request\fR] [\fB\-\-installed\-as\-dependency\fR]"
List installed formulae that are not dependencies of another installed formula or cask\.
.
.TP
\fB\-r\fR, \fB\-\-installed\-on\-request\fR
Only list leaves that were manually installed\.
.
.TP
\fB\-p\fR, \fB\-\-installed\-as\-dependency\fR
Only list leaves that were installed as dependencies\.
.
.SS "\fBlink\fR, \fBln\fR [\fIoptions\fR] \fIinstalled_formula\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 manual installations\.
.
.TP
\fB\-\-overwrite\fR
Delete files that already exist in the prefix while linking\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
List files which would be linked or deleted by \fBbrew link \-\-overwrite\fR without actually linking or deleting any files\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Allow keg\-only formulae to be linked\.
.
.TP
\fB\-\-HEAD\fR
Link the HEAD version of the formula if it is installed\.
.
.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR] [\fIinstalled_formula\fR|\fIinstalled_cask\fR \.\.\.]"
List all installed formulae and casks\. If \fIformula\fR is provided, summarise the paths within its current keg\. If \fIcask\fR is provided, list its artifacts\.
.
.TP
\fB\-\-formula\fR
List only formulae, or treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
List only casks, or treat all named arguments as casks\.
.
.TP
\fB\-\-full\-name\fR
Print formulae with fully\-qualified names\. Unless \fB\-\-full\-name\fR, \fB\-\-versions\fR or \fB\-\-pinned\fR are 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\.
.
.TP
\fB\-\-versions\fR
Show the version number for installed formulae, or only the specified formulae if \fIformula\fR are provided\.
.
.TP
\fB\-\-multiple\fR
Only show formulae with multiple versions installed\.
.
.TP
\fB\-\-pinned\fR
List only pinned formulae, or only the specified (pinned) formulae if \fIformula\fR are provided\. See also \fBpin\fR, \fBunpin\fR\.
.
.TP
\fB\-1\fR
Force output to be one entry per line\. This is the default when output is not to a terminal\.
.
.TP
\fB\-l\fR
List formulae and/or casks in long format\. Has no effect when a formula or cask name is passed as an argument\.
.
.TP
\fB\-r\fR
Reverse the order of the formulae and/or casks sort to list the oldest entries first\. Has no effect when a formula or cask name is passed as an argument\.
.
.TP
\fB\-t\fR
Sort formulae and/or casks by time modified, listing most recently modified first\. Has no effect when a formula or cask name is passed as an argument\.
.
.SS "\fBlog\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]"
Show the \fBgit log\fR for \fIformula\fR or \fIcask\fR, or show the log for the Homebrew repository if no formula or cask is provided\.
.
.TP
\fB\-p\fR, \fB\-\-patch\fR
Also print patch from commit\.
.
.TP
\fB\-\-stat\fR
Also print diffstat from commit\.
.
.TP
\fB\-\-oneline\fR
Print only one line per commit\.
.
.TP
\fB\-1\fR
Print only one commit\.
.
.TP
\fB\-n\fR, \fB\-\-max\-count\fR
Print only a specified number of commits\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBmigrate\fR [\fIoptions\fR] \fIinstalled_formula\fR|\fIinstalled_cask\fR [\.\.\.]"
Migrate renamed packages to new names, where \fIformula\fR are old names of packages\.
.
.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\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Show what would be migrated, but do not actually migrate anything\.
.
.TP
\fB\-\-formula\fR
Only migrate formulae\.
.
.TP
\fB\-\-cask\fR
Only migrate casks\.
.
.SS "\fBmissing\fR [\fB\-\-hide=\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\.
.
.TP
\fB\-\-hide\fR
Act as if none of the specified \fIhidden\fR are installed\. \fIhidden\fR should be a comma\-separated list of formulae\.
.
.SS "\fBnodenv\-sync\fR"
Create symlinks for Homebrew\'s installed NodeJS versions in \fB~/\.nodenv/versions\fR\.
.
.P
Note that older version symlinks will also be created so e\.g\. NodeJS 19\.1\.0 will also be symlinked to 19\.0\.0\.
.
.SS "\fBoptions\fR [\fIoptions\fR] [\fIformula\fR \.\.\.]"
Show install options specific to \fIformula\fR\.
.
.TP
\fB\-\-compact\fR
Show all options on a single line separated by spaces\.
.
.TP
\fB\-\-installed\fR
Show options for formulae that are currently installed\.
.
.TP
\fB\-\-eval\-all\fR
Evaluate all available formulae and casks, whether installed or not, to show their options\.
.
.TP
\fB\-\-command\fR
Show options for the specified \fIcommand\fR\.
.
.SS "\fBoutdated\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
List installed casks and formulae that have an updated version available\. By default, version information is displayed in interactive shells, and suppressed otherwise\.
.
.TP
\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
\fB\-\-formula\fR
List only outdated formulae\.
.
.TP
\fB\-\-cask\fR
List only outdated casks\.
.
.TP
\fB\-\-json\fR
Print output in JSON format\. There are two versions: \fBv1\fR and \fBv2\fR\. \fBv1\fR is deprecated and is currently the default if no version is specified\. \fBv2\fR prints outdated formulae and casks\.
.
.TP
\fB\-\-fetch\-HEAD\fR
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\.
.
.TP
\fB\-g\fR, \fB\-\-greedy\fR
Also include outdated casks with \fBauto_updates true\fR or \fBversion :latest\fR\.
.
.TP
\fB\-\-greedy\-latest\fR
Also include outdated casks including those with \fBversion :latest\fR\.
.
.TP
\fB\-\-greedy\-auto\-updates\fR
Also include outdated casks including those with \fBauto_updates true\fR\.
.
.SS "\fBpin\fR \fIinstalled_formula\fR [\.\.\.]"
Pin the specified \fIformula\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR \fIformula\fR command\. See also \fBunpin\fR\.
.
.SS "\fBpostinstall\fR, \fBpost_install\fR \fIinstalled_formula\fR [\.\.\.]"
Rerun the post\-install steps for \fIformula\fR\.
.
.SS "\fBpyenv\-sync\fR"
Create symlinks for Homebrew\'s installed Python versions in \fB~/\.pyenv/versions\fR\.
.
.P
Note that older patch version symlinks will be created and linked to the minor version so e\.g\. Python 3\.11\.0 will also be symlinked to 3\.11\.3\.
.
.SS "\fBrbenv\-sync\fR"
Create symlinks for Homebrew\'s installed Ruby versions in \fB~/\.rbenv/versions\fR\.
.
.P
Note that older version symlinks will also be created so e\.g\. Ruby 3\.2\.1 will also be symlinked to 3\.2\.0\.
.
.SS "\fBreadall\fR [\fIoptions\fR] [\fItap\fR \.\.\.]"
Import all items from the specified \fItap\fR, or from all installed taps if none is provided\. This can be useful for debugging issues across all items when making significant changes to \fBformula\.rb\fR, testing the performance of loading all items or checking if any current formulae/casks have Ruby issues\.
.
.TP
\fB\-\-os\fR
Read using the given operating system\. (Pass \fBall\fR to simulate all operating systems\.)
.
.TP
\fB\-\-arch\fR
Read using the given CPU architecture\. (Pass \fBall\fR to simulate all architectures\.)
.
.TP
\fB\-\-aliases\fR
Verify any alias symlinks in each tap\.
.
.TP
\fB\-\-syntax\fR
Syntax\-check all of Homebrew\'s Ruby files (if no \fItap\fR is passed)\.
.
.TP
\fB\-\-eval\-all\fR
Evaluate all available formulae and casks, whether installed or not\. Implied if \fBHOMEBREW_EVAL_ALL\fR is set\.
.
.TP
\fB\-\-no\-simulate\fR
Don\'t simulate other system configurations when checking formulae and casks\.
.
.SS "\fBreinstall\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR [\.\.\.]"
Uninstall and then reinstall a \fIformula\fR or \fIcask\fR using the same options it was originally installed with, plus any appended options specific to a \fIformula\fR\.
.
.P
Unless \fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fR is set, \fBbrew upgrade\fR or \fBbrew reinstall\fR will be run for outdated dependents and dependents with broken linkage, respectively\.
.
.P
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\.
.
.TP
\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
\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 post\-install steps\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile \fIformula\fR from source even if a bottle is available\.
.
.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\.
.
.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\.
.
.TP
\fB\-\-keep\-tmp\fR
Retain the temporary files created during installation\.
.
.TP
\fB\-\-debug\-symbols\fR
Generate debug symbols on build\. Source will be retained in a cache directory\.
.
.TP
\fB\-\-display\-times\fR
Print install times for each formula at the end of the run\.
.
.TP
\fB\-g\fR, \fB\-\-git\fR
Create a Git repository, useful for creating patches to the software\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.TP
\fB\-\-[no\-]binaries\fR
Disable/enable linking of helper executables (default: enabled)\.
.
.TP
\fB\-\-require\-sha\fR
Require all casks to have a checksum\.
.
.TP
\fB\-\-[no\-]quarantine\fR
Disable/enable quarantining of downloads (default: enabled)\.
.
.TP
\fB\-\-adopt\fR
Adopt existing artifacts in the destination that are identical to those being installed\. Cannot be combined with \-\-force\.
.
.TP
\fB\-\-skip\-cask\-deps\fR
Skip installing cask dependencies\.
.
.TP
\fB\-\-zap\fR
For use with \fBbrew reinstall \-\-cask\fR\. Remove all files associated with a cask\. \fIMay remove files which are shared between applications\.\fR
.
.SS "\fBsearch\fR, \fB\-S\fR [\fIoptions\fR] \fItext\fR|\fB/\fR\fIregex\fR\fB/\fR [\.\.\.]"
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\.
.
.TP
\fB\-\-formula\fR
Search for formulae\.
.
.TP
\fB\-\-cask\fR
Search for casks\.
.
.TP
\fB\-\-desc\fR
Search for formulae with a description matching \fItext\fR and casks with a name or description matching \fItext\fR\.
.
.TP
\fB\-\-eval\-all\fR
Evaluate all available formulae and casks, whether installed or not, to search their descriptions\. Implied if \fBHOMEBREW_EVAL_ALL\fR is set\.
.
.TP
\fB\-\-pull\-request\fR
Search for GitHub pull requests containing \fItext\fR\.
.
.TP
\fB\-\-open\fR
Search for only open GitHub pull requests\.
.
.TP
\fB\-\-closed\fR
Search for only closed GitHub pull requests\.
.
.TP
\fB\-\-repology\fR
Search for \fItext\fR in the given database\.
.
.TP
\fB\-\-macports\fR
Search for \fItext\fR in the given database\.
.
.TP
\fB\-\-fink\fR
Search for \fItext\fR in the given database\.
.
.TP
\fB\-\-opensuse\fR
Search for \fItext\fR in the given database\.
.
.TP
\fB\-\-fedora\fR
Search for \fItext\fR in the given database\.
.
.TP
\fB\-\-archlinux\fR
Search for \fItext\fR in the given database\.
.
.TP
\fB\-\-debian\fR
Search for \fItext\fR in the given database\.
.
.TP
\fB\-\-ubuntu\fR
Search for \fItext\fR in the given database\.
.
.SS "\fBshellenv [bash|csh|fish|pwsh|sh|tcsh|zsh]\fR"
Print export statements\. When run in a shell, this installation of Homebrew will be added to your \fBPATH\fR, \fBMANPATH\fR, and \fBINFOPATH\fR\.
.
.P
The variables \fBHOMEBREW_PREFIX\fR, \fBHOMEBREW_CELLAR\fR and \fBHOMEBREW_REPOSITORY\fR are also exported to avoid querying them multiple times\. To help guarantee idempotence, this command produces no output when Homebrew\'s \fBbin\fR and \fBsbin\fR directories are first and second respectively in your \fBPATH\fR\. Consider adding evaluation of this command\'s output to your dotfiles (e\.g\. \fB~/\.profile\fR, \fB~/\.bash_profile\fR, or \fB~/\.zprofile\fR) with: \fBeval "$(brew shellenv)"\fR
.
.P
The shell can be specified explicitly with a supported shell name parameter\. Unknown shells will output POSIX exports\.
.
.SS "\fBtap\fR [\fIoptions\fR] [\fIuser\fR\fB/\fR\fIrepo\fR] [\fIURL\fR]"
Tap a formula repository\. If no arguments are provided, list all installed taps\.
.
.P
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\.
.
.P
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\.
.
.TP
\fB\-\-[no\-]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)\.
.
.TP
\fB\-\-custom\-remote\fR
Install or change a tap with a custom remote\. Useful for mirrors\.
.
.TP
\fB\-\-repair\fR
Migrate tapped formulae from symlink\-based to directory\-based structure\.
.
.TP
\fB\-\-eval\-all\fR
Evaluate all the formulae, casks and aliases in the new tap to check validity\. Implied if \fBHOMEBREW_EVAL_ALL\fR is set\.
.
.TP
\fB\-\-force\fR
Force install core taps even under API mode\.
.
.SS "\fBtap\-info\fR [\fB\-\-installed\fR] [\fB\-\-json\fR] [\fItap\fR \.\.\.]"
Show detailed information about one or more \fItap\fRs\. If no \fItap\fR names are provided, display brief statistics for all installed taps\.
.
.TP
\fB\-\-installed\fR
Show information on each installed tap\.
.
.TP
\fB\-\-json\fR
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
.
.SS "\fBuninstall\fR, \fBremove\fR, \fBrm\fR [\fIoptions\fR] \fIinstalled_formula\fR|\fIinstalled_cask\fR [\.\.\.]"
Uninstall a \fIformula\fR or \fIcask\fR\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Delete all installed versions of \fIformula\fR\. Uninstall even if \fIcask\fR is not installed, overwrite existing files and ignore errors when removing files\.
.
.TP
\fB\-\-zap\fR