diff --git a/Library/Homebrew/brew.rb b/Library/Homebrew/brew.rb index 19aa38b31a..92308c66e4 100644 --- a/Library/Homebrew/brew.rb +++ b/Library/Homebrew/brew.rb @@ -180,7 +180,7 @@ rescue RuntimeError, SystemCallError => e rescue MethodDeprecatedError => e onoe e if e.issues_url - $stderr.puts "If reporting this issue please do so at (not Homebrew/brew or Homebrew/core):" + $stderr.puts "If reporting this issue please do so at (not Homebrew/brew or Homebrew/homebrew-core):" $stderr.puts " #{Formatter.url(e.issues_url)}" end $stderr.puts e.backtrace if args.debug? diff --git a/Library/Homebrew/brew.sh b/Library/Homebrew/brew.sh index f71b24b182..1b7850fb6f 100644 --- a/Library/Homebrew/brew.sh +++ b/Library/Homebrew/brew.sh @@ -1,6 +1,6 @@ ##### -##### First do the essential, fast things to be able to make e.g. brew --prefix and other commands we want to be -##### able to `source` in shell configuration quick. +##### First do the essential, fast things to ensure commands like `brew --prefix` and others that we want +##### to be able to `source` in shell configurations run quickly. ##### # Doesn't need a default case because we don't support other OSs @@ -202,9 +202,9 @@ check-prefix-is-not-tmpdir() { then odie </dev/null diff --git a/Library/Homebrew/cli/named_args.rb b/Library/Homebrew/cli/named_args.rb index e7337d2cf8..e06cbd1dd1 100644 --- a/Library/Homebrew/cli/named_args.rb +++ b/Library/Homebrew/cli/named_args.rb @@ -370,7 +370,7 @@ module Homebrew raise MultipleVersionsInstalledError, <<~EOS Multiple kegs installed to #{rack} However we don't know which one you refer to. - Please delete (with rm -rf!) all but one and then try again. + Please delete (with `rm -rf`!) all but one and then try again. EOS end end diff --git a/Library/Homebrew/cli/parser.rb b/Library/Homebrew/cli/parser.rb index c0f82d7e9e..81ca29b28c 100644 --- a/Library/Homebrew/cli/parser.rb +++ b/Library/Homebrew/cli/parser.rb @@ -441,9 +441,9 @@ module Homebrew else required_argument_types = [:required_flag, :comma_array] @non_global_processed_options.map do |option, type| - next " [<#{option}>`=`]" if required_argument_types.include? type + next " [`#{option}=`]" if required_argument_types.include? type - " [<#{option}>]" + " [`#{option}`]" end.join end diff --git a/Library/Homebrew/cmd/cleanup.rb b/Library/Homebrew/cmd/cleanup.rb index 79d41232f3..45002766ee 100644 --- a/Library/Homebrew/cmd/cleanup.rb +++ b/Library/Homebrew/cmd/cleanup.rb @@ -45,7 +45,7 @@ module Homebrew when "all" 0 else - raise UsageError, "`--prune=` expects an integer or `all`." + raise UsageError, "`--prune` expects an integer or `all`." end end diff --git a/Library/Homebrew/cmd/desc.rb b/Library/Homebrew/cmd/desc.rb index 5fa27f4656..965e8f23a8 100644 --- a/Library/Homebrew/cmd/desc.rb +++ b/Library/Homebrew/cmd/desc.rb @@ -29,7 +29,7 @@ module Homebrew "it is interpreted as a regular expression." switch "--eval-all", description: "Evaluate all available formulae and casks, whether installed or not, to search their " \ - "descriptions. Implied if HOMEBREW_EVAL_ALL is set." + "descriptions. Implied if `HOMEBREW_EVAL_ALL` is set." switch "--formula", "--formulae", description: "Treat all named arguments as formulae." switch "--cask", "--casks", diff --git a/Library/Homebrew/cmd/info.rb b/Library/Homebrew/cmd/info.rb index d54e2c09ce..866d369833 100644 --- a/Library/Homebrew/cmd/info.rb +++ b/Library/Homebrew/cmd/info.rb @@ -61,7 +61,7 @@ module Homebrew switch "--eval-all", depends_on: "--json", description: "Evaluate all available formulae and casks, whether installed or not, to print their " \ - "JSON. Implied if HOMEBREW_EVAL_ALL is set." + "JSON. Implied if `HOMEBREW_EVAL_ALL` is set." switch "--all", hidden: true, depends_on: "--json" @@ -93,16 +93,17 @@ module Homebrew if args.analytics? if args.days.present? && VALID_DAYS.exclude?(args.days) - raise UsageError, "--days must be one of #{VALID_DAYS.join(", ")}" + raise UsageError, "`--days` must be one of #{VALID_DAYS.join(", ")}." end if args.category.present? if args.named.present? && VALID_FORMULA_CATEGORIES.exclude?(args.category) - raise UsageError, "--category must be one of #{VALID_FORMULA_CATEGORIES.join(", ")} when querying formulae" + raise UsageError, + "`--category` must be one of #{VALID_FORMULA_CATEGORIES.join(", ")} when querying formulae." end unless VALID_CATEGORIES.include?(args.category) - raise UsageError, "--category must be one of #{VALID_CATEGORIES.join(", ")}" + raise UsageError, "`--category` must be one of #{VALID_CATEGORIES.join(", ")}." end end @@ -204,7 +205,7 @@ module Homebrew json = case json_version(args.json) when :v1, :default - raise UsageError, "cannot specify --cask with --json=v1!" if args.cask? + raise UsageError, "Cannot specify `--cask` when using `--json=v1`!" if args.cask? formulae = if all Formula.all.sort @@ -227,7 +228,9 @@ module Homebrew ENV["HOMEBREW_NO_INSTALL_FROM_API"] = "1" core_untapped = !CoreTap.instance.installed? cask_untapped = !Tap.fetch("Homebrew/homebrew-cask").installed? - raise UsageError, "tap homebrew/core and/or homebrew/cask to use --json=v2" if core_untapped || cask_untapped + if core_untapped || cask_untapped + raise UsageError, "Tap homebrew/core and/or homebrew/cask to use `--json=v2`." + end end formulae, casks = if all diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index 453b30462e..d1c1ef3d87 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -30,7 +30,7 @@ module Homebrew Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the installed formulae or, every 30 days, for all formulae. - Unless `HOMEBREW_NO_INSTALL_UPGRADE` is set, `brew install ` will upgrade if it + Unless `HOMEBREW_NO_INSTALL_UPGRADE` is set, `brew install` will upgrade if it is already installed but outdated. EOS switch "-d", "--debug", @@ -92,7 +92,7 @@ module Homebrew }], [:switch, "--debug-symbols", { depends_on: "--build-from-source", - description: "Generate debug symbols on build. Source will be retained in a cache directory. ", + description: "Generate debug symbols on build. Source will be retained in a cache directory.", }], [:switch, "--build-bottle", { description: "Prepare the formula for eventual bottling during installation, skipping any " \ diff --git a/Library/Homebrew/cmd/readall.rb b/Library/Homebrew/cmd/readall.rb index 7c9c3d7104..98efb088a9 100644 --- a/Library/Homebrew/cmd/readall.rb +++ b/Library/Homebrew/cmd/readall.rb @@ -25,7 +25,7 @@ module Homebrew description: "Syntax-check all of Homebrew's Ruby files (if no `` is passed)." switch "--eval-all", 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." switch "--no-simulate", description: "Don't simulate other system configurations when checking formulae and casks." diff --git a/Library/Homebrew/cmd/reinstall.rb b/Library/Homebrew/cmd/reinstall.rb index ea3818df54..5744513449 100644 --- a/Library/Homebrew/cmd/reinstall.rb +++ b/Library/Homebrew/cmd/reinstall.rb @@ -59,7 +59,7 @@ module Homebrew }], [:switch, "--debug-symbols", { depends_on: "--build-from-source", - description: "Generate debug symbols on build. Source will be retained in a cache directory. ", + description: "Generate debug symbols on build. Source will be retained in a cache directory.", }], [:switch, "--display-times", { env: :display_install_times, diff --git a/Library/Homebrew/cmd/search.rb b/Library/Homebrew/cmd/search.rb index 386d07ebda..191ae105f9 100644 --- a/Library/Homebrew/cmd/search.rb +++ b/Library/Homebrew/cmd/search.rb @@ -45,7 +45,7 @@ module Homebrew switch "--eval-all", depends_on: "--desc", description: "Evaluate all available formulae and casks, whether installed or not, to search their " \ - "descriptions. Implied if HOMEBREW_EVAL_ALL is set." + "descriptions. Implied if `HOMEBREW_EVAL_ALL` is set." switch "--pull-request", description: "Search for GitHub pull requests containing ." switch "--open", diff --git a/Library/Homebrew/cmd/tap.rb b/Library/Homebrew/cmd/tap.rb index 7eed84b689..a68cc58a5b 100644 --- a/Library/Homebrew/cmd/tap.rb +++ b/Library/Homebrew/cmd/tap.rb @@ -45,7 +45,7 @@ module Homebrew description: "List all pinned taps." switch "--eval-all", description: "Evaluate all the formulae, casks and aliases in the new tap to check validity. " \ - "Implied if HOMEBREW_EVAL_ALL is set." + "Implied if `HOMEBREW_EVAL_ALL` is set." named_args :tap, max: 2 end diff --git a/Library/Homebrew/cmd/update.sh b/Library/Homebrew/cmd/update.sh index 047b2473d4..e4276c5c1c 100644 --- a/Library/Homebrew/cmd/update.sh +++ b/Library/Homebrew/cmd/update.sh @@ -5,7 +5,7 @@ #: --merge Use `git merge` to apply updates (rather than `git rebase`). #: --auto-update Run on auto-updates (e.g. before `brew install`). Skips some slower steps. #: -f, --force Always do a slower, full update check (even if unnecessary). -#: -q, --quiet Make some output more quiet +#: -q, --quiet Make some output more quiet. #: -v, --verbose Print the directories checked and `git` operations performed. #: -d, --debug Display a trace of all shell commands as they are executed. #: -h, --help Show this message. @@ -48,7 +48,7 @@ git_init_if_necessary() { git config --bool core.symlinks true if [[ "${HOMEBREW_BREW_DEFAULT_GIT_REMOTE}" != "${HOMEBREW_BREW_GIT_REMOTE}" ]] then - echo "HOMEBREW_BREW_GIT_REMOTE set: using ${HOMEBREW_BREW_GIT_REMOTE} for Homebrew/brew Git remote URL." + echo "HOMEBREW_BREW_GIT_REMOTE set: using ${HOMEBREW_BREW_GIT_REMOTE} as the Homebrew/brew Git remote." fi git config remote.origin.url "${HOMEBREW_BREW_GIT_REMOTE}" git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*" @@ -71,7 +71,7 @@ git_init_if_necessary() { git config --bool core.symlinks true if [[ "${HOMEBREW_CORE_DEFAULT_GIT_REMOTE}" != "${HOMEBREW_CORE_GIT_REMOTE}" ]] then - echo "HOMEBREW_CORE_GIT_REMOTE set: using ${HOMEBREW_CORE_GIT_REMOTE} for Homebrew/core Git remote URL." + echo "HOMEBREW_CORE_GIT_REMOTE set: using ${HOMEBREW_CORE_GIT_REMOTE} as the Homebrew/homebrew-core Git remote." fi git config remote.origin.url "${HOMEBREW_CORE_GIT_REMOTE}" git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*" @@ -514,7 +514,7 @@ EOS if [[ "${HOMEBREW_BREW_DEFAULT_GIT_REMOTE}" != "${HOMEBREW_BREW_GIT_REMOTE}" ]] then safe_cd "${HOMEBREW_REPOSITORY}" - echo "HOMEBREW_BREW_GIT_REMOTE set: using ${HOMEBREW_BREW_GIT_REMOTE} for Homebrew/brew Git remote." + echo "HOMEBREW_BREW_GIT_REMOTE set: using ${HOMEBREW_BREW_GIT_REMOTE} as the Homebrew/brew Git remote." git remote set-url origin "${HOMEBREW_BREW_GIT_REMOTE}" git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*" git fetch --force --tags origin @@ -533,7 +533,7 @@ EOS fi safe_cd "${HOMEBREW_CORE_REPOSITORY}" - echo "HOMEBREW_CORE_GIT_REMOTE set: using ${HOMEBREW_CORE_GIT_REMOTE} for Homebrew/core Git remote." + echo "HOMEBREW_CORE_GIT_REMOTE set: using ${HOMEBREW_CORE_GIT_REMOTE} as the Homebrew/homebrew-core Git remote." git remote set-url origin "${HOMEBREW_CORE_GIT_REMOTE}" git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*" git fetch --force origin refs/heads/master:refs/remotes/origin/master @@ -635,7 +635,7 @@ EOS GITHUB_API_ENDPOINT="commits/${UPSTREAM_BRANCH_DIR}" fi - # HOMEBREW_CURL is set by brew.sh (and isn't mispelt here) + # HOMEBREW_CURL is set by brew.sh (and isn't misspelt here) # shellcheck disable=SC2153 UPSTREAM_SHA_HTTP_CODE="$( curl \ diff --git a/Library/Homebrew/cmd/upgrade.rb b/Library/Homebrew/cmd/upgrade.rb index e33b3cab0b..c6c679b8e0 100644 --- a/Library/Homebrew/cmd/upgrade.rb +++ b/Library/Homebrew/cmd/upgrade.rb @@ -70,7 +70,7 @@ module Homebrew }], [:switch, "--debug-symbols", { depends_on: "--build-from-source", - description: "Generate debug symbols on build. Source will be retained in a cache directory. ", + description: "Generate debug symbols on build. Source will be retained in a cache directory.", }], [:switch, "--display-times", { env: :display_install_times, diff --git a/Library/Homebrew/cmd/vendor-install.sh b/Library/Homebrew/cmd/vendor-install.sh index 90010adf0a..47516153d6 100644 --- a/Library/Homebrew/cmd/vendor-install.sh +++ b/Library/Homebrew/cmd/vendor-install.sh @@ -149,7 +149,7 @@ fetch() { first_try='' if [[ -f "${temporary_path}" ]] then - # HOMEBREW_CURL is set by brew.sh (and isn't mispelt here) + # HOMEBREW_CURL is set by brew.sh (and isn't misspelt here) # shellcheck disable=SC2153 "${HOMEBREW_CURL}" "${curl_args[@]}" -C - "${url}" -o "${temporary_path}" if [[ $? -eq 33 ]] diff --git a/Library/Homebrew/completions/bash.erb b/Library/Homebrew/completions/bash.erb index 9e01209aba..55d2d13dc0 100644 --- a/Library/Homebrew/completions/bash.erb +++ b/Library/Homebrew/completions/bash.erb @@ -117,7 +117,7 @@ __brew_complete_commands() { fi while read -r line; do COMPREPLY+=("${line}"); done < <(compgen -W "${cmds}" -- "${cur}") export __HOMEBREW_COMMANDS=${cmds} - } +} # compopt is only available in newer versions of bash __brew_complete_files() { diff --git a/Library/Homebrew/dev-cmd/audit.rb b/Library/Homebrew/dev-cmd/audit.rb index a04c19d3c7..585a9b8c6b 100644 --- a/Library/Homebrew/dev-cmd/audit.rb +++ b/Library/Homebrew/dev-cmd/audit.rb @@ -43,7 +43,7 @@ module Homebrew description: "Only check formulae and casks that are currently installed." switch "--eval-all", description: "Evaluate all available formulae and casks, whether installed or not, to audit them. " \ - "Implied if HOMEBREW_EVAL_ALL is set." + "Implied if `HOMEBREW_EVAL_ALL` is set." switch "--all", hidden: true switch "--new", "--new-formula", "--new-cask", diff --git a/Library/Homebrew/dev-cmd/bump-cask-pr.rb b/Library/Homebrew/dev-cmd/bump-cask-pr.rb index b971235e91..d00b417f61 100644 --- a/Library/Homebrew/dev-cmd/bump-cask-pr.rb +++ b/Library/Homebrew/dev-cmd/bump-cask-pr.rb @@ -85,7 +85,7 @@ module Homebrew new_hash = :no_check if ["no_check", ":no_check"].include? new_hash if new_version.nil? && new_base_url.nil? && new_hash.nil? - raise UsageError, "No `--version=`, `--url=` or `--sha256=` argument specified!" + raise UsageError, "No `--version`, `--url` or `--sha256` argument specified!" end old_version = cask.version diff --git a/Library/Homebrew/dev-cmd/bump-formula-pr.rb b/Library/Homebrew/dev-cmd/bump-formula-pr.rb index f2c6d6c388..b72ecd2ac1 100644 --- a/Library/Homebrew/dev-cmd/bump-formula-pr.rb +++ b/Library/Homebrew/dev-cmd/bump-formula-pr.rb @@ -160,7 +160,7 @@ module Homebrew false elsif old_hash.blank? if new_tag.blank? && new_version.blank? && new_revision.blank? - raise UsageError, "#{formula}: no --tag= or --version= argument specified!" + raise UsageError, "#{formula}: no `--tag` or `--version` argument specified!" end if old_tag.present? @@ -180,7 +180,7 @@ module Homebrew end false elsif new_url.blank? && new_version.blank? - raise UsageError, "#{formula}: no --url= or --version= argument specified!" + raise UsageError, "#{formula}: no `--url` or `--version` argument specified!" else new_url ||= PyPI.update_pypi_url(old_url, new_version) if new_url.blank? diff --git a/Library/Homebrew/dev-cmd/dispatch-build-bottle.rb b/Library/Homebrew/dev-cmd/dispatch-build-bottle.rb index 7385e5a8ba..0329710e74 100644 --- a/Library/Homebrew/dev-cmd/dispatch-build-bottle.rb +++ b/Library/Homebrew/dev-cmd/dispatch-build-bottle.rb @@ -21,8 +21,8 @@ module Homebrew description: "Build timeout (in minutes, default: 60)." flag "--issue=", description: "If specified, post a comment to this issue number if the job fails." - comma_array "--macos=", - description: "Version(s) of macOS the bottle should be built for." + comma_array "--macos", + description: "macOS version (or comma-separated list of versions) the bottle should be built for." flag "--workflow=", description: "Dispatch specified workflow (default: `dispatch-build-bottle.yml`)." switch "--upload", @@ -74,7 +74,7 @@ module Homebrew runners << "linux-self-hosted-1" end - raise UsageError, "Must specify --macos or --linux or --linux-self-hosted option" if runners.empty? + raise UsageError, "Must specify `--macos`, `--linux` or `--linux-self-hosted` option." if runners.empty? args.named.to_resolved_formulae.each do |formula| # Required inputs diff --git a/Library/Homebrew/dev-cmd/extract.rb b/Library/Homebrew/dev-cmd/extract.rb index 6207ac7702..fad9c4a9c0 100644 --- a/Library/Homebrew/dev-cmd/extract.rb +++ b/Library/Homebrew/dev-cmd/extract.rb @@ -77,7 +77,7 @@ module Homebrew sig { returns(CLI::Parser) } def extract_args Homebrew::CLI::Parser.new do - usage_banner "`extract` [<--version>`=`] [<--force>] " + usage_banner "`extract` [`--version=`] [`--force`] " description <<~EOS Look through repository history to find the most recent version of and create a copy in . Specifically, the command will create the new diff --git a/Library/Homebrew/dev-cmd/install-bundler-gems.rb b/Library/Homebrew/dev-cmd/install-bundler-gems.rb index 05e9a7d309..1f71a39fc8 100644 --- a/Library/Homebrew/dev-cmd/install-bundler-gems.rb +++ b/Library/Homebrew/dev-cmd/install-bundler-gems.rb @@ -14,7 +14,7 @@ module Homebrew description <<~EOS Install Homebrew's Bundler gems. EOS - comma_array "--groups=", + comma_array "--groups", description: "Installs the specified comma-separated list of gem groups (default: last used)." named_args :none diff --git a/Library/Homebrew/dev-cmd/pr-pull.rb b/Library/Homebrew/dev-cmd/pr-pull.rb index c8015d3935..914009d1b9 100644 --- a/Library/Homebrew/dev-cmd/pr-pull.rb +++ b/Library/Homebrew/dev-cmd/pr-pull.rb @@ -56,10 +56,10 @@ module Homebrew flag "--root-url-using=", description: "Use the specified download strategy class for downloading the bottle's URL instead of " \ "Homebrew's default." - comma_array "--workflows=", + comma_array "--workflows", description: "Retrieve artifacts from the specified workflow (default: `tests.yml`). " \ "Can be a comma-separated list to include multiple workflows." - comma_array "--ignore-missing-artifacts=", + comma_array "--ignore-missing-artifacts", description: "Comma-separated list of workflows which can be ignored if they have not been run." conflicts "--no-autosquash", "--message" diff --git a/Library/Homebrew/dev-cmd/tests.rb b/Library/Homebrew/dev-cmd/tests.rb index fd99820405..9f96fc9535 100644 --- a/Library/Homebrew/dev-cmd/tests.rb +++ b/Library/Homebrew/dev-cmd/tests.rb @@ -113,7 +113,7 @@ module Homebrew end if files.blank? - raise UsageError, "The --only= argument requires a valid file or folder name!" if args.only + raise UsageError, "The `--only` argument requires a valid file or folder name!" if args.only if args.changed? opoo "No tests are directly associated with the changed files!" diff --git a/Library/Homebrew/dev-cmd/unbottled.rb b/Library/Homebrew/dev-cmd/unbottled.rb index 5fa7c6e336..5c866198a6 100644 --- a/Library/Homebrew/dev-cmd/unbottled.rb +++ b/Library/Homebrew/dev-cmd/unbottled.rb @@ -24,7 +24,7 @@ module Homebrew description: "Print the number of unbottled and total formulae." switch "--eval-all", description: "Evaluate all available formulae and casks, whether installed or not, to check them. " \ - "Implied if HOMEBREW_EVAL_ALL is set." + "Implied if `HOMEBREW_EVAL_ALL` is set." conflicts "--dependents", "--total" @@ -64,7 +64,7 @@ module Homebrew if args.named.blank? ohai "Getting formulae..." elsif all - raise UsageError, "cannot specify `` and `--eval-all`/`--total`." + raise UsageError, "Cannot specify formulae when using `--eval-all`/`--total`." end formulae, all_formulae, formula_installs = diff --git a/Library/Homebrew/dev-cmd/update-python-resources.rb b/Library/Homebrew/dev-cmd/update-python-resources.rb index 8737b5a680..1e6e7bf96f 100644 --- a/Library/Homebrew/dev-cmd/update-python-resources.rb +++ b/Library/Homebrew/dev-cmd/update-python-resources.rb @@ -27,9 +27,9 @@ module Homebrew flag "--package-name=", description: "Use the specified when finding resources for . " \ "If no package name is specified, it will be inferred from the formula's stable URL." - comma_array "--extra-packages=", + comma_array "--extra-packages", description: "Include these additional packages when finding resources." - comma_array "--exclude-packages=", + comma_array "--exclude-packages", description: "Exclude these packages when finding resources." named_args :formula, min: 1 diff --git a/Library/Homebrew/dev-cmd/vendor-gems.rb b/Library/Homebrew/dev-cmd/vendor-gems.rb index 675136bfe0..b6b4c8da2e 100644 --- a/Library/Homebrew/dev-cmd/vendor-gems.rb +++ b/Library/Homebrew/dev-cmd/vendor-gems.rb @@ -16,7 +16,7 @@ module Homebrew EOS comma_array "--update", - description: "Update all vendored Gems to the latest version." + description: "Update the specified list of vendored gems to the latest version." switch "--no-commit", description: "Do not generate a new commit upon completion." diff --git a/Library/Homebrew/env_config.rb b/Library/Homebrew/env_config.rb index db9aa461f5..ce4e4935de 100644 --- a/Library/Homebrew/env_config.rb +++ b/Library/Homebrew/env_config.rb @@ -40,12 +40,12 @@ 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, " \ - "disable auto-update entirely with HOMEBREW_NO_AUTO_UPDATE.", - default_text: "86400 (24 hours) or 300 (5 minutes) if HOMEBREW_NO_INSTALL_FROM_API is set.", + "disable auto-update entirely with `HOMEBREW_NO_AUTO_UPDATE`.", + default_text: "86400 (24 hours) or 300 (5 minutes) if `HOMEBREW_NO_INSTALL_FROM_API` is set.", }, HOMEBREW_AUTOREMOVE: { description: "If set, calls to `brew cleanup` and `brew uninstall` will automatically " \ - "remove unused formula dependents and if HOMEBREW_NO_INSTALL_CLEANUP is not set, " \ + "remove unused formula dependents and if `HOMEBREW_NO_INSTALL_CLEANUP` is not set, " \ "`brew cleanup` will start running `brew autoremove` periodically.", boolean: true, }, @@ -98,15 +98,15 @@ module Homebrew "`~/.profile`, `~/.bash_profile`, or `~/.zshenv`:" \ '\n\n `export HOMEBREW_CASK_OPTS="--appdir=~/Applications --fontdir=/Library/Fonts"`', }, + HOMEBREW_CLEANUP_MAX_AGE_DAYS: { + description: "Cleanup all cached files older than this many days.", + default: 120, + }, HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS: { description: "If set, `brew install`, `brew upgrade` and `brew reinstall` will cleanup all formulae " \ "when this number of days has passed.", default: 30, }, - HOMEBREW_CLEANUP_MAX_AGE_DAYS: { - description: "Cleanup all cached files older than this many days.", - default: 120, - }, HOMEBREW_COLOR: { description: "If set, force colour output on non-TTY outputs.", boolean: true, @@ -116,11 +116,6 @@ module Homebrew default_text: "`https://github.com/Homebrew/homebrew-core`.", default: HOMEBREW_CORE_DEFAULT_GIT_REMOTE, }, - HOMEBREW_CURLRC: { - description: "If set, do not pass `--disable` when invoking `curl`(1), which disables the " \ - "use of `curlrc`.", - boolean: true, - }, HOMEBREW_CURL_PATH: { description: "Linux only: Set this value to a new enough `curl` executable for Homebrew to use.", default: "curl", @@ -133,6 +128,15 @@ module Homebrew description: "If set, pass `--verbose` when invoking `curl`(1).", boolean: true, }, + HOMEBREW_CURLRC: { + description: "If set, do not pass `--disable` when invoking `curl`(1), which disables the " \ + "use of `curlrc`.", + boolean: true, + }, + HOMEBREW_DEBUG: { + description: "If set, always assume `--debug` when running commands.", + boolean: true, + }, HOMEBREW_DEVELOPER: { description: "If set, tweak behaviour to be more relevant for Homebrew developers (active or " \ "budding) by e.g. turning warnings into errors.", @@ -152,6 +156,14 @@ module Homebrew description: "If set, print install times for each formula at the end of the run.", boolean: true, }, + HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN: { + description: "Use this base64 encoded username and password for authenticating with a Docker registry " \ + "proxying GitHub Packages. If `HOMEBREW_DOCKER_REGISTRY_TOKEN` is set, it will be used instead.", + }, + HOMEBREW_DOCKER_REGISTRY_TOKEN: { + description: "Use this bearer token for authenticating with a Docker registry proxying GitHub Packages. " \ + "Preferred over `HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN`.", + }, HOMEBREW_EDITOR: { description: "Use this editor when editing a single formula, or several formulae in the " \ "same directory." \ @@ -193,6 +205,16 @@ module Homebrew "of Ruby is new enough.", boolean: true, }, + HOMEBREW_GIT_EMAIL: { + description: "Set the Git author and committer email to this value.", + }, + HOMEBREW_GIT_NAME: { + description: "Set the Git author and committer name to this value.", + }, + HOMEBREW_GIT_PATH: { + description: "Linux only: Set this value to a new enough `git` executable for Homebrew to use.", + default: "git", + }, HOMEBREW_GITHUB_API_TOKEN: { description: "Use this personal access token for the GitHub API, for features such as " \ "`brew search`. You can create one at . If set, " \ @@ -205,27 +227,9 @@ module Homebrew description: "Use this GitHub personal access token when accessing the GitHub Packages Registry " \ "(where bottles may be stored).", }, - HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN: { - description: "Use this base64 encoded username and password for authenticating with a Docker registry " \ - "proxying GitHub Packages. If HOMEBREW_DOCKER_REGISTRY_TOKEN is set, it will be used instead.", - }, - HOMEBREW_DOCKER_REGISTRY_TOKEN: { - description: "Use this bearer token for authenticating with a Docker registry proxying GitHub Packages. " \ - "Preferred over HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN.", - }, HOMEBREW_GITHUB_PACKAGES_USER: { description: "Use this username when accessing the GitHub Packages Registry (where bottles may be stored).", }, - HOMEBREW_GIT_EMAIL: { - description: "Set the Git author and committer email to this value.", - }, - HOMEBREW_GIT_NAME: { - description: "Set the Git author and committer name to this value.", - }, - HOMEBREW_GIT_PATH: { - description: "Linux only: Set this value to a new enough `git` executable for Homebrew to use.", - default: "git", - }, HOMEBREW_INSTALL_BADGE: { description: "Print this text before the installation summary of each successful build.", default_text: 'The "Beer Mug" emoji.', @@ -259,20 +263,13 @@ 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`. Alternatively, " \ - "run this less often by setting HOMEBREW_AUTO_UPDATE_SECS to a value higher than the default.", + "run this less often by setting `HOMEBREW_AUTO_UPDATE_SECS` to a value higher than the default.", boolean: true, }, HOMEBREW_NO_BOOTSNAP: { description: "If set, do not use Bootsnap to speed up repeated `brew` calls.", boolean: true, }, - HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: { - description: "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 ` or `brew upgrade `.", - boolean: true, - }, HOMEBREW_NO_CLEANUP_FORMULAE: { description: "A comma-separated list of formulae. Homebrew will refuse to clean up " \ "or autoremove a formula if it appears on this list.", @@ -308,7 +305,7 @@ module Homebrew HOMEBREW_NO_INSTALL_CLEANUP: { description: "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 " \ + "`HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS` days. Alternatively, `HOMEBREW_NO_CLEANUP_FORMULAE` " \ "allows specifying specific formulae to not clean up.", boolean: true, }, @@ -318,10 +315,17 @@ module Homebrew boolean: true, }, HOMEBREW_NO_INSTALL_UPGRADE: { - description: "If set, `brew install ` will not upgrade `` if it is installed but " \ + description: "If set, `brew install` will not upgrade if it is installed but " \ "outdated.", boolean: true, }, + HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: { + description: "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` or `brew upgrade` .", + boolean: true, + }, HOMEBREW_PIP_INDEX_URL: { description: "If set, `brew install ` will use this URL to download PyPI package resources.", default_text: "`https://pypi.org/simple`.", @@ -335,11 +339,6 @@ module Homebrew "when auditing macOS formulae while on Linux.", boolean: true, }, - HOMEBREW_SSH_CONFIG_PATH: { - description: "If set, Homebrew will use the given config file instead of `~/.ssh/config` when fetching " \ - "`git` repos over `ssh`.", - default_text: "`$HOME/.ssh/config`", - }, HOMEBREW_SKIP_OR_LATER_BOTTLES: { description: "If set along with `HOMEBREW_DEVELOPER`, do not use bottles from older versions " \ "of macOS. This is useful in development on new macOS versions.", @@ -349,6 +348,11 @@ module Homebrew description: "If set, enable runtime typechecking using Sorbet.", boolean: true, }, + HOMEBREW_SSH_CONFIG_PATH: { + description: "If set, Homebrew will use the given config file instead of `~/.ssh/config` when fetching " \ + "`git` repos over `ssh`.", + default_text: "`$HOME/.ssh/config`", + }, HOMEBREW_SVN: { description: "Use this as the `svn`(1) binary.", default_text: "A Homebrew-built Subversion (if installed), or the system-provided binary.", @@ -376,15 +380,14 @@ module Homebrew description: "If set, always assume `--verbose` when running commands.", boolean: true, }, - HOMEBREW_DEBUG: { - description: "If set, always assume `--debug` when running commands.", - boolean: true, - }, HOMEBREW_VERBOSE_USING_DOTS: { description: "If set, verbose output will print a `.` no more than once a minute. This can be " \ "useful to avoid long-running Homebrew commands being killed due to no output.", boolean: true, }, + SUDO_ASKPASS: { + description: "If set, pass the `-A` option when calling `sudo`(8).", + }, all_proxy: { description: "Use this SOCKS5 proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.", }, @@ -401,9 +404,6 @@ module Homebrew description: "A comma-separated list of hostnames and domain names excluded " \ "from proxying by `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.", }, - SUDO_ASKPASS: { - description: "If set, pass the `-A` option when calling `sudo`(8).", - }, }.freeze def env_method_name(env, hash) diff --git a/Library/Homebrew/exceptions.rb b/Library/Homebrew/exceptions.rb index c8690e3f1d..cda88f88c9 100644 --- a/Library/Homebrew/exceptions.rb +++ b/Library/Homebrew/exceptions.rb @@ -332,7 +332,7 @@ class TapRemoteMismatchError < RuntimeError end end -# Raised when the remote of Homebrew/core does not match HOMEBREW_CORE_GIT_REMOTE. +# Raised when the remote of homebrew/core does not match HOMEBREW_CORE_GIT_REMOTE. class TapCoreRemoteMismatchError < TapRemoteMismatchError def message <<~EOS @@ -529,18 +529,18 @@ class BuildError < RuntimeError puts Formatter.error(Formatter.url(OS::ISSUES_URL), label: "READ THIS") elsif (issues_url = formula.tap.issues_url) puts <<~EOS - If reporting this issue please do so at (not Homebrew/brew or Homebrew/core): + If reporting this issue please do so at (not Homebrew/brew or Homebrew/homebrew-core): #{Formatter.url(issues_url)} EOS else puts <<~EOS - If reporting this issue please do so to (not Homebrew/brew or Homebrew/core): + If reporting this issue please do so to (not Homebrew/brew or Homebrew/homebrew-core): #{formula.tap} EOS end else puts <<~EOS - Do not report this issue to Homebrew/brew or Homebrew/core! + Do not report this issue to Homebrew/brew or Homebrew/homebrew-core! EOS end diff --git a/Library/Homebrew/extend/os/linux/diagnostic.rb b/Library/Homebrew/extend/os/linux/diagnostic.rb index 3971c62a65..110651a209 100644 --- a/Library/Homebrew/extend/os/linux/diagnostic.rb +++ b/Library/Homebrew/extend/os/linux/diagnostic.rb @@ -125,7 +125,7 @@ module Homebrew return unless CoreTap.instance.linuxbrew_core? <<~EOS - Your Linux Homebrew/core repository is still linuxbrew-core. + Your Linux core repository is still linuxbrew-core. You must `brew update` to update to homebrew-core. EOS end diff --git a/Library/Homebrew/formula.rb b/Library/Homebrew/formula.rb index 18e34c6cf3..666f36eafe 100644 --- a/Library/Homebrew/formula.rb +++ b/Library/Homebrew/formula.rb @@ -3065,7 +3065,7 @@ class Formula # 
depends_on "zeromq" => "with-pgm"
     # depends_on "qt" => ["with-qtdbus", "developer"] # Multiple options.
# - # Optional and enforce that "boost" is built with `--with-c++11`. + # Optional and enforce that "boost" is built using `--with-c++11`. # 
depends_on "boost" => [:optional, "with-c++11"]
# # If a dependency is only needed in certain cases: diff --git a/Library/Homebrew/formula_installer.rb b/Library/Homebrew/formula_installer.rb index b479a7e8e9..d367257b28 100644 --- a/Library/Homebrew/formula_installer.rb +++ b/Library/Homebrew/formula_installer.rb @@ -496,7 +496,7 @@ class FormulaInstaller raise if Homebrew::EnvConfig.developer? - $stderr.puts "Please report this issue to the #{formula.tap} tap (not Homebrew/brew or Homebrew/core)!" + $stderr.puts "Please report this issue to the #{formula.tap} tap (not Homebrew/brew or Homebrew/homebrew-core)!" false else f.linked_keg.exist? && f.opt_prefix.exist? diff --git a/Library/Homebrew/patch.rb b/Library/Homebrew/patch.rb index 01cae78d8e..9640e8eda9 100644 --- a/Library/Homebrew/patch.rb +++ b/Library/Homebrew/patch.rb @@ -26,7 +26,7 @@ module Patch when nil raise ArgumentError, "nil value for strip" else - raise ArgumentError, "unexpected value #{strip.inspect} for strip" + raise ArgumentError, "Unexpected value #{strip.inspect} for strip" end end end diff --git a/Library/Homebrew/resource.rb b/Library/Homebrew/resource.rb index 9c00389161..70839a3b73 100644 --- a/Library/Homebrew/resource.rb +++ b/Library/Homebrew/resource.rb @@ -118,7 +118,7 @@ class Resource # # @api public def stage(target = nil, debug_symbols: false, &block) - raise ArgumentError, "target directory or block is required" if !target && block.blank? + raise ArgumentError, "Target directory or block is required" if !target && block.blank? prepare_patches fetch_patches(skip_downloaded: true) diff --git a/Library/Homebrew/tap.rb b/Library/Homebrew/tap.rb index d00b628198..cdc49f8eff 100644 --- a/Library/Homebrew/tap.rb +++ b/Library/Homebrew/tap.rb @@ -814,11 +814,11 @@ class CoreTap < Tap remote = Homebrew::EnvConfig.core_git_remote # set by HOMEBREW_CORE_GIT_REMOTE requested_remote = clone_target || remote - # The remote will changed again on `brew update` since remotes for Homebrew/core are mismatched + # The remote will changed again on `brew update` since remotes for homebrew/core are mismatched raise TapCoreRemoteMismatchError.new(name, remote, requested_remote) if requested_remote != remote if remote != default_remote - $stderr.puts "HOMEBREW_CORE_GIT_REMOTE set: using #{remote} for Homebrew/core Git remote." + $stderr.puts "HOMEBREW_CORE_GIT_REMOTE set: using #{remote} as the Homebrew/homebrew-core Git remote." end super(quiet: quiet, clone_target: remote, force_auto_update: force_auto_update, custom_remote: custom_remote) diff --git a/Library/Homebrew/test/cli/parser_spec.rb b/Library/Homebrew/test/cli/parser_spec.rb index 97b76decb7..a9d5642193 100644 --- a/Library/Homebrew/test/cli/parser_spec.rb +++ b/Library/Homebrew/test/cli/parser_spec.rb @@ -119,7 +119,7 @@ describe Homebrew::CLI::Parser do subject(:parser) { described_class.new do flag "--filename=", description: "Name of the file" - comma_array "--files", description: "Comma separated filenames" + comma_array "--files", description: "Comma-separated filenames" flag "--hidden=", hidden: true comma_array "--hidden-array", hidden: true end diff --git a/Library/Homebrew/test/cmd/--prefix_spec.rb b/Library/Homebrew/test/cmd/--prefix_spec.rb index d16163b132..71940090b2 100644 --- a/Library/Homebrew/test/cmd/--prefix_spec.rb +++ b/Library/Homebrew/test/cmd/--prefix_spec.rb @@ -27,7 +27,7 @@ describe "brew --prefix" do .and be_a_failure end - it "prints a warning with `--installed` if the given Formula is not installed", :integration_test do + it "prints a warning when `--installed` is used and the given Formula is not installed", :integration_test do expect { brew "--prefix", "--installed", testball } .to not_to_output.to_stdout .and output(/testball/).to_stderr diff --git a/Library/Homebrew/test/completions_spec.rb b/Library/Homebrew/test/completions_spec.rb index 10998ef887..320ac37412 100644 --- a/Library/Homebrew/test/completions_spec.rb +++ b/Library/Homebrew/test/completions_spec.rb @@ -200,7 +200,7 @@ describe Homebrew::Completions do "--force" => "Always do a slower, full update check (even if unnecessary).", "--help" => "Show this message.", "--merge" => "Use `git merge` to apply updates (rather than `git rebase`).", - "--quiet" => "Make some output more quiet", + "--quiet" => "Make some output more quiet.", "--verbose" => "Print the directories checked and `git` operations performed.", } expect(described_class.command_options("update")).to eq expected_options diff --git a/Library/Homebrew/utils.rb b/Library/Homebrew/utils.rb index cb9aae4e06..1a01ee47a4 100644 --- a/Library/Homebrew/utils.rb +++ b/Library/Homebrew/utils.rb @@ -218,7 +218,7 @@ module Kernel next unless (match = line.match(HOMEBREW_TAP_PATH_REGEX)) tap = Tap.fetch(match[:user], match[:repo]) - tap_message = +"\nPlease report this issue to the #{tap} tap (not Homebrew/brew or Homebrew/core)" + tap_message = +"\nPlease report this issue to the #{tap} tap (not Homebrew/brew or Homebrew/homebrew-core)" tap_message += ", or even better, submit a PR to fix it" if replacement tap_message << ":\n #{line.sub(/^(.*:\d+):.*$/, '\1')}\n\n" break diff --git a/Library/Homebrew/utils/pypi.rb b/Library/Homebrew/utils/pypi.rb index 9ca89e555e..f81c8e904c 100644 --- a/Library/Homebrew/utils/pypi.rb +++ b/Library/Homebrew/utils/pypi.rb @@ -30,7 +30,7 @@ module PyPI match = if package_string.start_with?(PYTHONHOSTED_URL_PREFIX) File.basename(package_string).match(/^(.+)-([a-z\d.]+?)(?:.tar.gz|.zip)$/) end - raise ArgumentError, "package should be a valid PyPI URL" if match.blank? + raise ArgumentError, "Package should be a valid PyPI URL" if match.blank? @name = match[1] @version = match[2] diff --git a/completions/bash/brew b/completions/bash/brew index 12c6f8c86c..abe94e31cf 100644 --- a/completions/bash/brew +++ b/completions/bash/brew @@ -104,7 +104,7 @@ __brew_complete_commands() { fi while read -r line; do COMPREPLY+=("${line}"); done < <(compgen -W "${cmds}" -- "${cur}") export __HOMEBREW_COMMANDS=${cmds} - } +} # compopt is only available in newer versions of bash __brew_complete_files() { diff --git a/completions/fish/brew.fish b/completions/fish/brew.fish index 09d074c8ba..cf46baa578 100644 --- a/completions/fish/brew.fish +++ b/completions/fish/brew.fish @@ -280,7 +280,7 @@ __fish_brew_complete_arg '-S' -l closed -d 'Search for only closed GitHub pull r __fish_brew_complete_arg '-S' -l debian -d 'Search for text in the given database' __fish_brew_complete_arg '-S' -l debug -d 'Display any debugging information' __fish_brew_complete_arg '-S' -l desc -d 'Search for formulae with a description matching text and casks with a name or description matching text' -__fish_brew_complete_arg '-S' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if HOMEBREW_EVAL_ALL is set' +__fish_brew_complete_arg '-S' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set' __fish_brew_complete_arg '-S' -l fedora -d 'Search for text in the given database' __fish_brew_complete_arg '-S' -l fink -d 'Search for text in the given database' __fish_brew_complete_arg '-S' -l formula -d 'Search online and locally for formulae' @@ -301,7 +301,7 @@ __fish_brew_complete_arg 'abv' -l cask -d 'Treat all named arguments as casks' __fish_brew_complete_arg 'abv' -l category -d 'Which type of analytics data to retrieve. The value for category must be `install`, `install-on-request` or `build-error`; `cask-install` or `os-version` may be specified if formula is not. The default is `install`' __fish_brew_complete_arg 'abv' -l days -d 'How many days of analytics data to retrieve. The value for days must be `30`, `90` or `365`. The default is `30`' __fish_brew_complete_arg 'abv' -l debug -d 'Display any debugging information' -__fish_brew_complete_arg 'abv' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if HOMEBREW_EVAL_ALL is set' +__fish_brew_complete_arg 'abv' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `HOMEBREW_EVAL_ALL` is set' __fish_brew_complete_arg 'abv' -l formula -d 'Treat all named arguments as formulae' __fish_brew_complete_arg 'abv' -l github -d 'Open the GitHub source page for formula and cask in a browser. To view the history locally: `brew log -p` formula or cask' __fish_brew_complete_arg 'abv' -l help -d 'Show this message' @@ -333,7 +333,7 @@ __fish_brew_complete_arg 'audit' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'audit' -l display-cop-names -d 'Include the RuboCop cop name for each violation in the output' __fish_brew_complete_arg 'audit' -l display-failures-only -d 'Only display casks that fail the audit. This is the default for formulae' __fish_brew_complete_arg 'audit' -l display-filename -d 'Prefix every line of output with the file or formula name being audited, to make output easy to grep' -__fish_brew_complete_arg 'audit' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to audit them. Implied if HOMEBREW_EVAL_ALL is set' +__fish_brew_complete_arg 'audit' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to audit them. Implied if `HOMEBREW_EVAL_ALL` is set' __fish_brew_complete_arg 'audit' -l except -d 'Specify a comma-separated method list to skip running the methods named `audit_`method' __fish_brew_complete_arg 'audit' -l except-cops -d 'Specify a comma-separated cops list to skip checking for violations of the listed RuboCop cops' __fish_brew_complete_arg 'audit' -l fix -d 'Fix style violations automatically using RuboCop\'s auto-correct feature' @@ -600,7 +600,7 @@ __fish_brew_complete_cmd 'desc' 'Display formula\'s name and one-line descriptio __fish_brew_complete_arg 'desc' -l cask -d 'Treat all named arguments as casks' __fish_brew_complete_arg 'desc' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'desc' -l description -d 'Search just descriptions for text. If text is flanked by slashes, it is interpreted as a regular expression' -__fish_brew_complete_arg 'desc' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if HOMEBREW_EVAL_ALL is set' +__fish_brew_complete_arg 'desc' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set' __fish_brew_complete_arg 'desc' -l formula -d 'Treat all named arguments as formulae' __fish_brew_complete_arg 'desc' -l help -d 'Show this message' __fish_brew_complete_arg 'desc' -l name -d 'Search just names for text. If text is flanked by slashes, it is interpreted as a regular expression' @@ -628,7 +628,7 @@ __fish_brew_complete_arg 'dispatch-build-bottle' -l issue -d 'If specified, post __fish_brew_complete_arg 'dispatch-build-bottle' -l linux -d 'Dispatch bottle for Linux (using GitHub runners)' __fish_brew_complete_arg 'dispatch-build-bottle' -l linux-self-hosted -d 'Dispatch bottle for Linux (using self-hosted runner)' __fish_brew_complete_arg 'dispatch-build-bottle' -l linux-wheezy -d 'Use Debian Wheezy container for building the bottle on Linux' -__fish_brew_complete_arg 'dispatch-build-bottle' -l macos -d 'Version(s) of macOS the bottle should be built for' +__fish_brew_complete_arg 'dispatch-build-bottle' -l macos -d 'macOS version (or comma-separated list of versions) the bottle should be built for' __fish_brew_complete_arg 'dispatch-build-bottle' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg 'dispatch-build-bottle' -l tap -d 'Target tap repository (default: `homebrew/core`)' __fish_brew_complete_arg 'dispatch-build-bottle' -l timeout -d 'Build timeout (in minutes, default: 60)' @@ -773,7 +773,7 @@ __fish_brew_complete_arg 'info' -l cask -d 'Treat all named arguments as casks' __fish_brew_complete_arg 'info' -l category -d 'Which type of analytics data to retrieve. The value for category must be `install`, `install-on-request` or `build-error`; `cask-install` or `os-version` may be specified if formula is not. The default is `install`' __fish_brew_complete_arg 'info' -l days -d 'How many days of analytics data to retrieve. The value for days must be `30`, `90` or `365`. The default is `30`' __fish_brew_complete_arg 'info' -l debug -d 'Display any debugging information' -__fish_brew_complete_arg 'info' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if HOMEBREW_EVAL_ALL is set' +__fish_brew_complete_arg 'info' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `HOMEBREW_EVAL_ALL` is set' __fish_brew_complete_arg 'info' -l formula -d 'Treat all named arguments as formulae' __fish_brew_complete_arg 'info' -l github -d 'Open the GitHub source page for formula and cask in a browser. To view the history locally: `brew log -p` formula or cask' __fish_brew_complete_arg 'info' -l help -d 'Show this message' @@ -799,7 +799,7 @@ __fish_brew_complete_arg 'instal' -l cask -d 'Treat all named arguments as casks __fish_brew_complete_arg 'instal' -l cc -d 'Attempt to compile using the specified compiler, which should be the name of the compiler\'s executable, e.g. `gcc-7` for GCC 7. In order to use LLVM\'s clang, specify `llvm_clang`. To use the Apple-provided clang, specify `clang`. This option will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this option' __fish_brew_complete_arg 'instal' -l colorpickerdir -d 'Target location for Color Pickers (default: `~/Library/ColorPickers`)' __fish_brew_complete_arg 'instal' -l debug -d 'If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory' -__fish_brew_complete_arg 'instal' -l debug-symbols -d 'Generate debug symbols on build. Source will be retained in a cache directory. ' +__fish_brew_complete_arg 'instal' -l debug-symbols -d 'Generate debug symbols on build. Source will be retained in a cache directory' __fish_brew_complete_arg 'instal' -l dictionarydir -d 'Target location for Dictionaries (default: `~/Library/Dictionaries`)' __fish_brew_complete_arg 'instal' -l display-times -d 'Print install times for each package at the end of the run' __fish_brew_complete_arg 'instal' -l dry-run -d 'Show what would be installed, but do not actually install anything' @@ -851,7 +851,7 @@ __fish_brew_complete_arg 'install' -l cask -d 'Treat all named arguments as cask __fish_brew_complete_arg 'install' -l cc -d 'Attempt to compile using the specified compiler, which should be the name of the compiler\'s executable, e.g. `gcc-7` for GCC 7. In order to use LLVM\'s clang, specify `llvm_clang`. To use the Apple-provided clang, specify `clang`. This option will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this option' __fish_brew_complete_arg 'install' -l colorpickerdir -d 'Target location for Color Pickers (default: `~/Library/ColorPickers`)' __fish_brew_complete_arg 'install' -l debug -d 'If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory' -__fish_brew_complete_arg 'install' -l debug-symbols -d 'Generate debug symbols on build. Source will be retained in a cache directory. ' +__fish_brew_complete_arg 'install' -l debug-symbols -d 'Generate debug symbols on build. Source will be retained in a cache directory' __fish_brew_complete_arg 'install' -l dictionarydir -d 'Target location for Dictionaries (default: `~/Library/Dictionaries`)' __fish_brew_complete_arg 'install' -l display-times -d 'Print install times for each package at the end of the run' __fish_brew_complete_arg 'install' -l dry-run -d 'Show what would be installed, but do not actually install anything' @@ -1183,7 +1183,7 @@ __fish_brew_complete_arg 'prof' -a '(__fish_brew_suggest_commands)' __fish_brew_complete_cmd 'readall' 'Import all items from the specified tap, or from all installed taps if none is provided' __fish_brew_complete_arg 'readall' -l aliases -d 'Verify any alias symlinks in each tap' __fish_brew_complete_arg 'readall' -l debug -d 'Display any debugging information' -__fish_brew_complete_arg 'readall' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not. Implied if HOMEBREW_EVAL_ALL is set' +__fish_brew_complete_arg 'readall' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not. Implied if `HOMEBREW_EVAL_ALL` is set' __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 quiet -d 'Make some output more quiet' @@ -1201,7 +1201,7 @@ __fish_brew_complete_arg 'reinstall' -l build-from-source -d 'Compile formula fr __fish_brew_complete_arg 'reinstall' -l cask -d 'Treat all named arguments as casks' __fish_brew_complete_arg 'reinstall' -l colorpickerdir -d 'Target location for Color Pickers (default: `~/Library/ColorPickers`)' __fish_brew_complete_arg 'reinstall' -l debug -d 'If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory' -__fish_brew_complete_arg 'reinstall' -l debug-symbols -d 'Generate debug symbols on build. Source will be retained in a cache directory. ' +__fish_brew_complete_arg 'reinstall' -l debug-symbols -d 'Generate debug symbols on build. Source will be retained in a cache directory' __fish_brew_complete_arg 'reinstall' -l dictionarydir -d 'Target location for Dictionaries (default: `~/Library/Dictionaries`)' __fish_brew_complete_arg 'reinstall' -l display-times -d 'Print install times for each formula at the end of the run' __fish_brew_complete_arg 'reinstall' -l fontdir -d 'Target location for Fonts (default: `~/Library/Fonts`)' @@ -1287,7 +1287,7 @@ __fish_brew_complete_arg 'search' -l closed -d 'Search for only closed GitHub pu __fish_brew_complete_arg 'search' -l debian -d 'Search for text in the given database' __fish_brew_complete_arg 'search' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'search' -l desc -d 'Search for formulae with a description matching text and casks with a name or description matching text' -__fish_brew_complete_arg 'search' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if HOMEBREW_EVAL_ALL is set' +__fish_brew_complete_arg 'search' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set' __fish_brew_complete_arg 'search' -l fedora -d 'Search for text in the given database' __fish_brew_complete_arg 'search' -l fink -d 'Search for text in the given database' __fish_brew_complete_arg 'search' -l formula -d 'Search online and locally for formulae' @@ -1331,7 +1331,7 @@ __fish_brew_complete_arg 'style; and not __fish_seen_argument -l formula -l form __fish_brew_complete_cmd 'tap' 'Tap a formula repository' __fish_brew_complete_arg 'tap' -l custom-remote -d 'Install or change a tap with a custom remote. Useful for mirrors' __fish_brew_complete_arg 'tap' -l debug -d 'Display any debugging information' -__fish_brew_complete_arg 'tap' -l eval-all -d 'Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if HOMEBREW_EVAL_ALL is set' +__fish_brew_complete_arg 'tap' -l eval-all -d 'Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if `HOMEBREW_EVAL_ALL` is set' __fish_brew_complete_arg 'tap' -l force-auto-update -d 'Auto-update tap even if it is not hosted on GitHub. By default, only taps hosted on GitHub are auto-updated (for performance reasons)' __fish_brew_complete_arg 'tap' -l help -d 'Show this message' __fish_brew_complete_arg 'tap' -l list-pinned -d 'List all pinned taps' @@ -1422,7 +1422,7 @@ __fish_brew_complete_arg 'typecheck' -l verbose -d 'Make some output more verbos __fish_brew_complete_cmd 'unbottled' 'Show the unbottled dependents of formulae' __fish_brew_complete_arg 'unbottled' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'unbottled' -l dependents -d 'Skip getting analytics data and sort by number of dependents instead' -__fish_brew_complete_arg 'unbottled' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to check them. Implied if HOMEBREW_EVAL_ALL is set' +__fish_brew_complete_arg 'unbottled' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to check them. Implied if `HOMEBREW_EVAL_ALL` is set' __fish_brew_complete_arg 'unbottled' -l help -d 'Show this message' __fish_brew_complete_arg 'unbottled' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg 'unbottled' -l tag -d 'Use the specified bottle tag (e.g. `big_sur`) instead of the current OS' @@ -1581,7 +1581,7 @@ __fish_brew_complete_arg 'upgrade' -l build-from-source -d 'Compile formula from __fish_brew_complete_arg 'upgrade' -l cask -d 'Treat all named arguments as casks. If no named arguments are specified, upgrade only outdated casks' __fish_brew_complete_arg 'upgrade' -l colorpickerdir -d 'Target location for Color Pickers (default: `~/Library/ColorPickers`)' __fish_brew_complete_arg 'upgrade' -l debug -d 'If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory' -__fish_brew_complete_arg 'upgrade' -l debug-symbols -d 'Generate debug symbols on build. Source will be retained in a cache directory. ' +__fish_brew_complete_arg 'upgrade' -l debug-symbols -d 'Generate debug symbols on build. Source will be retained in a cache directory' __fish_brew_complete_arg 'upgrade' -l dictionarydir -d 'Target location for Dictionaries (default: `~/Library/Dictionaries`)' __fish_brew_complete_arg 'upgrade' -l display-times -d 'Print install times for each package at the end of the run' __fish_brew_complete_arg 'upgrade' -l dry-run -d 'Show what would be upgraded, but do not actually upgrade anything' @@ -1640,7 +1640,7 @@ __fish_brew_complete_arg 'vendor-gems' -l debug -d 'Display any debugging inform __fish_brew_complete_arg 'vendor-gems' -l help -d 'Show this message' __fish_brew_complete_arg 'vendor-gems' -l no-commit -d 'Do not generate a new commit upon completion' __fish_brew_complete_arg 'vendor-gems' -l quiet -d 'Make some output more quiet' -__fish_brew_complete_arg 'vendor-gems' -l update -d 'Update all vendored Gems to the latest version' +__fish_brew_complete_arg 'vendor-gems' -l update -d 'Update the specified list of vendored gems to the latest version' __fish_brew_complete_arg 'vendor-gems' -l verbose -d 'Make some output more verbose' diff --git a/completions/zsh/_brew b/completions/zsh/_brew index 6f0dabde5f..2a90f78d7f 100644 --- a/completions/zsh/_brew +++ b/completions/zsh/_brew @@ -357,7 +357,7 @@ _brew__s() { '(--repology --macports --fink --opensuse --fedora --archlinux --ubuntu)--debian[Search for text in the given database]' \ '--debug[Display any debugging information]' \ '(--pull-request)--desc[Search for formulae with a description matching text and casks with a name or description matching text]' \ - '--eval-all[Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if HOMEBREW_EVAL_ALL is set]' \ + '--eval-all[Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set]' \ '(--repology --macports --fink --opensuse --archlinux --debian --ubuntu)--fedora[Search for text in the given database]' \ '(--repology --macports --opensuse --fedora --archlinux --debian --ubuntu)--fink[Search for text in the given database]' \ '--formula[Search online and locally for formulae]' \ @@ -379,7 +379,7 @@ _brew_abv() { '--category[Which type of analytics data to retrieve. The value for category must be `install`, `install-on-request` or `build-error`; `cask-install` or `os-version` may be specified if formula is not. The default is `install`]' \ '--days[How many days of analytics data to retrieve. The value for days must be `30`, `90` or `365`. The default is `30`]' \ '--debug[Display any debugging information]' \ - '(--installed)--eval-all[Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if HOMEBREW_EVAL_ALL is set]' \ + '(--installed)--eval-all[Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `HOMEBREW_EVAL_ALL` is set]' \ '(--bottle)--github[Open the GitHub source page for formula and cask in a browser. To view the history locally: `brew log -p` formula or cask]' \ '--help[Show this message]' \ '(--eval-all --all)--installed[Print JSON of formulae that are currently installed]' \ @@ -415,7 +415,7 @@ _brew_audit() { '(--skip-style --only-cops --except-cops)--display-cop-names[Include the RuboCop cop name for each violation in the output]' \ '--display-failures-only[Only display casks that fail the audit. This is the default for formulae]' \ '--display-filename[Prefix every line of output with the file or formula name being audited, to make output easy to grep]' \ - '--eval-all[Evaluate all available formulae and casks, whether installed or not, to audit them. Implied if HOMEBREW_EVAL_ALL is set]' \ + '--eval-all[Evaluate all available formulae and casks, whether installed or not, to audit them. Implied if `HOMEBREW_EVAL_ALL` is set]' \ '(--only)--except[Specify a comma-separated method list to skip running the methods named `audit_`method]' \ '(--only-cops --strict --only-cops --only --display-cop-names)--except-cops[Specify a comma-separated cops list to skip checking for violations of the listed RuboCop cops]' \ '--fix[Fix style violations automatically using RuboCop'\''s auto-correct feature]' \ @@ -734,7 +734,7 @@ _brew_desc() { _arguments \ '--debug[Display any debugging information]' \ '(--search --name)--description[Search just descriptions for text. If text is flanked by slashes, it is interpreted as a regular expression]' \ - '--eval-all[Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if HOMEBREW_EVAL_ALL is set]' \ + '--eval-all[Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set]' \ '--help[Show this message]' \ '(--search --description)--name[Search just names for text. If text is flanked by slashes, it is interpreted as a regular expression]' \ '--quiet[Make some output more quiet]' \ @@ -768,7 +768,7 @@ _brew_dispatch_build_bottle() { '(--linux-self-hosted)--linux[Dispatch bottle for Linux (using GitHub runners)]' \ '(--linux)--linux-self-hosted[Dispatch bottle for Linux (using self-hosted runner)]' \ '--linux-wheezy[Use Debian Wheezy container for building the bottle on Linux]' \ - '--macos[Version(s) of macOS the bottle should be built for]' \ + '--macos[macOS version (or comma-separated list of versions) the bottle should be built for]' \ '--quiet[Make some output more quiet]' \ '--tap[Target tap repository (default: `homebrew/core`)]' \ '--timeout[Build timeout (in minutes, default: 60)]' \ @@ -954,7 +954,7 @@ _brew_info() { '--category[Which type of analytics data to retrieve. The value for category must be `install`, `install-on-request` or `build-error`; `cask-install` or `os-version` may be specified if formula is not. The default is `install`]' \ '--days[How many days of analytics data to retrieve. The value for days must be `30`, `90` or `365`. The default is `30`]' \ '--debug[Display any debugging information]' \ - '(--installed)--eval-all[Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if HOMEBREW_EVAL_ALL is set]' \ + '(--installed)--eval-all[Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `HOMEBREW_EVAL_ALL` is set]' \ '(--bottle)--github[Open the GitHub source page for formula and cask in a browser. To view the history locally: `brew log -p` formula or cask]' \ '--help[Show this message]' \ '(--eval-all --all)--installed[Print JSON of formulae that are currently installed]' \ @@ -984,7 +984,7 @@ _brew_instal() { '(--cask)--cc[Attempt to compile using the specified compiler, which should be the name of the compiler'\''s executable, e.g. `gcc-7` for GCC 7. In order to use LLVM'\''s clang, specify `llvm_clang`. To use the Apple-provided clang, specify `clang`. This option will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this option]' \ '(--formula)--colorpickerdir[Target location for Color Pickers (default: `~/Library/ColorPickers`)]' \ '--debug[If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory]' \ - '(--cask)--debug-symbols[Generate debug symbols on build. Source will be retained in a cache directory. ]' \ + '(--cask)--debug-symbols[Generate debug symbols on build. Source will be retained in a cache directory]' \ '(--formula)--dictionarydir[Target location for Dictionaries (default: `~/Library/Dictionaries`)]' \ '(--cask)--display-times[Print install times for each package at the end of the run]' \ '--dry-run[Show what would be installed, but do not actually install anything]' \ @@ -1040,7 +1040,7 @@ _brew_install() { '(--cask)--cc[Attempt to compile using the specified compiler, which should be the name of the compiler'\''s executable, e.g. `gcc-7` for GCC 7. In order to use LLVM'\''s clang, specify `llvm_clang`. To use the Apple-provided clang, specify `clang`. This option will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this option]' \ '(--formula)--colorpickerdir[Target location for Color Pickers (default: `~/Library/ColorPickers`)]' \ '--debug[If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory]' \ - '(--cask)--debug-symbols[Generate debug symbols on build. Source will be retained in a cache directory. ]' \ + '(--cask)--debug-symbols[Generate debug symbols on build. Source will be retained in a cache directory]' \ '(--formula)--dictionarydir[Target location for Dictionaries (default: `~/Library/Dictionaries`)]' \ '(--cask)--display-times[Print install times for each package at the end of the run]' \ '--dry-run[Show what would be installed, but do not actually install anything]' \ @@ -1442,7 +1442,7 @@ _brew_readall() { _arguments \ '--aliases[Verify any alias symlinks in each tap]' \ '--debug[Display any debugging information]' \ - '--eval-all[Evaluate all available formulae and casks, whether installed or not. Implied if HOMEBREW_EVAL_ALL is set]' \ + '--eval-all[Evaluate all available formulae and casks, whether installed or not. Implied if `HOMEBREW_EVAL_ALL` is set]' \ '--help[Show this message]' \ '--no-simulate[Don'\''t simulate other system configurations when checking formulae and casks]' \ '--quiet[Make some output more quiet]' \ @@ -1462,7 +1462,7 @@ _brew_reinstall() { '(--cask --force-bottle)--build-from-source[Compile formula from source even if a bottle is available]' \ '(--formula)--colorpickerdir[Target location for Color Pickers (default: `~/Library/ColorPickers`)]' \ '--debug[If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory]' \ - '(--cask)--debug-symbols[Generate debug symbols on build. Source will be retained in a cache directory. ]' \ + '(--cask)--debug-symbols[Generate debug symbols on build. Source will be retained in a cache directory]' \ '(--formula)--dictionarydir[Target location for Dictionaries (default: `~/Library/Dictionaries`)]' \ '(--cask)--display-times[Print install times for each formula at the end of the run]' \ '(--formula)--fontdir[Target location for Fonts (default: `~/Library/Fonts`)]' \ @@ -1567,7 +1567,7 @@ _brew_search() { '(--repology --macports --fink --opensuse --fedora --archlinux --ubuntu)--debian[Search for text in the given database]' \ '--debug[Display any debugging information]' \ '(--pull-request)--desc[Search for formulae with a description matching text and casks with a name or description matching text]' \ - '--eval-all[Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if HOMEBREW_EVAL_ALL is set]' \ + '--eval-all[Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set]' \ '(--repology --macports --fink --opensuse --archlinux --debian --ubuntu)--fedora[Search for text in the given database]' \ '(--repology --macports --opensuse --fedora --archlinux --debian --ubuntu)--fink[Search for text in the given database]' \ '--formula[Search online and locally for formulae]' \ @@ -1624,7 +1624,7 @@ _brew_tap() { _arguments \ '--custom-remote[Install or change a tap with a custom remote. Useful for mirrors]' \ '--debug[Display any debugging information]' \ - '--eval-all[Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if HOMEBREW_EVAL_ALL is set]' \ + '--eval-all[Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if `HOMEBREW_EVAL_ALL` is set]' \ '--force-auto-update[Auto-update tap even if it is not hosted on GitHub. By default, only taps hosted on GitHub are auto-updated (for performance reasons)]' \ '--help[Show this message]' \ '--list-pinned[List all pinned taps]' \ @@ -1733,7 +1733,7 @@ _brew_unbottled() { _arguments \ '--debug[Display any debugging information]' \ '(--total)--dependents[Skip getting analytics data and sort by number of dependents instead]' \ - '--eval-all[Evaluate all available formulae and casks, whether installed or not, to check them. Implied if HOMEBREW_EVAL_ALL is set]' \ + '--eval-all[Evaluate all available formulae and casks, whether installed or not, to check them. Implied if `HOMEBREW_EVAL_ALL` is set]' \ '--help[Show this message]' \ '--quiet[Make some output more quiet]' \ '--tag[Use the specified bottle tag (e.g. `big_sur`) instead of the current OS]' \ @@ -1931,7 +1931,7 @@ _brew_upgrade() { '(--cask --force-bottle)--build-from-source[Compile formula from source even if a bottle is available]' \ '(--formula)--colorpickerdir[Target location for Color Pickers (default: `~/Library/ColorPickers`)]' \ '--debug[If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory]' \ - '(--cask)--debug-symbols[Generate debug symbols on build. Source will be retained in a cache directory. ]' \ + '(--cask)--debug-symbols[Generate debug symbols on build. Source will be retained in a cache directory]' \ '(--formula)--dictionarydir[Target location for Dictionaries (default: `~/Library/Dictionaries`)]' \ '(--cask)--display-times[Print install times for each package at the end of the run]' \ '--dry-run[Show what would be upgraded, but do not actually upgrade anything]' \ @@ -1998,7 +1998,7 @@ _brew_vendor_gems() { '--help[Show this message]' \ '--no-commit[Do not generate a new commit upon completion]' \ '--quiet[Make some output more quiet]' \ - '--update[Update all vendored Gems to the latest version]' \ + '--update[Update the specified list of vendored gems to the latest version]' \ '--verbose[Make some output more verbose]' } diff --git a/docs/Manpage.md b/docs/Manpage.md index 210604cbc3..b598377863 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -82,7 +82,7 @@ Read more at . `brew analytics regenerate-uuid`
Regenerate the UUID used for Homebrew's analytics. -### `autoremove` [*`--dry-run`*] +### `autoremove` [`--dry-run`] Uninstall formulae that were only installed as a dependency of another formula and are now no longer needed. @@ -109,7 +109,7 @@ only do this for the given formulae and casks. Removes all downloads more than * `--prune-prefix`: Only prune the symlinks and directories from the prefix and remove no other files. -### `commands` [*`--quiet`*] [*`--include-aliases`*] +### `commands` [`--quiet`] [`--include-aliases`] Show lists of built-in and external commands. @@ -189,7 +189,7 @@ The cache is created on the first search, making that search slower than subsequ * `-d`, `--description`: Search just descriptions for *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression. * `--eval-all`: - Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if HOMEBREW_EVAL_ALL is set. + Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set. * `--formula`: Treat all named arguments as formulae. * `--cask`: @@ -211,7 +211,7 @@ branch instead of the latest stable version along with some other behaviour chan Open Homebrew's online documentation (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 if any potential problems are found. Please note that these warnings are just @@ -270,7 +270,7 @@ error message if no logs are found. * `-p`, `--private`: The Gist will be marked private and will not appear in listings but will be accessible with its link. -### `home`, `homepage` [*`--formula`*] [*`--cask`*] [*`formula`*|*`cask`* ...] +### `home`, `homepage` [`--formula`] [`--cask`] [*`formula`*|*`cask`* ...] Open a *`formula`* or *`cask`*'s homepage in a browser, or open Homebrew's own homepage if no argument is provided. @@ -299,7 +299,7 @@ If a *`formula`* or *`cask`* is provided, show summary of information about it. * `--installed`: Print JSON of formulae that are currently installed. * `--eval-all`: - Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if HOMEBREW_EVAL_ALL is set. + Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `HOMEBREW_EVAL_ALL` is set. * `--variations`: Include the variations hash in each formula's JSON output. * `-v`, `--verbose`: @@ -320,7 +320,7 @@ outdated dependents and dependents with broken linkage, respectively. Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the installed formulae or, every 30 days, for all formulae. -Unless `HOMEBREW_NO_INSTALL_UPGRADE` is set, `brew install *`formula`*` will upgrade *`formula`* if it +Unless `HOMEBREW_NO_INSTALL_UPGRADE` is set, `brew install` *`formula`* will upgrade *`formula`* if it is already installed but outdated. * `-d`, `--debug`: @@ -352,7 +352,7 @@ is already installed but outdated. * `--keep-tmp`: Retain the temporary files created during installation. * `--debug-symbols`: - Generate debug symbols on build. Source will be retained in a cache directory. + Generate debug symbols on build. Source will be retained in a cache directory. * `--build-bottle`: Prepare the formula for eventual bottling during installation, skipping any post-install steps. * `--bottle-arch`: @@ -380,7 +380,7 @@ is already installed but outdated. * `--zap`: For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.* -### `leaves` [*`--installed-on-request`*] [*`--installed-as-dependency`*] +### `leaves` [`--installed-on-request`] [`--installed-as-dependency`] List installed formulae that are not dependencies of another installed formula. @@ -452,7 +452,7 @@ if no formula or cask is provided. * `--cask`: Treat all named arguments as casks. -### `migrate` [*`--force`*] [*`--dry-run`*] *`installed_formula`* [...] +### `migrate` [`--force`] [`--dry-run`] *`installed_formula`* [...] Migrate renamed packages to new names, where *`formula`* are old names of packages. @@ -462,7 +462,7 @@ packages. * `-n`, `--dry-run`: Show what would be migrated, but do not actually migrate anything. -### `missing` [*`--hide`*`=`] [*`formula`* ...] +### `missing` [`--hide=`] [*`formula`* ...] Check the given *`formula`* kegs for missing dependencies. If no *`formula`* are provided, check all kegs. Will exit with a non-zero status if any kegs are found @@ -529,7 +529,7 @@ all items or checking if any current formulae/casks have Ruby issues. * `--syntax`: Syntax-check all of Homebrew's Ruby files (if no `*`tap`*` is passed). * `--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`: Don't simulate other system configurations when checking formulae and casks. @@ -561,7 +561,7 @@ reinstalled formulae or, every 30 days, for all formulae. * `--keep-tmp`: Retain the temporary files created during installation. * `--debug-symbols`: - Generate debug symbols on build. Source will be retained in a cache directory. + Generate debug symbols on build. Source will be retained in a cache directory. * `--display-times`: Print install times for each formula at the end of the run. * `-g`, `--git`: @@ -594,7 +594,7 @@ The search for *`text`* is extended online to `homebrew/core` and `homebrew/cask * `--desc`: Search for formulae with a description matching *`text`* and casks with a name or description matching *`text`*. * `--eval-all`: - Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if HOMEBREW_EVAL_ALL is set. + Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set. * `--pull-request`: Search for GitHub pull requests containing *`text`*. * `--open`: @@ -652,9 +652,9 @@ using protocols other than HTTPS, e.g. SSH, git, HTTP, FTP(S), rsync. * `--list-pinned`: List all pinned taps. * `--eval-all`: - Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if HOMEBREW_EVAL_ALL is set. + Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if `HOMEBREW_EVAL_ALL` is set. -### `tap-info` [*`--installed`*] [*`--json`*] [*`tap`* ...] +### `tap-info` [`--installed`] [`--json`] [*`tap`* ...] Show detailed information about one or more *`tap`*s. @@ -680,7 +680,7 @@ Uninstall a *`formula`* or *`cask`*. * `--cask`: Treat all named arguments as casks. -### `unlink` [*`--dry-run`*] *`installed_formula`* [...] +### `unlink` [`--dry-run`] *`installed_formula`* [...] Remove symlinks for *`formula`* from Homebrew's prefix. This can be useful for temporarily disabling a formula: @@ -694,7 +694,7 @@ for temporarily disabling a formula: Unpin *`formula`*, allowing them to be upgraded by `brew upgrade` *`formula`*. See also `pin`. -### `untap` [*`--force`*] *`tap`* [...] +### `untap` [`--force`] *`tap`* [...] Remove a tapped formula repository. @@ -753,7 +753,7 @@ upgraded formulae or, every 30 days, for all formulae. * `--keep-tmp`: Retain the temporary files created during installation. * `--debug-symbols`: - Generate debug symbols on build. Source will be retained in a cache directory. + Generate debug symbols on build. Source will be retained in a cache directory. * `--display-times`: Print install times for each package at the end of the run. * `--cask`: @@ -833,7 +833,7 @@ that directory doesn't exist, `$(brew --repository)/Cellar`. If *`formula`* is provided, display the location in the Cellar where *`formula`* would be installed, without any sort of versioned directory as the last path. -### `--env`, `environment` [*`--shell`*`=`] [*`--plain`*] [*`formula`* ...] +### `--env`, `environment` [`--shell=`] [`--plain`] [*`formula`* ...] Summarise Homebrew's build environment as a plain list. @@ -845,7 +845,7 @@ the list is formatted for export to `bash`(1) unless `--plain` is passed. * `--plain`: Generate plain output even when piped. -### `--prefix` [*`--unbrewed`*] [*`--installed`*] [*`formula`* ...] +### `--prefix` [`--unbrewed`] [`--installed`] [*`formula`* ...] Display Homebrew's install path. *Default:* @@ -888,7 +888,7 @@ non-zero status if any errors are found. * `--installed`: Only check formulae and casks that are currently installed. * `--eval-all`: - Evaluate all available formulae and casks, whether installed or not, to audit them. Implied if HOMEBREW_EVAL_ALL is set. + Evaluate all available formulae and casks, whether installed or not, to audit them. Implied if `HOMEBREW_EVAL_ALL` is set. * `--new`: Run various additional style checks to determine if a new formula or cask is eligible for Homebrew. This should be used when creating new formula and implies `--strict` and `--online`. * `--[no-]appcast`: @@ -1101,7 +1101,7 @@ Check all casks with unversioned URLs in a given *`tap`* for updates. * `--state-file`: File for caching state. -### `cat` [*`--formula`*] [*`--cask`*] *`formula`*|*`cask`* [...] +### `cat` [`--formula`] [`--cask`] *`formula`*|*`cask`* [...] Display the source of a *`formula`* or *`cask`*. @@ -1183,7 +1183,7 @@ Build bottles for these formulae with GitHub Actions. * `--issue`: If specified, post a comment to this issue number if the job fails. * `--macos`: - Version(s) of macOS the bottle should be built for. + macOS version (or comma-separated list of versions) the bottle should be built for. * `--workflow`: Dispatch specified workflow (default: `dispatch-build-bottle.yml`). * `--upload`: @@ -1207,7 +1207,7 @@ or open the Homebrew repository for editing if no formula is provided. * `--print-path`: Print the file path to be edited, without opening an editor. -### `extract` [*`--version`*`=`] [*`--force`*] *`formula`* *`tap`* +### `extract` [`--version=`] [`--force`] *`formula`* *`tap`* Look through repository history to find the most recent version of *`formula`* and create a copy in *`tap`*. Specifically, the command will create the new @@ -1229,14 +1229,14 @@ Display the path where *`formula`* is located. Generate Homebrew's manpages and shell completions. -### `install-bundler-gems` [*`--groups`*`=`] +### `install-bundler-gems` [`--groups=`] Install Homebrew's Bundler gems. * `--groups`: Installs the specified comma-separated list of gem groups (default: last used). -### `irb` [*`--examples`*] [*`--pry`*] +### `irb` [`--examples`] [`--pry`] Enter the interactive Homebrew Ruby shell. @@ -1387,14 +1387,14 @@ Apply the bottle commit and publish bottles to a host. * `--root-url-using`: Use the specified download strategy class for downloading the bottle's URL instead of Homebrew's default. -### `prof` [*`--stackprof`*] *`command`* [...] +### `prof` [`--stackprof`] *`command`* [...] Run Homebrew with a Ruby profiler. For example, `brew prof readall`. * `--stackprof`: Use `stackprof` instead of `ruby-prof` (the default). -### `release` [*`--major`*] [*`--minor`*] +### `release` [`--major`] [`--minor`] Create a new draft Homebrew/brew release with the appropriate version number and release notes. @@ -1426,7 +1426,7 @@ Run e.g. `brew ruby -- --version` to pass arbitrary arguments to `ruby`. * `-e`: Execute the given text string as a script. -### `sh` [*`--env`*`=`] [*`--cmd`*`=`] [*`file`*] +### `sh` [`--env=`] [`--cmd=`] [*`file`*] Enter an interactive shell for Homebrew's build environment. Use years-battle-hardened build logic to help your `./configure && make && make install` @@ -1545,7 +1545,7 @@ Show the unbottled dependents of formulae. * `--total`: Print the number of unbottled and total formulae. * `--eval-all`: - Evaluate all available formulae and casks, whether installed or not, to check them. Implied if HOMEBREW_EVAL_ALL is set. + Evaluate all available formulae and casks, whether installed or not, to check them. Implied if `HOMEBREW_EVAL_ALL` is set. ### `unpack` [*`options`*] *`formula`* [...] @@ -1606,12 +1606,12 @@ If no options are passed, use `origin/master` as the start commit. * `--before`: Use the commit at the specified *`date`* as the start commit. -### `vendor-gems` [*`--update`*`=`] [*`--no-commit`*] +### `vendor-gems` [`--update=`] [`--no-commit`] Install and commit Homebrew's vendored gems. * `--update`: - Update all vendored Gems to the latest version. + Update the specified list of vendored gems to the latest version. * `--no-commit`: Do not generate a new commit upon completion. @@ -1915,7 +1915,7 @@ Only supports GitHub Actions as a CI provider. This is because Homebrew uses Git Remove aliases. -### `which-formula` [*`--explain`*] *`command`* [...] +### `which-formula` [`--explain`] *`command`* [...] Prints the formula(e) which provides the given command. @@ -1996,12 +1996,12 @@ example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just
Prefix all download URLs, including those for bottles, with this value. For example, `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080` will cause a formula with the URL `https://example.com/foo.tar.gz` to instead download from `http://localhost:8080/https://example.com/foo.tar.gz`. Bottle URLs however, have their domain replaced with this prefix. This results in e.g. `https://ghcr.io/v2/homebrew/core/gettext/manifests/0.21` to instead be downloaded from `http://localhost:8080/v2/homebrew/core/gettext/manifests/0.21` - `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, disable auto-update entirely with HOMEBREW_NO_AUTO_UPDATE. +
Run `brew update` once every `HOMEBREW_AUTO_UPDATE_SECS` seconds before some commands, e.g. `brew install`, `brew upgrade` and `brew tap`. Alternatively, disable auto-update entirely with `HOMEBREW_NO_AUTO_UPDATE`. - *Default:* 86400 (24 hours) or 300 (5 minutes) if HOMEBREW_NO_INSTALL_FROM_API is set. + *Default:* 86400 (24 hours) or 300 (5 minutes) if `HOMEBREW_NO_INSTALL_FROM_API` is set. - `HOMEBREW_AUTOREMOVE` -
If set, calls to `brew cleanup` and `brew uninstall` will automatically remove unused formula dependents and if HOMEBREW_NO_INSTALL_CLEANUP is not set, `brew cleanup` will start running `brew autoremove` periodically. +
If set, calls to `brew cleanup` and `brew uninstall` will automatically remove unused formula dependents and if `HOMEBREW_NO_INSTALL_CLEANUP` is not set, `brew cleanup` will start running `brew autoremove` periodically. - `HOMEBREW_BAT`
If set, use `bat` for the `brew cat` command. @@ -2042,16 +2042,16 @@ example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just - `HOMEBREW_CASK_OPTS`
Append these options to all `cask` commands. All `--*dir` options, `--language`, `--require-sha`, `--no-quarantine` and `--no-binaries` are supported. For example, you might add something like the following to your `~/.profile`, `~/.bash_profile`, or `~/.zshenv`:\n\n `export HOMEBREW_CASK_OPTS="--appdir=~/Applications --fontdir=/Library/Fonts"` -- `HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS` -
If set, `brew install`, `brew upgrade` and `brew reinstall` will cleanup all formulae when this number of days has passed. - - *Default:* `30`. - - `HOMEBREW_CLEANUP_MAX_AGE_DAYS`
Cleanup all cached files older than this many days. *Default:* `120`. +- `HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS` +
If set, `brew install`, `brew upgrade` and `brew reinstall` will cleanup all formulae when this number of days has passed. + + *Default:* `30`. + - `HOMEBREW_COLOR`
If set, force colour output on non-TTY outputs. @@ -2060,9 +2060,6 @@ example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just *Default:* `https://github.com/Homebrew/homebrew-core`. -- `HOMEBREW_CURLRC` -
If set, do not pass `--disable` when invoking `curl`(1), which disables the use of `curlrc`. - - `HOMEBREW_CURL_PATH`
Linux only: Set this value to a new enough `curl` executable for Homebrew to use. @@ -2076,6 +2073,12 @@ example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just - `HOMEBREW_CURL_VERBOSE`
If set, pass `--verbose` when invoking `curl`(1). +- `HOMEBREW_CURLRC` +
If set, do not pass `--disable` when invoking `curl`(1), which disables the use of `curlrc`. + +- `HOMEBREW_DEBUG` +
If set, always assume `--debug` when running commands. + - `HOMEBREW_DEVELOPER`
If set, tweak behaviour to be more relevant for Homebrew developers (active or budding) by e.g. turning warnings into errors. @@ -2090,6 +2093,12 @@ example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just - `HOMEBREW_DISPLAY_INSTALL_TIMES`
If set, print install times for each formula at the end of the run. +- `HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN` +
Use this base64 encoded username and password for authenticating with a Docker registry proxying GitHub Packages. If `HOMEBREW_DOCKER_REGISTRY_TOKEN` is set, it will be used instead. + +- `HOMEBREW_DOCKER_REGISTRY_TOKEN` +
Use this bearer token for authenticating with a Docker registry proxying GitHub Packages. Preferred over `HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN`. + - `HOMEBREW_EDITOR`
Use this editor when editing a single formula, or several formulae in the same directory. @@ -2120,23 +2129,6 @@ example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just - `HOMEBREW_FORCE_VENDOR_RUBY`
If set, always use Homebrew's vendored, relocatable Ruby version even if the system version of Ruby is new enough. -- `HOMEBREW_GITHUB_API_TOKEN` -
Use this personal access token for the GitHub API, for features such as `brew search`. You can create one at . If set, GitHub will allow you a greater number of API requests. For more information, see: - - *Note:* Homebrew doesn't require permissions for any of the scopes, but some developer commands may require additional permissions. - -- `HOMEBREW_GITHUB_PACKAGES_TOKEN` -
Use this GitHub personal access token when accessing the GitHub Packages Registry (where bottles may be stored). - -- `HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN` -
Use this base64 encoded username and password for authenticating with a Docker registry proxying GitHub Packages. If HOMEBREW_DOCKER_REGISTRY_TOKEN is set, it will be used instead. - -- `HOMEBREW_DOCKER_REGISTRY_TOKEN` -
Use this bearer token for authenticating with a Docker registry proxying GitHub Packages. Preferred over HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN. - -- `HOMEBREW_GITHUB_PACKAGES_USER` -
Use this username when accessing the GitHub Packages Registry (where bottles may be stored). - - `HOMEBREW_GIT_EMAIL`
Set the Git author and committer email to this value. @@ -2148,6 +2140,17 @@ example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just *Default:* `git`. +- `HOMEBREW_GITHUB_API_TOKEN` +
Use this personal access token for the GitHub API, for features such as `brew search`. You can create one at . If set, GitHub will allow you a greater number of API requests. For more information, see: + + *Note:* Homebrew doesn't require permissions for any of the scopes, but some developer commands may require additional permissions. + +- `HOMEBREW_GITHUB_PACKAGES_TOKEN` +
Use this GitHub personal access token when accessing the GitHub Packages Registry (where bottles may be stored). + +- `HOMEBREW_GITHUB_PACKAGES_USER` +
Use this username when accessing the GitHub Packages Registry (where bottles may be stored). + - `HOMEBREW_INSTALL_BADGE`
Print this text before the installation summary of each successful build. @@ -2172,14 +2175,11 @@ example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just
If set, do not send analytics. For more information, see: - `HOMEBREW_NO_AUTO_UPDATE` -
If set, do not automatically update before running some commands, e.g. `brew install`, `brew upgrade` and `brew tap`. Alternatively, run this less often by setting HOMEBREW_AUTO_UPDATE_SECS to a value higher than the default. +
If set, do not automatically update before running some commands, e.g. `brew install`, `brew upgrade` and `brew tap`. Alternatively, run this less often by setting `HOMEBREW_AUTO_UPDATE_SECS` to a value higher than the default. - `HOMEBREW_NO_BOOTSNAP`
If set, do not use Bootsnap to speed up repeated `brew` calls. -- `HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` -
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`*`. - - `HOMEBREW_NO_CLEANUP_FORMULAE`
A comma-separated list of formulae. Homebrew will refuse to clean up or autoremove a formula if it appears on this list. @@ -2206,13 +2206,16 @@ example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just *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` -
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. +
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. - `HOMEBREW_NO_INSTALL_FROM_API`
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` -
If set, `brew install *`formula`*` will not upgrade `*`formula`*` if it is installed but outdated. +
If set, `brew install` *`formula`* will not upgrade *`formula`* if it is installed but outdated. + +- `HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` +
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`*. - `HOMEBREW_PIP_INDEX_URL`
If set, `brew install *`formula`*` will use this URL to download PyPI package resources. @@ -2225,17 +2228,17 @@ example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just - `HOMEBREW_SIMULATE_MACOS_ON_LINUX`
If set, running Homebrew on Linux will simulate certain macOS code paths. This is useful when auditing macOS formulae while on Linux. -- `HOMEBREW_SSH_CONFIG_PATH` -
If set, Homebrew will use the given config file instead of `~/.ssh/config` when fetching `git` repos over `ssh`. - - *Default:* `$HOME/.ssh/config` - - `HOMEBREW_SKIP_OR_LATER_BOTTLES`
If set along with `HOMEBREW_DEVELOPER`, do not use bottles from older versions of macOS. This is useful in development on new macOS versions. - `HOMEBREW_SORBET_RUNTIME`
If set, enable runtime typechecking using Sorbet. +- `HOMEBREW_SSH_CONFIG_PATH` +
If set, Homebrew will use the given config file instead of `~/.ssh/config` when fetching `git` repos over `ssh`. + + *Default:* `$HOME/.ssh/config` + - `HOMEBREW_SVN`
Use this as the `svn`(1) binary. @@ -2255,12 +2258,12 @@ example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just - `HOMEBREW_VERBOSE`
If set, always assume `--verbose` when running commands. -- `HOMEBREW_DEBUG` -
If set, always assume `--debug` when running commands. - - `HOMEBREW_VERBOSE_USING_DOTS`
If set, verbose output will print a `.` no more than once a minute. This can be useful to avoid long-running Homebrew commands being killed due to no output. +- `SUDO_ASKPASS` +
If set, pass the `-A` option when calling `sudo`(8). + - `all_proxy`
Use this SOCKS5 proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew. @@ -2276,9 +2279,6 @@ example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just - `no_proxy`
A comma-separated list of hostnames and domain names excluded from proxying by `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew. -- `SUDO_ASKPASS` -
If set, pass the `-A` option when calling `sudo`(8). - ## USING HOMEBREW BEHIND A PROXY Set the `http_proxy`, `https_proxy`, `all_proxy`, `ftp_proxy` and/or `no_proxy` diff --git a/manpages/brew.1 b/manpages/brew.1 index 571d2521bf..124c6d3f86 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -96,7 +96,7 @@ Control Homebrew\'s anonymous aggregate user behaviour analytics\. Read more at \fBbrew analytics regenerate\-uuid\fR Regenerate the UUID used for Homebrew\'s analytics\. . -.SS "\fBautoremove\fR [\fI\-\-dry\-run\fR]" +.SS "\fBautoremove\fR [\fB\-\-dry\-run\fR]" Uninstall formulae that were only installed as a dependency of another formula and are now no longer needed\. . .TP @@ -125,7 +125,7 @@ Scrub the cache, including downloads for even the latest versions\. Note that do \fB\-\-prune\-prefix\fR Only prune the symlinks and directories from the prefix and remove no other files\. . -.SS "\fBcommands\fR [\fI\-\-quiet\fR] [\fI\-\-include\-aliases\fR]" +.SS "\fBcommands\fR [\fB\-\-quiet\fR] [\fB\-\-include\-aliases\fR]" Show lists of built\-in and external commands\. . .TP @@ -242,7 +242,7 @@ Search just descriptions for \fItext\fR\. If \fItext\fR is flanked by slashes, i . .TP \fB\-\-eval\-all\fR -Evaluate all available formulae and casks, whether installed or not, to search their descriptions\. Implied if HOMEBREW_EVAL_ALL is set\. +Evaluate all available formulae and casks, whether installed or not, to search their descriptions\. Implied if \fBHOMEBREW_EVAL_ALL\fR is set\. . .TP \fB\-\-formula\fR @@ -266,7 +266,7 @@ Control Homebrew\'s developer mode\. When developer mode is enabled, \fBbrew upd .SS "\fBdocs\fR" Open Homebrew\'s online documentation (https://docs\.brew\.sh) in a browser\. . -.SS "\fBdoctor\fR, \fBdr\fR [\fI\-\-list\-checks\fR] [\fI\-\-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\. . .TP @@ -346,7 +346,7 @@ Automatically create a new issue in the appropriate GitHub repository after crea \fB\-p\fR, \fB\-\-private\fR The Gist will be marked private and will not appear in listings but will be accessible with its link\. . -.SS "\fBhome\fR, \fBhomepage\fR [\fI\-\-formula\fR] [\fI\-\-cask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]" +.SS "\fBhome\fR, \fBhomepage\fR [\fB\-\-formula\fR] [\fB\-\-cask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]" Open a \fIformula\fR or \fIcask\fR\'s homepage in a browser, or open Homebrew\'s own homepage if no argument is provided\. . .TP @@ -389,7 +389,7 @@ Print JSON of formulae that are currently installed\. . .TP \fB\-\-eval\-all\fR -Evaluate all available formulae and casks, whether installed or not, to print their JSON\. Implied if HOMEBREW_EVAL_ALL is set\. +Evaluate all available formulae and casks, whether installed or not, to print their JSON\. Implied if \fBHOMEBREW_EVAL_ALL\fR is set\. . .TP \fB\-\-variations\fR @@ -417,7 +417,7 @@ Unless \fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fR is set, \fBbrew upgrade\fR o Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will then be run for the installed formulae or, every 30 days, for all formulae\. . .P -Unless \fBHOMEBREW_NO_INSTALL_UPGRADE\fR is set, \fBbrew install \fR will upgrade \fIformula\fR if it is already installed but outdated\. +Unless \fBHOMEBREW_NO_INSTALL_UPGRADE\fR is set, \fBbrew install\fR \fIformula\fR will upgrade \fIformula\fR if it is already installed but outdated\. . .TP \fB\-d\fR, \fB\-\-debug\fR @@ -531,7 +531,7 @@ Skip installing cask dependencies\. \fB\-\-zap\fR For use with \fBbrew reinstall \-\-cask\fR\. Remove all files associated with a cask\. \fIMay remove files which are shared between applications\.\fR . -.SS "\fBleaves\fR [\fI\-\-installed\-on\-request\fR] [\fI\-\-installed\-as\-dependency\fR]" +.SS "\fBleaves\fR [\fB\-\-installed\-on\-request\fR] [\fB\-\-installed\-as\-dependency\fR]" List installed formulae that are not dependencies of another installed formula\. . .TP @@ -638,7 +638,7 @@ Treat all named arguments as formulae\. \fB\-\-cask\fR Treat all named arguments as casks\. . -.SS "\fBmigrate\fR [\fI\-\-force\fR] [\fI\-\-dry\-run\fR] \fIinstalled_formula\fR [\.\.\.]" +.SS "\fBmigrate\fR [\fB\-\-force\fR] [\fB\-\-dry\-run\fR] \fIinstalled_formula\fR [\.\.\.]" Migrate renamed packages to new names, where \fIformula\fR are old names of packages\. . .TP @@ -649,7 +649,7 @@ Treat installed \fIformula\fR and provided \fIformula\fR as if they are from the \fB\-n\fR, \fB\-\-dry\-run\fR Show what would be migrated, but do not actually migrate anything\. . -.SS "\fBmissing\fR [\fI\-\-hide\fR\fB=\fR] [\fIformula\fR \.\.\.]" +.SS "\fBmissing\fR [\fB\-\-hide=\fR] [\fIformula\fR \.\.\.]" Check the given \fIformula\fR kegs for missing dependencies\. If no \fIformula\fR are provided, check all kegs\. Will exit with a non\-zero status if any kegs are found to be missing dependencies\. . .TP @@ -733,7 +733,7 @@ Syntax\-check all of Homebrew\'s Ruby files (if no \fB\fR is passed)\. . .TP \fB\-\-eval\-all\fR -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 \fBHOMEBREW_EVAL_ALL\fR is set\. . .TP \fB\-\-no\-simulate\fR @@ -837,7 +837,7 @@ Search for formulae with a description matching \fItext\fR and casks with a name . .TP \fB\-\-eval\-all\fR -Evaluate all available formulae and casks, whether installed or not, to search their descriptions\. Implied if HOMEBREW_EVAL_ALL is set\. +Evaluate all available formulae and casks, whether installed or not, to search their descriptions\. Implied if \fBHOMEBREW_EVAL_ALL\fR is set\. . .TP \fB\-\-pull\-request\fR @@ -919,9 +919,9 @@ List all pinned taps\. . .TP \fB\-\-eval\-all\fR -Evaluate all the formulae, casks and aliases in the new tap to check validity\. Implied if HOMEBREW_EVAL_ALL is set\. +Evaluate all the formulae, casks and aliases in the new tap to check validity\. Implied if \fBHOMEBREW_EVAL_ALL\fR is set\. . -.SS "\fBtap\-info\fR [\fI\-\-installed\fR] [\fI\-\-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\. . .P @@ -958,7 +958,7 @@ Treat all named arguments as formulae\. \fB\-\-cask\fR Treat all named arguments as casks\. . -.SS "\fBunlink\fR [\fI\-\-dry\-run\fR] \fIinstalled_formula\fR [\.\.\.]" +.SS "\fBunlink\fR [\fB\-\-dry\-run\fR] \fIinstalled_formula\fR [\.\.\.]" Remove symlinks for \fIformula\fR from Homebrew\'s prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink\fR \fIformula\fR \fB&&\fR \fIcommands\fR \fB&& brew link\fR \fIformula\fR . .TP @@ -968,7 +968,7 @@ List files which would be unlinked without actually unlinking or deleting any fi .SS "\fBunpin\fR \fIinstalled_formula\fR [\.\.\.]" Unpin \fIformula\fR, allowing them to be upgraded by \fBbrew upgrade\fR \fIformula\fR\. See also \fBpin\fR\. . -.SS "\fBuntap\fR [\fI\-\-force\fR] \fItap\fR [\.\.\.]" +.SS "\fBuntap\fR [\fB\-\-force\fR] \fItap\fR [\.\.\.]" Remove a tapped formula repository\. . .TP @@ -1170,7 +1170,7 @@ Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB$(brew \-\-prefix)/Cellar\fR .P If \fIformula\fR is provided, display the location in the Cellar where \fIformula\fR would be installed, without any sort of versioned directory as the last path\. . -.SS "\fB\-\-env\fR, \fBenvironment\fR [\fI\-\-shell\fR\fB=\fR] [\fI\-\-plain\fR] [\fIformula\fR \.\.\.]" +.SS "\fB\-\-env\fR, \fBenvironment\fR [\fB\-\-shell=\fR] [\fB\-\-plain\fR] [\fIformula\fR \.\.\.]" Summarise Homebrew\'s build environment as a plain list\. . .P @@ -1184,7 +1184,7 @@ Generate a list of environment variables for the specified shell, or \fB\-\-shel \fB\-\-plain\fR Generate plain output even when piped\. . -.SS "\fB\-\-prefix\fR [\fI\-\-unbrewed\fR] [\fI\-\-installed\fR] [\fIformula\fR \.\.\.]" +.SS "\fB\-\-prefix\fR [\fB\-\-unbrewed\fR] [\fB\-\-installed\fR] [\fIformula\fR \.\.\.]" Display Homebrew\'s install path\. \fIDefault:\fR . .IP "\(bu" 4 @@ -1241,7 +1241,7 @@ Only check formulae and casks that are currently installed\. . .TP \fB\-\-eval\-all\fR -Evaluate all available formulae and casks, whether installed or not, to audit them\. Implied if HOMEBREW_EVAL_ALL is set\. +Evaluate all available formulae and casks, whether installed or not, to audit them\. Implied if \fBHOMEBREW_EVAL_ALL\fR is set\. . .TP \fB\-\-new\fR @@ -1588,7 +1588,7 @@ Maximum runtime in minutes\. \fB\-\-state\-file\fR File for caching state\. . -.SS "\fBcat\fR [\fI\-\-formula\fR] [\fI\-\-cask\fR] \fIformula\fR|\fIcask\fR [\.\.\.]" +.SS "\fBcat\fR [\fB\-\-formula\fR] [\fB\-\-cask\fR] \fIformula\fR|\fIcask\fR [\.\.\.]" Display the source of a \fIformula\fR or \fIcask\fR\. . .TP @@ -1712,7 +1712,7 @@ If specified, post a comment to this issue number if the job fails\. . .TP \fB\-\-macos\fR -Version(s) of macOS the bottle should be built for\. +macOS version (or comma\-separated list of versions) the bottle should be built for\. . .TP \fB\-\-workflow\fR @@ -1749,7 +1749,7 @@ Treat all named arguments as casks\. \fB\-\-print\-path\fR Print the file path to be edited, without opening an editor\. . -.SS "\fBextract\fR [\fI\-\-version\fR\fB=\fR] [\fI\-\-force\fR] \fIformula\fR \fItap\fR" +.SS "\fBextract\fR [\fB\-\-version=\fR] [\fB\-\-force\fR] \fIformula\fR \fItap\fR" Look through repository history to find the most recent version of \fIformula\fR and create a copy in \fItap\fR\. Specifically, the command will create the new formula file at \fItap\fR\fB/Formula/\fR\fIformula\fR\fB@\fR\fIversion\fR\fB\.rb\fR\. If the tap is not installed yet, attempt to install/clone the tap before continuing\. To extract a formula from a tap that is not \fBhomebrew/core\fR use its fully\-qualified form of \fIuser\fR\fB/\fR\fIrepo\fR\fB/\fR\fIformula\fR\. . .TP @@ -1766,14 +1766,14 @@ Display the path where \fIformula\fR is located\. .SS "\fBgenerate\-man\-completions\fR" Generate Homebrew\'s manpages and shell completions\. . -.SS "\fBinstall\-bundler\-gems\fR [\fI\-\-groups\fR\fB=\fR]" +.SS "\fBinstall\-bundler\-gems\fR [\fB\-\-groups=\fR]" Install Homebrew\'s Bundler gems\. . .TP \fB\-\-groups\fR Installs the specified comma\-separated list of gem groups (default: last used)\. . -.SS "\fBirb\fR [\fI\-\-examples\fR] [\fI\-\-pry\fR]" +.SS "\fBirb\fR [\fB\-\-examples\fR] [\fB\-\-pry\fR]" Enter the interactive Homebrew Ruby shell\. . .TP @@ -2013,14 +2013,14 @@ Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew \fB\-\-root\-url\-using\fR Use the specified download strategy class for downloading the bottle\'s URL instead of Homebrew\'s default\. . -.SS "\fBprof\fR [\fI\-\-stackprof\fR] \fIcommand\fR [\.\.\.]" +.SS "\fBprof\fR [\fB\-\-stackprof\fR] \fIcommand\fR [\.\.\.]" Run Homebrew with a Ruby profiler\. For example, \fBbrew prof readall\fR\. . .TP \fB\-\-stackprof\fR Use \fBstackprof\fR instead of \fBruby\-prof\fR (the default)\. . -.SS "\fBrelease\fR [\fI\-\-major\fR] [\fI\-\-minor\fR]" +.SS "\fBrelease\fR [\fB\-\-major\fR] [\fB\-\-minor\fR]" Create a new draft Homebrew/brew release with the appropriate version number and release notes\. . .P @@ -2054,7 +2054,7 @@ Load a library using \fBrequire\fR\. \fB\-e\fR Execute the given text string as a script\. . -.SS "\fBsh\fR [\fI\-\-env\fR\fB=\fR] [\fI\-\-cmd\fR\fB=\fR] [\fIfile\fR]" +.SS "\fBsh\fR [\fB\-\-env=\fR] [\fB\-\-cmd=\fR] [\fIfile\fR]" Enter an interactive shell for Homebrew\'s build environment\. Use years\-battle\-hardened build logic to help your \fB\./configure && make && make install\fR and even your \fBgem install\fR succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fR to your \fBPATH\fR which build systems would not find otherwise\. . .TP @@ -2227,7 +2227,7 @@ Print the number of unbottled and total formulae\. . .TP \fB\-\-eval\-all\fR -Evaluate all available formulae and casks, whether installed or not, to check them\. Implied if HOMEBREW_EVAL_ALL is set\. +Evaluate all available formulae and casks, whether installed or not, to check them\. Implied if \fBHOMEBREW_EVAL_ALL\fR is set\. . .SS "\fBunpack\fR [\fIoptions\fR] \fIformula\fR [\.\.\.]" Unpack the source files for \fIformula\fR into subdirectories of the current working directory\. @@ -2307,12 +2307,12 @@ Use the specified \fIcommit\fR as the start commit\. \fB\-\-before\fR Use the commit at the specified \fIdate\fR as the start commit\. . -.SS "\fBvendor\-gems\fR [\fI\-\-update\fR\fB=\fR] [\fI\-\-no\-commit\fR]" +.SS "\fBvendor\-gems\fR [\fB\-\-update=\fR] [\fB\-\-no\-commit\fR]" Install and commit Homebrew\'s vendored gems\. . .TP \fB\-\-update\fR -Update all vendored Gems to the latest version\. +Update the specified list of vendored gems to the latest version\. . .TP \fB\-\-no\-commit\fR @@ -2761,7 +2761,7 @@ Use these skipped or failed formulae from formulae steps for a formulae dependen .SS "\fBunalias\fR \fIalias\fR [\.\.\.]" Remove aliases\. . -.SS "\fBwhich\-formula\fR [\fI\-\-explain\fR] \fIcommand\fR [\.\.\.]" +.SS "\fBwhich\-formula\fR [\fB\-\-explain\fR] \fIcommand\fR [\.\.\.]" Prints the formula(e) which provides the given command\. . .TP @@ -2852,16 +2852,16 @@ Prefix all download URLs, including those for bottles, with this value\. For exa \fBHOMEBREW_AUTO_UPDATE_SECS\fR . .br -Run \fBbrew update\fR once every \fBHOMEBREW_AUTO_UPDATE_SECS\fR seconds before some commands, e\.g\. \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew tap\fR\. Alternatively, disable auto\-update entirely with HOMEBREW_NO_AUTO_UPDATE\. +Run \fBbrew update\fR once every \fBHOMEBREW_AUTO_UPDATE_SECS\fR seconds before some commands, e\.g\. \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew tap\fR\. Alternatively, disable auto\-update entirely with \fBHOMEBREW_NO_AUTO_UPDATE\fR\. . .IP -\fIDefault:\fR 86400 (24 hours) or 300 (5 minutes) if HOMEBREW_NO_INSTALL_FROM_API is set\. +\fIDefault:\fR 86400 (24 hours) or 300 (5 minutes) if \fBHOMEBREW_NO_INSTALL_FROM_API\fR is set\. . .TP \fBHOMEBREW_AUTOREMOVE\fR . .br -If set, calls to \fBbrew cleanup\fR and \fBbrew uninstall\fR will automatically remove unused formula dependents and if HOMEBREW_NO_INSTALL_CLEANUP is not set, \fBbrew cleanup\fR will start running \fBbrew autoremove\fR periodically\. +If set, calls to \fBbrew cleanup\fR and \fBbrew uninstall\fR will automatically remove unused formula dependents and if \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is not set, \fBbrew cleanup\fR will start running \fBbrew autoremove\fR periodically\. . .TP \fBHOMEBREW_BAT\fR @@ -2936,15 +2936,6 @@ Use this directory as the download cache\. Append these options to all \fBcask\fR commands\. All \fB\-\-*dir\fR options, \fB\-\-language\fR, \fB\-\-require\-sha\fR, \fB\-\-no\-quarantine\fR and \fB\-\-no\-binaries\fR are supported\. For example, you might add something like the following to your \fB~/\.profile\fR, \fB~/\.bash_profile\fR, or \fB~/\.zshenv\fR:\en\en \fBexport HOMEBREW_CASK_OPTS="\-\-appdir=~/Applications \-\-fontdir=/Library/Fonts"\fR . .TP -\fBHOMEBREW_CLEANUP_PERIODIC_FULL_DAYS\fR -. -.br -If set, \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew reinstall\fR will cleanup all formulae when this number of days has passed\. -. -.IP -\fIDefault:\fR \fB30\fR\. -. -.TP \fBHOMEBREW_CLEANUP_MAX_AGE_DAYS\fR . .br @@ -2954,6 +2945,15 @@ Cleanup all cached files older than this many days\. \fIDefault:\fR \fB120\fR\. . .TP +\fBHOMEBREW_CLEANUP_PERIODIC_FULL_DAYS\fR +. +.br +If set, \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew reinstall\fR will cleanup all formulae when this number of days has passed\. +. +.IP +\fIDefault:\fR \fB30\fR\. +. +.TP \fBHOMEBREW_COLOR\fR . .br @@ -2969,12 +2969,6 @@ Use this URL as the Homebrew/homebrew\-core \fBgit\fR(1) remote\. \fIDefault:\fR \fBhttps://github\.com/Homebrew/homebrew\-core\fR\. . .TP -\fBHOMEBREW_CURLRC\fR -. -.br -If set, do not pass \fB\-\-disable\fR when invoking \fBcurl\fR(1), which disables the use of \fBcurlrc\fR\. -. -.TP \fBHOMEBREW_CURL_PATH\fR . .br @@ -2999,6 +2993,18 @@ Pass the given retry count to \fB\-\-retry\fR when invoking \fBcurl\fR(1)\. If set, pass \fB\-\-verbose\fR when invoking \fBcurl\fR(1)\. . .TP +\fBHOMEBREW_CURLRC\fR +. +.br +If set, do not pass \fB\-\-disable\fR when invoking \fBcurl\fR(1), which disables the use of \fBcurlrc\fR\. +. +.TP +\fBHOMEBREW_DEBUG\fR +. +.br +If set, always assume \fB\-\-debug\fR when running commands\. +. +.TP \fBHOMEBREW_DEVELOPER\fR . .br @@ -3026,6 +3032,18 @@ Use this X11 display when opening a page in a browser, for example with \fBbrew If set, print install times for each formula at the end of the run\. . .TP +\fBHOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN\fR +. +.br +Use this base64 encoded username and password for authenticating with a Docker registry proxying GitHub Packages\. If \fBHOMEBREW_DOCKER_REGISTRY_TOKEN\fR is set, it will be used instead\. +. +.TP +\fBHOMEBREW_DOCKER_REGISTRY_TOKEN\fR +. +.br +Use this bearer token for authenticating with a Docker registry proxying GitHub Packages\. Preferred over \fBHOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN\fR\. +. +.TP \fBHOMEBREW_EDITOR\fR . .br @@ -3083,39 +3101,6 @@ If set, always use a Homebrew\-installed \fBgit\fR(1) rather than the system ver If set, always use Homebrew\'s vendored, relocatable Ruby version even if the system version of Ruby is new enough\. . .TP -\fBHOMEBREW_GITHUB_API_TOKEN\fR -. -.br -Use this personal access token for the GitHub API, for features such as \fBbrew search\fR\. You can create one at \fIhttps://github\.com/settings/tokens\fR\. If set, GitHub will allow you a greater number of API requests\. For more information, see: \fIhttps://docs\.github\.com/en/rest/overview/resources\-in\-the\-rest\-api#rate\-limiting\fR -. -.IP -\fINote:\fR Homebrew doesn\'t require permissions for any of the scopes, but some developer commands may require additional permissions\. -. -.TP -\fBHOMEBREW_GITHUB_PACKAGES_TOKEN\fR -. -.br -Use this GitHub personal access token when accessing the GitHub Packages Registry (where bottles may be stored)\. -. -.TP -\fBHOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN\fR -. -.br -Use this base64 encoded username and password for authenticating with a Docker registry proxying GitHub Packages\. If HOMEBREW_DOCKER_REGISTRY_TOKEN is set, it will be used instead\. -. -.TP -\fBHOMEBREW_DOCKER_REGISTRY_TOKEN\fR -. -.br -Use this bearer token for authenticating with a Docker registry proxying GitHub Packages\. Preferred over HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN\. -. -.TP -\fBHOMEBREW_GITHUB_PACKAGES_USER\fR -. -.br -Use this username when accessing the GitHub Packages Registry (where bottles may be stored)\. -. -.TP \fBHOMEBREW_GIT_EMAIL\fR . .br @@ -3137,6 +3122,27 @@ Linux only: Set this value to a new enough \fBgit\fR executable for Homebrew to \fIDefault:\fR \fBgit\fR\. . .TP +\fBHOMEBREW_GITHUB_API_TOKEN\fR +. +.br +Use this personal access token for the GitHub API, for features such as \fBbrew search\fR\. You can create one at \fIhttps://github\.com/settings/tokens\fR\. If set, GitHub will allow you a greater number of API requests\. For more information, see: \fIhttps://docs\.github\.com/en/rest/overview/resources\-in\-the\-rest\-api#rate\-limiting\fR +. +.IP +\fINote:\fR Homebrew doesn\'t require permissions for any of the scopes, but some developer commands may require additional permissions\. +. +.TP +\fBHOMEBREW_GITHUB_PACKAGES_TOKEN\fR +. +.br +Use this GitHub personal access token when accessing the GitHub Packages Registry (where bottles may be stored)\. +. +.TP +\fBHOMEBREW_GITHUB_PACKAGES_USER\fR +. +.br +Use this username when accessing the GitHub Packages Registry (where bottles may be stored)\. +. +.TP \fBHOMEBREW_INSTALL_BADGE\fR . .br @@ -3182,7 +3188,7 @@ If set, do not send analytics\. For more information, see: \fIhttps://docs\.brew \fBHOMEBREW_NO_AUTO_UPDATE\fR . .br -If set, do not automatically update before running some commands, e\.g\. \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew tap\fR\. Alternatively, run this less often by setting HOMEBREW_AUTO_UPDATE_SECS to a value higher than the default\. +If set, do not automatically update before running some commands, e\.g\. \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew tap\fR\. Alternatively, run this less often by setting \fBHOMEBREW_AUTO_UPDATE_SECS\fR to a value higher than the default\. . .TP \fBHOMEBREW_NO_BOOTSNAP\fR @@ -3191,12 +3197,6 @@ If set, do not automatically update before running some commands, e\.g\. \fBbrew If set, do not use Bootsnap to speed up repeated \fBbrew\fR calls\. . .TP -\fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fR -. -.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 \fBbrew install \fR or \fBbrew upgrade \fR\. -. -.TP \fBHOMEBREW_NO_CLEANUP_FORMULAE\fR . .br @@ -3248,7 +3248,7 @@ If set, forbid redirects from secure HTTPS to insecure HTTP\. \fBHOMEBREW_NO_INSTALL_CLEANUP\fR . .br -If set, \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew reinstall\fR will never automatically cleanup installed/upgraded/reinstalled formulae or all formulae every \fBHOMEBREW_CLEANUP_PERIODIC_FULL_DAYS\fR days\. Alternatively, HOMEBREW_NO_CLEANUP_FORMULAE allows specifying specific formulae to not clean up\. +If set, \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew reinstall\fR will never automatically cleanup installed/upgraded/reinstalled formulae or all formulae every \fBHOMEBREW_CLEANUP_PERIODIC_FULL_DAYS\fR days\. Alternatively, \fBHOMEBREW_NO_CLEANUP_FORMULAE\fR allows specifying specific formulae to not clean up\. . .TP \fBHOMEBREW_NO_INSTALL_FROM_API\fR @@ -3260,7 +3260,13 @@ If set, do not install formulae and casks in homebrew/core and homebrew/cask tap \fBHOMEBREW_NO_INSTALL_UPGRADE\fR . .br -If set, \fBbrew install \fR will not upgrade \fB\fR if it is installed but outdated\. +If set, \fBbrew install\fR \fIformula\fR will not upgrade \fIformula\fR if it is installed but outdated\. +. +.TP +\fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fR +. +.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 \fBbrew install\fR \fIformula\fR or \fBbrew upgrade\fR \fIformula\fR\. . .TP \fBHOMEBREW_PIP_INDEX_URL\fR @@ -3284,15 +3290,6 @@ If set, use Pry for the \fBbrew irb\fR command\. If set, running Homebrew on Linux will simulate certain macOS code paths\. This is useful when auditing macOS formulae while on Linux\. . .TP -\fBHOMEBREW_SSH_CONFIG_PATH\fR -. -.br -If set, Homebrew will use the given config file instead of \fB~/\.ssh/config\fR when fetching \fBgit\fR repos over \fBssh\fR\. -. -.IP -\fIDefault:\fR \fB$HOME/\.ssh/config\fR -. -.TP \fBHOMEBREW_SKIP_OR_LATER_BOTTLES\fR . .br @@ -3305,6 +3302,15 @@ If set along with \fBHOMEBREW_DEVELOPER\fR, do not use bottles from older versio If set, enable runtime typechecking using Sorbet\. . .TP +\fBHOMEBREW_SSH_CONFIG_PATH\fR +. +.br +If set, Homebrew will use the given config file instead of \fB~/\.ssh/config\fR when fetching \fBgit\fR repos over \fBssh\fR\. +. +.IP +\fIDefault:\fR \fB$HOME/\.ssh/config\fR +. +.TP \fBHOMEBREW_SVN\fR . .br @@ -3341,18 +3347,18 @@ If set, always use the latest stable tag (even if developer commands have been r If set, always assume \fB\-\-verbose\fR when running commands\. . .TP -\fBHOMEBREW_DEBUG\fR -. -.br -If set, always assume \fB\-\-debug\fR when running commands\. -. -.TP \fBHOMEBREW_VERBOSE_USING_DOTS\fR . .br If set, verbose output will print a \fB\.\fR no more than once a minute\. This can be useful to avoid long\-running Homebrew commands being killed due to no output\. . .TP +\fBSUDO_ASKPASS\fR +. +.br +If set, pass the \fB\-A\fR option when calling \fBsudo\fR(8)\. +. +.TP \fBall_proxy\fR . .br @@ -3382,12 +3388,6 @@ Use this HTTPS proxy for \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downl .br A comma\-separated list of hostnames and domain names excluded from proxying by \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\. . -.TP -\fBSUDO_ASKPASS\fR -. -.br -If set, pass the \fB\-A\fR option when calling \fBsudo\fR(8)\. -. .SH "USING HOMEBREW BEHIND A PROXY" Set the \fBhttp_proxy\fR, \fBhttps_proxy\fR, \fBall_proxy\fR, \fBftp_proxy\fR and/or \fBno_proxy\fR environment variables documented above\. .