admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Manpage: source wording & formatting fixes

Browse Source
This commit is contained in:
Eric Knibbe 2025-06-03 13:01:49 -04:00
parent a29a643c66
commit fe13aac730
No known key found for this signature in database
33 changed files with 211 additions and 192 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -52,6 +52,7 @@ module Homebrew
description: "List files in Homebrew's prefix not installed by Homebrew."
switch "--installed",
description: "Outputs nothing and returns a failing status code if <formula> is not installed."
conflicts "--unbrewed", "--installed"
named_args :formula

8
Library/Homebrew/cmd/bundle.rb
View File

@ -51,15 +51,15 @@ module Homebrew
`brew bundle remove` <name> [...]:
Remove entries that match `name` from your `Brewfile`. Use `--formula`, `--cask`, `--tap`, `--mas`, `--whalebrew` or `--vscode` to remove only entries of the corresponding type. Passing `--formula` also removes matches against formula aliases and old formula names.
`brew bundle exec` [--check] <command>:
`brew bundle exec` [`--check`] <command>:
Run an external command in an isolated build environment based on the `Brewfile` dependencies.
This sanitized build environment ignores unrequested dependencies, which makes sure that things you didn't specify in your `Brewfile` won't get picked up by commands like `bundle install`, `npm install`, etc. It will also add compiler flags which will help with finding keg-only dependencies like `openssl`, `icu4c`, etc.
`brew bundle sh` [--check]:
`brew bundle sh` [`--check`]:
Run your shell in a `brew bundle exec` environment.
`brew bundle env` [--check]:
`brew bundle env` [`--check`]:
Print the environment variables that would be set in a `brew bundle exec` environment.
EOS
flag "--file=",
@ -84,7 +84,7 @@ module Homebrew
description: "`install` runs `brew upgrade` on any of these comma-separated formulae, " \
"even if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set."
switch "--install",
description: "Run `install` before continuing to other operations e.g. `exec`."
description: "Run `install` before continuing to other operations, e.g. `exec`."
switch "--services",
description: "Temporarily start services while running the `exec` or `sh` command.",
env: :bundle_services

1
Library/Homebrew/cmd/help.rb
View File

@ -12,6 +12,7 @@ module Homebrew
Outputs the usage instructions for `brew` <command>.
Equivalent to `brew --help` <command>.
EOS
named_args [:command]
end

4
Library/Homebrew/cmd/install.rb
View File

@ -134,7 +134,9 @@ module Homebrew
end
formula_options
[
[:switch, "--cask", "--casks", { description: "Treat all named arguments as casks." }],
[:switch, "--cask", "--casks", {
description: "Treat all named arguments as casks.",
}],
[:switch, "--[no-]binaries", {
description: "Disable/enable linking of helper executables (default: enabled).",
env: :cask_opts_binaries,

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

@ -54,7 +54,7 @@ module Homebrew
description: "List formulae and/or casks in long format. " \
"Has no effect when a formula or cask name is passed as an argument."
switch "-r",
description: "Reverse the order of the formulae and/or casks sort to list the oldest entries first. " \
description: "Reverse the order of formula and/or cask sorting to list the oldest entries first. " \
"Has no effect when a formula or cask name is passed as an argument."
switch "-t",
description: "Sort formulae and/or casks by time modified, listing most recently modified first. " \

8
Library/Homebrew/cmd/reinstall.rb
View File

@ -44,7 +44,9 @@ module Homebrew
"Print download, install and net install sizes of bottles and dependencies.",
env: :ask
[
[:switch, "--formula", "--formulae", { description: "Treat all named arguments as formulae." }],
[:switch, "--formula", "--formulae", {
description: "Treat all named arguments as formulae.",
}],
[:switch, "-s", "--build-from-source", {
description: "Compile <formula> from source even if a bottle is available.",
}],
@ -74,7 +76,9 @@ module Homebrew
end
formula_options
[
[:switch, "--cask", "--casks", { description: "Treat all named arguments as casks." }],
[:switch, "--cask", "--casks", {
description: "Treat all named arguments as casks.",
}],
[:switch, "--[no-]binaries", {
description: "Disable/enable linking of helper executables (default: enabled).",
env: :cask_opts_binaries,

23
Library/Homebrew/cmd/services.rb
View File

@ -51,15 +51,24 @@ module Homebrew
[`sudo`] `brew services cleanup`:
Remove all unused services.
EOS
flag "--file=", description: "Use the service file from this location to `start` the service."
flag "--sudo-service-user=", description: "When run as root on macOS, run the service(s) as this user."
flag "--max-wait=", description: "Wait at most this many seconds for `stop` to finish stopping a service. " \
flag "--file=",
description: "Use the service file from this location to `start` the service."
flag "--sudo-service-user=",
description: "When run as root on macOS, run the service(s) as this user."
flag "--max-wait=",
description: "Wait at most this many seconds for `stop` to finish stopping a service. " \
"Defaults to 60. Set this to zero (0) seconds to wait indefinitely."
switch "--all", description: "Run <subcommand> on all services."
switch "--json", description: "Output as JSON."
switch "--no-wait", description: "Don't wait for `stop` to finish stopping the service."
switch "--keep", description: "When stopped, don't unregister the service from launching at login (or boot)."
switch "--all",
description: "Run <subcommand> on all services."
switch "--json",
description: "Output as JSON."
switch "--no-wait",
description: "Don't wait for `stop` to finish stopping the service."
switch "--keep",
description: "When stopped, don't unregister the service from launching at login (or boot)."
conflicts "--max-wait=", "--no-wait"
named_args %w[list info run start stop kill restart cleanup]
end

1
Library/Homebrew/cmd/tab.rb
View File

@ -17,7 +17,6 @@ module Homebrew
To prevent removal, mark the formula as installed on request;
to allow removal, mark the formula as not installed on request.
EOS
switch "--installed-on-request",
description: "Mark <installed_formula> or <installed_cask> as installed on request."
switch "--no-installed-on-request",

1
Library/Homebrew/cmd/unalias.rb
View File

@ -11,6 +11,7 @@ module Homebrew
description <<~EOS
Remove aliases.
EOS
named_args :alias, min: 1
end

1
Library/Homebrew/dev-cmd/bump-formula-pr.rb
View File

@ -83,6 +83,7 @@ module Homebrew
description: "Exclude these Python packages when finding resources."
comma_array "--bump-synced=",
hidden: true
conflicts "--dry-run", "--write-only"
conflicts "--no-audit", "--strict"
conflicts "--no-audit", "--online"

1
Library/Homebrew/dev-cmd/cat.rb
View File

@ -13,7 +13,6 @@ module Homebrew
description <<~EOS
Display the source of a <formula> or <cask>.
EOS
switch "--formula", "--formulae",
description: "Treat all named arguments as formulae."
switch "--cask", "--casks",

22
Library/Homebrew/dev-cmd/contributions.rb
View File

@ -15,28 +15,24 @@ module Homebrew
MAX_REPO_COMMITS = 1000
cmd_args do
usage_banner "`contributions` [--user=<email|username>] [<--repositories>`=`] [<--csv>]"
usage_banner "`contributions` [`--user=`] [`--repositories=`] [`--from=`] [`--to=`] [`--csv`]"
description <<~EOS
Summarise contributions to Homebrew repositories.
EOS
comma_array "--user=",
description: "Specify a comma-separated list of GitHub usernames or email addresses to find " \
"contributions from. Omitting this flag searches Homebrew maintainers."
comma_array "--repositories",
description: "Specify a comma-separated list of repositories to search. " \
"Supported repositories: #{SUPPORTED_REPOS.map { |t| "`#{t}`" }.to_sentence}. " \
"Omitting this flag, or specifying `--repositories=primary`, searches only the " \
"main repositories: brew,core,cask. " \
"Specifying `--repositories=all`, searches all repositories. "
"main repositories: `brew`, `core`, `cask`. " \
"Specifying `--repositories=all` searches all repositories. "
flag "--from=",
description: "Date (ISO-8601 format) to start searching contributions. " \
"Omitting this flag searches the last year."
description: "Date (ISO 8601 format) to start searching contributions. " \
"Omitting this flag searches the past year."
flag "--to=",
description: "Date (ISO-8601 format) to stop searching contributions."
comma_array "--user=",
description: "Specify a comma-separated list of GitHub usernames or email addresses to find " \
"contributions from. Omitting this flag searches maintainers."
description: "Date (ISO 8601 format) to stop searching contributions."
switch "--csv",
description: "Print a CSV of contributions across repositories over the time period."
end

1
Library/Homebrew/dev-cmd/dispatch-build-bottle.rb
View File

@ -35,6 +35,7 @@ module Homebrew
description: "Use Debian Wheezy container for building the bottle on Linux."
conflicts "--linux", "--linux-self-hosted"
named_args :formula, min: 1
end

16
Library/Homebrew/dev-cmd/formula-analytics.rb
View File

@ -17,19 +17,19 @@ module Homebrew
description: "Query from the specified days ago until the present. The default is 30 days."
switch "--install",
description: "Output the number of specifically requested installations or installation as " \
"dependencies of the formula. This is the default."
"dependencies of formulae. This is the default."
switch "--install-on-request",
description: "Output the number of specifically requested installations of formulae."
switch "--cask-install",
description: "Output the number of installations of casks."
switch "--install-on-request",
description: "Output the number of specifically requested installations of the formula."
switch "--build-error",
description: "Output the number of build errors for the formulae."
description: "Output the number of build errors for formulae."
switch "--os-version",
description: "Output OS versions."
description: "Output the number of events by OS name and version."
switch "--homebrew-devcmdrun-developer",
description: "Output devcmdrun/HOMEBREW_DEVELOPER."
description: "Output the number of devcmdrun/HOMEBREW_DEVELOPER events."
switch "--homebrew-os-arch-ci",
description: "Output OS/Architecture/CI."
description: "Output the number of OS/Architecture/CI events."
switch "--homebrew-prefixes",
description: "Output Homebrew prefixes."
switch "--homebrew-versions",
@ -47,10 +47,12 @@ module Homebrew
"Homebrew/homebrew-core formulae."
switch "--setup",
description: "Install the necessary gems, require them and exit without running a query."
conflicts "--install", "--cask-install", "--install-on-request", "--build-error", "--os-version",
"--homebrew-devcmdrun-developer", "--homebrew-os-arch-ci", "--homebrew-prefixes",
"--homebrew-versions", "--brew-command-run", "--brew-command-run-options", "--brew-test-bot-test"
conflicts "--json", "--all-core-formulae-json", "--setup"
named_args :none
end

3
Library/Homebrew/dev-cmd/generate-analytics-api.rb
View File

@ -22,8 +22,7 @@ module Homebrew
cmd_args do
description <<~EOS
Generates analytics API data files for formulae.brew.sh.
Generates analytics API data files for <#{HOMEBREW_API_WWW}>.
The generated files are written to the current directory.
EOS

4
Library/Homebrew/dev-cmd/generate-cask-api.rb
View File

@ -21,8 +21,8 @@ module Homebrew
Generate `homebrew/cask` API data files for <#{HOMEBREW_API_WWW}>.
The generated files are written to the current directory.
EOS
switch "-n", "--dry-run", description: "Generate API data without writing it to files."
switch "-n", "--dry-run",
description: "Generate API data without writing it to files."
named_args :none
end

2
Library/Homebrew/dev-cmd/generate-cask-ci-matrix.rb
View File

@ -28,7 +28,6 @@ module Homebrew
Generate a GitHub Actions matrix for a given pull request URL or list of cask names.
For internal use in Homebrew taps.
EOS
switch "--url",
description: "Treat named argument as a pull request URL."
switch "--cask", "--casks",
@ -45,6 +44,7 @@ module Homebrew
conflicts "--syntax-only", "--new"
named_args [:cask, :url], min: 0
hide_from_man_page!
end

4
Library/Homebrew/dev-cmd/generate-formula-api.rb
View File

@ -20,8 +20,8 @@ module Homebrew
Generate `homebrew/core` API data files for <#{HOMEBREW_API_WWW}>.
The generated files are written to the current directory.
EOS
switch "-n", "--dry-run", description: "Generate API data without writing it to files."
switch "-n", "--dry-run",
description: "Generate API data without writing it to files."
named_args :none
end

1
Library/Homebrew/dev-cmd/generate-man-completions.rb
View File

@ -16,6 +16,7 @@ module Homebrew
description <<~EOS
Generate Homebrew's manpages and shell completions.
EOS
named_args :none
end

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

@ -25,7 +25,7 @@ module Homebrew
switch "--installed",
description: "Check formulae and casks that are currently installed."
switch "--newer-only",
description: "Show the latest version only if it's newer than the formula/cask."
description: "Show the latest version only if it's newer than the current formula or cask version."
switch "--json",
description: "Output information in JSON format."
switch "-r", "--resources",

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

@ -21,6 +21,7 @@ module Homebrew
description: "Create a major release."
switch "--minor",
description: "Create a minor release."
conflicts "--major", "--minor"
named_args :none

1
Library/Homebrew/dev-cmd/tap-new.rb
View File

@ -17,7 +17,6 @@ module Homebrew
description <<~EOS
Generate the template files for a new tap.
EOS
switch "--no-git",
description: "Don't initialize a Git repository for the tap."
flag "--pull-label=",

1
Library/Homebrew/dev-cmd/update-license-data.rb
View File

@ -14,6 +14,7 @@ module Homebrew
description <<~EOS
Update SPDX license data in the Homebrew repository.
EOS
named_args :none
end

1
Library/Homebrew/dev-cmd/vendor-gems.rb
View File

@ -12,7 +12,6 @@ module Homebrew
description <<~EOS
Install and commit Homebrew's vendored gems.
EOS
comma_array "--update",
description: "Update the specified list of vendored gems to the latest version."
switch "--no-commit",

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

@ -29,8 +29,10 @@ module Homebrew
description: "Remove a previously cached version and re-fetch."
switch "-j", "--json",
description: "Return JSON for the attestation data for each bottle."
conflicts "--os", "--bottle-tag"
conflicts "--arch", "--bottle-tag"
named_args [:formula], min: 1
end

12
Library/Homebrew/env_config.rb
View File

@ -55,7 +55,7 @@ module Homebrew
},
HOMEBREW_AUTO_UPDATE_SECS: {
description: "Run `brew update` once every `$HOMEBREW_AUTO_UPDATE_SECS` seconds before some commands, " \
"e.g. `brew install`, `brew upgrade` and `brew tap`. Alternatively, " \
"e.g. `brew install`, `brew upgrade` or `brew tap`. Alternatively, " \
"disable auto-update entirely with `$HOMEBREW_NO_AUTO_UPDATE`.",
default_text: "`86400` (24 hours), `3600` (1 hour) if a developer command has been run " \
"or `300` (5 minutes) if `$HOMEBREW_NO_INSTALL_FROM_API` is set.",
@ -274,17 +274,17 @@ module Homebrew
HOMEBREW_FORMULA_BUILD_NETWORK: {
description: "If set, controls network access to the sandbox for formulae builds. Overrides any " \
"controls set through DSL usage inside formulae. Must be `allow` or `deny`. If no value is " \
"set through this environment variable or DSL usage, the default behavior is `allow`.",
"set through this environment variable or DSL usage, the default behaviour is `allow`.",
},
HOMEBREW_FORMULA_POSTINSTALL_NETWORK: {
description: "If set, controls network access to the sandbox for formulae postinstall. Overrides any " \
"controls set through DSL usage inside formulae. Must be `allow` or `deny`. If no value is " \
"set through this environment variable or DSL usage, the default behavior is `allow`.",
"set through this environment variable or DSL usage, the default behaviour is `allow`.",
},
HOMEBREW_FORMULA_TEST_NETWORK: {
description: "If set, controls network access to the sandbox for formulae test. Overrides any " \
"controls set through DSL usage inside formulae. Must be `allow` or `deny`. If no value is " \
"set through this environment variable or DSL usage, the default behavior is `allow`.",
"set through this environment variable or DSL usage, the default behaviour is `allow`.",
},
HOMEBREW_GITHUB_API_TOKEN: {
description: "Use this personal access token for the GitHub API, for features such as " \
@ -366,7 +366,7 @@ module Homebrew
},
HOMEBREW_NO_AUTO_UPDATE: {
description: "If set, do not automatically update before running some commands, e.g. " \
"`brew install`, `brew upgrade` and `brew tap`. Preferably, " \
"`brew install`, `brew upgrade` or `brew tap`. Preferably, " \
"run this less often by setting `$HOMEBREW_AUTO_UPDATE_SECS` to a value higher than the " \
"default. Note that setting this and e.g. tapping new taps may result in a broken " \
"configuration. Please ensure you always run `brew update` before reporting any issues.",
@ -405,7 +405,7 @@ module Homebrew
HOMEBREW_NO_INSECURE_REDIRECT: {
description: "If set, forbid redirects from secure HTTPS to insecure HTTP." \
"\n\n *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.",
"sources for certain formulae hosted by SourceForge, GNU or GNOME to fail to download.",
boolean: true,
},
HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: {

6
Library/Homebrew/manpages/brew.1.md.erb
View File

@ -36,7 +36,7 @@ Linux distribution without requiring `sudo`.
**cask**
: Homebrew package definition that installs macOS native applications
: Homebrew package definition that installs native applications directly from upstream
**prefix**
@ -186,8 +186,8 @@ User-specific environment files take precedence over prefix-specific files and
prefix-specific files take precedence over system-wide files (unless
`$HOMEBREW_SYSTEM_ENV_TAKES_PRIORITY` is set, see below).
Note that these files do not support shell variable expansion e.g. `$HOME` or
command execution e.g. `$(cat file)`.
Note that these files do not support shell variable expansion (e.g. `$HOME`) or
command execution (e.g. `$(cat file)`).
<%= environment_variables %>

32
completions/fish/brew.fish
View File

@ -515,7 +515,7 @@ __fish_brew_complete_arg 'bundle' -l force -d '`install` runs with `--force`/`--
__fish_brew_complete_arg 'bundle' -l formula -d '`list`, `dump` or `cleanup` Homebrew formula dependencies'
__fish_brew_complete_arg 'bundle' -l global -d 'Read from or write to the `Brewfile` from `$HOMEBREW_BUNDLE_FILE_GLOBAL` (if set), `${XDG_CONFIG_HOME}/homebrew/Brewfile` (if `$XDG_CONFIG_HOME` is set), `~/.homebrew/Brewfile` or `~/.Brewfile` otherwise'
__fish_brew_complete_arg 'bundle' -l help -d 'Show this message'
__fish_brew_complete_arg 'bundle' -l install -d 'Run `install` before continuing to other operations e.g. `exec`'
__fish_brew_complete_arg 'bundle' -l install -d 'Run `install` before continuing to other operations, e.g. `exec`'
__fish_brew_complete_arg 'bundle' -l mas -d '`list` or `dump` Mac App Store dependencies'
__fish_brew_complete_arg 'bundle' -l no-restart -d '`dump` does not add `restart_service` to formula lines'
__fish_brew_complete_arg 'bundle' -l no-upgrade -d '`install` does not run `brew upgrade` on outdated dependencies. `check` does not check for outdated dependencies. Note they may still be upgraded by `brew install` if needed. Enabled by default if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set'
@ -598,12 +598,12 @@ __fish_brew_complete_arg 'config' -l verbose -d 'Make some output more verbose'
__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 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 past year'
__fish_brew_complete_arg 'contributions' -l help -d 'Show this message'
__fish_brew_complete_arg 'contributions' -l quiet -d 'Make some output more quiet'
__fish_brew_complete_arg 'contributions' -l repositories -d 'Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `command-not-found` and `test-bot`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: brew,core,cask. Specifying `--repositories=all`, searches all repositories. '
__fish_brew_complete_arg 'contributions' -l to -d 'Date (ISO-8601 format) to stop searching contributions'
__fish_brew_complete_arg 'contributions' -l user -d 'Specify a comma-separated list of GitHub usernames or email addresses to find contributions from. Omitting this flag searches maintainers'
__fish_brew_complete_arg 'contributions' -l repositories -d 'Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `command-not-found` and `test-bot`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: `brew`, `core`, `cask`. Specifying `--repositories=all` searches all repositories. '
__fish_brew_complete_arg 'contributions' -l to -d 'Date (ISO 8601 format) to stop searching contributions'
__fish_brew_complete_arg 'contributions' -l user -d 'Specify a comma-separated list of GitHub usernames or email addresses to find contributions from. Omitting this flag searches Homebrew maintainers'
__fish_brew_complete_arg 'contributions' -l verbose -d 'Make some output more verbose'
@ -826,19 +826,19 @@ __fish_brew_complete_arg 'formula-analytics' -l all-core-formulae-json -d 'Outpu
__fish_brew_complete_arg 'formula-analytics' -l brew-command-run -d 'Output `brew` commands run'
__fish_brew_complete_arg 'formula-analytics' -l brew-command-run-options -d 'Output `brew` commands run with options'
__fish_brew_complete_arg 'formula-analytics' -l brew-test-bot-test -d 'Output `brew test-bot` steps run'
__fish_brew_complete_arg 'formula-analytics' -l build-error -d 'Output the number of build errors for the formulae'
__fish_brew_complete_arg 'formula-analytics' -l build-error -d 'Output the number of build errors for formulae'
__fish_brew_complete_arg 'formula-analytics' -l cask-install -d 'Output the number of installations of casks'
__fish_brew_complete_arg 'formula-analytics' -l days-ago -d 'Query from the specified days ago until the present. The default is 30 days'
__fish_brew_complete_arg 'formula-analytics' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'formula-analytics' -l help -d 'Show this message'
__fish_brew_complete_arg 'formula-analytics' -l homebrew-devcmdrun-developer -d 'Output devcmdrun/HOMEBREW_DEVELOPER'
__fish_brew_complete_arg 'formula-analytics' -l homebrew-os-arch-ci -d 'Output OS/Architecture/CI'
__fish_brew_complete_arg 'formula-analytics' -l homebrew-devcmdrun-developer -d 'Output the number of devcmdrun/HOMEBREW_DEVELOPER events'
__fish_brew_complete_arg 'formula-analytics' -l homebrew-os-arch-ci -d 'Output the number of OS/Architecture/CI events'
__fish_brew_complete_arg 'formula-analytics' -l homebrew-prefixes -d 'Output Homebrew prefixes'
__fish_brew_complete_arg 'formula-analytics' -l homebrew-versions -d 'Output Homebrew versions'
__fish_brew_complete_arg 'formula-analytics' -l install -d 'Output the number of specifically requested installations or installation as dependencies of the formula. This is the default'
__fish_brew_complete_arg 'formula-analytics' -l install-on-request -d 'Output the number of specifically requested installations of the formula'
__fish_brew_complete_arg 'formula-analytics' -l install -d 'Output the number of specifically requested installations or installation as dependencies of formulae. This is the default'
__fish_brew_complete_arg 'formula-analytics' -l install-on-request -d 'Output the number of specifically requested installations of formulae'
__fish_brew_complete_arg 'formula-analytics' -l json -d 'Output JSON. This is required: plain text support has been removed'
__fish_brew_complete_arg 'formula-analytics' -l os-version -d 'Output OS versions'
__fish_brew_complete_arg 'formula-analytics' -l os-version -d 'Output the number of events by OS name and version'
__fish_brew_complete_arg 'formula-analytics' -l quiet -d 'Make some output more quiet'
__fish_brew_complete_arg 'formula-analytics' -l setup -d 'Install the necessary gems, require them and exit without running a query'
__fish_brew_complete_arg 'formula-analytics' -l verbose -d 'Make some output more verbose'
@ -851,7 +851,7 @@ __fish_brew_complete_arg 'formulae' -l quiet -d 'Make some output more quiet'
__fish_brew_complete_arg 'formulae' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_cmd 'generate-analytics-api' 'Generates analytics API data files for formulae.brew.sh'
__fish_brew_complete_cmd 'generate-analytics-api' 'Generates analytics API data files for https://formulae.brew.sh'
__fish_brew_complete_arg 'generate-analytics-api' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'generate-analytics-api' -l help -d 'Show this message'
__fish_brew_complete_arg 'generate-analytics-api' -l quiet -d 'Make some output more quiet'
@ -1089,7 +1089,7 @@ __fish_brew_complete_arg 'lc' -l full-name -d 'Print formulae and casks with ful
__fish_brew_complete_arg 'lc' -l help -d 'Show this message'
__fish_brew_complete_arg 'lc' -l installed -d 'Check formulae and casks that are currently installed'
__fish_brew_complete_arg 'lc' -l json -d 'Output information in JSON format'
__fish_brew_complete_arg 'lc' -l newer-only -d 'Show the latest version only if it\'s newer than the formula/cask'
__fish_brew_complete_arg 'lc' -l newer-only -d 'Show the latest version only if it\'s newer than the current formula or cask version'
__fish_brew_complete_arg 'lc' -l quiet -d 'Suppress warnings, don\'t print a progress bar for JSON output'
__fish_brew_complete_arg 'lc' -l resources -d 'Also check resources for formulae'
__fish_brew_complete_arg 'lc' -l tap -d 'Check formulae and casks within the given tap, specified as user`/`repo'
@ -1148,7 +1148,7 @@ __fish_brew_complete_arg 'list' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_arg 'list' -l versions -d 'Show the version number for installed formulae, or only the specified formulae if formula are provided'
__fish_brew_complete_arg 'list' -l 1 -d 'Force output to be one entry per line. This is the default when output is not to a terminal'
__fish_brew_complete_arg 'list' -l l -d 'List formulae and/or casks in long format. Has no effect when a formula or cask name is passed as an argument'
__fish_brew_complete_arg 'list' -l r -d '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'
__fish_brew_complete_arg 'list' -l r -d 'Reverse the order of formula and/or cask sorting to list the oldest entries first. Has no effect when a formula or cask name is passed as an argument'
__fish_brew_complete_arg 'list' -l t -d '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'
__fish_brew_complete_arg 'list; and not __fish_seen_argument -l cask -l casks' -a '(__fish_brew_suggest_formulae_installed)'
__fish_brew_complete_arg 'list; and not __fish_seen_argument -l formula -l formulae' -a '(__fish_brew_suggest_casks_installed)'
@ -1165,7 +1165,7 @@ __fish_brew_complete_arg 'livecheck' -l full-name -d 'Print formulae and casks w
__fish_brew_complete_arg 'livecheck' -l help -d 'Show this message'
__fish_brew_complete_arg 'livecheck' -l installed -d 'Check formulae and casks that are currently installed'
__fish_brew_complete_arg 'livecheck' -l json -d 'Output information in JSON format'
__fish_brew_complete_arg 'livecheck' -l newer-only -d 'Show the latest version only if it\'s newer than the formula/cask'
__fish_brew_complete_arg 'livecheck' -l newer-only -d 'Show the latest version only if it\'s newer than the current formula or cask version'
__fish_brew_complete_arg 'livecheck' -l quiet -d 'Suppress warnings, don\'t print a progress bar for JSON output'
__fish_brew_complete_arg 'livecheck' -l resources -d 'Also check resources for formulae'
__fish_brew_complete_arg 'livecheck' -l tap -d 'Check formulae and casks within the given tap, specified as user`/`repo'
@ -1219,7 +1219,7 @@ __fish_brew_complete_arg 'ls' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_arg 'ls' -l versions -d 'Show the version number for installed formulae, or only the specified formulae if formula are provided'
__fish_brew_complete_arg 'ls' -l 1 -d 'Force output to be one entry per line. This is the default when output is not to a terminal'
__fish_brew_complete_arg 'ls' -l l -d 'List formulae and/or casks in long format. Has no effect when a formula or cask name is passed as an argument'
__fish_brew_complete_arg 'ls' -l r -d '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'
__fish_brew_complete_arg 'ls' -l r -d 'Reverse the order of formula and/or cask sorting to list the oldest entries first. Has no effect when a formula or cask name is passed as an argument'
__fish_brew_complete_arg 'ls' -l t -d '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'
__fish_brew_complete_arg 'ls; and not __fish_seen_argument -l cask -l casks' -a '(__fish_brew_suggest_formulae_installed)'
__fish_brew_complete_arg 'ls; and not __fish_seen_argument -l formula -l formulae' -a '(__fish_brew_suggest_casks_installed)'

32
completions/zsh/_brew
View File

@ -173,7 +173,7 @@ __brew_internal_commands() {
'formula:Display the path where formula is located'
'formula-analytics:Query Homebrew'\''s analytics'
'formulae:List all locally installable formulae including short names'
'generate-analytics-api:Generates analytics API data files for formulae.brew.sh'
'generate-analytics-api:Generates analytics API data files for https://formulae.brew.sh'
'generate-cask-api:Generate `homebrew/cask` API data files for https://formulae.brew.sh'
'generate-cask-ci-matrix:Generate a GitHub Actions matrix for a given pull request URL or list of cask names'
'generate-formula-api:Generate `homebrew/core` API data files for https://formulae.brew.sh'
@ -660,7 +660,7 @@ _brew_bundle() {
'--formula[`list`, `dump` or `cleanup` Homebrew formula dependencies]' \
'(--file)--global[Read from or write to the `Brewfile` from `$HOMEBREW_BUNDLE_FILE_GLOBAL` (if set), `${XDG_CONFIG_HOME}/homebrew/Brewfile` (if `$XDG_CONFIG_HOME` is set), `~/.homebrew/Brewfile` or `~/.Brewfile` otherwise]' \
'--help[Show this message]' \
'(--upgrade)--install[Run `install` before continuing to other operations e.g. `exec`]' \
'(--upgrade)--install[Run `install` before continuing to other operations, e.g. `exec`]' \
'--mas[`list` or `dump` Mac App Store dependencies]' \
'--no-restart[`dump` does not add `restart_service` to formula lines]' \
'--no-upgrade[`install` does not run `brew upgrade` on outdated dependencies. `check` does not check for outdated dependencies. Note they may still be upgraded by `brew install` if needed. Enabled by default if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set]' \
@ -765,12 +765,12 @@ _brew_contributions() {
_arguments \
'--csv[Print a CSV of contributions across repositories over the time period]' \
'--debug[Display any debugging information]' \
'--from[Date (ISO-8601 format) to start searching contributions. Omitting this flag searches the last year]' \
'--from[Date (ISO 8601 format) to start searching contributions. Omitting this flag searches the past year]' \
'--help[Show this message]' \
'--quiet[Make some output more quiet]' \
'--repositories[Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `command-not-found` and `test-bot`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: brew,core,cask. Specifying `--repositories=all`, searches all repositories. ]' \
'--to[Date (ISO-8601 format) to stop searching contributions]' \
'--user[Specify a comma-separated list of GitHub usernames or email addresses to find contributions from. Omitting this flag searches maintainers]' \
'--repositories[Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `command-not-found` and `test-bot`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: `brew`, `core`, `cask`. Specifying `--repositories=all` searches all repositories. ]' \
'--to[Date (ISO 8601 format) to stop searching contributions]' \
'--user[Specify a comma-separated list of GitHub usernames or email addresses to find contributions from. Omitting this flag searches Homebrew maintainers]' \
'--verbose[Make some output more verbose]'
}
@ -1041,19 +1041,19 @@ _brew_formula_analytics() {
'(--install --cask-install --install-on-request --build-error --os-version --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run-options --brew-test-bot-test)--brew-command-run[Output `brew` commands run]' \
'(--install --cask-install --install-on-request --build-error --os-version --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-test-bot-test)--brew-command-run-options[Output `brew` commands run with options]' \
'(--install --cask-install --install-on-request --build-error --os-version --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options)--brew-test-bot-test[Output `brew test-bot` steps run]' \
'(--install --cask-install --install-on-request --os-version --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--build-error[Output the number of build errors for the formulae]' \
'(--install --cask-install --install-on-request --os-version --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--build-error[Output the number of build errors for formulae]' \
'(--install --install-on-request --build-error --os-version --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--cask-install[Output the number of installations of casks]' \
'--days-ago[Query from the specified days ago until the present. The default is 30 days]' \
'--debug[Display any debugging information]' \
'--help[Show this message]' \
'(--install --cask-install --install-on-request --build-error --os-version --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--homebrew-devcmdrun-developer[Output devcmdrun/HOMEBREW_DEVELOPER]' \
'(--install --cask-install --install-on-request --build-error --os-version --homebrew-devcmdrun-developer --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--homebrew-os-arch-ci[Output OS/Architecture/CI]' \
'(--install --cask-install --install-on-request --build-error --os-version --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--homebrew-devcmdrun-developer[Output the number of devcmdrun/HOMEBREW_DEVELOPER events]' \
'(--install --cask-install --install-on-request --build-error --os-version --homebrew-devcmdrun-developer --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--homebrew-os-arch-ci[Output the number of OS/Architecture/CI events]' \
'(--install --cask-install --install-on-request --build-error --os-version --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--homebrew-prefixes[Output Homebrew prefixes]' \
'(--install --cask-install --install-on-request --build-error --os-version --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --brew-command-run --brew-command-run-options --brew-test-bot-test)--homebrew-versions[Output Homebrew versions]' \
'(--cask-install --install-on-request --build-error --os-version --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--install[Output the number of specifically requested installations or installation as dependencies of the formula. This is the default]' \
'(--install --cask-install --build-error --os-version --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--install-on-request[Output the number of specifically requested installations of the formula]' \
'(--cask-install --install-on-request --build-error --os-version --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--install[Output the number of specifically requested installations or installation as dependencies of formulae. This is the default]' \
'(--install --cask-install --build-error --os-version --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--install-on-request[Output the number of specifically requested installations of formulae]' \
'(--all-core-formulae-json --setup)--json[Output JSON. This is required: plain text support has been removed]' \
'(--install --cask-install --install-on-request --build-error --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--os-version[Output OS versions]' \
'(--install --cask-install --install-on-request --build-error --homebrew-devcmdrun-developer --homebrew-os-arch-ci --homebrew-prefixes --homebrew-versions --brew-command-run --brew-command-run-options --brew-test-bot-test)--os-version[Output the number of events by OS name and version]' \
'--quiet[Make some output more quiet]' \
'(--json --all-core-formulae-json)--setup[Install the necessary gems, require them and exit without running a query]' \
'--verbose[Make some output more verbose]'
@ -1345,7 +1345,7 @@ _brew_lc() {
'--help[Show this message]' \
'(--tap --eval-all)--installed[Check formulae and casks that are currently installed]' \
'(--debug)--json[Output information in JSON format]' \
'--newer-only[Show the latest version only if it'\''s newer than the formula/cask]' \
'--newer-only[Show the latest version only if it'\''s newer than the current formula or cask version]' \
'--quiet[Suppress warnings, don'\''t print a progress bar for JSON output]' \
'--resources[Also check resources for formulae]' \
'(--eval-all --installed)--tap[Check formulae and casks within the given tap, specified as user`/`repo]' \
@ -1416,7 +1416,7 @@ _brew_list() {
'(--installed-on-request --installed-as-dependency --poured-from-bottle --built-from-source -1 -l -r -t --full-name)--versions[Show the version number for installed formulae, or only the specified formulae if formula are provided]' \
'(--versions --pinned)-1[Force output to be one entry per line. This is the default when output is not to a terminal]' \
'(--installed-on-request --installed-as-dependency --poured-from-bottle --built-from-source --versions --pinned --full-name)-l[List formulae and/or casks in long format. Has no effect when a formula or cask name is passed as an argument]' \
'(--versions --pinned --full-name)-r[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]' \
'(--versions --pinned --full-name)-r[Reverse the order of formula and/or cask sorting to list the oldest entries first. Has no effect when a formula or cask name is passed as an argument]' \
'(--versions --pinned --full-name)-t[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]' \
- installed_formula \
'(--cask)--formula[List only formulae, or treat all named arguments as formulae]' \
@ -1437,7 +1437,7 @@ _brew_livecheck() {
'--help[Show this message]' \
'(--tap --eval-all)--installed[Check formulae and casks that are currently installed]' \
'(--debug)--json[Output information in JSON format]' \
'--newer-only[Show the latest version only if it'\''s newer than the formula/cask]' \
'--newer-only[Show the latest version only if it'\''s newer than the current formula or cask version]' \
'--quiet[Suppress warnings, don'\''t print a progress bar for JSON output]' \
'--resources[Also check resources for formulae]' \
'(--eval-all --installed)--tap[Check formulae and casks within the given tap, specified as user`/`repo]' \
@ -1502,7 +1502,7 @@ _brew_ls() {
'(--installed-on-request --installed-as-dependency --poured-from-bottle --built-from-source -1 -l -r -t --full-name)--versions[Show the version number for installed formulae, or only the specified formulae if formula are provided]' \
'(--versions --pinned)-1[Force output to be one entry per line. This is the default when output is not to a terminal]' \
'(--installed-on-request --installed-as-dependency --poured-from-bottle --built-from-source --versions --pinned --full-name)-l[List formulae and/or casks in long format. Has no effect when a formula or cask name is passed as an argument]' \
'(--versions --pinned --full-name)-r[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]' \
'(--versions --pinned --full-name)-r[Reverse the order of formula and/or cask sorting to list the oldest entries first. Has no effect when a formula or cask name is passed as an argument]' \
'(--versions --pinned --full-name)-t[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]' \
- installed_formula \
'(--cask)--formula[List only formulae, or treat all named arguments as formulae]' \

79
docs/Manpage.md
View File

@ -19,7 +19,8 @@ Linux distribution without requiring `sudo`.
**cask**
: Homebrew package definition that installs macOS native applications
: Homebrew package definition that installs native applications directly from
upstream
**prefix**
@ -199,7 +200,7 @@ By default, only Homebrew formula dependencies are listed.
of the corresponding type. Passing `--formula` also removes matches against
formula aliases and old formula names.
`brew bundle exec` \[--check\] *`command`*
`brew bundle exec` \[`--check`\] *`command`*
: Run an external command in an isolated build environment based on the
`Brewfile` dependencies.
@ -210,11 +211,11 @@ commands like `bundle install`, `npm install`, etc. It will also add compiler
flags which will help with finding keg-only dependencies like `openssl`,
`icu4c`, etc.
`brew bundle sh` \[--check\]
`brew bundle sh` \[`--check`\]
: Run your shell in a `brew bundle exec` environment.
`brew bundle env` \[--check\]
`brew bundle env` \[`--check`\]
: Print the environment variables that would be set in a `brew bundle exec`
environment.
@ -254,7 +255,7 @@ flags which will help with finding keg-only dependencies like `openssl`,
`--install`
: Run `install` before continuing to other operations e.g. `exec`.
: Run `install` before continuing to other operations, e.g. `exec`.
`--services`
@ -1010,7 +1011,7 @@ paths within its current keg. If *`cask`* is provided, list its artifacts.
`-r`
: Reverse the order of the formulae and/or casks sort to list the oldest entries
: Reverse the order of formula and/or cask sorting to list the oldest entries
first. Has no effect when a formula or cask name is passed as an argument.
`-t`
@ -2394,31 +2395,31 @@ Display the source of a *`formula`* or *`cask`*.
: Treat all named arguments as casks.
### `contributions` \[--user=*`email|username`*\] \[*`--repositories`*`=`\] \[*`--csv`*\]
### `contributions` \[`--user=`\] \[`--repositories=`\] \[`--from=`\] \[`--to=`\] \[`--csv`\]
Summarise contributions to Homebrew repositories.
`--user`
: Specify a comma-separated list of GitHub usernames or email addresses to find
contributions from. Omitting this flag searches Homebrew maintainers.
`--repositories`
: Specify a comma-separated list of repositories to search. Supported
repositories: `brew`, `core`, `cask`, `command-not-found` and `test-bot`.
Omitting this flag, or specifying `--repositories=primary`, searches only the
main repositories: brew,core,cask. Specifying `--repositories=all`, searches
all repositories.
main repositories: `brew`, `core`, `cask`. Specifying `--repositories=all`
searches all repositories.
`--from`
: Date (ISO-8601 format) to start searching contributions. Omitting this flag
searches the last year.
: Date (ISO 8601 format) to start searching contributions. Omitting this flag
searches the past year.
`--to`
: Date (ISO-8601 format) to stop searching contributions.
`--user`
: Specify a comma-separated list of GitHub usernames or email addresses to find
contributions from. Omitting this flag searches maintainers.
: Date (ISO 8601 format) to stop searching contributions.
`--csv`
@ -2626,31 +2627,31 @@ Query Homebrew's analytics.
`--install`
: Output the number of specifically requested installations or installation as
dependencies of the formula. This is the default.
dependencies of formulae. This is the default.
`--install-on-request`
: Output the number of specifically requested installations of formulae.
`--cask-install`
: Output the number of installations of casks.
`--install-on-request`
: Output the number of specifically requested installations of the formula.
`--build-error`
: Output the number of build errors for the formulae.
: Output the number of build errors for formulae.
`--os-version`
: Output OS versions.
: Output the number of events by OS name and version.
`--homebrew-devcmdrun-developer`
: Output devcmdrun/HOMEBREW\_DEVELOPER.
: Output the number of devcmdrun/HOMEBREW\_DEVELOPER events.
`--homebrew-os-arch-ci`
: Output OS/Architecture/CI.
: Output the number of OS/Architecture/CI events.
`--homebrew-prefixes`
@ -2687,9 +2688,8 @@ Query Homebrew's analytics.
### `generate-analytics-api`
Generates analytics API data files for formulae.brew.sh.
The generated files are written to the current directory.
Generates analytics API data files for <https://formulae.brew.sh>. The generated
files are written to the current directory.
### `generate-cask-api` \[`--dry-run`\]
@ -2790,7 +2790,8 @@ from `$HOMEBREW_LIVECHECK_WATCHLIST` or `~/.homebrew/livecheck_watchlist.txt`.
`--newer-only`
: Show the latest version only if it's newer than the formula/cask.
: Show the latest version only if it's newer than the current formula or cask
version.
`--json`
@ -3833,8 +3834,8 @@ User-specific environment files take precedence over prefix-specific files and
prefix-specific files take precedence over system-wide files (unless
`$HOMEBREW_SYSTEM_ENV_TAKES_PRIORITY` is set, see below).
Note that these files do not support shell variable expansion e.g. `$HOME` or
command execution e.g. `$(cat file)`.
Note that these files do not support shell variable expansion (e.g. `$HOME`) or
command execution (e.g. `$(cat file)`).
`HOMEBREW_ALLOWED_TAPS`
@ -3890,7 +3891,7 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_AUTO_UPDATE_SECS`
: Run `brew update` once every `$HOMEBREW_AUTO_UPDATE_SECS` seconds before some
commands, e.g. `brew install`, `brew upgrade` and `brew tap`. Alternatively,
commands, e.g. `brew install`, `brew upgrade` or `brew tap`. Alternatively,
disable auto-update entirely with `$HOMEBREW_NO_AUTO_UPDATE`.
*Default:* `86400` (24 hours), `3600` (1 hour) if a developer command has been
@ -4158,21 +4159,21 @@ command execution e.g. `$(cat file)`.
: If set, controls network access to the sandbox for formulae builds. Overrides
any controls set through DSL usage inside formulae. Must be `allow` or `deny`.
If no value is set through this environment variable or DSL usage, the default
behavior is `allow`.
behaviour is `allow`.
`HOMEBREW_FORMULA_POSTINSTALL_NETWORK`
: If set, controls network access to the sandbox for formulae postinstall.
Overrides any controls set through DSL usage inside formulae. Must be `allow`
or `deny`. If no value is set through this environment variable or DSL usage,
the default behavior is `allow`.
the default behaviour is `allow`.
`HOMEBREW_FORMULA_TEST_NETWORK`
: If set, controls network access to the sandbox for formulae test. Overrides
any controls set through DSL usage inside formulae. Must be `allow` or `deny`.
If no value is set through this environment variable or DSL usage, the default
behavior is `allow`.
behaviour is `allow`.
`HOMEBREW_GITHUB_API_TOKEN`
@ -4270,7 +4271,7 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_NO_AUTO_UPDATE`
: If set, do not automatically update before running some commands, e.g. `brew
install`, `brew upgrade` and `brew tap`. Preferably, run this less often by
install`, `brew upgrade` or `brew tap`. Preferably, run this less often by
setting `$HOMEBREW_AUTO_UPDATE_SECS` to a value higher than the default. Note
that setting this and e.g. tapping new taps may result in a broken
configuration. Please ensure you always run `brew update` before reporting any
@ -4314,8 +4315,8 @@ command execution e.g. `$(cat file)`.
: 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.
cause sources for certain formulae hosted by SourceForge, GNU or GNOME to fail
to download.
`HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK`

64
manpages/brew.1
View File

@ -14,7 +14,7 @@ Homebrew is the easiest and most flexible way to install the UNIX tools Apple di
Homebrew package definition that builds from upstream sources
.TP
\fBcask\fP
Homebrew package definition that installs macOS native applications
Homebrew package definition that installs native applications directly from upstream
.TP
\fBprefix\fP
path in which Homebrew is installed, e\.g\. \fB/opt/homebrew\fP or \fB/home/linuxbrew/\.linuxbrew\fP
@ -124,15 +124,15 @@ Add entries to your \fBBrewfile\fP\&\. Adds formulae by default\. Use \fB\-\-cas
\fBbrew bundle remove\fP \fIname\fP [\.\.\.]
Remove entries that match \fBname\fP from your \fBBrewfile\fP\&\. Use \fB\-\-formula\fP, \fB\-\-cask\fP, \fB\-\-tap\fP, \fB\-\-mas\fP, \fB\-\-whalebrew\fP or \fB\-\-vscode\fP to remove only entries of the corresponding type\. Passing \fB\-\-formula\fP also removes matches against formula aliases and old formula names\.
.TP
\fBbrew bundle exec\fP [\-\-check] \fIcommand\fP
\fBbrew bundle exec\fP [\fB\-\-check\fP] \fIcommand\fP
Run an external command in an isolated build environment based on the \fBBrewfile\fP dependencies\.
.P
This sanitized build environment ignores unrequested dependencies, which makes sure that things you didn\[u2019]t specify in your \fBBrewfile\fP won\[u2019]t get picked up by commands like \fBbundle install\fP, \fBnpm install\fP, etc\. It will also add compiler flags which will help with finding keg\-only dependencies like \fBopenssl\fP, \fBicu4c\fP, etc\.
.TP
\fBbrew bundle sh\fP [\-\-check]
\fBbrew bundle sh\fP [\fB\-\-check\fP]
Run your shell in a \fBbrew bundle exec\fP environment\.
.TP
\fBbrew bundle env\fP [\-\-check]
\fBbrew bundle env\fP [\fB\-\-check\fP]
Print the environment variables that would be set in a \fBbrew bundle exec\fP environment\.
.TP
\fB\-\-file\fP
@ -154,7 +154,7 @@ Read from or write to the \fBBrewfile\fP from \fB$HOMEBREW_BUNDLE_FILE_GLOBAL\fP
\fBinstall\fP runs \fBbrew upgrade\fP on any of these comma\-separated formulae, even if \fB$HOMEBREW_BUNDLE_NO_UPGRADE\fP is set\.
.TP
\fB\-\-install\fP
Run \fBinstall\fP before continuing to other operations e\.g\. \fBexec\fP\&\.
Run \fBinstall\fP before continuing to other operations, e\.g\. \fBexec\fP\&\.
.TP
\fB\-\-services\fP
Temporarily start services while running the \fBexec\fP or \fBsh\fP command\. Enabled by default if \fB$HOMEBREW_BUNDLE_SERVICES\fP is set\.
@ -629,7 +629,7 @@ Force output to be one entry per line\. This is the default when output is not t
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\fP
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\.
Reverse the order of formula and/or cask sorting to list the oldest entries first\. Has no effect when a formula or cask name is passed as an argument\.
.TP
\fB\-t\fP
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\.
@ -1502,20 +1502,20 @@ Treat all named arguments as formulae\.
.TP
\fB\-\-cask\fP
Treat all named arguments as casks\.
.SS "\fBcontributions\fP \fR[\-\-user=\fIemail|username\fP] \fR[\fI\-\-repositories\fP\fB=\fP] \fR[\fI\-\-csv\fP]"
.SS "\fBcontributions\fP \fR[\fB\-\-user=\fP] \fR[\fB\-\-repositories=\fP] \fR[\fB\-\-from=\fP] \fR[\fB\-\-to=\fP] \fR[\fB\-\-csv\fP]"
Summarise contributions to Homebrew repositories\.
.TP
\fB\-\-user\fP
Specify a comma\-separated list of GitHub usernames or email addresses to find contributions from\. Omitting this flag searches Homebrew maintainers\.
.TP
\fB\-\-repositories\fP
Specify a comma\-separated list of repositories to search\. Supported repositories: \fBbrew\fP, \fBcore\fP, \fBcask\fP, \fBcommand\-not\-found\fP and \fBtest\-bot\fP\&\. Omitting this flag, or specifying \fB\-\-repositories=primary\fP, searches only the main repositories: brew,core,cask\. Specifying \fB\-\-repositories=all\fP, searches all repositories\.
Specify a comma\-separated list of repositories to search\. Supported repositories: \fBbrew\fP, \fBcore\fP, \fBcask\fP, \fBcommand\-not\-found\fP and \fBtest\-bot\fP\&\. Omitting this flag, or specifying \fB\-\-repositories=primary\fP, searches only the main repositories: \fBbrew\fP, \fBcore\fP, \fBcask\fP\&\. Specifying \fB\-\-repositories=all\fP searches all repositories\.
.TP
\fB\-\-from\fP
Date (ISO\-8601 format) to start searching contributions\. Omitting this flag searches the last year\.
Date (ISO 8601 format) to start searching contributions\. Omitting this flag searches the past year\.
.TP
\fB\-\-to\fP
Date (ISO\-8601 format) to stop searching contributions\.
.TP
\fB\-\-user\fP
Specify a comma\-separated list of GitHub usernames or email addresses to find contributions from\. Omitting this flag searches maintainers\.
Date (ISO 8601 format) to stop searching contributions\.
.TP
\fB\-\-csv\fP
Print a CSV of contributions across repositories over the time period\.
@ -1653,25 +1653,25 @@ Query Homebrew\[u2019]s analytics\.
Query from the specified days ago until the present\. The default is 30 days\.
.TP
\fB\-\-install\fP
Output the number of specifically requested installations or installation as dependencies of the formula\. This is the default\.
Output the number of specifically requested installations or installation as dependencies of formulae\. This is the default\.
.TP
\fB\-\-install\-on\-request\fP
Output the number of specifically requested installations of formulae\.
.TP
\fB\-\-cask\-install\fP
Output the number of installations of casks\.
.TP
\fB\-\-install\-on\-request\fP
Output the number of specifically requested installations of the formula\.
.TP
\fB\-\-build\-error\fP
Output the number of build errors for the formulae\.
Output the number of build errors for formulae\.
.TP
\fB\-\-os\-version\fP
Output OS versions\.
Output the number of events by OS name and version\.
.TP
\fB\-\-homebrew\-devcmdrun\-developer\fP
Output devcmdrun/HOMEBREW_DEVELOPER\.
Output the number of devcmdrun/HOMEBREW_DEVELOPER events\.
.TP
\fB\-\-homebrew\-os\-arch\-ci\fP
Output OS/Architecture/CI\.
Output the number of OS/Architecture/CI events\.
.TP
\fB\-\-homebrew\-prefixes\fP
Output Homebrew prefixes\.
@ -1697,9 +1697,9 @@ Output a different JSON format containing the JSON data for all Homebrew/homebre
\fB\-\-setup\fP
Install the necessary gems, require them and exit without running a query\.
.SS "\fBgenerate\-analytics\-api\fP"
Generates analytics API data files for formulae\.brew\.sh\.
.P
The generated files are written to the current directory\.
Generates analytics API data files for
.UR https://formulae\.brew\.sh
.UE \&\. The generated files are written to the current directory\.
.SS "\fBgenerate\-cask\-api\fP \fR[\fB\-\-dry\-run\fP]"
Generate \fBhomebrew/cask\fP API data files for
.UR https://formulae\.brew\.sh
@ -1762,7 +1762,7 @@ Evaluate all available formulae and casks, whether installed or not, to check th
Check formulae and casks that are currently installed\.
.TP
\fB\-\-newer\-only\fP
Show the latest version only if it\[u2019]s newer than the formula/cask\.
Show the latest version only if it\[u2019]s newer than the current formula or cask version\.
.TP
\fB\-\-json\fP
Output information in JSON format\.
@ -2448,7 +2448,7 @@ Note that environment variables must have a value set to be detected\. For examp
.P
User\-specific environment files take precedence over prefix\-specific files and prefix\-specific files take precedence over system\-wide files (unless \fB$HOMEBREW_SYSTEM_ENV_TAKES_PRIORITY\fP is set, see below)\.
.P
Note that these files do not support shell variable expansion e\.g\. \fB$HOME\fP or command execution e\.g\. \fB$(cat file)\fP\&\.
Note that these files do not support shell variable expansion (e\.g\. \fB$HOME\fP) or command execution (e\.g\. \fB$(cat file)\fP)\.
.TP
\fBHOMEBREW_ALLOWED_TAPS\fP
A space\-separated list of taps\. Homebrew will refuse to install a formula unless it and all of its dependencies are in an official tap or in a tap on this list\.
@ -2484,7 +2484,7 @@ When \fB$HOMEBREW_ARTIFACT_DOMAIN\fP and \fB$HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBAC
If set, pass \fB\-\-ask\fP to all formulae \fBbrew install\fP, \fBbrew upgrade\fP and \fBbrew reinstall\fP commands\.
.TP
\fBHOMEBREW_AUTO_UPDATE_SECS\fP
Run \fBbrew update\fP once every \fB$HOMEBREW_AUTO_UPDATE_SECS\fP seconds before some commands, e\.g\. \fBbrew install\fP, \fBbrew upgrade\fP and \fBbrew tap\fP\&\. Alternatively, disable auto\-update entirely with \fB$HOMEBREW_NO_AUTO_UPDATE\fP\&\.
Run \fBbrew update\fP once every \fB$HOMEBREW_AUTO_UPDATE_SECS\fP seconds before some commands, e\.g\. \fBbrew install\fP, \fBbrew upgrade\fP or \fBbrew tap\fP\&\. Alternatively, disable auto\-update entirely with \fB$HOMEBREW_NO_AUTO_UPDATE\fP\&\.
.RS
.P
\fIDefault:\fP \fB86400\fP (24 hours), \fB3600\fP (1 hour) if a developer command has been run or \fB300\fP (5 minutes) if \fB$HOMEBREW_NO_INSTALL_FROM_API\fP is set\.
@ -2696,13 +2696,13 @@ If set, require \fB$HOMEBREW_BREW_WRAPPER\fP to be set to the same value as \fB$
If set, always use Homebrew\[u2019]s vendored, relocatable Ruby version even if the system version of Ruby is new enough\.
.TP
\fBHOMEBREW_FORMULA_BUILD_NETWORK\fP
If set, controls network access to the sandbox for formulae builds\. Overrides any controls set through DSL usage inside formulae\. Must be \fBallow\fP or \fBdeny\fP\&\. If no value is set through this environment variable or DSL usage, the default behavior is \fBallow\fP\&\.
If set, controls network access to the sandbox for formulae builds\. Overrides any controls set through DSL usage inside formulae\. Must be \fBallow\fP or \fBdeny\fP\&\. If no value is set through this environment variable or DSL usage, the default behaviour is \fBallow\fP\&\.
.TP
\fBHOMEBREW_FORMULA_POSTINSTALL_NETWORK\fP
If set, controls network access to the sandbox for formulae postinstall\. Overrides any controls set through DSL usage inside formulae\. Must be \fBallow\fP or \fBdeny\fP\&\. If no value is set through this environment variable or DSL usage, the default behavior is \fBallow\fP\&\.
If set, controls network access to the sandbox for formulae postinstall\. Overrides any controls set through DSL usage inside formulae\. Must be \fBallow\fP or \fBdeny\fP\&\. If no value is set through this environment variable or DSL usage, the default behaviour is \fBallow\fP\&\.
.TP
\fBHOMEBREW_FORMULA_TEST_NETWORK\fP
If set, controls network access to the sandbox for formulae test\. Overrides any controls set through DSL usage inside formulae\. Must be \fBallow\fP or \fBdeny\fP\&\. If no value is set through this environment variable or DSL usage, the default behavior is \fBallow\fP\&\.
If set, controls network access to the sandbox for formulae test\. Overrides any controls set through DSL usage inside formulae\. Must be \fBallow\fP or \fBdeny\fP\&\. If no value is set through this environment variable or DSL usage, the default behaviour is \fBallow\fP\&\.
.TP
\fBHOMEBREW_GITHUB_API_TOKEN\fP
Use this personal access token for the GitHub API, for features such as \fBbrew search\fP\&\. You can create one at
@ -2783,7 +2783,7 @@ If set, do not send analytics\. Google Analytics were destroyed\. For more infor
If set, calls to \fBbrew cleanup\fP and \fBbrew uninstall\fP will not automatically remove unused formula dependents\.
.TP
\fBHOMEBREW_NO_AUTO_UPDATE\fP
If set, do not automatically update before running some commands, e\.g\. \fBbrew install\fP, \fBbrew upgrade\fP and \fBbrew tap\fP\&\. Preferably, run this less often by setting \fB$HOMEBREW_AUTO_UPDATE_SECS\fP to a value higher than the default\. Note that setting this and e\.g\. tapping new taps may result in a broken configuration\. Please ensure you always run \fBbrew update\fP before reporting any issues\.
If set, do not automatically update before running some commands, e\.g\. \fBbrew install\fP, \fBbrew upgrade\fP or \fBbrew tap\fP\&\. Preferably, run this less often by setting \fB$HOMEBREW_AUTO_UPDATE_SECS\fP to a value higher than the default\. Note that setting this and e\.g\. tapping new taps may result in a broken configuration\. Please ensure you always run \fBbrew update\fP before reporting any issues\.
.TP
\fBHOMEBREW_NO_BOOTSNAP\fP
If set, do not use Bootsnap to speed up repeated \fBbrew\fP calls\.
@ -2814,7 +2814,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\.
.RS
.P
\fINote:\fP 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:\fP while ensuring your downloads are fully secure, this is likely to cause sources for certain formulae hosted by SourceForge, GNU or GNOME to fail to download\.
.RE
.TP
\fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fP