mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

cmd+dev-cmd: fixes for output formatting

Browse Source
This commit is contained in:
Eric Knibbe 2023-09-09 12:09:38 -04:00
parent 4662678b3b
commit c493b5e680
No known key found for this signature in database
GPG Key ID: 179D9CDDDB814168
14 changed files with 113 additions and 129 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Library/Homebrew/cmd/--prefix.rb
View File

@ -10,8 +10,8 @@ module Homebrew
description <<~EOS description <<~EOS
Display Homebrew's install path. *Default:* Display Homebrew's install path. *Default:*
- macOS Intel: `#{HOMEBREW_DEFAULT_PREFIX}`
- macOS ARM: `#{HOMEBREW_MACOS_ARM_DEFAULT_PREFIX}` - macOS ARM: `#{HOMEBREW_MACOS_ARM_DEFAULT_PREFIX}`
- macOS Intel: `#{HOMEBREW_DEFAULT_PREFIX}`
- Linux: `#{HOMEBREW_LINUX_DEFAULT_PREFIX}` - Linux: `#{HOMEBREW_LINUX_DEFAULT_PREFIX}`
If <formula> is provided, display the location where <formula> is or would be installed. If <formula> is provided, display the location where <formula> is or would be installed.

2
Library/Homebrew/cmd/deps.rb
View File

@ -22,7 +22,7 @@ module Homebrew
to `brew linkage`), which may differ from the current versons' stated to `brew linkage`), which may differ from the current versons' stated
dependencies if the installed versions are outdated. dependencies if the installed versions are outdated.
Note: `--missing` and `--skip-recommended` have precedence over `--include-*`. *Note:* `--missing` and `--skip-recommended` have precedence over `--include-*`.
EOS EOS
switch "-n", "--topological", switch "-n", "--topological",
description: "Sort dependencies in topological order." description: "Sort dependencies in topological order."

2
Library/Homebrew/cmd/docs.rb
View File

@ -10,7 +10,7 @@ module Homebrew
def docs_args def docs_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
description <<~EOS description <<~EOS
Open Homebrew's online documentation (#{HOMEBREW_DOCS_WWW}) in a browser. Open Homebrew's online documentation at <#{HOMEBREW_DOCS_WWW}> in a browser.
EOS EOS
end end
end end

2
Library/Homebrew/cmd/nodenv-sync.rb
View File

@ -11,7 +11,7 @@ module Homebrew
def nodenv_sync_args def nodenv_sync_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
description <<~EOS description <<~EOS
Create symlinks for Homebrew's installed NodeJS versions in ~/.nodenv/versions. Create symlinks for Homebrew's installed NodeJS versions in `~/.nodenv/versions`.
Note that older version symlinks will also be created so e.g. NodeJS 19.1.0 will Note that older version symlinks will also be created so e.g. NodeJS 19.1.0 will
also be symlinked to 19.0.0. also be symlinked to 19.0.0.

2
Library/Homebrew/cmd/pyenv-sync.rb
View File

@ -11,7 +11,7 @@ module Homebrew
def pyenv_sync_args def pyenv_sync_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
description <<~EOS description <<~EOS
Create symlinks for Homebrew's installed Python versions in ~/.pyenv/versions. Create symlinks for Homebrew's installed Python versions in `~/.pyenv/versions`.
Note that older patch version symlinks will be created and linked to the minor 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. version so e.g. Python 3.11.0 will also be symlinked to 3.11.3.

2
Library/Homebrew/cmd/rbenv-sync.rb
View File

@ -11,7 +11,7 @@ module Homebrew
def rbenv_sync_args def rbenv_sync_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
description <<~EOS description <<~EOS
Create symlinks for Homebrew's installed Ruby versions in ~/.rbenv/versions. Create symlinks for Homebrew's installed Ruby versions in `~/.rbenv/versions`.
Note that older version symlinks will also be created so e.g. Ruby 3.2.1 will Note that older version symlinks will also be created so e.g. Ruby 3.2.1 will
also be symlinked to 3.2.0. also be symlinked to 3.2.0.

2
Library/Homebrew/cmd/readall.rb
View File

@ -24,7 +24,7 @@ module Homebrew
switch "--aliases", switch "--aliases",
description: "Verify any alias symlinks in each tap." description: "Verify any alias symlinks in each tap."
switch "--syntax", switch "--syntax",
description: "Syntax-check all of Homebrew's Ruby files (if no `<tap>` is passed)." description: "Syntax-check all of Homebrew's Ruby files (if no <tap> is passed)."
switch "--eval-all", switch "--eval-all",
description: "Evaluate all available formulae and casks, whether installed or not. " \ description: "Evaluate all available formulae and casks, whether installed or not. " \
"Implied if `HOMEBREW_EVAL_ALL` is set." "Implied if `HOMEBREW_EVAL_ALL` is set."

2
Library/Homebrew/cmd/uses.rb
View File

@ -23,7 +23,7 @@ module Homebrew
of formulae that use <formula>. By default, `uses` shows all formulae and casks that of formulae that use <formula>. By default, `uses` shows all formulae and casks that
specify <formula> as a required or recommended dependency for their stable builds. specify <formula> as a required or recommended dependency for their stable builds.
Note: `--missing` and `--skip-recommended` have precedence over `--include-*`. *Note:* `--missing` and `--skip-recommended` have precedence over `--include-*`.
EOS EOS
switch "--recursive", switch "--recursive",
description: "Resolve more than one level of dependencies." description: "Resolve more than one level of dependencies."

2
Library/Homebrew/dev-cmd/release.rb
View File

@ -17,7 +17,7 @@ module Homebrew
The command will fail if the previous major or minor release was made less than The command will fail if the previous major or minor release was made less than
one month ago. one month ago.
Requires write access to the Homebrew/brew repository. *Note:* Requires write access to the Homebrew/brew repository.
EOS EOS
switch "--major", switch "--major",
description: "Create a major release." description: "Create a major release."

4
Library/Homebrew/env_config.rb
View File

@ -317,7 +317,7 @@ module Homebrew
boolean: true, boolean: true,
}, },
HOMEBREW_NO_INSTALL_UPGRADE: { HOMEBREW_NO_INSTALL_UPGRADE: {
description: "If set, `brew install` <formula/cask> will not upgrade <formula/cask> if it is installed but " \ description: "If set, `brew install` <formula|cask> will not upgrade <formula|cask> if it is installed but " \
"outdated.", "outdated.",
boolean: true, boolean: true,
}, },
@ -333,7 +333,7 @@ module Homebrew
boolean: true, boolean: true,
}, },
HOMEBREW_PIP_INDEX_URL: { HOMEBREW_PIP_INDEX_URL: {
description: "If set, `brew install <formula>` will use this URL to download PyPI package resources.", description: "If set, `brew install` <formula> will use this URL to download PyPI package resources.",
default_text: "`https://pypi.org/simple`.", default_text: "`https://pypi.org/simple`.",
}, },
HOMEBREW_PRY: { HOMEBREW_PRY: {

32
completions/fish/brew.fish
View File

@ -250,7 +250,7 @@ __fish_brew_complete_arg '--prefix' -l verbose -d 'Make some output more verbose
__fish_brew_complete_arg '--prefix' -a '(__fish_brew_suggest_formulae_all)' __fish_brew_complete_arg '--prefix' -a '(__fish_brew_suggest_formulae_all)'
__fish_brew_complete_cmd '--repo' 'Display where Homebrew\'s git repository is located' __fish_brew_complete_cmd '--repo' 'Display where Homebrew\'s Git repository is located'
__fish_brew_complete_arg '--repo' -l debug -d 'Display any debugging information' __fish_brew_complete_arg '--repo' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg '--repo' -l help -d 'Show this message' __fish_brew_complete_arg '--repo' -l help -d 'Show this message'
__fish_brew_complete_arg '--repo' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg '--repo' -l quiet -d 'Make some output more quiet'
@ -258,7 +258,7 @@ __fish_brew_complete_arg '--repo' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_arg '--repo' -a '(__fish_brew_suggest_taps_installed)' __fish_brew_complete_arg '--repo' -a '(__fish_brew_suggest_taps_installed)'
__fish_brew_complete_cmd '--repository' 'Display where Homebrew\'s git repository is located' __fish_brew_complete_cmd '--repository' 'Display where Homebrew\'s Git repository is located'
__fish_brew_complete_arg '--repository' -l debug -d 'Display any debugging information' __fish_brew_complete_arg '--repository' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg '--repository' -l help -d 'Show this message' __fish_brew_complete_arg '--repository' -l help -d 'Show this message'
__fish_brew_complete_arg '--repository' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg '--repository' -l quiet -d 'Make some output more quiet'
@ -528,7 +528,7 @@ __fish_brew_complete_arg 'config' -l quiet -d 'Make some output more quiet'
__fish_brew_complete_arg 'config' -l verbose -d 'Make some output more verbose' __fish_brew_complete_arg 'config' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_cmd 'contributions' 'Contributions to Homebrew repositories' __fish_brew_complete_cmd 'contributions' 'Summarise contributions to Homebrew repositories'
__fish_brew_complete_arg 'contributions' -l csv -d 'Print a CSV of contributions across repositories over the time period' __fish_brew_complete_arg 'contributions' -l csv -d 'Print a CSV of contributions across repositories over the time period'
__fish_brew_complete_arg 'contributions' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'contributions' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'contributions' -l from -d 'Date (ISO-8601 format) to start searching contributions. Omitting this flag searches the last year' __fish_brew_complete_arg 'contributions' -l from -d 'Date (ISO-8601 format) to start searching contributions. Omitting this flag searches the last year'
@ -644,7 +644,7 @@ __fish_brew_complete_arg 'dispatch-build-bottle' -l workflow -d 'Dispatch specif
__fish_brew_complete_arg 'dispatch-build-bottle' -a '(__fish_brew_suggest_formulae_all)' __fish_brew_complete_arg 'dispatch-build-bottle' -a '(__fish_brew_suggest_formulae_all)'
__fish_brew_complete_cmd 'docs' 'Open Homebrew\'s online documentation (https://docs.brew.sh) in a browser' __fish_brew_complete_cmd 'docs' 'Open Homebrew\'s online documentation at https://docs.brew.sh in a browser'
__fish_brew_complete_arg 'docs' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'docs' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'docs' -l help -d 'Show this message' __fish_brew_complete_arg 'docs' -l help -d 'Show this message'
__fish_brew_complete_arg 'docs' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg 'docs' -l quiet -d 'Make some output more quiet'
@ -736,7 +736,7 @@ __fish_brew_complete_arg 'formula' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_arg 'formula' -a '(__fish_brew_suggest_formulae_all)' __fish_brew_complete_arg 'formula' -a '(__fish_brew_suggest_formulae_all)'
__fish_brew_complete_cmd 'generate-cask-api' 'Generates Cask API data files for formulae.brew.sh' __fish_brew_complete_cmd 'generate-cask-api' 'Generate `homebrew/cask` API data files for https://formulae.brew.sh'
__fish_brew_complete_arg 'generate-cask-api' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'generate-cask-api' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'generate-cask-api' -l dry-run -d 'Generate API data without writing it to files' __fish_brew_complete_arg 'generate-cask-api' -l dry-run -d 'Generate API data without writing it to files'
__fish_brew_complete_arg 'generate-cask-api' -l help -d 'Show this message' __fish_brew_complete_arg 'generate-cask-api' -l help -d 'Show this message'
@ -744,7 +744,7 @@ __fish_brew_complete_arg 'generate-cask-api' -l quiet -d 'Make some output more
__fish_brew_complete_arg 'generate-cask-api' -l verbose -d 'Make some output more verbose' __fish_brew_complete_arg 'generate-cask-api' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_cmd 'generate-formula-api' 'Generates Formula API data files for formulae.brew.sh' __fish_brew_complete_cmd 'generate-formula-api' 'Generate `homebrew/core` API data files for https://formulae.brew.sh'
__fish_brew_complete_arg 'generate-formula-api' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'generate-formula-api' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'generate-formula-api' -l dry-run -d 'Generate API data without writing it to files' __fish_brew_complete_arg 'generate-formula-api' -l dry-run -d 'Generate API data without writing it to files'
__fish_brew_complete_arg 'generate-formula-api' -l help -d 'Show this message' __fish_brew_complete_arg 'generate-formula-api' -l help -d 'Show this message'
@ -835,7 +835,7 @@ __fish_brew_complete_arg 'instal' -l force-bottle -d 'Install from a bottle if i
__fish_brew_complete_arg 'instal' -l formula -d 'Treat all named arguments as formulae' __fish_brew_complete_arg 'instal' -l formula -d 'Treat all named arguments as formulae'
__fish_brew_complete_arg 'instal' -l git -d 'Create a Git repository, useful for creating patches to the software' __fish_brew_complete_arg 'instal' -l git -d 'Create a Git repository, useful for creating patches to the software'
__fish_brew_complete_arg 'instal' -l help -d 'Show this message' __fish_brew_complete_arg 'instal' -l help -d 'Show this message'
__fish_brew_complete_arg 'instal' -l ignore-dependencies -d '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' __fish_brew_complete_arg 'instal' -l ignore-dependencies -d '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'
__fish_brew_complete_arg 'instal' -l include-test -d 'Install testing dependencies required to run `brew test` formula' __fish_brew_complete_arg 'instal' -l include-test -d 'Install testing dependencies required to run `brew test` formula'
__fish_brew_complete_arg 'instal' -l input-methoddir -d 'Target location for Input Methods (default: `~/Library/Input Methods`)' __fish_brew_complete_arg 'instal' -l input-methoddir -d 'Target location for Input Methods (default: `~/Library/Input Methods`)'
__fish_brew_complete_arg 'instal' -l interactive -d 'Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package' __fish_brew_complete_arg 'instal' -l interactive -d 'Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package'
@ -857,7 +857,7 @@ __fish_brew_complete_arg 'instal' -l screen-saverdir -d 'Target location for Scr
__fish_brew_complete_arg 'instal' -l servicedir -d 'Target location for Services (default: `~/Library/Services`)' __fish_brew_complete_arg 'instal' -l servicedir -d 'Target location for Services (default: `~/Library/Services`)'
__fish_brew_complete_arg 'instal' -l skip-cask-deps -d 'Skip installing cask dependencies' __fish_brew_complete_arg 'instal' -l skip-cask-deps -d 'Skip installing cask dependencies'
__fish_brew_complete_arg 'instal' -l skip-post-install -d 'Install but skip any post-install steps' __fish_brew_complete_arg 'instal' -l skip-post-install -d 'Install but skip any post-install steps'
__fish_brew_complete_arg 'instal' -l verbose -d 'Print the verification and postinstall steps' __fish_brew_complete_arg 'instal' -l verbose -d 'Print the verification and post-install steps'
__fish_brew_complete_arg 'instal' -l vst-plugindir -d 'Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)' __fish_brew_complete_arg 'instal' -l vst-plugindir -d 'Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)'
__fish_brew_complete_arg 'instal' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)' __fish_brew_complete_arg 'instal' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)'
__fish_brew_complete_arg 'instal' -l zap -d 'For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*' __fish_brew_complete_arg 'instal' -l zap -d 'For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*'
@ -889,7 +889,7 @@ __fish_brew_complete_arg 'install' -l force-bottle -d 'Install from a bottle if
__fish_brew_complete_arg 'install' -l formula -d 'Treat all named arguments as formulae' __fish_brew_complete_arg 'install' -l formula -d 'Treat all named arguments as formulae'
__fish_brew_complete_arg 'install' -l git -d 'Create a Git repository, useful for creating patches to the software' __fish_brew_complete_arg 'install' -l git -d 'Create a Git repository, useful for creating patches to the software'
__fish_brew_complete_arg 'install' -l help -d 'Show this message' __fish_brew_complete_arg 'install' -l help -d 'Show this message'
__fish_brew_complete_arg 'install' -l ignore-dependencies -d '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' __fish_brew_complete_arg 'install' -l ignore-dependencies -d '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'
__fish_brew_complete_arg 'install' -l include-test -d 'Install testing dependencies required to run `brew test` formula' __fish_brew_complete_arg 'install' -l include-test -d 'Install testing dependencies required to run `brew test` formula'
__fish_brew_complete_arg 'install' -l input-methoddir -d 'Target location for Input Methods (default: `~/Library/Input Methods`)' __fish_brew_complete_arg 'install' -l input-methoddir -d 'Target location for Input Methods (default: `~/Library/Input Methods`)'
__fish_brew_complete_arg 'install' -l interactive -d 'Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package' __fish_brew_complete_arg 'install' -l interactive -d 'Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package'
@ -911,7 +911,7 @@ __fish_brew_complete_arg 'install' -l screen-saverdir -d 'Target location for Sc
__fish_brew_complete_arg 'install' -l servicedir -d 'Target location for Services (default: `~/Library/Services`)' __fish_brew_complete_arg 'install' -l servicedir -d 'Target location for Services (default: `~/Library/Services`)'
__fish_brew_complete_arg 'install' -l skip-cask-deps -d 'Skip installing cask dependencies' __fish_brew_complete_arg 'install' -l skip-cask-deps -d 'Skip installing cask dependencies'
__fish_brew_complete_arg 'install' -l skip-post-install -d 'Install but skip any post-install steps' __fish_brew_complete_arg 'install' -l skip-post-install -d 'Install but skip any post-install steps'
__fish_brew_complete_arg 'install' -l verbose -d 'Print the verification and postinstall steps' __fish_brew_complete_arg 'install' -l verbose -d 'Print the verification and post-install steps'
__fish_brew_complete_arg 'install' -l vst-plugindir -d 'Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)' __fish_brew_complete_arg 'install' -l vst-plugindir -d 'Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)'
__fish_brew_complete_arg 'install' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)' __fish_brew_complete_arg 'install' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)'
__fish_brew_complete_arg 'install' -l zap -d 'For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*' __fish_brew_complete_arg 'install' -l zap -d 'For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*'
@ -1093,7 +1093,7 @@ __fish_brew_complete_arg 'missing' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_arg 'missing' -a '(__fish_brew_suggest_formulae_all)' __fish_brew_complete_arg 'missing' -a '(__fish_brew_suggest_formulae_all)'
__fish_brew_complete_cmd 'nodenv-sync' 'Create symlinks for Homebrew\'s installed NodeJS versions in ~/.nodenv/versions' __fish_brew_complete_cmd 'nodenv-sync' 'Create symlinks for Homebrew\'s installed NodeJS versions in `~/.nodenv/versions`'
__fish_brew_complete_arg 'nodenv-sync' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'nodenv-sync' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'nodenv-sync' -l help -d 'Show this message' __fish_brew_complete_arg 'nodenv-sync' -l help -d 'Show this message'
__fish_brew_complete_arg 'nodenv-sync' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg 'nodenv-sync' -l quiet -d 'Make some output more quiet'
@ -1239,14 +1239,14 @@ __fish_brew_complete_arg 'prof' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_arg 'prof' -a '(__fish_brew_suggest_commands)' __fish_brew_complete_arg 'prof' -a '(__fish_brew_suggest_commands)'
__fish_brew_complete_cmd 'pyenv-sync' 'Create symlinks for Homebrew\'s installed Python versions in ~/.pyenv/versions' __fish_brew_complete_cmd 'pyenv-sync' 'Create symlinks for Homebrew\'s installed Python versions in `~/.pyenv/versions`'
__fish_brew_complete_arg 'pyenv-sync' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'pyenv-sync' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'pyenv-sync' -l help -d 'Show this message' __fish_brew_complete_arg 'pyenv-sync' -l help -d 'Show this message'
__fish_brew_complete_arg 'pyenv-sync' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg 'pyenv-sync' -l quiet -d 'Make some output more quiet'
__fish_brew_complete_arg 'pyenv-sync' -l verbose -d 'Make some output more verbose' __fish_brew_complete_arg 'pyenv-sync' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_cmd 'rbenv-sync' 'Create symlinks for Homebrew\'s installed Ruby versions in ~/.rbenv/versions' __fish_brew_complete_cmd 'rbenv-sync' 'Create symlinks for Homebrew\'s installed Ruby versions in `~/.rbenv/versions`'
__fish_brew_complete_arg 'rbenv-sync' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'rbenv-sync' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'rbenv-sync' -l help -d 'Show this message' __fish_brew_complete_arg 'rbenv-sync' -l help -d 'Show this message'
__fish_brew_complete_arg 'rbenv-sync' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg 'rbenv-sync' -l quiet -d 'Make some output more quiet'
@ -1262,7 +1262,7 @@ __fish_brew_complete_arg 'readall' -l help -d 'Show this message'
__fish_brew_complete_arg 'readall' -l no-simulate -d 'Don\'t simulate other system configurations when checking formulae and casks' __fish_brew_complete_arg 'readall' -l no-simulate -d 'Don\'t simulate other system configurations when checking formulae and casks'
__fish_brew_complete_arg 'readall' -l os -d 'Read using the given operating system. (Pass `all` to simulate all operating systems.)' __fish_brew_complete_arg 'readall' -l os -d 'Read using the given operating system. (Pass `all` to simulate all operating systems.)'
__fish_brew_complete_arg 'readall' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg 'readall' -l quiet -d 'Make some output more quiet'
__fish_brew_complete_arg 'readall' -l syntax -d 'Syntax-check all of Homebrew\'s Ruby files (if no `tap` is passed)' __fish_brew_complete_arg 'readall' -l syntax -d 'Syntax-check all of Homebrew\'s Ruby files (if no tap is passed)'
__fish_brew_complete_arg 'readall' -l verbose -d 'Make some output more verbose' __fish_brew_complete_arg 'readall' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_arg 'readall' -a '(__fish_brew_suggest_taps_installed)' __fish_brew_complete_arg 'readall' -a '(__fish_brew_suggest_taps_installed)'
@ -1302,7 +1302,7 @@ __fish_brew_complete_arg 'reinstall' -l require-sha -d 'Require all casks to hav
__fish_brew_complete_arg 'reinstall' -l screen-saverdir -d 'Target location for Screen Savers (default: `~/Library/Screen Savers`)' __fish_brew_complete_arg 'reinstall' -l screen-saverdir -d 'Target location for Screen Savers (default: `~/Library/Screen Savers`)'
__fish_brew_complete_arg 'reinstall' -l servicedir -d 'Target location for Services (default: `~/Library/Services`)' __fish_brew_complete_arg 'reinstall' -l servicedir -d 'Target location for Services (default: `~/Library/Services`)'
__fish_brew_complete_arg 'reinstall' -l skip-cask-deps -d 'Skip installing cask dependencies' __fish_brew_complete_arg 'reinstall' -l skip-cask-deps -d 'Skip installing cask dependencies'
__fish_brew_complete_arg 'reinstall' -l verbose -d 'Print the verification and postinstall steps' __fish_brew_complete_arg 'reinstall' -l verbose -d 'Print the verification and post-install steps'
__fish_brew_complete_arg 'reinstall' -l vst-plugindir -d 'Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)' __fish_brew_complete_arg 'reinstall' -l vst-plugindir -d 'Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)'
__fish_brew_complete_arg 'reinstall' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)' __fish_brew_complete_arg 'reinstall' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)'
__fish_brew_complete_arg 'reinstall' -l zap -d 'For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*' __fish_brew_complete_arg 'reinstall' -l zap -d 'For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*'
@ -1687,7 +1687,7 @@ __fish_brew_complete_arg 'upgrade' -l require-sha -d 'Require all casks to have
__fish_brew_complete_arg 'upgrade' -l screen-saverdir -d 'Target location for Screen Savers (default: `~/Library/Screen Savers`)' __fish_brew_complete_arg 'upgrade' -l screen-saverdir -d 'Target location for Screen Savers (default: `~/Library/Screen Savers`)'
__fish_brew_complete_arg 'upgrade' -l servicedir -d 'Target location for Services (default: `~/Library/Services`)' __fish_brew_complete_arg 'upgrade' -l servicedir -d 'Target location for Services (default: `~/Library/Services`)'
__fish_brew_complete_arg 'upgrade' -l skip-cask-deps -d 'Skip installing cask dependencies' __fish_brew_complete_arg 'upgrade' -l skip-cask-deps -d 'Skip installing cask dependencies'
__fish_brew_complete_arg 'upgrade' -l verbose -d 'Print the verification and postinstall steps' __fish_brew_complete_arg 'upgrade' -l verbose -d 'Print the verification and post-install steps'
__fish_brew_complete_arg 'upgrade' -l vst-plugindir -d 'Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)' __fish_brew_complete_arg 'upgrade' -l vst-plugindir -d 'Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)'
__fish_brew_complete_arg 'upgrade' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)' __fish_brew_complete_arg 'upgrade' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)'
__fish_brew_complete_arg 'upgrade; and not __fish_seen_argument -l cask -l casks' -a '(__fish_brew_suggest_formulae_outdated)' __fish_brew_complete_arg 'upgrade; and not __fish_seen_argument -l cask -l casks' -a '(__fish_brew_suggest_formulae_outdated)'

30
completions/zsh/_brew
View File

@ -137,7 +137,7 @@ __brew_internal_commands() {
'--cellar:Display Homebrew'\''s Cellar path' '--cellar:Display Homebrew'\''s Cellar path'
'--env:Summarise Homebrew'\''s build environment as a plain list' '--env:Summarise Homebrew'\''s build environment as a plain list'
'--prefix:Display Homebrew'\''s install path' '--prefix:Display Homebrew'\''s install path'
'--repository:Display where Homebrew'\''s git repository is located' '--repository:Display where Homebrew'\''s Git repository is located'
'--version:Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask (if tapped) to standard output' '--version:Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask (if tapped) to standard output'
'analytics:Control Homebrew'\''s anonymous aggregate user behaviour analytics' 'analytics:Control Homebrew'\''s anonymous aggregate user behaviour analytics'
'audit:Check formula for Homebrew coding style violations' 'audit:Check formula for Homebrew coding style violations'
@ -155,22 +155,22 @@ __brew_internal_commands() {
'commands:Show lists of built-in and external commands' 'commands:Show lists of built-in and external commands'
'completions:Control whether Homebrew automatically links external tap shell completion files' 'completions:Control whether Homebrew automatically links external tap shell completion files'
'config:Show Homebrew and system configuration info useful for debugging' 'config:Show Homebrew and system configuration info useful for debugging'
'contributions:Contributions to Homebrew repositories' 'contributions:Summarise contributions to Homebrew repositories'
'create:Generate a formula or, with `--cask`, a cask for the downloadable file at URL and open it in the editor' 'create:Generate a formula or, with `--cask`, a cask for the downloadable file at URL and open it in the editor'
'deps:Show dependencies for formula' 'deps:Show dependencies for formula'
'desc:Display formula'\''s name and one-line description' 'desc:Display formula'\''s name and one-line description'
'determine-test-runners:Determines the runners used to test formulae or their dependents' 'determine-test-runners:Determines the runners used to test formulae or their dependents'
'developer:Control Homebrew'\''s developer mode' 'developer:Control Homebrew'\''s developer mode'
'dispatch-build-bottle:Build bottles for these formulae with GitHub Actions' 'dispatch-build-bottle:Build bottles for these formulae with GitHub Actions'
'docs:Open Homebrew'\''s online documentation (https://docs.brew.sh) in a browser' 'docs:Open Homebrew'\''s online documentation at https://docs.brew.sh in a browser'
'doctor:Check your system for potential problems' 'doctor:Check your system for potential problems'
'edit:Open a formula, cask or tap in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the Homebrew repository for editing if no argument is provided' 'edit:Open a formula, cask or tap in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the Homebrew repository for editing if no argument is provided'
'extract:Look through repository history to find the most recent version of formula and create a copy in tap' 'extract:Look through repository history to find the most recent version of formula and create a copy in tap'
'fetch:Download a bottle (if available) or source packages for formulae and binaries for casks' 'fetch:Download a bottle (if available) or source packages for formulae and binaries for casks'
'formula:Display the path where formula is located' 'formula:Display the path where formula is located'
'formulae:List all locally installable formulae including short names' 'formulae:List all locally installable formulae including short names'
'generate-cask-api:Generates Cask API data files for formulae.brew.sh' 'generate-cask-api:Generate `homebrew/cask` API data files for https://formulae.brew.sh'
'generate-formula-api:Generates Formula API data files for formulae.brew.sh' 'generate-formula-api:Generate `homebrew/core` API data files for https://formulae.brew.sh'
'generate-man-completions:Generate Homebrew'\''s manpages and shell completions' 'generate-man-completions:Generate Homebrew'\''s manpages and shell completions'
'gist-logs:Upload logs for a failed build of formula to a new Gist' 'gist-logs:Upload logs for a failed build of formula to a new Gist'
'home:Open a formula or cask'\''s homepage in a browser, or open Homebrew'\''s own homepage if no argument is provided' 'home:Open a formula or cask'\''s homepage in a browser, or open Homebrew'\''s own homepage if no argument is provided'
@ -186,7 +186,7 @@ __brew_internal_commands() {
'log:Show the `git log` for formula or cask, or show the log for the Homebrew repository if no formula or cask is provided' 'log:Show the `git log` for formula or cask, or show the log for the Homebrew repository if no formula or cask is provided'
'migrate:Migrate renamed packages to new names, where formula are old names of packages' 'migrate:Migrate renamed packages to new names, where formula are old names of packages'
'missing:Check the given formula kegs for missing dependencies' 'missing:Check the given formula kegs for missing dependencies'
'nodenv-sync:Create symlinks for Homebrew'\''s installed NodeJS versions in ~/.nodenv/versions' 'nodenv-sync:Create symlinks for Homebrew'\''s installed NodeJS versions in `~/.nodenv/versions`'
'options:Show install options specific to formula' 'options:Show install options specific to formula'
'outdated:List installed casks and formulae that have an updated version available' 'outdated:List installed casks and formulae that have an updated version available'
'pin:Pin the specified formula, preventing them from being upgraded when issuing the `brew upgrade` formula command' 'pin:Pin the specified formula, preventing them from being upgraded when issuing the `brew upgrade` formula command'
@ -197,8 +197,8 @@ __brew_internal_commands() {
'pr-pull:Download and publish bottles, and apply the bottle commit from a pull request with artifacts generated by GitHub Actions' 'pr-pull:Download and publish bottles, and apply the bottle commit from a pull request with artifacts generated by GitHub Actions'
'pr-upload:Apply the bottle commit and publish bottles to a host' 'pr-upload:Apply the bottle commit and publish bottles to a host'
'prof:Run Homebrew with a Ruby profiler' 'prof:Run Homebrew with a Ruby profiler'
'pyenv-sync:Create symlinks for Homebrew'\''s installed Python versions in ~/.pyenv/versions' 'pyenv-sync:Create symlinks for Homebrew'\''s installed Python versions in `~/.pyenv/versions`'
'rbenv-sync:Create symlinks for Homebrew'\''s installed Ruby versions in ~/.rbenv/versions' 'rbenv-sync:Create symlinks for Homebrew'\''s installed Ruby versions in `~/.rbenv/versions`'
'readall:Import all items from the specified tap, or from all installed taps if none is provided' 'readall:Import all items from the specified tap, or from all installed taps if none is provided'
'reinstall:Uninstall and then reinstall a formula or cask using the same options it was originally installed with, plus any appended options specific to a formula' 'reinstall:Uninstall and then reinstall a formula or cask using the same options it was originally installed with, plus any appended options specific to a formula'
'release:Create a new draft Homebrew/brew release with the appropriate version number and release notes' 'release:Create a new draft Homebrew/brew release with the appropriate version number and release notes'
@ -1045,7 +1045,7 @@ _brew_instal() {
'(--cask --build-from-source --build-bottle)--force-bottle[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]' \ '(--cask --build-from-source --build-bottle)--force-bottle[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]' \
'(--cask)--git[Create a Git repository, useful for creating patches to the software]' \ '(--cask)--git[Create a Git repository, useful for creating patches to the software]' \
'--help[Show this message]' \ '--help[Show this message]' \
'(--cask --only-dependencies)--ignore-dependencies[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]' \ '(--cask --only-dependencies)--ignore-dependencies[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]' \
'(--cask)--include-test[Install testing dependencies required to run `brew test` formula]' \ '(--cask)--include-test[Install testing dependencies required to run `brew test` formula]' \
'(--formula)--input-methoddir[Target location for Input Methods (default: `~/Library/Input Methods`)]' \ '(--formula)--input-methoddir[Target location for Input Methods (default: `~/Library/Input Methods`)]' \
'(--cask)--interactive[Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package]' \ '(--cask)--interactive[Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package]' \
@ -1067,7 +1067,7 @@ _brew_instal() {
'(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \ '(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \
'(--formula)--skip-cask-deps[Skip installing cask dependencies]' \ '(--formula)--skip-cask-deps[Skip installing cask dependencies]' \
'(--cask)--skip-post-install[Install but skip any post-install steps]' \ '(--cask)--skip-post-install[Install but skip any post-install steps]' \
'--verbose[Print the verification and postinstall steps]' \ '--verbose[Print the verification and post-install steps]' \
'(--formula)--vst-plugindir[Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)]' \ '(--formula)--vst-plugindir[Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)]' \
'(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)]' \ '(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)]' \
'(--formula)--zap[For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*]' \ '(--formula)--zap[For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*]' \
@ -1103,7 +1103,7 @@ _brew_install() {
'(--cask --build-from-source --build-bottle)--force-bottle[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]' \ '(--cask --build-from-source --build-bottle)--force-bottle[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]' \
'(--cask)--git[Create a Git repository, useful for creating patches to the software]' \ '(--cask)--git[Create a Git repository, useful for creating patches to the software]' \
'--help[Show this message]' \ '--help[Show this message]' \
'(--cask --only-dependencies)--ignore-dependencies[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]' \ '(--cask --only-dependencies)--ignore-dependencies[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]' \
'(--cask)--include-test[Install testing dependencies required to run `brew test` formula]' \ '(--cask)--include-test[Install testing dependencies required to run `brew test` formula]' \
'(--formula)--input-methoddir[Target location for Input Methods (default: `~/Library/Input Methods`)]' \ '(--formula)--input-methoddir[Target location for Input Methods (default: `~/Library/Input Methods`)]' \
'(--cask)--interactive[Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package]' \ '(--cask)--interactive[Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package]' \
@ -1125,7 +1125,7 @@ _brew_install() {
'(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \ '(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \
'(--formula)--skip-cask-deps[Skip installing cask dependencies]' \ '(--formula)--skip-cask-deps[Skip installing cask dependencies]' \
'(--cask)--skip-post-install[Install but skip any post-install steps]' \ '(--cask)--skip-post-install[Install but skip any post-install steps]' \
'--verbose[Print the verification and postinstall steps]' \ '--verbose[Print the verification and post-install steps]' \
'(--formula)--vst-plugindir[Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)]' \ '(--formula)--vst-plugindir[Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)]' \
'(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)]' \ '(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)]' \
'(--formula)--zap[For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*]' \ '(--formula)--zap[For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*]' \
@ -1559,7 +1559,7 @@ _brew_readall() {
'--no-simulate[Don'\''t simulate other system configurations when checking formulae and casks]' \ '--no-simulate[Don'\''t simulate other system configurations when checking formulae and casks]' \
'--os[Read using the given operating system. (Pass `all` to simulate all operating systems.)]' \ '--os[Read using the given operating system. (Pass `all` to simulate all operating systems.)]' \
'--quiet[Make some output more quiet]' \ '--quiet[Make some output more quiet]' \
'--syntax[Syntax-check all of Homebrew'\''s Ruby files (if no `tap` is passed)]' \ '--syntax[Syntax-check all of Homebrew'\''s Ruby files (if no tap is passed)]' \
'--verbose[Make some output more verbose]' \ '--verbose[Make some output more verbose]' \
- tap \ - tap \
'*::tap:__brew_any_tap' '*::tap:__brew_any_tap'
@ -1600,7 +1600,7 @@ _brew_reinstall() {
'(--formula)--screen-saverdir[Target location for Screen Savers (default: `~/Library/Screen Savers`)]' \ '(--formula)--screen-saverdir[Target location for Screen Savers (default: `~/Library/Screen Savers`)]' \
'(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \ '(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \
'(--formula)--skip-cask-deps[Skip installing cask dependencies]' \ '(--formula)--skip-cask-deps[Skip installing cask dependencies]' \
'--verbose[Print the verification and postinstall steps]' \ '--verbose[Print the verification and post-install steps]' \
'(--formula)--vst-plugindir[Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)]' \ '(--formula)--vst-plugindir[Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)]' \
'(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)]' \ '(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)]' \
'(--formula)--zap[For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*]' \ '(--formula)--zap[For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*]' \
@ -2074,7 +2074,7 @@ _brew_upgrade() {
'(--formula)--screen-saverdir[Target location for Screen Savers (default: `~/Library/Screen Savers`)]' \ '(--formula)--screen-saverdir[Target location for Screen Savers (default: `~/Library/Screen Savers`)]' \
'(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \ '(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \
'(--formula)--skip-cask-deps[Skip installing cask dependencies]' \ '(--formula)--skip-cask-deps[Skip installing cask dependencies]' \
'--verbose[Print the verification and postinstall steps]' \ '--verbose[Print the verification and post-install steps]' \
'(--formula)--vst-plugindir[Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)]' \ '(--formula)--vst-plugindir[Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)]' \
'(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)]' \ '(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)]' \
- outdated_formula \ - outdated_formula \

71
docs/Manpage.md
View File

@ -141,7 +141,12 @@ Show dependencies for *`formula`*. When given multiple formula arguments,
show the intersection of dependencies for each formula. By default, `deps` show the intersection of dependencies for each formula. By default, `deps`
shows all required and recommended dependencies. shows all required and recommended dependencies.
Note: `--missing` and `--skip-recommended` have precedence over `--include-*`. If any version of each formula argument is installed and no other options
are passed, this command displays their actual runtime dependencies (similar
to `brew linkage`), which may differ from the current versons' stated
dependencies if the installed versions are outdated.
*Note:* `--missing` and `--skip-recommended` have precedence over `--include-*`.
* `-n`, `--topological`: * `-n`, `--topological`:
Sort dependencies in topological order. Sort dependencies in topological order.
@ -214,15 +219,16 @@ branch instead of the latest stable version along with some other behaviour chan
### `docs` ### `docs`
Open Homebrew's online documentation (https://docs.brew.sh) in a browser. Open Homebrew's online documentation at <https://docs.brew.sh> in a browser.
### `doctor`, `dr` [`--list-checks`] [`--audit-debug`] [*`diagnostic_check`* ...] ### `doctor`, `dr` [`--list-checks`] [`--audit-debug`] [*`diagnostic_check`* ...]
Check your system for potential problems. Will exit with a non-zero status 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 if any potential problems are found.
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 Please note that these warnings are just used to help the Homebrew maintainers
an issue; just ignore this. 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.
* `--list-checks`: * `--list-checks`:
List all audit methods, which can be run individually if provided as arguments. List all audit methods, which can be run individually if provided as arguments.
@ -292,7 +298,6 @@ Homebrew's own homepage if no argument is provided.
### `info`, `abv` [*`options`*] [*`formula`*|*`cask`* ...] ### `info`, `abv` [*`options`*] [*`formula`*|*`cask`* ...]
Display brief statistics for your Homebrew installation. Display brief statistics for your Homebrew installation.
If a *`formula`* or *`cask`* is provided, show summary of information about it. If a *`formula`* or *`cask`* is provided, show summary of information about it.
* `--analytics`: * `--analytics`:
@ -337,13 +342,13 @@ is already installed but outdated.
* `-f`, `--force`: * `-f`, `--force`:
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). 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).
* `-v`, `--verbose`: * `-v`, `--verbose`:
Print the verification and postinstall steps. Print the verification and post-install steps.
* `-n`, `--dry-run`: * `-n`, `--dry-run`:
Show what would be installed, but do not actually install anything. Show what would be installed, but do not actually install anything.
* `--formula`: * `--formula`:
Treat all named arguments as formulae. Treat all named arguments as formulae.
* `--ignore-dependencies`: * `--ignore-dependencies`:
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. 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.
* `--only-dependencies`: * `--only-dependencies`:
Install the dependencies with specified options but do not install the formula itself. Install the dependencies with specified options but do not install the formula itself.
* `--cc`: * `--cc`:
@ -402,9 +407,9 @@ List installed formulae that are not dependencies of another installed formula o
### `link`, `ln` [*`options`*] *`installed_formula`* [...] ### `link`, `ln` [*`options`*] *`installed_formula`* [...]
Symlink all of *`formula`*'s installed files into Homebrew's prefix. This Symlink all of *`formula`*'s installed files into Homebrew's prefix.
is done automatically when you install formulae but can be useful for DIY This is done automatically when you install formulae but can be useful
installations. for manual installations.
* `--overwrite`: * `--overwrite`:
Delete files that already exist in the prefix while linking. Delete files that already exist in the prefix while linking.
@ -418,7 +423,6 @@ installations.
### `list`, `ls` [*`options`*] [*`installed_formula`*|*`installed_cask`* ...] ### `list`, `ls` [*`options`*] [*`installed_formula`*|*`installed_cask`* ...]
List all installed formulae and casks. List all installed formulae and casks.
If *`formula`* is provided, summarise the paths within its current keg. If *`formula`* is provided, summarise the paths within its current keg.
If *`cask`* is provided, list its artifacts. If *`cask`* is provided, list its artifacts.
@ -488,7 +492,7 @@ to be missing dependencies.
### `nodenv-sync` ### `nodenv-sync`
Create symlinks for Homebrew's installed NodeJS versions in ~/.nodenv/versions. Create symlinks for Homebrew's installed NodeJS versions in `~/.nodenv/versions`.
Note that older version symlinks will also be created so e.g. NodeJS 19.1.0 will Note that older version symlinks will also be created so e.g. NodeJS 19.1.0 will
also be symlinked to 19.0.0. also be symlinked to 19.0.0.
@ -541,14 +545,14 @@ Rerun the post-install steps for *`formula`*.
### `pyenv-sync` ### `pyenv-sync`
Create symlinks for Homebrew's installed Python versions in ~/.pyenv/versions. Create symlinks for Homebrew's installed Python versions in `~/.pyenv/versions`.
Note that older patch version symlinks will be created and linked to the minor 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. version so e.g. Python 3.11.0 will also be symlinked to 3.11.3.
### `rbenv-sync` ### `rbenv-sync`
Create symlinks for Homebrew's installed Ruby versions in ~/.rbenv/versions. Create symlinks for Homebrew's installed Ruby versions in `~/.rbenv/versions`.
Note that older version symlinks will also be created so e.g. Ruby 3.2.1 will Note that older version symlinks will also be created so e.g. Ruby 3.2.1 will
also be symlinked to 3.2.0. also be symlinked to 3.2.0.
@ -567,7 +571,7 @@ all items or checking if any current formulae/casks have Ruby issues.
* `--aliases`: * `--aliases`:
Verify any alias symlinks in each tap. Verify any alias symlinks in each tap.
* `--syntax`: * `--syntax`:
Syntax-check all of Homebrew's Ruby files (if no `*`tap`*` is passed). Syntax-check all of Homebrew's Ruby files (if no *`tap`* is passed).
* `--eval-all`: * `--eval-all`:
Evaluate all available formulae and casks, whether installed or not. Implied if `HOMEBREW_EVAL_ALL` is set. Evaluate all available formulae and casks, whether installed or not. Implied if `HOMEBREW_EVAL_ALL` is set.
* `--no-simulate`: * `--no-simulate`:
@ -589,7 +593,7 @@ reinstalled formulae or, every 30 days, for all formulae.
* `-f`, `--force`: * `-f`, `--force`:
Install without checking for previously installed keg-only or non-migrated versions. Install without checking for previously installed keg-only or non-migrated versions.
* `-v`, `--verbose`: * `-v`, `--verbose`:
Print the verification and postinstall steps. Print the verification and post-install steps.
* `--formula`: * `--formula`:
Treat all named arguments as formulae. Treat all named arguments as formulae.
* `-s`, `--build-from-source`: * `-s`, `--build-from-source`:
@ -671,7 +675,6 @@ The shell can be specified explicitly with a supported shell name parameter. Unk
### `tap` [*`options`*] [*`user`*`/`*`repo`*] [*`URL`*] ### `tap` [*`options`*] [*`user`*`/`*`repo`*] [*`URL`*]
Tap a formula repository. Tap a formula repository.
If no arguments are provided, list all installed taps. If no arguments are provided, list all installed taps.
With *`URL`* unspecified, tap a formula repository from GitHub using HTTPS. With *`URL`* unspecified, tap a formula repository from GitHub using HTTPS.
@ -698,7 +701,6 @@ using protocols other than HTTPS, e.g. SSH, git, HTTP, FTP(S), rsync.
### `tap-info` [`--installed`] [`--json`] [*`tap`* ...] ### `tap-info` [`--installed`] [`--json`] [*`tap`* ...]
Show detailed information about one or more *`tap`*s. Show detailed information about one or more *`tap`*s.
If no *`tap`* names are provided, display brief statistics for all installed taps. If no *`tap`* names are provided, display brief statistics for all installed taps.
* `--installed`: * `--installed`:
@ -776,7 +778,7 @@ upgraded formulae or, every 30 days, for all formulae.
* `-f`, `--force`: * `-f`, `--force`:
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). 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).
* `-v`, `--verbose`: * `-v`, `--verbose`:
Print the verification and postinstall steps. Print the verification and post-install steps.
* `-n`, `--dry-run`: * `-n`, `--dry-run`:
Show what would be upgraded, but do not actually upgrade anything. Show what would be upgraded, but do not actually upgrade anything.
* `--formula`: * `--formula`:
@ -821,7 +823,7 @@ of *`formula`*. When given multiple formula arguments, show the intersection
of formulae that use *`formula`*. By default, `uses` shows all formulae and casks that of formulae that use *`formula`*. By default, `uses` shows all formulae and casks that
specify *`formula`* as a required or recommended dependency for their stable builds. specify *`formula`* as a required or recommended dependency for their stable builds.
Note: `--missing` and `--skip-recommended` have precedence over `--include-*`. *Note:* `--missing` and `--skip-recommended` have precedence over `--include-*`.
* `--recursive`: * `--recursive`:
Resolve more than one level of dependencies. Resolve more than one level of dependencies.
@ -898,8 +900,8 @@ the list is formatted for export to `bash`(1) unless `--plain` is passed.
Display Homebrew's install path. *Default:* Display Homebrew's install path. *Default:*
- macOS Intel: `/usr/local`
- macOS ARM: `/opt/homebrew` - macOS ARM: `/opt/homebrew`
- macOS Intel: `/usr/local`
- Linux: `/home/linuxbrew/.linuxbrew` - Linux: `/home/linuxbrew/.linuxbrew`
If *`formula`* is provided, display the location where *`formula`* is or would be installed. If *`formula`* is provided, display the location where *`formula`* is or would be installed.
@ -911,7 +913,7 @@ If *`formula`* is provided, display the location where *`formula`* is or would b
### `--repository`, `--repo` [*`tap`* ...] ### `--repository`, `--repo` [*`tap`* ...]
Display where Homebrew's git repository is located. Display where Homebrew's Git repository is located.
If *`user`*`/`*`repo`* are provided, display where tap *`user`*`/`*`repo`*'s directory is located. If *`user`*`/`*`repo`* are provided, display where tap *`user`*`/`*`repo`*'s directory is located.
@ -1169,7 +1171,7 @@ Display the path to the file being used when invoking `brew` *`cmd`*.
### `contributions` [--user=*`email|username`*] [*`--repositories`*`=`] [*`--csv`*] ### `contributions` [--user=*`email|username`*] [*`--repositories`*`=`] [*`--csv`*]
Contributions to Homebrew repositories. Summarise contributions to Homebrew repositories.
* `--repositories`: * `--repositories`:
Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `aliases`, `autoupdate`, `bundle`, `command-not-found`, `test-bot`, `services`, `cask-fonts` and `cask-versions`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: brew,core,cask. Specifying `--repositories=all`, searches all repositories. Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `aliases`, `autoupdate`, `bundle`, `command-not-found`, `test-bot`, `services`, `cask-fonts` and `cask-versions`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: brew,core,cask. Specifying `--repositories=all`, searches all repositories.
@ -1282,8 +1284,7 @@ Display the path where *`formula`* is located.
### `generate-cask-api` [`--dry-run`] ### `generate-cask-api` [`--dry-run`]
Generates Cask API data files for formulae.brew.sh. Generate `homebrew/cask` API data files for <https://formulae.brew.sh>.
The generated files are written to the current directory. The generated files are written to the current directory.
* `-n`, `--dry-run`: * `-n`, `--dry-run`:
@ -1291,8 +1292,7 @@ The generated files are written to the current directory.
### `generate-formula-api` [`--dry-run`] ### `generate-formula-api` [`--dry-run`]
Generates Formula API data files for formulae.brew.sh. Generate `homebrew/core` API data files for <https://formulae.brew.sh>.
The generated files are written to the current directory. The generated files are written to the current directory.
* `-n`, `--dry-run`: * `-n`, `--dry-run`:
@ -1335,7 +1335,6 @@ provided, check all kegs. Raises an error if run on uninstalled formulae.
### `livecheck`, `lc` [*`options`*] [*`formula`*|*`cask`* ...] ### `livecheck`, `lc` [*`options`*] [*`formula`*|*`cask`* ...]
Check for newer versions of formulae and/or casks from upstream. Check for newer versions of formulae and/or casks from upstream.
If no formula or cask argument is passed, the list of formulae and If no formula or cask argument is passed, the list of formulae and
casks to check is taken from `HOMEBREW_LIVECHECK_WATCHLIST` or casks to check is taken from `HOMEBREW_LIVECHECK_WATCHLIST` or
`~/.homebrew/livecheck_watchlist.txt`. `~/.homebrew/livecheck_watchlist.txt`.
@ -1486,7 +1485,7 @@ By default, `brew release` will bump the patch version number. Pass
The command will fail if the previous major or minor release was made less than The command will fail if the previous major or minor release was made less than
one month ago. one month ago.
Requires write access to the Homebrew/brew repository. *Note:* Requires write access to the Homebrew/brew repository.
* `--major`: * `--major`:
Create a major release. Create a major release.
@ -1698,7 +1697,7 @@ Install and commit Homebrew's vendored gems.
## GLOBAL CASK OPTIONS ## GLOBAL CASK OPTIONS
These options are applicable to the `install`, `reinstall`, and `upgrade` subcommands with the `--cask` flag. These options are applicable to the `install`, `reinstall`, and `upgrade` subcommands with the `--cask` switch.
* `--appdir`: * `--appdir`:
Target location for Applications (default: `/Applications`). Target location for Applications (default: `/Applications`).
@ -2306,7 +2305,7 @@ prefix-specific files take precedence over system-wide files (unless
- `HOMEBREW_NO_INSECURE_REDIRECT` - `HOMEBREW_NO_INSECURE_REDIRECT`
<br>If set, forbid redirects from secure HTTPS to insecure HTTP. <br>If set, forbid redirects from secure HTTPS to insecure HTTP.
*Note:* While ensuring your downloads are fully secure, this is likely to cause from-source SourceForge, some GNU & GNOME-hosted formulae to fail to download. *Note:* while ensuring your downloads are fully secure, this is likely to cause from-source SourceForge, some GNU & GNOME-hosted formulae to fail to download.
- `HOMEBREW_NO_INSTALL_CLEANUP` - `HOMEBREW_NO_INSTALL_CLEANUP`
<br>If set, `brew install`, `brew upgrade` and `brew reinstall` will never automatically cleanup installed/upgraded/reinstalled formulae or all formulae every `HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS` days. Alternatively, `HOMEBREW_NO_CLEANUP_FORMULAE` allows specifying specific formulae to not clean up. <br>If set, `brew install`, `brew upgrade` and `brew reinstall` will never automatically cleanup installed/upgraded/reinstalled formulae or all formulae every `HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS` days. Alternatively, `HOMEBREW_NO_CLEANUP_FORMULAE` allows specifying specific formulae to not clean up.
@ -2315,7 +2314,7 @@ prefix-specific files take precedence over system-wide files (unless
<br>If set, do not install formulae and casks in homebrew/core and homebrew/cask taps using Homebrew's API and instead use (large, slow) local checkouts of these repositories. <br>If set, do not install formulae and casks in homebrew/core and homebrew/cask taps using Homebrew's API and instead use (large, slow) local checkouts of these repositories.
- `HOMEBREW_NO_INSTALL_UPGRADE` - `HOMEBREW_NO_INSTALL_UPGRADE`
<br>If set, `brew install` <formula/cask> will not upgrade <formula/cask> if it is installed but outdated. <br>If set, `brew install` *`formula|cask`* will not upgrade *`formula|cask`* if it is installed but outdated.
- `HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` - `HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK`
<br>If set, do not check for broken linkage of dependents or outdated dependents after installing, upgrading or reinstalling formulae. This will result in fewer dependents (and their dependencies) being upgraded or reinstalled but may result in more breakage from running `brew install` *`formula`* or `brew upgrade` *`formula`*. <br>If set, do not check for broken linkage of dependents or outdated dependents after installing, upgrading or reinstalling formulae. This will result in fewer dependents (and their dependencies) being upgraded or reinstalled but may result in more breakage from running `brew install` *`formula`* or `brew upgrade` *`formula`*.
@ -2324,7 +2323,7 @@ prefix-specific files take precedence over system-wide files (unless
<br>If set, `brew update` will not show the list of newly added formulae/casks. <br>If set, `brew update` will not show the list of newly added formulae/casks.
- `HOMEBREW_PIP_INDEX_URL` - `HOMEBREW_PIP_INDEX_URL`
<br>If set, `brew install *`formula`*` will use this URL to download PyPI package resources. <br>If set, `brew install` *`formula`* will use this URL to download PyPI package resources.
*Default:* `https://pypi.org/simple`. *Default:* `https://pypi.org/simple`.
@ -2344,7 +2343,7 @@ prefix-specific files take precedence over system-wide files (unless
<br>If set, enable runtime typechecking using Sorbet. Set by default for HOMEBREW_DEVELOPER or when running some developer commands. <br>If set, enable runtime typechecking using Sorbet. Set by default for HOMEBREW_DEVELOPER or when running some developer commands.
- `HOMEBREW_SSH_CONFIG_PATH` - `HOMEBREW_SSH_CONFIG_PATH`
<br>If set, Homebrew will use the given config file instead of `~/.ssh/config` when fetching `git` repos over `ssh`. <br>If set, Homebrew will use the given config file instead of `~/.ssh/config` when fetching Git repositories over SSH.
*Default:* `$HOME/.ssh/config` *Default:* `$HOME/.ssh/config`

87
manpages/brew.1
View File

@ -158,7 +158,10 @@ Show Homebrew and system configuration info useful for debugging\. If you file a
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\. 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 .P
Note: \fB\-\-missing\fR and \fB\-\-skip\-recommended\fR have precedence over \fB\-\-include\-*\fR\. 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 .TP
\fB\-n\fR, \fB\-\-topological\fR \fB\-n\fR, \fB\-\-topological\fR
@ -275,10 +278,13 @@ Control Homebrew\'s developer mode\. When developer mode is enabled, \fBbrew upd
Turn Homebrew\'s developer mode on or off respectively\. Turn Homebrew\'s developer mode on or off respectively\.
. .
.SS "\fBdocs\fR" .SS "\fBdocs\fR"
Open Homebrew\'s online documentation (https://docs\.brew\.sh) in a browser\. 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 \.\.\.]" .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\. 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\. 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 .TP
\fB\-\-list\-checks\fR \fB\-\-list\-checks\fR
@ -377,10 +383,7 @@ Treat all named arguments as formulae\.
Treat all named arguments as casks\. Treat all named arguments as casks\.
. .
.SS "\fBinfo\fR, \fBabv\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]" .SS "\fBinfo\fR, \fBabv\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Display brief statistics for your Homebrew installation\. Display brief statistics for your Homebrew installation\. If a \fIformula\fR or \fIcask\fR is provided, show summary of information about it\.
.
.P
If a \fIformula\fR or \fIcask\fR is provided, show summary of information about it\.
. .
.TP .TP
\fB\-\-analytics\fR \fB\-\-analytics\fR
@ -448,7 +451,7 @@ Install formulae without checking for previously installed keg\-only or non\-mig
. .
.TP .TP
\fB\-v\fR, \fB\-\-verbose\fR \fB\-v\fR, \fB\-\-verbose\fR
Print the verification and postinstall steps\. Print the verification and post\-install steps\.
. .
.TP .TP
\fB\-n\fR, \fB\-\-dry\-run\fR \fB\-n\fR, \fB\-\-dry\-run\fR
@ -460,7 +463,7 @@ Treat all named arguments as formulae\.
. .
.TP .TP
\fB\-\-ignore\-dependencies\fR \fB\-\-ignore\-dependencies\fR
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\. 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 .TP
\fB\-\-only\-dependencies\fR \fB\-\-only\-dependencies\fR
@ -566,7 +569,7 @@ Only list leaves that were manually installed\.
Only list leaves that were installed as dependencies\. Only list leaves that were installed as dependencies\.
. .
.SS "\fBlink\fR, \fBln\fR [\fIoptions\fR] \fIinstalled_formula\fR [\.\.\.]" .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 DIY installations\. 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 .TP
\fB\-\-overwrite\fR \fB\-\-overwrite\fR
@ -585,10 +588,7 @@ Allow keg\-only formulae to be linked\.
Link the HEAD version of the formula if it is installed\. Link the HEAD version of the formula if it is installed\.
. .
.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR] [\fIinstalled_formula\fR|\fIinstalled_cask\fR \.\.\.]" .SS "\fBlist\fR, \fBls\fR [\fIoptions\fR] [\fIinstalled_formula\fR|\fIinstalled_cask\fR \.\.\.]"
List all installed formulae and casks\. 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\.
.
.P
If \fIformula\fR is provided, summarise the paths within its current keg\. If \fIcask\fR is provided, list its artifacts\.
. .
.TP .TP
\fB\-\-formula\fR \fB\-\-formula\fR
@ -688,7 +688,7 @@ Check the given \fIformula\fR kegs for missing dependencies\. If no \fIformula\f
Act as if none of the specified \fIhidden\fR are installed\. \fIhidden\fR should be a comma\-separated list of formulae\. 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" .SS "\fBnodenv\-sync\fR"
Create symlinks for Homebrew\'s installed NodeJS versions in ~/\.nodenv/versions\. Create symlinks for Homebrew\'s installed NodeJS versions in \fB~/\.nodenv/versions\fR\.
. .
.P .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\. Note that older version symlinks will also be created so e\.g\. NodeJS 19\.1\.0 will also be symlinked to 19\.0\.0\.
@ -758,13 +758,13 @@ Pin the specified \fIformula\fR, preventing them from being upgraded when issuin
Rerun the post\-install steps for \fIformula\fR\. Rerun the post\-install steps for \fIformula\fR\.
. .
.SS "\fBpyenv\-sync\fR" .SS "\fBpyenv\-sync\fR"
Create symlinks for Homebrew\'s installed Python versions in ~/\.pyenv/versions\. Create symlinks for Homebrew\'s installed Python versions in \fB~/\.pyenv/versions\fR\.
. .
.P .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\. 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" .SS "\fBrbenv\-sync\fR"
Create symlinks for Homebrew\'s installed Ruby versions in ~/\.rbenv/versions\. Create symlinks for Homebrew\'s installed Ruby versions in \fB~/\.rbenv/versions\fR\.
. .
.P .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\. Note that older version symlinks will also be created so e\.g\. Ruby 3\.2\.1 will also be symlinked to 3\.2\.0\.
@ -786,7 +786,7 @@ Verify any alias symlinks in each tap\.
. .
.TP .TP
\fB\-\-syntax\fR \fB\-\-syntax\fR
Syntax\-check all of Homebrew\'s Ruby files (if no \fB<tap>\fR is passed)\. Syntax\-check all of Homebrew\'s Ruby files (if no \fItap\fR is passed)\.
. .
.TP .TP
\fB\-\-eval\-all\fR \fB\-\-eval\-all\fR
@ -815,7 +815,7 @@ Install without checking for previously installed keg\-only or non\-migrated ver
. .
.TP .TP
\fB\-v\fR, \fB\-\-verbose\fR \fB\-v\fR, \fB\-\-verbose\fR
Print the verification and postinstall steps\. Print the verification and post\-install steps\.
. .
.TP .TP
\fB\-\-formula\fR \fB\-\-formula\fR
@ -950,10 +950,7 @@ The variables \fBHOMEBREW_PREFIX\fR, \fBHOMEBREW_CELLAR\fR and \fBHOMEBREW_REPOS
The shell can be specified explicitly with a supported shell name parameter\. Unknown shells will output POSIX exports\. 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]" .SS "\fBtap\fR [\fIoptions\fR] [\fIuser\fR\fB/\fR\fIrepo\fR] [\fIURL\fR]"
Tap a formula repository\. Tap a formula repository\. If no arguments are provided, list all installed taps\.
.
.P
If no arguments are provided, list all installed taps\.
. .
.P .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\. 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\.
@ -982,10 +979,7 @@ Evaluate all the formulae, casks and aliases in the new tap to check validity\.
Force install core taps even under API mode\. Force install core taps even under API mode\.
. .
.SS "\fBtap\-info\fR [\fB\-\-installed\fR] [\fB\-\-json\fR] [\fItap\fR \.\.\.]" .SS "\fBtap\-info\fR [\fB\-\-installed\fR] [\fB\-\-json\fR] [\fItap\fR \.\.\.]"
Show detailed information about one or more \fItap\fRs\. Show detailed information about one or more \fItap\fRs\. If no \fItap\fR names are provided, display brief statistics for all installed taps\.
.
.P
If no \fItap\fR names are provided, display brief statistics for all installed taps\.
. .
.TP .TP
\fB\-\-installed\fR \fB\-\-installed\fR
@ -1075,7 +1069,7 @@ Install formulae without checking for previously installed keg\-only or non\-mig
. .
.TP .TP
\fB\-v\fR, \fB\-\-verbose\fR \fB\-v\fR, \fB\-\-verbose\fR
Print the verification and postinstall steps\. Print the verification and post\-install steps\.
. .
.TP .TP
\fB\-n\fR, \fB\-\-dry\-run\fR \fB\-n\fR, \fB\-\-dry\-run\fR
@ -1153,7 +1147,7 @@ Disable/enable quarantining of downloads (default: enabled)\.
Show formulae and casks that specify \fIformula\fR as a dependency; that is, show dependents of \fIformula\fR\. When given multiple formula arguments, show the intersection of formulae that use \fIformula\fR\. By default, \fBuses\fR shows all formulae and casks that specify \fIformula\fR as a required or recommended dependency for their stable builds\. Show formulae and casks that specify \fIformula\fR as a dependency; that is, show dependents of \fIformula\fR\. When given multiple formula arguments, show the intersection of formulae that use \fIformula\fR\. By default, \fBuses\fR shows all formulae and casks that specify \fIformula\fR as a required or recommended dependency for their stable builds\.
. .
.P .P
Note: \fB\-\-missing\fR and \fB\-\-skip\-recommended\fR have precedence over \fB\-\-include\-*\fR\. \fINote:\fR \fB\-\-missing\fR and \fB\-\-skip\-recommended\fR have precedence over \fB\-\-include\-*\fR\.
. .
.TP .TP
\fB\-\-recursive\fR \fB\-\-recursive\fR
@ -1263,10 +1257,10 @@ Generate plain output even when piped\.
Display Homebrew\'s install path\. \fIDefault:\fR Display Homebrew\'s install path\. \fIDefault:\fR
. .
.IP "\(bu" 4 .IP "\(bu" 4
macOS Intel: \fB/usr/local\fR macOS ARM: \fB/opt/homebrew\fR
. .
.IP "\(bu" 4 .IP "\(bu" 4
macOS ARM: \fB/opt/homebrew\fR macOS Intel: \fB/usr/local\fR
. .
.IP "\(bu" 4 .IP "\(bu" 4
Linux: \fB/home/linuxbrew/\.linuxbrew\fR Linux: \fB/home/linuxbrew/\.linuxbrew\fR
@ -1285,7 +1279,7 @@ List files in Homebrew\'s prefix not installed by Homebrew\.
Outputs nothing and returns a failing status code if \fIformula\fR is not installed\. Outputs nothing and returns a failing status code if \fIformula\fR is not installed\.
. .
.SS "\fB\-\-repository\fR, \fB\-\-repo\fR [\fItap\fR \.\.\.]" .SS "\fB\-\-repository\fR, \fB\-\-repo\fR [\fItap\fR \.\.\.]"
Display where Homebrew\'s git repository is located\. Display where Homebrew\'s Git repository is located\.
. .
.P .P
If \fIuser\fR\fB/\fR\fIrepo\fR are provided, display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\. If \fIuser\fR\fB/\fR\fIrepo\fR are provided, display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\.
@ -1686,7 +1680,7 @@ Treat all named arguments as casks\.
Display the path to the file being used when invoking \fBbrew\fR \fIcmd\fR\. Display the path to the file being used when invoking \fBbrew\fR \fIcmd\fR\.
. .
.SS "\fBcontributions\fR [\-\-user=\fIemail|username\fR] [\fI\-\-repositories\fR\fB=\fR] [\fI\-\-csv\fR]" .SS "\fBcontributions\fR [\-\-user=\fIemail|username\fR] [\fI\-\-repositories\fR\fB=\fR] [\fI\-\-csv\fR]"
Contributions to Homebrew repositories\. Summarise contributions to Homebrew repositories\.
. .
.TP .TP
\fB\-\-repositories\fR \fB\-\-repositories\fR
@ -1852,20 +1846,14 @@ Overwrite the destination formula if it already exists\.
Display the path where \fIformula\fR is located\. Display the path where \fIformula\fR is located\.
. .
.SS "\fBgenerate\-cask\-api\fR [\fB\-\-dry\-run\fR]" .SS "\fBgenerate\-cask\-api\fR [\fB\-\-dry\-run\fR]"
Generates Cask API data files for formulae\.brew\.sh\. Generate \fBhomebrew/cask\fR API data files for \fIhttps://formulae\.brew\.sh\fR\. The generated files are written to the current directory\.
.
.P
The generated files are written to the current directory\.
. .
.TP .TP
\fB\-n\fR, \fB\-\-dry\-run\fR \fB\-n\fR, \fB\-\-dry\-run\fR
Generate API data without writing it to files\. Generate API data without writing it to files\.
. .
.SS "\fBgenerate\-formula\-api\fR [\fB\-\-dry\-run\fR]" .SS "\fBgenerate\-formula\-api\fR [\fB\-\-dry\-run\fR]"
Generates Formula API data files for formulae\.brew\.sh\. Generate \fBhomebrew/core\fR API data files for \fIhttps://formulae\.brew\.sh\fR\. The generated files are written to the current directory\.
.
.P
The generated files are written to the current directory\.
. .
.TP .TP
\fB\-n\fR, \fB\-\-dry\-run\fR \fB\-n\fR, \fB\-\-dry\-run\fR
@ -1912,10 +1900,7 @@ For every library that a keg references, print its dylib path followed by the bi
Print the cached linkage values stored in \fBHOMEBREW_CACHE\fR, set by a previous \fBbrew linkage\fR run\. Print the cached linkage values stored in \fBHOMEBREW_CACHE\fR, set by a previous \fBbrew linkage\fR run\.
. .
.SS "\fBlivecheck\fR, \fBlc\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]" .SS "\fBlivecheck\fR, \fBlc\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Check for newer versions of formulae and/or casks from upstream\. Check for newer versions of formulae and/or casks from upstream\. If no formula or cask argument is passed, the list of formulae and casks to check is taken from \fBHOMEBREW_LIVECHECK_WATCHLIST\fR or \fB~/\.homebrew/livecheck_watchlist\.txt\fR\.
.
.P
If no formula or cask argument is passed, the list of formulae and casks to check is taken from \fBHOMEBREW_LIVECHECK_WATCHLIST\fR or \fB~/\.homebrew/livecheck_watchlist\.txt\fR\.
. .
.TP .TP
\fB\-\-full\-name\fR \fB\-\-full\-name\fR
@ -2155,7 +2140,7 @@ Create a new draft Homebrew/brew release with the appropriate version number and
By default, \fBbrew release\fR will bump the patch version number\. Pass \fB\-\-major\fR or \fB\-\-minor\fR to bump the major or minor version numbers, respectively\. The command will fail if the previous major or minor release was made less than one month ago\. By default, \fBbrew release\fR will bump the patch version number\. Pass \fB\-\-major\fR or \fB\-\-minor\fR to bump the major or minor version numbers, respectively\. The command will fail if the previous major or minor release was made less than one month ago\.
. .
.P .P
Requires write access to the Homebrew/brew repository\. \fINote:\fR Requires write access to the Homebrew/brew repository\.
. .
.TP .TP
\fB\-\-major\fR \fB\-\-major\fR
@ -2443,7 +2428,7 @@ Update the specified list of vendored gems to the latest version\.
Do not generate a new commit upon completion\. Do not generate a new commit upon completion\.
. .
.SH "GLOBAL CASK OPTIONS" .SH "GLOBAL CASK OPTIONS"
These options are applicable to the \fBinstall\fR, \fBreinstall\fR, and \fBupgrade\fR subcommands with the \fB\-\-cask\fR flag\. These options are applicable to the \fBinstall\fR, \fBreinstall\fR, and \fBupgrade\fR subcommands with the \fB\-\-cask\fR switch\.
. .
.TP .TP
\fB\-\-appdir\fR \fB\-\-appdir\fR
@ -3395,7 +3380,7 @@ If set, do not use the GitHub API, e\.g\. for searches or fetching relevant issu
If set, forbid redirects from secure HTTPS to insecure HTTP\. If set, forbid redirects from secure HTTPS to insecure HTTP\.
. .
.IP .IP
\fINote:\fR While ensuring your downloads are fully secure, this is likely to cause from\-source SourceForge, some GNU & GNOME\-hosted formulae to fail to download\. \fINote:\fR while ensuring your downloads are fully secure, this is likely to cause from\-source SourceForge, some GNU & GNOME\-hosted formulae to fail to download\.
. .
.TP .TP
\fBHOMEBREW_NO_INSTALL_CLEANUP\fR \fBHOMEBREW_NO_INSTALL_CLEANUP\fR
@ -3413,7 +3398,7 @@ If set, do not install formulae and casks in homebrew/core and homebrew/cask tap
\fBHOMEBREW_NO_INSTALL_UPGRADE\fR \fBHOMEBREW_NO_INSTALL_UPGRADE\fR
. .
.br .br
If set, \fBbrew install\fR <formula/cask> will not upgrade <formula/cask> if it is installed but outdated\. If set, \fBbrew install\fR \fIformula|cask\fR will not upgrade \fIformula|cask\fR if it is installed but outdated\.
. .
.TP .TP
\fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fR \fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fR
@ -3431,7 +3416,7 @@ If set, \fBbrew update\fR will not show the list of newly added formulae/casks\.
\fBHOMEBREW_PIP_INDEX_URL\fR \fBHOMEBREW_PIP_INDEX_URL\fR
. .
.br .br
If set, \fBbrew install <formula>\fR will use this URL to download PyPI package resources\. If set, \fBbrew install\fR \fIformula\fR will use this URL to download PyPI package resources\.
. .
.IP .IP
\fIDefault:\fR \fBhttps://pypi\.org/simple\fR\. \fIDefault:\fR \fBhttps://pypi\.org/simple\fR\.
@ -3470,7 +3455,7 @@ If set, enable runtime typechecking using Sorbet\. Set by default for HOMEBREW_D
\fBHOMEBREW_SSH_CONFIG_PATH\fR \fBHOMEBREW_SSH_CONFIG_PATH\fR
. .
.br .br
If set, Homebrew will use the given config file instead of \fB~/\.ssh/config\fR when fetching \fBgit\fR repos over \fBssh\fR\. If set, Homebrew will use the given config file instead of \fB~/\.ssh/config\fR when fetching Git repositories over SSH\.
. .
.IP .IP
\fIDefault:\fR \fB$HOME/\.ssh/config\fR \fIDefault:\fR \fB$HOME/\.ssh/config\fR