From eb16624c5fab35a6ec6c5655ba6cf83ca3785d78 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Wed, 11 Nov 2020 16:12:38 -0500 Subject: [PATCH 1/5] manpage: reformat lists of subcommands & env vars Modify parser.rb to add a colon between each term and the line break, which `ronn` converts into a definition list. The
that follows ensures each term description is on a new line in the manpage output, and also replaces the double trailing space for generating the hard return that follows each term in the HTML output. Also modify man.rb to print environment variables with list markup matching the cask commands, and then drop trailing colons from both lists of terms (cask commands, env vars) and non-list terms (analytics, bundle, services; a
is added here because it would prevent the term description from being indented in the manpage output). https://docs.brew.sh/Manpage#cask-command-options-cask --- Library/Homebrew/cask/cmd.rb | 1 - Library/Homebrew/cli/parser.rb | 2 +- Library/Homebrew/dev-cmd/man.rb | 6 ++++-- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/Library/Homebrew/cask/cmd.rb b/Library/Homebrew/cask/cmd.rb index c5dc653c5f45f..cee4589519ca9 100644 --- a/Library/Homebrew/cask/cmd.rb +++ b/Library/Homebrew/cask/cmd.rb @@ -78,7 +78,6 @@ def self.description Commands: #{command_lines.join} - See also: `man brew` EOS end diff --git a/Library/Homebrew/cli/parser.rb b/Library/Homebrew/cli/parser.rb index a758d4ece97cb..433bf8fdbf9dd 100644 --- a/Library/Homebrew/cli/parser.rb +++ b/Library/Homebrew/cli/parser.rb @@ -176,7 +176,7 @@ def usage_banner(text) def usage_banner_text @parser.banner - .gsub(/^ - (`[^`]+`)\s+/, "\n- \\1 \n ") # Format `cask` subcommands as MarkDown list. + .gsub(/^ - (`[^`]+`)\s+/, "\n- \\1:\n
") # Format `cask` subcommands as Markdown list. end def comma_array(name, description: nil) diff --git a/Library/Homebrew/dev-cmd/man.rb b/Library/Homebrew/dev-cmd/man.rb index 6a3e27c372855..24fe0e0ff7c56 100644 --- a/Library/Homebrew/dev-cmd/man.rb +++ b/Library/Homebrew/dev-cmd/man.rb @@ -135,6 +135,8 @@ def convert_man_page(markup, target, preserve_date:) when "--markdown" ronn_output = ronn_output.gsub(%r{(.*?)}, "*`\\1`*") .gsub(/\n\n\n+/, "\n\n") + .gsub(/^(- `[^`]+`):/, "\\1") # drop trailing colons from definition lists + .gsub(/(?<=\n\n)([\[`].+):\n/, "\\1\n
") # replace colons with
on subcommands when "--roff" ronn_output = ronn_output.gsub(%r{(.*?)}, "\\fB\\1\\fR") .gsub(%r{(.*?)}, "\\fI\\1\\fR") @@ -234,10 +236,10 @@ def global_options_manpage sig { returns(String) } def env_vars_manpage lines = Homebrew::EnvConfig::ENVS.flat_map do |env, hash| - entry = " * `#{env}`:\n #{hash[:description]}\n" + entry = "- `#{env}`:\n
#{hash[:description]}\n" default = hash[:default_text] default ||= "`#{hash[:default]}`." if hash[:default] - entry += "\n\n *Default:* #{default}\n" if default + entry += "\n\n *Default:* #{default}\n" if default entry end From 19f3acea41956ac87714f0ebbfa925b16b6ecbf2 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Thu, 12 Nov 2020 11:55:42 -0500 Subject: [PATCH 2/5] manpage: update instructions & description in template file --- Library/Homebrew/manpages/brew.1.md.erb | 40 ++++++++++++++----------- 1 file changed, 23 insertions(+), 17 deletions(-) diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index 6d4773cd7713a..98333ba688b67 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -1,16 +1,20 @@ <% # To make changes to this man page: # -# - For changes to a specific command (appears in the `COMMANDS` section): -# - Edit the top comment in `Library/Homebrew/cmd/.{rb,sh}`. -# - Make sure to use the line prefix `#:` for the comments to be recognized as -# documentation. If in doubt, compare with already documented commands. +# - For changes to a command under `COMMANDS` or `DEVELOPER COMMANDS` sections): +# - Find the source file in `Library/Homebrew/[dev-]cmd/.{rb,sh}`. +# - For `.rb` files, edit the `_args` method. +# - For `.sh` files, edit the top comment, being sure to use the line prefix +# `#:` for the comments to be recognized as documentation. If in doubt, +# compare with already documented commands. +# - For global options: Edit `Library/Homebrew/cli/parser.rb`. +# - For environment variables: Edit `Library/Homebrew/env_config.rb`. # - For other changes: Edit this file. # # When done, regenerate the man page and its HTML version by running `brew man`. %> -brew(1) -- The Missing Package Manager for macOS -================================================ +brew(1) -- The Missing Package Manager for macOS (or Linux) +=========================================================== ## SYNOPSIS @@ -20,21 +24,23 @@ brew(1) -- The Missing Package Manager for macOS ## DESCRIPTION Homebrew is the easiest and most flexible way to install the UNIX tools Apple -didn't include with macOS. +didn't include with macOS. It can also install software not packaged for your +Linux distribution to your home directory without requiring `sudo`. ## ESSENTIAL COMMANDS For the full command list, see the [COMMANDS](#commands) section. -With `--verbose` or `--debug`, many commands print extra debugging information. Note that -these options should only appear after a command. +With `--verbose` or `--debug`, many commands print extra debugging information. +Note that these options should only appear after a command. ### `install` : Install . - is usually the name of the formula to install, but it has other syntaxes which -are listed in the [SPECIFYING FORMULAE](#specifying-formulae) section. + is usually the name of the formula to install, but it has other +syntaxes which are listed in the [SPECIFYING FORMULAE](#specifying-formulae) +section. ### `uninstall` : @@ -46,8 +52,8 @@ List all installed formulae. ### `search` (|`/``/`): -Perform a substring search of cask tokens and formula names for . If -is flanked by slashes, it is interpreted as a regular expression. +Perform a substring search of cask tokens and formula names for . If + is flanked by slashes, it is interpreted as a regular expression. The search for is extended online to `homebrew/core` and `homebrew/cask`. If no search term is provided, all locally available formulae are listed. @@ -75,8 +81,8 @@ If no search term is provided, all locally available formulae are listed. Homebrew, like `git`(1), supports external commands. These are executable scripts that reside somewhere in the `PATH`, named `brew-` or -`brew-``.rb`, which can be invoked like `brew` . This allows you -to create your own commands without modifying Homebrew's internals. +`brew-``.rb`, which can be invoked like `brew` . This allows +you to create your own commands without modifying Homebrew's internals. Instructions for creating your own commands can be found in the docs: @@ -107,8 +113,8 @@ specified the same way as the arguments described in ## ENVIRONMENT -Note that environment variables must have a value set to be detected. For example, run -`export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just +Note that environment variables must have a value set to be detected. For +example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just `export HOMEBREW_NO_INSECURE_REDIRECT`. <%= environment_variables %> From f784b7107f265bd710a62b507988ab17442cb075 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Thu, 12 Nov 2020 10:40:48 -0500 Subject: [PATCH 3/5] manpage: fixes for grammar --- Library/Homebrew/cask/cmd/abstract_command.rb | 4 +- Library/Homebrew/cli/parser.rb | 62 +++++++++---------- Library/Homebrew/cmd/list.rb | 4 +- Library/Homebrew/cmd/outdated.rb | 4 +- Library/Homebrew/cmd/search.rb | 2 +- Library/Homebrew/dev-cmd/audit.rb | 2 +- Library/Homebrew/dev-cmd/create.rb | 2 +- Library/Homebrew/dev-cmd/tap-new.rb | 6 +- Library/Homebrew/env_config.rb | 44 ++++++------- 9 files changed, 65 insertions(+), 65 deletions(-) diff --git a/Library/Homebrew/cask/cmd/abstract_command.rb b/Library/Homebrew/cask/cmd/abstract_command.rb index acea33ce5811a..fe57b597c8957 100644 --- a/Library/Homebrew/cask/cmd/abstract_command.rb +++ b/Library/Homebrew/cask/cmd/abstract_command.rb @@ -42,7 +42,7 @@ def self.banner_headline OPTIONS = [ [:switch, "--[no-]binaries", { - description: "Disable/enable linking of helper executables. Default: enabled", + description: "Disable/enable linking of helper executables (default: enabled).", env: :cask_opts_binaries, }], [:switch, "--require-sha", { @@ -50,7 +50,7 @@ def self.banner_headline env: :cask_opts_require_sha, }], [:switch, "--[no-]quarantine", { - description: "Disable/enable quarantining of downloads. Default: enabled", + description: "Disable/enable quarantining of downloads (default: enabled).", env: :cask_opts_quarantine, }], ].freeze diff --git a/Library/Homebrew/cli/parser.rb b/Library/Homebrew/cli/parser.rb index 433bf8fdbf9dd..6ff29d5a37c7a 100644 --- a/Library/Homebrew/cli/parser.rb +++ b/Library/Homebrew/cli/parser.rb @@ -33,65 +33,65 @@ def self.from_cmd_path(cmd_path) def self.global_cask_options [ [:flag, "--appdir=", { - description: "Target location for Applications. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:appdir]}`", + description: "Target location for Applications " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:appdir]}`).", }], [:flag, "--colorpickerdir=", { - description: "Target location for Color Pickers. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:colorpickerdir]}`", + description: "Target location for Color Pickers " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:colorpickerdir]}`).", }], [:flag, "--prefpanedir=", { - description: "Target location for Preference Panes. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:prefpanedir]}`", + description: "Target location for Preference Panes " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:prefpanedir]}`).", }], [:flag, "--qlplugindir=", { - description: "Target location for QuickLook Plugins. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:qlplugindir]}`", + description: "Target location for QuickLook Plugins " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:qlplugindir]}`).", }], [:flag, "--mdimporterdir=", { - description: "Target location for Spotlight Plugins. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:mdimporterdir]}`", + description: "Target location for Spotlight Plugins " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:mdimporterdir]}`).", }], [:flag, "--dictionarydir=", { - description: "Target location for Dictionaries. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:dictionarydir]}`", + description: "Target location for Dictionaries " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:dictionarydir]}`).", }], [:flag, "--fontdir=", { - description: "Target location for Fonts. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:fontdir]}`", + description: "Target location for Fonts " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:fontdir]}`).", }], [:flag, "--servicedir=", { - description: "Target location for Services. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:servicedir]}`", + description: "Target location for Services " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:servicedir]}`).", }], [:flag, "--input_methoddir=", { - description: "Target location for Input Methods. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:input_methoddir]}`", + description: "Target location for Input Methods " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:input_methoddir]}`).", }], [:flag, "--internet_plugindir=", { - description: "Target location for Internet Plugins. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:internet_plugindir]}`", + description: "Target location for Internet Plugins " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:internet_plugindir]}`).", }], [:flag, "--audio_unit_plugindir=", { - description: "Target location for Audio Unit Plugins. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:audio_unit_plugindir]}`", + description: "Target location for Audio Unit Plugins " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:audio_unit_plugindir]}`).", }], [:flag, "--vst_plugindir=", { - description: "Target location for VST Plugins. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:vst_plugindir]}`", + description: "Target location for VST Plugins " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:vst_plugindir]}`).", }], [:flag, "--vst3_plugindir=", { - description: "Target location for VST3 Plugins. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:vst3_plugindir]}`", + description: "Target location for VST3 Plugins " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:vst3_plugindir]}`).", }], [:flag, "--screen_saverdir=", { - description: "Target location for Screen Savers. " \ - "Default: `#{Cask::Config::DEFAULT_DIRS[:screen_saverdir]}`", + description: "Target location for Screen Savers " \ + "(default: `#{Cask::Config::DEFAULT_DIRS[:screen_saverdir]}`).", }], [:comma_array, "--language", { - description: "Set language of the Cask to install. The first matching " \ - "language is used, otherwise the default language on the Cask. " \ - "The default value is the `language of your system`", + description: "Comma-separated list of language codes to prefer for cask installation. " \ + "The first matching language is used, otherwise it reverts to the cask's " \ + "default language. The default value is the language of your system.", }], ] end diff --git a/Library/Homebrew/cmd/list.rb b/Library/Homebrew/cmd/list.rb index 83788413bc878..13dc067728d32 100644 --- a/Library/Homebrew/cmd/list.rb +++ b/Library/Homebrew/cmd/list.rb @@ -17,12 +17,12 @@ def list_args usage_banner <<~EOS `list`, `ls` [] [] - List all installed formulae or casks + List all installed formulae and casks. If is provided, summarise the paths within its current keg. EOS switch "--formula", "--formulae", - description: "List only formulae. `This is the default action on non TTY.`" + description: "List only formulae. This is the default when output is not to a terminal." switch "--cask", "--casks", description: "List only casks, or if provided." switch "--unbrewed", diff --git a/Library/Homebrew/cmd/outdated.rb b/Library/Homebrew/cmd/outdated.rb index d3261a337abde..6cb52621cbe76 100644 --- a/Library/Homebrew/cmd/outdated.rb +++ b/Library/Homebrew/cmd/outdated.rb @@ -26,9 +26,9 @@ def outdated_args switch "-v", "--verbose", description: "Include detailed version information." switch "--formula", - description: "Only output outdated formulae." + description: "List only outdated formulae." switch "--cask", - description: "Only output outdated casks." + description: "List only outdated casks." flag "--json", description: "Print output in JSON format. There are two versions: v1 and v2. " \ "v1 is deprecated and is currently the default if no version is specified. " \ diff --git a/Library/Homebrew/cmd/search.rb b/Library/Homebrew/cmd/search.rb index 7fc967ecb0a74..4dca6423bbda6 100644 --- a/Library/Homebrew/cmd/search.rb +++ b/Library/Homebrew/cmd/search.rb @@ -50,7 +50,7 @@ def search_args description: "Search for formulae with a description matching and casks with "\ "a name matching ." switch "--pull-request", - description: "Search for GitHub pull requests for ." + description: "Search for GitHub pull requests containing ." package_manager_switches = PACKAGE_MANAGERS.keys.map { |name| "--#{name}" } package_manager_switches.each do |s| diff --git a/Library/Homebrew/dev-cmd/audit.rb b/Library/Homebrew/dev-cmd/audit.rb index 5b1a302706345..9d4b2311ae4d1 100644 --- a/Library/Homebrew/dev-cmd/audit.rb +++ b/Library/Homebrew/dev-cmd/audit.rb @@ -54,7 +54,7 @@ def audit_args "make output easy to grep." switch "--skip-style", description: "Skip running non-RuboCop style checks. Useful if you plan on running "\ - "`brew style` separately. Default unless a formula is specified by name" + "`brew style` separately. Enabled by default unless a formula is specified by name." switch "-D", "--audit-debug", description: "Enable debugging and profiling of audit methods." comma_array "--only", diff --git a/Library/Homebrew/dev-cmd/create.rb b/Library/Homebrew/dev-cmd/create.rb index ecedb06f264f4..ea4b8a38a1225 100644 --- a/Library/Homebrew/dev-cmd/create.rb +++ b/Library/Homebrew/dev-cmd/create.rb @@ -59,7 +59,7 @@ def create_args flag "--tap=", description: "Generate the new formula within the given tap, specified as `/`." switch "-f", "--force", - description: "Ignore errors for disallowed formula names and named that shadow aliases." + description: "Ignore errors for disallowed formula names and names that shadow aliases." conflicts "--autotools", "--cmake", "--crystal", "--go", "--meson", "--node", "--perl", "--python", "--rust" named 1 diff --git a/Library/Homebrew/dev-cmd/tap-new.rb b/Library/Homebrew/dev-cmd/tap-new.rb index 883263d58a28d..fb63340591466 100644 --- a/Library/Homebrew/dev-cmd/tap-new.rb +++ b/Library/Homebrew/dev-cmd/tap-new.rb @@ -19,11 +19,11 @@ def tap_new_args EOS switch "--no-git", - description: "Don't initialize a git repository for the tap." + description: "Don't initialize a Git repository for the tap." flag "--pull-label=", - description: "Label name for pull requests ready to be pulled (default `pr-pull`)." + description: "Label name for pull requests ready to be pulled (default: `pr-pull`)." flag "--branch=", - description: "Initialize git repository with the specified branch name (default `main`)." + description: "Initialize Git repository with the specified branch name (default: `main`)." conflicts "--no-git", "--branch" named 1 diff --git a/Library/Homebrew/env_config.rb b/Library/Homebrew/env_config.rb index a4e6a4e25fa92..f135217c91972 100644 --- a/Library/Homebrew/env_config.rb +++ b/Library/Homebrew/env_config.rb @@ -12,7 +12,7 @@ module EnvConfig ENVS = { HOMEBREW_ARCH: { - description: "Linux only: Pass the set value to a type name representing the compiler's `-march` option.", + description: "Linux only: Pass this value to a type name representing the compiler's `-march` option.", default: "native", }, HOMEBREW_ARTIFACT_DOMAIN: { @@ -30,8 +30,8 @@ module EnvConfig boolean: true, }, HOMEBREW_BAT_CONFIG_PATH: { - description: "Use the `bat` configuration file. For example, `HOMEBREW_BAT=$HOME/.bat/config`.", - default_text: "$HOME/.bat/config", + description: "Use this as the `bat` configuration file.", + default_text: "`$HOME/.bat/config`.", }, HOMEBREW_BINTRAY_KEY: { description: "Use this API key when accessing the Bintray API (where bottles are stored).", @@ -47,7 +47,7 @@ module EnvConfig default: HOMEBREW_BOTTLE_DEFAULT_DOMAIN, }, HOMEBREW_BREW_GIT_REMOTE: { - description: "Use the specified URL as the Homebrew/brew `git`(1) remote.", + description: "Use this URL as the Homebrew/brew `git`(1) remote.", default: HOMEBREW_BREW_DEFAULT_GIT_REMOTE, }, HOMEBREW_BROWSER: { @@ -55,13 +55,13 @@ module EnvConfig default_text: "`$BROWSER` or the OS's default browser.", }, HOMEBREW_CACHE: { - description: "Use the specified directory as the download cache.", + description: "Use this directory as the download cache.", default_text: "macOS: `$HOME/Library/Caches/Homebrew`, " \ "Linux: `$XDG_CACHE_HOME/Homebrew` or `$HOME/.cache/Homebrew`.", default: HOMEBREW_DEFAULT_CACHE, }, HOMEBREW_CASK_OPTS: { - description: "Options which should be used for all `cask` commands. All `--*dir` options, " \ + description: "Append these options to all `cask` commands. All `--*dir` options, " \ "`--language`, `--require-sha`, `--no-quarantine` and `--no-binaries` are supported." \ "\n" \ "For example, you might add something like the following to your " \ @@ -77,7 +77,7 @@ module EnvConfig boolean: true, }, HOMEBREW_CORE_GIT_REMOTE: { - description: "Use the specified URL as the Homebrew/homebrew-core `git`(1) remote.", + description: "Use this URL as the Homebrew/homebrew-core `git`(1) remote.", default_text: "macOS: `https://github.com/Homebrew/homebrew-core`, " \ "Linux: `https://github.com/Homebrew/linuxbrew-core`.", default: HOMEBREW_CORE_DEFAULT_GIT_REMOTE, @@ -127,7 +127,7 @@ module EnvConfig }, HOMEBREW_FORBIDDEN_LICENSES: { description: "A space-separated list of licenses. Homebrew will refuse to install a " \ - "formula if that formula or any of its dependencies has a license on this list.", + "formula if it or any of its dependencies has a license on this list.", }, HOMEBREW_FORCE_BREWED_CURL: { description: "If set, always use a Homebrew-installed `curl`(1) rather than the system version. " \ @@ -166,10 +166,10 @@ module EnvConfig "such as `brew search`. This is deprecated in favour of using `HOMEBREW_GITHUB_API_TOKEN`.", }, HOMEBREW_GIT_EMAIL: { - description: "Set the Git author and committer name to this value.", + description: "Set the Git author and committer email to this value.", }, HOMEBREW_GIT_NAME: { - description: "Set the Git author and committer email to this value.", + description: "Set the Git author and committer name to this value.", }, HOMEBREW_INSTALL_BADGE: { description: "Print this text before the installation summary of each successful build.", @@ -177,13 +177,13 @@ module EnvConfig default: "🍺", }, HOMEBREW_LIVECHECK_WATCHLIST: { - description: "Use this file to get the list of default Formulae to check when no Formula argument " \ - "is passed to `brew livecheck`", + description: "Consult this file for the list of formulae to check by default when no formula argument " \ + "is passed to `brew livecheck`.", default: "$HOME/.brew_livecheck_watchlist", }, HOMEBREW_LOGS: { - description: "Use the specified directory to store log files.", - default_text: "macOS: `$HOME/Library/Logs/Homebrew`, "\ + description: "Use this directory to store log files.", + default_text: "macOS: `$HOME/Library/Logs/Homebrew`, " \ "Linux: `$XDG_CACHE_HOME/Homebrew/Logs` or `$HOME/.cache/Homebrew/Logs`.", default: HOMEBREW_DEFAULT_LOGS, }, @@ -197,7 +197,7 @@ module EnvConfig }, }, HOMEBREW_NO_ANALYTICS: { - description: "If set, do not send analytics. See: .", + description: "If set, do not send analytics. For more information, see: ", boolean: true, }, HOMEBREW_NO_AUTO_UPDATE: { @@ -226,18 +226,18 @@ module EnvConfig }, HOMEBREW_NO_EMOJI: { description: "If set, do not print `HOMEBREW_INSTALL_BADGE` on a successful build." \ - "\n\n *Note:* Only tries to print emoji on OS X Lion or newer.", + "\n\n *Note:* Will only try to print emoji on OS X Lion or newer.", boolean: true, }, HOMEBREW_NO_GITHUB_API: { description: "If set, do not use the GitHub API, e.g. for searches or fetching relevant issues " \ - "on a failed install.", + "after a failed install.", boolean: true, }, HOMEBREW_NO_INSECURE_REDIRECT: { description: "If set, forbid redirects from secure HTTPS to insecure HTTP." \ "\n\n *Note:* While ensuring your downloads are fully secure, this is likely to cause " \ - "from-source SourceForge, some GNU & GNOME based formulae to fail to download.", + "from-source SourceForge, some GNU & GNOME-hosted formulae to fail to download.", boolean: true, }, HOMEBREW_NO_INSTALL_CLEANUP: { @@ -250,12 +250,12 @@ module EnvConfig boolean: true, }, HOMEBREW_SKIP_OR_LATER_BOTTLES: { - description: "If set with `HOMEBREW_DEVELOPER`, do not use bottles from older versions " \ + 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.", boolean: true, }, HOMEBREW_SORBET_RUNTIME: { - description: "Enable runtime typechecking using Sorbet.", + description: "If set, enable runtime typechecking using Sorbet.", boolean: true, }, HOMEBREW_SVN: { @@ -272,7 +272,7 @@ module EnvConfig default: HOMEBREW_DEFAULT_TEMP, }, HOMEBREW_UPDATE_REPORT_ONLY_INSTALLED: { - description: "If set, `brew update` only outputs updates to installed software.", + description: "If set, `brew update` only lists updates to installed software.", boolean: true, }, HOMEBREW_UPDATE_TO_TAG: { @@ -310,7 +310,7 @@ module EnvConfig "from proxying by `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.", }, SUDO_ASKPASS: { - description: "When this variable is set, the `-A` option is passed when calling `sudo`(8)", + description: "If set, pass the `-A` option when calling `sudo`(8).", }, }.freeze From 72bc0570149172ee6be6e1d82bb938dbfc9e096a Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Thu, 12 Nov 2020 10:40:41 -0500 Subject: [PATCH 4/5] manpage: fixes for formatting --- Library/Homebrew/cmd/--cache.rb | 2 +- Library/Homebrew/cmd/--version.rb | 1 + Library/Homebrew/cmd/analytics.rb | 3 +- Library/Homebrew/cmd/autoremove.rb | 3 +- Library/Homebrew/cmd/install.rb | 2 - Library/Homebrew/cmd/list.rb | 2 +- Library/Homebrew/cmd/log.rb | 3 +- Library/Homebrew/cmd/reinstall.rb | 5 +- Library/Homebrew/cmd/upgrade.rb | 5 +- Library/Homebrew/cmd/uses.rb | 1 + Library/Homebrew/dev-cmd/bump-cask-pr.rb | 2 +- Library/Homebrew/dev-cmd/bump-formula-pr.rb | 2 +- Library/Homebrew/dev-cmd/bump.rb | 4 +- Library/Homebrew/dev-cmd/cat.rb | 1 + .../Homebrew/dev-cmd/dispatch-build-bottle.rb | 4 +- Library/Homebrew/dev-cmd/man.rb | 3 +- Library/Homebrew/dev-cmd/mirror.rb | 2 +- Library/Homebrew/dev-cmd/pr-automerge.rb | 6 +- Library/Homebrew/dev-cmd/pr-pull.rb | 3 +- Library/Homebrew/dev-cmd/pull.rb | 2 +- Library/Homebrew/dev-cmd/release-notes.rb | 1 + Library/Homebrew/dev-cmd/sh.rb | 1 + Library/Homebrew/dev-cmd/typecheck.rb | 1 + .../Homebrew/dev-cmd/update-license-data.rb | 1 + .../dev-cmd/update-python-resources.rb | 7 +- Library/Homebrew/env_config.rb | 31 +- Library/Homebrew/manpages/brew.1.md.erb | 14 +- docs/Manpage.md | 619 +++++++++--------- manpages/brew.1 | 383 +++++++---- 29 files changed, 631 insertions(+), 483 deletions(-) diff --git a/Library/Homebrew/cmd/--cache.rb b/Library/Homebrew/cmd/--cache.rb index 78e6df0fa554b..d21f3bd8cd81c 100644 --- a/Library/Homebrew/cmd/--cache.rb +++ b/Library/Homebrew/cmd/--cache.rb @@ -16,7 +16,7 @@ module Homebrew def __cache_args Homebrew::CLI::Parser.new do usage_banner <<~EOS - `--cache` [] [] + `--cache` [] [|] Display Homebrew's download cache. See also `HOMEBREW_CACHE`. diff --git a/Library/Homebrew/cmd/--version.rb b/Library/Homebrew/cmd/--version.rb index 531b0b119c83d..ff038f70960c0 100644 --- a/Library/Homebrew/cmd/--version.rb +++ b/Library/Homebrew/cmd/--version.rb @@ -17,6 +17,7 @@ def __version_args Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask (if tapped) to standard output. EOS + max_named 0 end end diff --git a/Library/Homebrew/cmd/analytics.rb b/Library/Homebrew/cmd/analytics.rb index 12e545f352559..0efdf6afe1643 100644 --- a/Library/Homebrew/cmd/analytics.rb +++ b/Library/Homebrew/cmd/analytics.rb @@ -20,12 +20,13 @@ def analytics_args `brew analytics` [`state`]: Display the current state of Homebrew's analytics. - `brew analytics` [`on`|`off`]: + `brew analytics` (`on`|`off`): Turn Homebrew's analytics on or off respectively. `brew analytics regenerate-uuid`: Regenerate the UUID used for Homebrew's analytics. EOS + max_named 1 end end diff --git a/Library/Homebrew/cmd/autoremove.rb b/Library/Homebrew/cmd/autoremove.rb index fd5c786f5b308..21c211cfeab44 100644 --- a/Library/Homebrew/cmd/autoremove.rb +++ b/Library/Homebrew/cmd/autoremove.rb @@ -17,7 +17,8 @@ def autoremove_args EOS switch "-n", "--dry-run", description: "List what would be uninstalled, but do not actually uninstall anything." - named 0 + + max_named 0 end end diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index 436f607172e73..9728aba9b9784 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -85,7 +85,6 @@ def install_args }], [:switch, "--keep-tmp", { description: "Retain the temporary files created during installation.", - }], [:switch, "--build-bottle", { description: "Prepare the formula for eventual bottling during installation, skipping any " \ @@ -125,7 +124,6 @@ def install_args conflicts "--ignore-dependencies", "--only-dependencies" conflicts "--build-from-source", "--build-bottle", "--force-bottle" - min_named :formula_or_cask end end diff --git a/Library/Homebrew/cmd/list.rb b/Library/Homebrew/cmd/list.rb index 13dc067728d32..e7e5a97536e6b 100644 --- a/Library/Homebrew/cmd/list.rb +++ b/Library/Homebrew/cmd/list.rb @@ -15,7 +15,7 @@ module Homebrew def list_args Homebrew::CLI::Parser.new do usage_banner <<~EOS - `list`, `ls` [] [] + `list`, `ls` [] [|] List all installed formulae and casks. diff --git a/Library/Homebrew/cmd/log.rb b/Library/Homebrew/cmd/log.rb index 5a24d9d1beec6..391d213f52038 100644 --- a/Library/Homebrew/cmd/log.rb +++ b/Library/Homebrew/cmd/log.rb @@ -28,8 +28,9 @@ def log_args description: "Print only one commit." flag "-n", "--max-count=", description: "Print only a specified number of commits." - max_named 1 + conflicts "-1", "--max-count" + max_named 1 end end diff --git a/Library/Homebrew/cmd/reinstall.rb b/Library/Homebrew/cmd/reinstall.rb index 4bc7a230c27a3..ab69edd5d3206 100644 --- a/Library/Homebrew/cmd/reinstall.rb +++ b/Library/Homebrew/cmd/reinstall.rb @@ -45,8 +45,8 @@ def reinstall_args }], [:switch, "-i", "--interactive", { description: "Download and patch , then open a shell. This allows the user to " \ - "run `./configure --help` and otherwise determine how to turn the software " \ - "package into a Homebrew package.", + "run `./configure --help` and otherwise determine how to turn the software " \ + "package into a Homebrew package.", }], [:switch, "--force-bottle", { description: "Install from a bottle if it exists for the current or newest version of " \ @@ -75,7 +75,6 @@ def reinstall_args cask_options conflicts "--build-from-source", "--force-bottle" - min_named :formula_or_cask end end diff --git a/Library/Homebrew/cmd/upgrade.rb b/Library/Homebrew/cmd/upgrade.rb index ce8ec7bf8a7ef..24aa0383c4eea 100644 --- a/Library/Homebrew/cmd/upgrade.rb +++ b/Library/Homebrew/cmd/upgrade.rb @@ -47,8 +47,8 @@ def upgrade_args }], [:switch, "-i", "--interactive", { description: "Download and patch , then open a shell. This allows the user to "\ - "run `./configure --help` and otherwise determine how to turn the software "\ - "package into a Homebrew package.", + "run `./configure --help` and otherwise determine how to turn the software "\ + "package into a Homebrew package.", }], [:switch, "--force-bottle", { description: "Install from a bottle if it exists for the current or newest version of "\ @@ -58,7 +58,6 @@ def upgrade_args description: "Fetch the upstream repository to detect if the HEAD installation of the "\ "formula is outdated. Otherwise, the repository's HEAD will only be checked for "\ "updates when a new stable or development version has been released.", - }], [:switch, "--ignore-pinned", { description: "Set a successful exit status even if pinned formulae are not upgraded.", diff --git a/Library/Homebrew/cmd/uses.rb b/Library/Homebrew/cmd/uses.rb index ae0a28ed5794f..1b0ef16e8c374 100644 --- a/Library/Homebrew/cmd/uses.rb +++ b/Library/Homebrew/cmd/uses.rb @@ -40,6 +40,7 @@ def uses_args description: "Include all formulae that specify as `:optional` type dependency." switch "--skip-recommended", description: "Skip all formulae that specify as `:recommended` type dependency." + min_named :formula end end diff --git a/Library/Homebrew/dev-cmd/bump-cask-pr.rb b/Library/Homebrew/dev-cmd/bump-cask-pr.rb index 7d381eab642ed..032a8df0aaa57 100644 --- a/Library/Homebrew/dev-cmd/bump-cask-pr.rb +++ b/Library/Homebrew/dev-cmd/bump-cask-pr.rb @@ -14,7 +14,7 @@ module Homebrew def bump_cask_pr_args Homebrew::CLI::Parser.new do usage_banner <<~EOS - `bump-cask-pr` [] [] + `bump-cask-pr` [] Create a pull request to update with a new version. diff --git a/Library/Homebrew/dev-cmd/bump-formula-pr.rb b/Library/Homebrew/dev-cmd/bump-formula-pr.rb index b3f6550f3b0f9..4e648874f28ad 100644 --- a/Library/Homebrew/dev-cmd/bump-formula-pr.rb +++ b/Library/Homebrew/dev-cmd/bump-formula-pr.rb @@ -73,7 +73,7 @@ def bump_formula_pr_args depends_on: "--tag=", description: "Specify the new git commit corresponding to the specified ." switch "-f", "--force", - description: "Ignore duplicate open PRs. Remove all mirrors if --mirror= was not specified." + description: "Ignore duplicate open PRs. Remove all mirrors if `--mirror` was not specified." conflicts "--dry-run", "--write" conflicts "--no-audit", "--strict" diff --git a/Library/Homebrew/dev-cmd/bump.rb b/Library/Homebrew/dev-cmd/bump.rb index e5a9695b8f2ac..00f51e8870744 100644 --- a/Library/Homebrew/dev-cmd/bump.rb +++ b/Library/Homebrew/dev-cmd/bump.rb @@ -17,8 +17,8 @@ def bump_args Display out-of-date brew formulae and the latest version available. Also displays whether a pull request has been opened with the URL. EOS - flag "--limit=", - description: "Limit number of package results returned." + flag "--limit=", + description: "Limit number of package results returned." switch :verbose switch :debug end diff --git a/Library/Homebrew/dev-cmd/cat.rb b/Library/Homebrew/dev-cmd/cat.rb index a0410216fe6b7..625ee66779d66 100644 --- a/Library/Homebrew/dev-cmd/cat.rb +++ b/Library/Homebrew/dev-cmd/cat.rb @@ -16,6 +16,7 @@ def cat_args Display the source of . EOS + named :formula end end diff --git a/Library/Homebrew/dev-cmd/dispatch-build-bottle.rb b/Library/Homebrew/dev-cmd/dispatch-build-bottle.rb index 4353beeb77b24..fbb867e8aef0d 100644 --- a/Library/Homebrew/dev-cmd/dispatch-build-bottle.rb +++ b/Library/Homebrew/dev-cmd/dispatch-build-bottle.rb @@ -27,14 +27,14 @@ def dispatch_build_bottle_args description: "Dispatch specified workflow (default: `dispatch-build-bottle.yml`)." switch "--upload", description: "Upload built bottles to Bintray." + + min_named :formula end end def dispatch_build_bottle args = dispatch_build_bottle_args.parse - raise FormulaUnspecifiedError if args.named.empty? - odie "Must specify --macos option" unless args.macos macos = begin diff --git a/Library/Homebrew/dev-cmd/man.rb b/Library/Homebrew/dev-cmd/man.rb index 24fe0e0ff7c56..e32972af79463 100644 --- a/Library/Homebrew/dev-cmd/man.rb +++ b/Library/Homebrew/dev-cmd/man.rb @@ -30,6 +30,7 @@ def man_args "comparison without factoring in the date)." switch "--link", description: "This is now done automatically by `brew update`." + max_named 0 end end @@ -219,7 +220,7 @@ def cmd_comment_manpage_lines(cmd_path) def global_cask_options_manpage lines = ["These options are applicable to subcommands accepting a `--cask` flag and all `cask` commands.\n"] lines += Homebrew::CLI::Parser.global_cask_options.map do |_, long, description:, **| - generate_option_doc(nil, long, description) + generate_option_doc(nil, long.chomp("="), description) end lines.join("\n") end diff --git a/Library/Homebrew/dev-cmd/mirror.rb b/Library/Homebrew/dev-cmd/mirror.rb index 70400ee846efb..a6c2b45b1a6a0 100644 --- a/Library/Homebrew/dev-cmd/mirror.rb +++ b/Library/Homebrew/dev-cmd/mirror.rb @@ -24,8 +24,8 @@ def mirror_args switch "--no-publish", description: "Upload to Bintray, but don't publish." - hide_from_man_page! min_named :formula + hide_from_man_page! end end diff --git a/Library/Homebrew/dev-cmd/pr-automerge.rb b/Library/Homebrew/dev-cmd/pr-automerge.rb index d23ad3e394605..d4120ab4f4713 100644 --- a/Library/Homebrew/dev-cmd/pr-automerge.rb +++ b/Library/Homebrew/dev-cmd/pr-automerge.rb @@ -21,9 +21,9 @@ def pr_automerge_args description: "Target tap repository (default: `homebrew/core`)." flag "--with-label=", description: "Pull requests must have this label." - comma_array "--without-labels=", - description: "Pull requests must not have these labels "\ - "(default: `do not merge`, `new formula`, `automerge-skip`)." + comma_array "--without-labels", + description: "Pull requests must not have these labels (default: "\ + "`do not merge`, `new formula`, `automerge-skip`, `linux-only`)." switch "--without-approval", description: "Pull requests do not require approval to be merged." switch "--publish", diff --git a/Library/Homebrew/dev-cmd/pr-pull.rb b/Library/Homebrew/dev-cmd/pr-pull.rb index 82a6a7f4aed51..5f7e65629e2fc 100644 --- a/Library/Homebrew/dev-cmd/pr-pull.rb +++ b/Library/Homebrew/dev-cmd/pr-pull.rb @@ -62,8 +62,9 @@ def pr_pull_args flag "--bintray-mirror=", description: "Use the specified Bintray repository to automatically mirror stable URLs "\ "defined in the formulae (default: `mirror`)." - min_named 1 + conflicts "--clean", "--autosquash" + min_named 1 end end diff --git a/Library/Homebrew/dev-cmd/pull.rb b/Library/Homebrew/dev-cmd/pull.rb index 8c1b8b2b5c7ec..ce6f69c358ed2 100644 --- a/Library/Homebrew/dev-cmd/pull.rb +++ b/Library/Homebrew/dev-cmd/pull.rb @@ -19,7 +19,6 @@ module Homebrew sig { returns(CLI::Parser) } def pull_args Homebrew::CLI::Parser.new do - hide_from_man_page! usage_banner <<~EOS `pull` [] @@ -43,6 +42,7 @@ def pull_args description: "Do not copy anything to the system clipboard." min_named 1 + hide_from_man_page! end end diff --git a/Library/Homebrew/dev-cmd/release-notes.rb b/Library/Homebrew/dev-cmd/release-notes.rb index bde64f84dea84..3e7286cdc46dc 100644 --- a/Library/Homebrew/dev-cmd/release-notes.rb +++ b/Library/Homebrew/dev-cmd/release-notes.rb @@ -20,6 +20,7 @@ def release_notes_args EOS switch "--markdown", description: "Print as a Markdown list." + max_named 2 end end diff --git a/Library/Homebrew/dev-cmd/sh.rb b/Library/Homebrew/dev-cmd/sh.rb index eb0af7cd84297..3c56c13dd0d39 100644 --- a/Library/Homebrew/dev-cmd/sh.rb +++ b/Library/Homebrew/dev-cmd/sh.rb @@ -26,6 +26,7 @@ def sh_args description: "Use the standard `PATH` instead of superenv's when `std` is passed." flag "-c=", "--cmd=", description: "Execute commands in a non-interactive shell." + max_named 1 end end diff --git a/Library/Homebrew/dev-cmd/typecheck.rb b/Library/Homebrew/dev-cmd/typecheck.rb index 2914b518c6ea3..454715b098477 100644 --- a/Library/Homebrew/dev-cmd/typecheck.rb +++ b/Library/Homebrew/dev-cmd/typecheck.rb @@ -32,6 +32,7 @@ def typecheck_args flag "--ignore=", description: "Ignores input files that contain the given string " \ "in their paths (relative to the input path passed to Sorbet)." + conflicts "--dir", "--file" max_named 0 end diff --git a/Library/Homebrew/dev-cmd/update-license-data.rb b/Library/Homebrew/dev-cmd/update-license-data.rb index bb3220074bba1..c41c6ace7fa1b 100644 --- a/Library/Homebrew/dev-cmd/update-license-data.rb +++ b/Library/Homebrew/dev-cmd/update-license-data.rb @@ -20,6 +20,7 @@ def update_license_data_args switch "--fail-if-not-changed", description: "Return a failing status code if current license data's version is the same as " \ "the upstream. This can be used to notify CI when the SPDX license data is out of date." + max_named 0 end end diff --git a/Library/Homebrew/dev-cmd/update-python-resources.rb b/Library/Homebrew/dev-cmd/update-python-resources.rb index e8017c3766fac..ee3cd4be19ec4 100644 --- a/Library/Homebrew/dev-cmd/update-python-resources.rb +++ b/Library/Homebrew/dev-cmd/update-python-resources.rb @@ -23,9 +23,10 @@ def update_python_resources_args description: "Suppress any output." switch "--ignore-non-pypi-packages", description: "Don't fail if is not a PyPI package." - flag "--version=", - description: "Use the specified when finding resources for . "\ - "If no version is specified, the current version for will be used." + flag "--version=", + description: "Use the specified when finding resources for . "\ + "If no version is specified, the current version for will be used." + min_named :formula end end diff --git a/Library/Homebrew/env_config.rb b/Library/Homebrew/env_config.rb index f135217c91972..713c460222c0c 100644 --- a/Library/Homebrew/env_config.rb +++ b/Library/Homebrew/env_config.rb @@ -40,10 +40,11 @@ module EnvConfig description: "Use this username when accessing the Bintray API (where bottles are stored).", }, HOMEBREW_BOTTLE_DOMAIN: { - description: "Use the specified URL as the download mirror for bottles. " \ - "For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will cause all bottles to " \ - "download from the prefix `http://localhost:8080/`.", - default_text: "macOS: `https://homebrew.bintray.com/`, Linux: `https://linuxbrew.bintray.com/`.", + description: "Use this URL as the download mirror for bottles. " \ + "For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will cause all bottles to " \ + "download from the prefix `http://localhost:8080/`.", + default_text: "macOS: `https://homebrew.bintray.com/`, " \ + "Linux: `https://linuxbrew.bintray.com/`.", default: HOMEBREW_BOTTLE_DEFAULT_DOMAIN, }, HOMEBREW_BREW_GIT_REMOTE: { @@ -62,11 +63,10 @@ module EnvConfig }, HOMEBREW_CASK_OPTS: { description: "Append these options to all `cask` commands. All `--*dir` options, " \ - "`--language`, `--require-sha`, `--no-quarantine` and `--no-binaries` are supported." \ - "\n" \ + "`--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'`", + "`~/.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.", @@ -107,7 +107,7 @@ module EnvConfig }, HOMEBREW_DISPLAY: { description: "Use this X11 display when opening a page in a browser, for example with " \ - "`brew home`. Primarily useful on Linux.", + "`brew home`. Primarily useful on Linux.", default_text: "`$DISPLAY`.", }, HOMEBREW_DISPLAY_INSTALL_TIMES: { @@ -116,9 +116,10 @@ module EnvConfig }, HOMEBREW_EDITOR: { description: "Use this editor when editing a single formula, or several formulae in the " \ - "same directory.\n\n *Note:* `brew edit` will open all of Homebrew as discontinuous files " \ - "and directories. Visual Studio Code can handle this correctly in project mode, but many " \ - "editors will do strange things in this case.", + "same directory." \ + "\n\n *Note:* `brew edit` will open all of Homebrew as discontinuous files " \ + "and directories. Visual Studio Code can handle this correctly in project mode, but many " \ + "editors will do strange things in this case.", default_text: "`$EDITOR` or `$VISUAL`.", }, HOMEBREW_FAIL_LOG_LINES: { @@ -157,9 +158,9 @@ module EnvConfig description: "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: " \ - ".\n\n" \ - " *Note:* Homebrew doesn't require permissions for any of the scopes, but some developer " \ - "commands may require additional permissions.", + "" \ + "\n\n *Note:* Homebrew doesn't require permissions for any of the scopes, but some " \ + "developer commands may require additional permissions.", }, HOMEBREW_GITHUB_API_USERNAME: { description: "Use this username for authentication with the GitHub API, for features " \ diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index 98333ba688b67..ba4d02d0f7c3d 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -34,7 +34,7 @@ For the full command list, see the [COMMANDS](#commands) section. With `--verbose` or `--debug`, many commands print extra debugging information. Note that these options should only appear after a command. -### `install` : +### `install` Install . @@ -42,15 +42,15 @@ Install . syntaxes which are listed in the [SPECIFYING FORMULAE](#specifying-formulae) section. -### `uninstall` : +### `uninstall` Uninstall . -### `list`: +### `list` List all installed formulae. -### `search` (|`/``/`): +### `search` [|`/``/`] Perform a substring search of cask tokens and formula names for . If is flanked by slashes, it is interpreted as a regular expression. @@ -161,10 +161,10 @@ Homebrew API: See our issues on GitHub: * **Homebrew/brew**: - +
* **Homebrew/homebrew-core**: - +
* **Homebrew/homebrew-cask**: - +
diff --git a/docs/Manpage.md b/docs/Manpage.md index 5574ec9d87170..881fe0eac973d 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -1,5 +1,5 @@ -brew(1) -- The Missing Package Manager for macOS -================================================ +brew(1) -- The Missing Package Manager for macOS (or Linux) +=========================================================== ## SYNOPSIS @@ -9,34 +9,36 @@ brew(1) -- The Missing Package Manager for macOS ## DESCRIPTION Homebrew is the easiest and most flexible way to install the UNIX tools Apple -didn't include with macOS. +didn't include with macOS. It can also install software not packaged for your +Linux distribution to your home directory without requiring `sudo`. ## ESSENTIAL COMMANDS For the full command list, see the [COMMANDS](#commands) section. -With `--verbose` or `--debug`, many commands print extra debugging information. Note that -these options should only appear after a command. +With `--verbose` or `--debug`, many commands print extra debugging information. +Note that these options should only appear after a command. -### `install` *`formula`*: +### `install` *`formula`* Install *`formula`*. -*`formula`* is usually the name of the formula to install, but it has other syntaxes which -are listed in the [SPECIFYING FORMULAE](#specifying-formulae) section. +*`formula`* is usually the name of the formula to install, but it has other +syntaxes which are listed in the [SPECIFYING FORMULAE](#specifying-formulae) +section. -### `uninstall` *`formula`*: +### `uninstall` *`formula`* Uninstall *`formula`*. -### `list`: +### `list` List all installed formulae. -### `search` (*`text`*|`/`*`text`*`/`): +### `search` [*`text`*|`/`*`text`*`/`] -Perform a substring search of cask tokens and formula names for *`text`*. If *`text`* -is flanked by slashes, it is interpreted as a regular expression. +Perform a substring search of cask tokens and formula names for *`text`*. If +*`text`* is flanked by slashes, it is interpreted as a regular expression. The search for *`text`* is extended online to `homebrew/core` and `homebrew/cask`. If no search term is provided, all locally available formulae are listed. @@ -47,14 +49,14 @@ If no search term is provided, all locally available formulae are listed. Control Homebrew's anonymous aggregate user behaviour analytics. Read more at . -`brew analytics` [`state`]: -Display the current state of Homebrew's analytics. +`brew analytics` [`state`] +
Display the current state of Homebrew's analytics. -`brew analytics` [`on`|`off`]: -Turn Homebrew's analytics on or off respectively. +`brew analytics` (`on`|`off`) +
Turn Homebrew's analytics on or off respectively. -`brew analytics regenerate-uuid`: -Regenerate the UUID used for Homebrew's analytics. +`brew analytics regenerate-uuid` +
Regenerate the UUID used for Homebrew's analytics. ### `autoremove` [*`options`*] @@ -69,59 +71,59 @@ Homebrew Cask provides a friendly CLI workflow for the administration of macOS a Commands: -- `--cache` - Display the file used to cache a *`cask`*. +- `--cache` +
Display the file used to cache a *`cask`*. -- `audit` - Check *`cask`* for Homebrew coding style violations. +- `audit` +
Check *`cask`* for Homebrew coding style violations. -- `cat` - Dump raw source of a *`cask`* to the standard output. +- `cat` +
Dump raw source of a *`cask`* to the standard output. -- `create` - Creates the given *`cask`* and opens it in an editor. +- `create` +
Creates the given *`cask`* and opens it in an editor. -- `doctor` - Checks for configuration issues. +- `doctor` +
Checks for configuration issues. -- `edit` - Open the given *`cask`* for editing. +- `edit` +
Open the given *`cask`* for editing. -- `fetch` - Downloads remote application files to local cache. +- `fetch` +
Downloads remote application files to local cache. -- `help` - Print help for `cask` commands. +- `help` +
Print help for `cask` commands. -- `home` - Opens the homepage of the given *`cask`*. +- `home` +
Opens the homepage of the given *`cask`*. -- `info` - Displays information about the given *`cask`*. +- `info` +
Displays information about the given *`cask`*. -- `install` - Installs the given *`cask`*. +- `install` +
Installs the given *`cask`*. -- `list` - Lists installed casks or the casks provided in the arguments. +- `list` +
Lists installed casks or the casks provided in the arguments. -- `outdated` - List the outdated installed casks. +- `outdated` +
List the outdated installed casks. -- `reinstall` - Reinstalls the given *`cask`*. +- `reinstall` +
Reinstalls the given *`cask`*. -- `style` - Checks style of the given *`cask`* using RuboCop. +- `style` +
Checks style of the given *`cask`* using RuboCop. -- `uninstall` - Uninstalls the given *`cask`*. +- `uninstall` +
Uninstalls the given *`cask`*. -- `upgrade` - Upgrades all outdated casks or the specified casks. +- `upgrade` +
Upgrades all outdated casks or the specified casks. -- `zap` - Zaps all files associated with the given *`cask`*. +- `zap` +
Zaps all files associated with the given *`cask`*. See also: `man brew` @@ -329,11 +331,11 @@ the installed formulae or, every 30 days, for all formulae. * `--cask`: Treat all named arguments as casks. * `--[no-]binaries`: - Disable/enable linking of helper executables. Default: enabled + Disable/enable linking of helper executables (default: enabled). * `--require-sha`: Require all casks to have a checksum. * `--[no-]quarantine`: - Disable/enable quarantining of downloads. Default: enabled + Disable/enable quarantining of downloads (default: enabled). * `--skip-cask-deps`: Skip installing cask dependencies. @@ -354,14 +356,14 @@ installations. * `-f`, `--force`: Allow keg-only formulae to be linked. -### `list`, `ls` [*`options`*] [*`formula|cask`*] +### `list`, `ls` [*`options`*] [*`formula`*|*`cask`*] -List all installed formulae or casks +List all installed formulae and casks. If *`formula`* is provided, summarise the paths within its current keg. * `--formula`: - List only formulae. `This is the default action on non TTY.` + List only formulae. This is the default when output is not to a terminal. * `--cask`: List only casks, or *`cask`* if provided. * `--unbrewed`: @@ -439,9 +441,9 @@ information is displayed in interactive shells, and suppressed otherwise. * `-v`, `--verbose`: Include detailed version information. * `--formula`: - Only output outdated formulae. + List only outdated formulae. * `--cask`: - Only output outdated casks. + List only outdated casks. * `--json`: Print output in JSON format. There are two versions: v1 and v2. v1 is deprecated and is currently the default if no version is specified. v2 prints outdated formulae and casks. * `--fetch-HEAD`: @@ -499,11 +501,11 @@ reinstalled formulae or, every 30 days, for all formulae. * `--cask`: Treat all named arguments as casks. * `--[no-]binaries`: - Disable/enable linking of helper executables. Default: enabled + Disable/enable linking of helper executables (default: enabled). * `--require-sha`: Require all casks to have a checksum. * `--[no-]quarantine`: - Disable/enable quarantining of downloads. Default: enabled + Disable/enable quarantining of downloads (default: enabled). * `--skip-cask-deps`: Skip installing cask dependencies. @@ -523,7 +525,7 @@ No online search is performed. * `--desc`: Search for formulae with a description matching *`text`* and casks with a name matching *`text`*. * `--pull-request`: - Search for GitHub pull requests for *`text`*. + Search for GitHub pull requests containing *`text`*. * `--macports`: Search for *`text`* in the given package manager's list. * `--fink`: @@ -662,11 +664,11 @@ upgraded formulae or, every 30 days, for all formulae. * `--cask`: Treat all named arguments as casks. If no named arguments are specified, upgrade only outdated casks. * `--[no-]binaries`: - Disable/enable linking of helper executables. Default: enabled + Disable/enable linking of helper executables (default: enabled). * `--require-sha`: Require all casks to have a checksum. * `--[no-]quarantine`: - Disable/enable quarantining of downloads. Default: enabled + Disable/enable quarantining of downloads (default: enabled). * `--skip-cask-deps`: Skip installing cask dependencies. * `--greedy`: @@ -692,7 +694,7 @@ specify *`formula`* as a required or recommended dependency for their stable bui * `--skip-recommended`: Skip all formulae that specify *`formula`* as `:recommended` type dependency. -### `--cache` [*`options`*] [*`formula|cask`*] +### `--cache` [*`options`*] [*`formula`*|*`cask`*] Display Homebrew's download cache. See also `HOMEBREW_CACHE`. @@ -779,7 +781,7 @@ errors are found. * `--display-filename`: Prefix every line of output with the file or formula name being audited, to make output easy to grep. * `--skip-style`: - Skip running non-RuboCop style checks. Useful if you plan on running `brew style` separately. Default unless a formula is specified by name + Skip running non-RuboCop style checks. Useful if you plan on running `brew style` separately. Enabled by default unless a formula is specified by name. * `-D`, `--audit-debug`: Enable debugging and profiling of audit methods. * `--only`: @@ -826,7 +828,7 @@ Also displays whether a pull request has been opened with the URL. * `--limit`: Limit number of package results returned. -### `bump-cask-pr` [*`options`*] [*`cask`*] +### `bump-cask-pr` [*`options`*] *`cask`* Create a pull request to update *`cask`* with a new version. @@ -910,7 +912,7 @@ nor vice versa. It must use whichever style specification the formula already us * `--revision`: Specify the new git commit *`revision`* corresponding to the specified *`tag`*. * `-f`, `--force`: - Ignore duplicate open PRs. Remove all mirrors if --mirror= was not specified. + Ignore duplicate open PRs. Remove all mirrors if `--mirror` was not specified. ### `bump-revision` [*`options`*] *`formula`* [*`formula`* ...] @@ -971,7 +973,7 @@ a simple example. For the complete API, see: * `--tap`: Generate the new formula within the given tap, specified as *`user`*`/`*`repo`*. * `-f`, `--force`: - Ignore errors for disallowed formula names and named that shadow aliases. + Ignore errors for disallowed formula names and names that shadow aliases. ### `dispatch-build-bottle` [*`options`*] *`formula`* [*`formula`* ...] @@ -1086,7 +1088,7 @@ Find pull requests that can be automatically merged using `brew pr-publish`. * `--with-label`: Pull requests must have this label. * `--without-labels`: - Pull requests must not have these labels (default: `do not merge`, `new formula`, `automerge-skip`). + Pull requests must not have these labels (default: `do not merge`, `new formula`, `automerge-skip`, `linux-only`). * `--without-approval`: Pull requests do not require approval to be merged. * `--publish`: @@ -1233,11 +1235,11 @@ including core code and all formulae. Generate the template files for a new tap. * `--no-git`: - Don't initialize a git repository for the tap. + Don't initialize a Git repository for the tap. * `--pull-label`: - Label name for pull requests ready to be pulled (default `pr-pull`). + Label name for pull requests ready to be pulled (default: `pr-pull`). * `--branch`: - Initialize git repository with the specified branch name (default `main`). + Initialize Git repository with the specified branch name (default: `main`). ### `test` [*`options`*] *`formula`* @@ -1350,50 +1352,50 @@ Install and commit Homebrew's vendored gems. These options are applicable to subcommands accepting a `--cask` flag and all `cask` commands. -* `--appdir=`: - Target location for Applications. Default: `/Applications` +* `--appdir`: + Target location for Applications (default: `/Applications`). -* `--colorpickerdir=`: - Target location for Color Pickers. Default: `~/Library/ColorPickers` +* `--colorpickerdir`: + Target location for Color Pickers (default: `~/Library/ColorPickers`). -* `--prefpanedir=`: - Target location for Preference Panes. Default: `~/Library/PreferencePanes` +* `--prefpanedir`: + Target location for Preference Panes (default: `~/Library/PreferencePanes`). -* `--qlplugindir=`: - Target location for QuickLook Plugins. Default: `~/Library/QuickLook` +* `--qlplugindir`: + Target location for QuickLook Plugins (default: `~/Library/QuickLook`). -* `--mdimporterdir=`: - Target location for Spotlight Plugins. Default: `~/Library/Spotlight` +* `--mdimporterdir`: + Target location for Spotlight Plugins (default: `~/Library/Spotlight`). -* `--dictionarydir=`: - Target location for Dictionaries. Default: `~/Library/Dictionaries` +* `--dictionarydir`: + Target location for Dictionaries (default: `~/Library/Dictionaries`). -* `--fontdir=`: - Target location for Fonts. Default: `~/Library/Fonts` +* `--fontdir`: + Target location for Fonts (default: `~/Library/Fonts`). -* `--servicedir=`: - Target location for Services. Default: `~/Library/Services` +* `--servicedir`: + Target location for Services (default: `~/Library/Services`). -* `--input_methoddir=`: - Target location for Input Methods. Default: `~/Library/Input Methods` +* `--input_methoddir`: + Target location for Input Methods (default: `~/Library/Input Methods`). -* `--internet_plugindir=`: - Target location for Internet Plugins. Default: `~/Library/Internet Plug-Ins` +* `--internet_plugindir`: + Target location for Internet Plugins (default: `~/Library/Internet Plug-Ins`). -* `--audio_unit_plugindir=`: - Target location for Audio Unit Plugins. Default: `~/Library/Audio/Plug-Ins/Components` +* `--audio_unit_plugindir`: + Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`). -* `--vst_plugindir=`: - Target location for VST Plugins. Default: `~/Library/Audio/Plug-Ins/VST` +* `--vst_plugindir`: + Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`). -* `--vst3_plugindir=`: - Target location for VST3 Plugins. Default: `~/Library/Audio/Plug-Ins/VST3` +* `--vst3_plugindir`: + Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`). -* `--screen_saverdir=`: - Target location for Screen Savers. Default: `~/Library/Screen Savers` +* `--screen_saverdir`: + Target location for Screen Savers (default: `~/Library/Screen Savers`). * `--language`: - Set language of the Cask to install. The first matching language is used, otherwise the default language on the Cask. The default value is the `language of your system` + Comma-separated list of language codes to prefer for cask installation. The first matching language is used, otherwise it reverts to the cask's default language. The default value is the language of your system. ## GLOBAL OPTIONS @@ -1417,33 +1419,35 @@ These options are applicable across multiple subcommands. Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store and Whalebrew. -`brew bundle` [`install`]: -Install and upgrade (by default) all dependencies from the `Brewfile`. +`brew bundle` [`install`] +
Install and upgrade (by default) all dependencies from the `Brewfile`. + +You can specify the `Brewfile` location using `--file` or by setting the `HOMEBREW_BUNDLE_FILE` environment variable. -You can skip the installation of dependencies by adding space-separated values to one or more of the following environment variables: `HOMEBREW_BUNDLE_BREW_SKIP`, `HOMEBREW_BUNDLE_CASK_SKIP`, `HOMEBREW_BUNDLE_MAS_SKIP`, `HOMEBREW_BUNDLE_WHALEBREW_SKIP`, `HOMEBREW_BUNDLE_TAP_SKIP` +You can skip the installation of dependencies by adding space-separated values to one or more of the following environment variables: `HOMEBREW_BUNDLE_BREW_SKIP`, `HOMEBREW_BUNDLE_CASK_SKIP`, `HOMEBREW_BUNDLE_MAS_SKIP`, `HOMEBREW_BUNDLE_WHALEBREW_SKIP`, `HOMEBREW_BUNDLE_TAP_SKIP`. `brew bundle` will output a `Brewfile.lock.json` in the same directory as the `Brewfile` if all dependencies are installed successfully. This contains dependency and system status information which can be useful in debugging `brew bundle` failures and replicating a "last known good build" state. You can opt-out of this behaviour by setting the `HOMEBREW_BUNDLE_NO_LOCK` environment variable or passing the `--no-lock` option. You may wish to check this file into the same version control system as your `Brewfile` (or ensure your version control system ignores it if you'd prefer to rely on debugging information from a local machine). -`brew bundle dump`: -Write all installed casks/formulae/images/taps into a `Brewfile`. +`brew bundle dump` +
Write all installed casks/formulae/images/taps into a `Brewfile` in the current directory. -`brew bundle cleanup`: -Uninstall all dependencies not listed from the `Brewfile`. +`brew bundle cleanup` +
Uninstall all dependencies not listed from the `Brewfile`. This workflow is useful for maintainers or testers who regularly install lots of formulae. -`brew bundle check`: -Check if all dependencies are installed from the `Brewfile` . +`brew bundle check` +
Check if all dependencies are installed from the `Brewfile`. This provides a successful exit code if everything is up-to-date, making it useful for scripting. -`brew bundle list`: -List all dependencies present in a `Brewfile`. +`brew bundle list` +
List all dependencies present in the `Brewfile`. By default, only Homebrew dependencies are listed. -`brew bundle exec` *`command`*: -Run an external command in an isolated build environment based on the `Brewfile` dependencies. +`brew bundle exec` *`command`* +
Run an external command in an isolated build environment based on the `Brewfile` dependencies. This sanitized build environment ignores unrequested dependencies, which makes sure that things you didn't specify in your `Brewfile` won't get picked up by commands like `bundle install`, `npm install`, etc. It will also add compiler flags which will help find keg-only dependencies like `openssl`, `icu4c`, etc. @@ -1487,67 +1491,67 @@ Manage background services with macOS' `launchctl`(1) daemon manager. If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot). Otherwise, operate on `~/Library/LaunchAgents` (started at login). -[`sudo`] `brew services` [`list`]: -List all managed services for the current user (or root). +[`sudo`] `brew services` [`list`] +
List all managed services for the current user (or root). -[`sudo`] `brew services run` (*`formula`*|`--all`): -Run the service *`formula`* without registering to launch at login (or boot). +[`sudo`] `brew services run` (*`formula`*|`--all`) +
Run the service *`formula`* without registering to launch at login (or boot). -[`sudo`] `brew services start` (*`formula`*|`--all`): -Start the service *`formula`* immediately and register it to launch at login (or boot). +[`sudo`] `brew services start` (*`formula`*|`--all`) +
Start the service *`formula`* immediately and register it to launch at login (or boot). -[`sudo`] `brew services stop` (*`formula`*|`--all`): -Stop the service *`formula`* immediately and unregister it from launching at login (or boot). +[`sudo`] `brew services stop` (*`formula`*|`--all`) +
Stop the service *`formula`* immediately and unregister it from launching at login (or boot). -[`sudo`] `brew services restart` (*`formula`*|`--all`): -Stop (if necessary) and start the service *`formula`* immediately and register it to launch at login (or boot). +[`sudo`] `brew services restart` (*`formula`*|`--all`) +
Stop (if necessary) and start the service *`formula`* immediately and register it to launch at login (or boot). -[`sudo`] `brew services cleanup`: -Remove all unused services. +[`sudo`] `brew services cleanup` +
Remove all unused services. * `--all`: Run *`subcommand`* on all services. -### `test-bot` [*`options`*] [*`formula`*]: +### `test-bot` [*`options`*] [*`formula`*] -Tests the full lifecycle of a Homebrew change to a tap (Git repository). For example, for a GitHub Actions pull request that changes a formula `brew test-bot` will ensure the system is cleaned and setup to test the formula, install the formula, run various tests and checks on it, bottle (package) the binaries and test formulae that depend on it to ensure they aren't broken by these changes. +Tests the full lifecycle of a Homebrew change to a tap (Git repository). For example, for a GitHub Actions pull request that changes a formula `brew test-bot` will ensure the system is cleaned and set up to test the formula, install the formula, run various tests and checks on it, bottle (package) the binaries and test formulae that depend on it to ensure they aren't broken by these changes. Only supports GitHub Actions as a CI provider. This is because Homebrew uses GitHub Actions and it's freely available for public and private use with macOS and Linux workers. * `--dry-run`: - print what would be done rather than doing it. + Print what would be done rather than doing it. * `--cleanup`: - clean all state from the Homebrew directory. Use with care! + Clean all state from the Homebrew directory. Use with care! * `--skip-setup`: - don't check if the local system is set up correctly. + Don't check if the local system is set up correctly. * `--keep-old`: - run `brew bottle --keep-old` to build new bottles for a single platform. + Run `brew bottle --keep-old` to build new bottles for a single platform. * `--skip-relocation`: - run `brew bottle --skip-relocation` to build new bottles that don't require relocation. + Run `brew bottle --skip-relocation` to build new bottles that don't require relocation. * `--local`: - ask Homebrew to write verbose logs under `./logs/` and set `$HOME` to `./home/` + Ask Homebrew to write verbose logs under `./logs/` and set `$HOME` to `./home/` * `--tap`: - use the `git` repository of the given tap. Defaults to the core tap for syntax checking. + Use the Git repository of the given tap. Defaults to the core tap for syntax checking. * `--fail-fast`: - immediately exit on a failing step. + Immediately exit on a failing step. * `-v`, `--verbose`: - print test step output in real time. Has the side effect of passing output as raw bytes instead of re-encoding in UTF-8. + Print test step output in real time. Has the side effect of passing output as raw bytes instead of re-encoding in UTF-8. * `--test-default-formula`: - use a default testing formula when not building a tap and no other formulae are specified. + Use a default testing formula when not building a tap and no other formulae are specified. * `--bintray-org`: - upload to the given Bintray organisation. + Upload bottles to the given Bintray organisation. * `--root-url`: - use the specified *`URL`* as the root of the bottle's URL instead of Homebrew's default. + Use the specified *`URL`* as the root of the bottle's URL instead of Homebrew's default. * `--git-name`: - set the Git author/committer names to the given name. + Set the Git author/committer names to the given name. * `--git-email`: - set the Git author/committer email to the given email. + Set the Git author/committer email to the given email. * `--ci-upload`: - use the Homebrew CI bottle upload options. + Use the Homebrew CI bottle upload options. * `--publish`: - publish the uploaded bottles. + Publish the uploaded bottles. * `--skip-recursive-dependents`: - only test the direct dependents. + Only test the direct dependents. * `--only-cleanup-before`: Only run the pre-cleanup step. Needs `--cleanup`. * `--only-setup`: @@ -1563,8 +1567,8 @@ Only supports GitHub Actions as a CI provider. This is because Homebrew uses Git Homebrew, like `git`(1), supports external commands. These are executable scripts that reside somewhere in the `PATH`, named `brew-`*`cmdname`* or -`brew-`*`cmdname`*`.rb`, which can be invoked like `brew` *`cmdname`*. This allows you -to create your own commands without modifying Homebrew's internals. +`brew-`*`cmdname`*`.rb`, which can be invoked like `brew` *`cmdname`*. This allows +you to create your own commands without modifying Homebrew's internals. Instructions for creating your own commands can be found in the docs: @@ -1595,252 +1599,251 @@ specified the same way as the *`formula`* arguments described in ## ENVIRONMENT -Note that environment variables must have a value set to be detected. For example, run -`export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just +Note that environment variables must have a value set to be detected. For +example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just `export HOMEBREW_NO_INSECURE_REDIRECT`. - * `HOMEBREW_ARCH`: - Linux only: Pass the set value to a type name representing the compiler's `-march` option. +- `HOMEBREW_ARCH` +
Linux only: Pass this value to a type name representing the compiler's `-march` option. - *Default:* `native`. + *Default:* `native`. - * `HOMEBREW_ARTIFACT_DOMAIN`: - Prefix all download URLs, including those for bottles, with this variable. 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/example.com/foo.tar.gz`. +- `HOMEBREW_ARTIFACT_DOMAIN` +
Prefix all download URLs, including those for bottles, with this variable. 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/example.com/foo.tar.gz`. - * `HOMEBREW_AUTO_UPDATE_SECS`: - Automatically check for updates once per this seconds interval. +- `HOMEBREW_AUTO_UPDATE_SECS` +
Automatically check for updates once per this seconds interval. - *Default:* `300`. + *Default:* `300`. - * `HOMEBREW_BAT`: - If set, use `bat` for the `brew cat` command. +- `HOMEBREW_BAT` +
If set, use `bat` for the `brew cat` command. - * `HOMEBREW_BAT_CONFIG_PATH`: - Use the `bat` configuration file. For example, `HOMEBREW_BAT=$HOME/.bat/config`. +- `HOMEBREW_BAT_CONFIG_PATH` +
Use this as the `bat` configuration file. - *Default:* $HOME/.bat/config + *Default:* `$HOME/.bat/config`. - * `HOMEBREW_BINTRAY_KEY`: - Use this API key when accessing the Bintray API (where bottles are stored). +- `HOMEBREW_BINTRAY_KEY` +
Use this API key when accessing the Bintray API (where bottles are stored). - * `HOMEBREW_BINTRAY_USER`: - Use this username when accessing the Bintray API (where bottles are stored). +- `HOMEBREW_BINTRAY_USER` +
Use this username when accessing the Bintray API (where bottles are stored). - * `HOMEBREW_BOTTLE_DOMAIN`: - Use the specified URL as the download mirror for bottles. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will cause all bottles to download from the prefix `http://localhost:8080/`. +- `HOMEBREW_BOTTLE_DOMAIN` +
Use this URL as the download mirror for bottles. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will cause all bottles to download from the prefix `http://localhost:8080/`. - *Default:* macOS: `https://homebrew.bintray.com/`, Linux: `https://linuxbrew.bintray.com/`. + *Default:* macOS: `https://homebrew.bintray.com/`, Linux: `https://linuxbrew.bintray.com/`. - * `HOMEBREW_BREW_GIT_REMOTE`: - Use the specified URL as the Homebrew/brew `git`(1) remote. +- `HOMEBREW_BREW_GIT_REMOTE` +
Use this URL as the Homebrew/brew `git`(1) remote. - *Default:* `https://github.com/Homebrew/brew`. + *Default:* `https://github.com/Homebrew/brew`. - * `HOMEBREW_BROWSER`: - Use this as the browser when opening project homepages. +- `HOMEBREW_BROWSER` +
Use this as the browser when opening project homepages. - *Default:* `$BROWSER` or the OS's default browser. + *Default:* `$BROWSER` or the OS's default browser. - * `HOMEBREW_CACHE`: - Use the specified directory as the download cache. +- `HOMEBREW_CACHE` +
Use this directory as the download cache. - *Default:* macOS: `$HOME/Library/Caches/Homebrew`, Linux: `$XDG_CACHE_HOME/Homebrew` or `$HOME/.cache/Homebrew`. + *Default:* macOS: `$HOME/Library/Caches/Homebrew`, Linux: `$XDG_CACHE_HOME/Homebrew` or `$HOME/.cache/Homebrew`. - * `HOMEBREW_CASK_OPTS`: - Options which should be used for 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: +- `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`: -`export HOMEBREW_CASK_OPTS='--appdir=~/Applications --fontdir=/Library/Fonts'` + `export HOMEBREW_CASK_OPTS="--appdir=~/Applications --fontdir=/Library/Fonts"` - * `HOMEBREW_CLEANUP_MAX_AGE_DAYS`: - Cleanup all cached files older than this many days. +- `HOMEBREW_CLEANUP_MAX_AGE_DAYS` +
Cleanup all cached files older than this many days. - *Default:* `120`. + *Default:* `120`. - * `HOMEBREW_COLOR`: - If set, force colour output on non-TTY outputs. +- `HOMEBREW_COLOR` +
If set, force colour output on non-TTY outputs. - * `HOMEBREW_CORE_GIT_REMOTE`: - Use the specified URL as the Homebrew/homebrew-core `git`(1) remote. +- `HOMEBREW_CORE_GIT_REMOTE` +
Use this URL as the Homebrew/homebrew-core `git`(1) remote. - *Default:* macOS: `https://github.com/Homebrew/homebrew-core`, Linux: `https://github.com/Homebrew/linuxbrew-core`. + *Default:* macOS: `https://github.com/Homebrew/homebrew-core`, Linux: `https://github.com/Homebrew/linuxbrew-core`. - * `HOMEBREW_CURLRC`: - If set, do not pass `--disable` when invoking `curl`(1), which disables the use of `curlrc`. +- `HOMEBREW_CURLRC` +
If set, do not pass `--disable` when invoking `curl`(1), which disables the use of `curlrc`. - * `HOMEBREW_CURL_RETRIES`: - Pass the given retry count to `--retry` when invoking `curl`(1). +- `HOMEBREW_CURL_RETRIES` +
Pass the given retry count to `--retry` when invoking `curl`(1). - *Default:* `3`. + *Default:* `3`. - * `HOMEBREW_CURL_VERBOSE`: - If set, pass `--verbose` when invoking `curl`(1). +- `HOMEBREW_CURL_VERBOSE` +
If set, pass `--verbose` when invoking `curl`(1). - * `HOMEBREW_DEVELOPER`: - If set, tweak behaviour to be more relevant for Homebrew developers (active or budding) by e.g. turning warnings into errors. +- `HOMEBREW_DEVELOPER` +
If set, tweak behaviour to be more relevant for Homebrew developers (active or budding) by e.g. turning warnings into errors. - * `HOMEBREW_DISABLE_LOAD_FORMULA`: - If set, refuse to load formulae. This is useful when formulae are not trusted (such as in pull requests). +- `HOMEBREW_DISABLE_LOAD_FORMULA` +
If set, refuse to load formulae. This is useful when formulae are not trusted (such as in pull requests). - * `HOMEBREW_DISPLAY`: - Use this X11 display when opening a page in a browser, for example with `brew home`. Primarily useful on Linux. +- `HOMEBREW_DISPLAY` +
Use this X11 display when opening a page in a browser, for example with `brew home`. Primarily useful on Linux. - *Default:* `$DISPLAY`. + *Default:* `$DISPLAY`. - * `HOMEBREW_DISPLAY_INSTALL_TIMES`: - If set, print install times for each formula at the end of the run. +- `HOMEBREW_DISPLAY_INSTALL_TIMES` +
If set, print install times for each formula at the end of the run. - * `HOMEBREW_EDITOR`: - Use this editor when editing a single formula, or several formulae in the same directory. +- `HOMEBREW_EDITOR` +
Use this editor when editing a single formula, or several formulae in the same directory. *Note:* `brew edit` will open all of Homebrew as discontinuous files and directories. Visual Studio Code can handle this correctly in project mode, but many editors will do strange things in this case. - *Default:* `$EDITOR` or `$VISUAL`. + *Default:* `$EDITOR` or `$VISUAL`. - * `HOMEBREW_FAIL_LOG_LINES`: - Output this many lines of output on formula `system` failures. +- `HOMEBREW_FAIL_LOG_LINES` +
Output this many lines of output on formula `system` failures. - *Default:* `15`. + *Default:* `15`. - * `HOMEBREW_FORBIDDEN_LICENSES`: - A space-separated list of licenses. Homebrew will refuse to install a formula if that formula or any of its dependencies has a license on this list. +- `HOMEBREW_FORBIDDEN_LICENSES` +
A space-separated list of licenses. Homebrew will refuse to install a formula if it or any of its dependencies has a license on this list. - * `HOMEBREW_FORCE_BREWED_CURL`: - If set, always use a Homebrew-installed `curl`(1) rather than the system version. Automatically set if the system version of `curl` is too old. +- `HOMEBREW_FORCE_BREWED_CURL` +
If set, always use a Homebrew-installed `curl`(1) rather than the system version. Automatically set if the system version of `curl` is too old. - * `HOMEBREW_FORCE_BREWED_GIT`: - If set, always use a Homebrew-installed `git`(1) rather than the system version. Automatically set if the system version of `git` is too old. +- `HOMEBREW_FORCE_BREWED_GIT` +
If set, always use a Homebrew-installed `git`(1) rather than the system version. Automatically set if the system version of `git` is too old. - * `HOMEBREW_FORCE_HOMEBREW_ON_LINUX`: - If set, running Homebrew on Linux will use URLs for macOS. This is useful when merging pull requests for macOS while on Linux. +- `HOMEBREW_FORCE_HOMEBREW_ON_LINUX` +
If set, running Homebrew on Linux will use URLs for macOS. This is useful when merging pull requests for macOS while on Linux. - * `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_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_PASSWORD`: - Use this password for authentication with the GitHub API, for features such as `brew search`. This is deprecated in favour of using `HOMEBREW_GITHUB_API_TOKEN`. +- `HOMEBREW_GITHUB_API_PASSWORD` +
Use this password for authentication with the GitHub API, for features such as `brew search`. This is deprecated in favour of using `HOMEBREW_GITHUB_API_TOKEN`. - * `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: . +- `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_API_USERNAME`: - Use this username for authentication with the GitHub API, for features such as `brew search`. This is deprecated in favour of using `HOMEBREW_GITHUB_API_TOKEN`. +- `HOMEBREW_GITHUB_API_USERNAME` +
Use this username for authentication with the GitHub API, for features such as `brew search`. This is deprecated in favour of using `HOMEBREW_GITHUB_API_TOKEN`. - * `HOMEBREW_GIT_EMAIL`: - Set the Git author and committer name to this value. +- `HOMEBREW_GIT_EMAIL` +
Set the Git author and committer email to this value. - * `HOMEBREW_GIT_NAME`: - Set the Git author and committer email to this value. +- `HOMEBREW_GIT_NAME` +
Set the Git author and committer name to this value. - * `HOMEBREW_INSTALL_BADGE`: - Print this text before the installation summary of each successful build. +- `HOMEBREW_INSTALL_BADGE` +
Print this text before the installation summary of each successful build. - *Default:* The "Beer Mug" emoji. + *Default:* The "Beer Mug" emoji. - * `HOMEBREW_LIVECHECK_WATCHLIST`: - Use this file to get the list of default Formulae to check when no Formula argument is passed to `brew livecheck` +- `HOMEBREW_LIVECHECK_WATCHLIST` +
Consult this file for the list of formulae to check by default when no formula argument is passed to `brew livecheck`. - *Default:* `$HOME/.brew_livecheck_watchlist`. + *Default:* `$HOME/.brew_livecheck_watchlist`. - * `HOMEBREW_LOGS`: - Use the specified directory to store log files. +- `HOMEBREW_LOGS` +
Use this directory to store log files. - *Default:* macOS: `$HOME/Library/Logs/Homebrew`, Linux: `$XDG_CACHE_HOME/Homebrew/Logs` or `$HOME/.cache/Homebrew/Logs`. + *Default:* macOS: `$HOME/Library/Logs/Homebrew`, Linux: `$XDG_CACHE_HOME/Homebrew/Logs` or `$HOME/.cache/Homebrew/Logs`. - * `HOMEBREW_MAKE_JOBS`: - Use this value as the number of parallel jobs to run when building with `make`(1). +- `HOMEBREW_MAKE_JOBS` +
Use this value as the number of parallel jobs to run when building with `make`(1). - *Default:* The number of available CPU cores. + *Default:* The number of available CPU cores. - * `HOMEBREW_NO_ANALYTICS`: - If set, do not send analytics. See: . +- `HOMEBREW_NO_ANALYTICS` +
If set, do not send analytics. For more information, see: - * `HOMEBREW_NO_AUTO_UPDATE`: - If set, do not automatically update before running `brew install`, `brew upgrade` or `brew tap`. +- `HOMEBREW_NO_AUTO_UPDATE` +
If set, do not automatically update before running `brew install`, `brew upgrade` or `brew tap`. - * `HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK`: - If set, fail on the failure of installation from a bottle rather than falling back to building from source. +- `HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK` +
If set, fail on the failure of installation from a bottle rather than falling back to building from source. - * `HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK`: - If set, do not check for broken dependents after installing, upgrading or reinstalling formulae. +- `HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` +
If set, do not check for broken dependents after installing, upgrading or reinstalling formulae. - * `HOMEBREW_NO_COLOR`: - If set, do not print text with colour added. +- `HOMEBREW_NO_COLOR` +
If set, do not print text with colour added. - *Default:* `$NO_COLOR`. + *Default:* `$NO_COLOR`. - * `HOMEBREW_NO_COMPAT`: - If set, disable all use of legacy compatibility code. +- `HOMEBREW_NO_COMPAT` +
If set, disable all use of legacy compatibility code. - * `HOMEBREW_NO_EMOJI`: - If set, do not print `HOMEBREW_INSTALL_BADGE` on a successful build. +- `HOMEBREW_NO_EMOJI` +
If set, do not print `HOMEBREW_INSTALL_BADGE` on a successful build. - *Note:* Only tries to print emoji on OS X Lion or newer. + *Note:* Will only try to print emoji on OS X Lion or newer. - * `HOMEBREW_NO_GITHUB_API`: - If set, do not use the GitHub API, e.g. for searches or fetching relevant issues on a failed install. +- `HOMEBREW_NO_GITHUB_API` +
If set, do not use the GitHub API, e.g. for searches or fetching relevant issues after a failed install. - * `HOMEBREW_NO_INSECURE_REDIRECT`: - If set, forbid redirects from secure HTTPS to insecure HTTP. +- `HOMEBREW_NO_INSECURE_REDIRECT` +
If set, forbid redirects from secure HTTPS to insecure HTTP. - *Note:* While ensuring your downloads are fully secure, this is likely to cause from-source SourceForge, some GNU & GNOME based formulae to fail to download. + *Note:* While ensuring your downloads are fully secure, this is likely to cause from-source SourceForge, some GNU & GNOME-hosted formulae to fail to download. - * `HOMEBREW_NO_INSTALL_CLEANUP`: - If set, `brew install`, `brew upgrade` and `brew reinstall` will never automatically cleanup installed/upgraded/reinstalled formulae or all formulae every 30 days. +- `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 30 days. - * `HOMEBREW_PRY`: - If set, use Pry for the `brew irb` command. +- `HOMEBREW_PRY` +
If set, use Pry for the `brew irb` command. - * `HOMEBREW_SKIP_OR_LATER_BOTTLES`: - If set with `HOMEBREW_DEVELOPER`, do not use bottles from older versions of macOS. This is useful in development on new macOS versions. +- `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`: - Enable runtime typechecking using Sorbet. +- `HOMEBREW_SORBET_RUNTIME` +
If set, enable runtime typechecking using Sorbet. - * `HOMEBREW_SVN`: - Use this as the `svn`(1) binary. +- `HOMEBREW_SVN` +
Use this as the `svn`(1) binary. - *Default:* A Homebrew-built Subversion (if installed), or the system-provided binary. + *Default:* A Homebrew-built Subversion (if installed), or the system-provided binary. - * `HOMEBREW_TEMP`: - Use this path as the temporary directory for building packages. Changing this may be needed if your system temporary directory and Homebrew prefix are on different volumes, as macOS has trouble moving symlinks across volumes when the target does not yet exist. This issue typically occurs when using FileVault or custom SSD configurations. +- `HOMEBREW_TEMP` +
Use this path as the temporary directory for building packages. Changing this may be needed if your system temporary directory and Homebrew prefix are on different volumes, as macOS has trouble moving symlinks across volumes when the target does not yet exist. This issue typically occurs when using FileVault or custom SSD configurations. - *Default:* macOS: `/private/tmp`, Linux: `/tmp`. + *Default:* macOS: `/private/tmp`, Linux: `/tmp`. - * `HOMEBREW_UPDATE_REPORT_ONLY_INSTALLED`: - If set, `brew update` only outputs updates to installed software. +- `HOMEBREW_UPDATE_REPORT_ONLY_INSTALLED` +
If set, `brew update` only lists updates to installed software. - * `HOMEBREW_UPDATE_TO_TAG`: - If set, always use the latest stable tag (even if developer commands have been run). +- `HOMEBREW_UPDATE_TO_TAG` +
If set, always use the latest stable tag (even if developer commands have been run). - * `HOMEBREW_VERBOSE`: - If set, always assume `--verbose` when running commands. +- `HOMEBREW_VERBOSE` +
If set, always assume `--verbose` when running commands. - * `HOMEBREW_DEBUG`: - If set, always assume `--debug` 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. +- `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. - * `all_proxy`: - Use this SOCKS5 proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew. +- `all_proxy` +
Use this SOCKS5 proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew. - * `ftp_proxy`: - Use this FTP proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew. +- `ftp_proxy` +
Use this FTP proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew. - * `http_proxy`: - Use this HTTP proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew. +- `http_proxy` +
Use this HTTP proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew. - * `https_proxy`: - Use this HTTPS proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew. +- `https_proxy` +
Use this HTTPS proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew. - * `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. +- `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`: - When this variable is set, the `-A` option is passed when calling `sudo`(8) +- `SUDO_ASKPASS` +
If set, pass the `-A` option when calling `sudo`(8). ## USING HOMEBREW BEHIND A PROXY @@ -1884,13 +1887,13 @@ Former maintainers with significant contributions include Jan Viljanen, JCount, See our issues on GitHub: * **Homebrew/brew**: - +
* **Homebrew/homebrew-core**: - +
* **Homebrew/homebrew-cask**: - +
[SYNOPSIS]: #SYNOPSIS "SYNOPSIS" [DESCRIPTION]: #DESCRIPTION "DESCRIPTION" diff --git a/manpages/brew.1 b/manpages/brew.1 index 30dbbc65e4d3f..cab09a8e776f6 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -4,7 +4,7 @@ .TH "BREW" "1" "November 2020" "Homebrew" "brew" . .SH "NAME" -\fBbrew\fR \- The Missing Package Manager for macOS +\fBbrew\fR \- The Missing Package Manager for macOS (or Linux) . .SH "SYNOPSIS" \fBbrew\fR \fB\-\-version\fR @@ -13,7 +13,7 @@ \fBbrew\fR \fIcommand\fR [\fB\-\-verbose\fR|\fB\-v\fR] [\fIoptions\fR] [\fIformula\fR] \.\.\. . .SH "DESCRIPTION" -Homebrew is the easiest and most flexible way to install the UNIX tools Apple didn\'t include with macOS\. +Homebrew is the easiest and most flexible way to install the UNIX tools Apple didn\'t include with macOS\. It can also install software not packaged for your Linux distribution to your home directory without requiring \fBsudo\fR\. . .SH "ESSENTIAL COMMANDS" For the full command list, see the \fICOMMANDS\fR section\. @@ -21,19 +21,19 @@ For the full command list, see the \fICOMMANDS\fR section\. .P With \fB\-\-verbose\fR or \fB\-\-debug\fR, many commands print extra debugging information\. Note that these options should only appear after a command\. . -.SS "\fBinstall\fR \fIformula\fR:" +.SS "\fBinstall\fR \fIformula\fR" Install \fIformula\fR\. . .P \fIformula\fR is usually the name of the formula to install, but it has other syntaxes which are listed in the \fISPECIFYING FORMULAE\fR section\. . -.SS "\fBuninstall\fR \fIformula\fR:" +.SS "\fBuninstall\fR \fIformula\fR" Uninstall \fIformula\fR\. . -.SS "\fBlist\fR:" +.SS "\fBlist\fR" List all installed formulae\. . -.SS "\fBsearch\fR (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR):" +.SS "\fBsearch\fR [\fItext\fR|\fB/\fR\fItext\fR\fB/\fR]" Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\. The search for \fItext\fR is extended online to \fBhomebrew/core\fR and \fBhomebrew/cask\fR\. If no search term is provided, all locally available formulae are listed\. . .SH "COMMANDS" @@ -46,7 +46,7 @@ Control Homebrew\'s anonymous aggregate user behaviour analytics\. Read more at Display the current state of Homebrew\'s analytics\. . .P -\fBbrew analytics\fR [\fBon\fR|\fBoff\fR] +\fBbrew analytics\fR (\fBon\fR|\fBoff\fR) Turn Homebrew\'s analytics on or off respectively\. . .P @@ -66,116 +66,114 @@ Homebrew Cask provides a friendly CLI workflow for the administration of macOS a .P Commands: . -.IP "\(bu" 4 +.TP \fB\-\-cache\fR . .br Display the file used to cache a \fIcask\fR\. . -.IP "\(bu" 4 +.TP \fBaudit\fR . .br Check \fIcask\fR for Homebrew coding style violations\. . -.IP "\(bu" 4 +.TP \fBcat\fR . .br Dump raw source of a \fIcask\fR to the standard output\. . -.IP "\(bu" 4 +.TP \fBcreate\fR . .br Creates the given \fIcask\fR and opens it in an editor\. . -.IP "\(bu" 4 +.TP \fBdoctor\fR . .br Checks for configuration issues\. . -.IP "\(bu" 4 +.TP \fBedit\fR . .br Open the given \fIcask\fR for editing\. . -.IP "\(bu" 4 +.TP \fBfetch\fR . .br Downloads remote application files to local cache\. . -.IP "\(bu" 4 +.TP \fBhelp\fR . .br Print help for \fBcask\fR commands\. . -.IP "\(bu" 4 +.TP \fBhome\fR . .br Opens the homepage of the given \fIcask\fR\. . -.IP "\(bu" 4 +.TP \fBinfo\fR . .br Displays information about the given \fIcask\fR\. . -.IP "\(bu" 4 +.TP \fBinstall\fR . .br Installs the given \fIcask\fR\. . -.IP "\(bu" 4 +.TP \fBlist\fR . .br Lists installed casks or the casks provided in the arguments\. . -.IP "\(bu" 4 +.TP \fBoutdated\fR . .br List the outdated installed casks\. . -.IP "\(bu" 4 +.TP \fBreinstall\fR . .br Reinstalls the given \fIcask\fR\. . -.IP "\(bu" 4 +.TP \fBstyle\fR . .br Checks style of the given \fIcask\fR using RuboCop\. . -.IP "\(bu" 4 +.TP \fBuninstall\fR . .br Uninstalls the given \fIcask\fR\. . -.IP "\(bu" 4 +.TP \fBupgrade\fR . .br Upgrades all outdated casks or the specified casks\. . -.IP "\(bu" 4 +.TP \fBzap\fR . .br Zaps all files associated with the given \fIcask\fR\. . -.IP "" 0 -. .P See also: \fBman brew\fR . @@ -480,7 +478,7 @@ Treat all named arguments as casks\. . .TP \fB\-\-[no\-]binaries\fR -Disable/enable linking of helper executables\. Default: enabled +Disable/enable linking of helper executables (default: enabled)\. . .TP \fB\-\-require\-sha\fR @@ -488,7 +486,7 @@ Require all casks to have a checksum\. . .TP \fB\-\-[no\-]quarantine\fR -Disable/enable quarantining of downloads\. Default: enabled +Disable/enable quarantining of downloads (default: enabled)\. . .TP \fB\-\-skip\-cask\-deps\fR @@ -512,15 +510,15 @@ List files which would be linked or deleted by \fBbrew link \-\-overwrite\fR wit \fB\-f\fR, \fB\-\-force\fR Allow keg\-only formulae to be linked\. . -.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR] [\fIformula|cask\fR]" -List all installed formulae or casks +.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]" +List all installed formulae and casks\. . .P If \fIformula\fR is provided, summarise the paths within its current keg\. . .TP \fB\-\-formula\fR -List only formulae\. \fBThis is the default action on non TTY\.\fR +List only formulae\. This is the default when output is not to a terminal\. . .TP \fB\-\-cask\fR @@ -631,11 +629,11 @@ Include detailed version information\. . .TP \fB\-\-formula\fR -Only output outdated formulae\. +List only outdated formulae\. . .TP \fB\-\-cask\fR -Only output outdated casks\. +List only outdated casks\. . .TP \fB\-\-json\fR @@ -714,7 +712,7 @@ Treat all named arguments as casks\. . .TP \fB\-\-[no\-]binaries\fR -Disable/enable linking of helper executables\. Default: enabled +Disable/enable linking of helper executables (default: enabled)\. . .TP \fB\-\-require\-sha\fR @@ -722,7 +720,7 @@ Require all casks to have a checksum\. . .TP \fB\-\-[no\-]quarantine\fR -Disable/enable quarantining of downloads\. Default: enabled +Disable/enable quarantining of downloads (default: enabled)\. . .TP \fB\-\-skip\-cask\-deps\fR @@ -748,7 +746,7 @@ Search for formulae with a description matching \fItext\fR and casks with a name . .TP \fB\-\-pull\-request\fR -Search for GitHub pull requests for \fItext\fR\. +Search for GitHub pull requests containing \fItext\fR\. . .TP \fB\-\-macports\fR @@ -931,7 +929,7 @@ Treat all named arguments as casks\. If no named arguments are specified, upgrad . .TP \fB\-\-[no\-]binaries\fR -Disable/enable linking of helper executables\. Default: enabled +Disable/enable linking of helper executables (default: enabled)\. . .TP \fB\-\-require\-sha\fR @@ -939,7 +937,7 @@ Require all casks to have a checksum\. . .TP \fB\-\-[no\-]quarantine\fR -Disable/enable quarantining of downloads\. Default: enabled +Disable/enable quarantining of downloads (default: enabled)\. . .TP \fB\-\-skip\-cask\-deps\fR @@ -976,7 +974,7 @@ Include all formulae that specify \fIformula\fR as \fB:optional\fR type dependen \fB\-\-skip\-recommended\fR Skip all formulae that specify \fIformula\fR as \fB:recommended\fR type dependency\. . -.SS "\fB\-\-cache\fR [\fIoptions\fR] [\fIformula|cask\fR]" +.SS "\fB\-\-cache\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]" Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\. . .P @@ -1078,7 +1076,7 @@ Prefix every line of output with the file or formula name being audited, to make . .TP \fB\-\-skip\-style\fR -Skip running non\-RuboCop style checks\. Useful if you plan on running \fBbrew style\fR separately\. Default unless a formula is specified by name +Skip running non\-RuboCop style checks\. Useful if you plan on running \fBbrew style\fR separately\. Enabled by default unless a formula is specified by name\. . .TP \fB\-D\fR, \fB\-\-audit\-debug\fR @@ -1146,7 +1144,7 @@ Display out\-of\-date brew formulae and the latest version available\. Also disp \fB\-\-limit\fR Limit number of package results returned\. . -.SS "\fBbump\-cask\-pr\fR [\fIoptions\fR] [\fIcask\fR]" +.SS "\fBbump\-cask\-pr\fR [\fIoptions\fR] \fIcask\fR" Create a pull request to update \fIcask\fR with a new version\. . .P @@ -1281,7 +1279,7 @@ Specify the new git commit \fIrevision\fR corresponding to the specified \fItag\ . .TP \fB\-f\fR, \fB\-\-force\fR -Ignore duplicate open PRs\. Remove all mirrors if \-\-mirror= was not specified\. +Ignore duplicate open PRs\. Remove all mirrors if \fB\-\-mirror\fR was not specified\. . .SS "\fBbump\-revision\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]" Create a commit to increment the revision of \fIformula\fR\. If no revision is present, "revision 1" will be added\. @@ -1369,7 +1367,7 @@ Generate the new formula within the given tap, specified as \fIuser\fR\fB/\fR\fI . .TP \fB\-f\fR, \fB\-\-force\fR -Ignore errors for disallowed formula names and named that shadow aliases\. +Ignore errors for disallowed formula names and names that shadow aliases\. . .SS "\fBdispatch\-build\-bottle\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]" Build bottles for these formulae with GitHub Actions\. @@ -1509,7 +1507,7 @@ Pull requests must have this label\. . .TP \fB\-\-without\-labels\fR -Pull requests must not have these labels (default: \fBdo not merge\fR, \fBnew formula\fR, \fBautomerge\-skip\fR)\. +Pull requests must not have these labels (default: \fBdo not merge\fR, \fBnew formula\fR, \fBautomerge\-skip\fR, \fBlinux\-only\fR)\. . .TP \fB\-\-without\-approval\fR @@ -1710,15 +1708,15 @@ Generate the template files for a new tap\. . .TP \fB\-\-no\-git\fR -Don\'t initialize a git repository for the tap\. +Don\'t initialize a Git repository for the tap\. . .TP \fB\-\-pull\-label\fR -Label name for pull requests ready to be pulled (default \fBpr\-pull\fR)\. +Label name for pull requests ready to be pulled (default: \fBpr\-pull\fR)\. . .TP \fB\-\-branch\fR -Initialize git repository with the specified branch name (default \fBmain\fR)\. +Initialize Git repository with the specified branch name (default: \fBmain\fR)\. . .SS "\fBtest\fR [\fIoptions\fR] \fIformula\fR" Run the test method provided by an installed formula\. There is no standard output or return code, but generally it should notify the user if something is wrong with the installed formula\. @@ -1875,64 +1873,64 @@ Install and commit Homebrew\'s vendored gems\. These options are applicable to subcommands accepting a \fB\-\-cask\fR flag and all \fBcask\fR commands\. . .TP -\fB\-\-appdir=\fR -Target location for Applications\. Default: \fB/Applications\fR +\fB\-\-appdir\fR +Target location for Applications (default: \fB/Applications\fR)\. . .TP -\fB\-\-colorpickerdir=\fR -Target location for Color Pickers\. Default: \fB~/Library/ColorPickers\fR +\fB\-\-colorpickerdir\fR +Target location for Color Pickers (default: \fB~/Library/ColorPickers\fR)\. . .TP -\fB\-\-prefpanedir=\fR -Target location for Preference Panes\. Default: \fB~/Library/PreferencePanes\fR +\fB\-\-prefpanedir\fR +Target location for Preference Panes (default: \fB~/Library/PreferencePanes\fR)\. . .TP -\fB\-\-qlplugindir=\fR -Target location for QuickLook Plugins\. Default: \fB~/Library/QuickLook\fR +\fB\-\-qlplugindir\fR +Target location for QuickLook Plugins (default: \fB~/Library/QuickLook\fR)\. . .TP -\fB\-\-mdimporterdir=\fR -Target location for Spotlight Plugins\. Default: \fB~/Library/Spotlight\fR +\fB\-\-mdimporterdir\fR +Target location for Spotlight Plugins (default: \fB~/Library/Spotlight\fR)\. . .TP -\fB\-\-dictionarydir=\fR -Target location for Dictionaries\. Default: \fB~/Library/Dictionaries\fR +\fB\-\-dictionarydir\fR +Target location for Dictionaries (default: \fB~/Library/Dictionaries\fR)\. . .TP -\fB\-\-fontdir=\fR -Target location for Fonts\. Default: \fB~/Library/Fonts\fR +\fB\-\-fontdir\fR +Target location for Fonts (default: \fB~/Library/Fonts\fR)\. . .TP -\fB\-\-servicedir=\fR -Target location for Services\. Default: \fB~/Library/Services\fR +\fB\-\-servicedir\fR +Target location for Services (default: \fB~/Library/Services\fR)\. . .TP -\fB\-\-input_methoddir=\fR -Target location for Input Methods\. Default: \fB~/Library/Input Methods\fR +\fB\-\-input_methoddir\fR +Target location for Input Methods (default: \fB~/Library/Input Methods\fR)\. . .TP -\fB\-\-internet_plugindir=\fR -Target location for Internet Plugins\. Default: \fB~/Library/Internet Plug\-Ins\fR +\fB\-\-internet_plugindir\fR +Target location for Internet Plugins (default: \fB~/Library/Internet Plug\-Ins\fR)\. . .TP -\fB\-\-audio_unit_plugindir=\fR -Target location for Audio Unit Plugins\. Default: \fB~/Library/Audio/Plug\-Ins/Components\fR +\fB\-\-audio_unit_plugindir\fR +Target location for Audio Unit Plugins (default: \fB~/Library/Audio/Plug\-Ins/Components\fR)\. . .TP -\fB\-\-vst_plugindir=\fR -Target location for VST Plugins\. Default: \fB~/Library/Audio/Plug\-Ins/VST\fR +\fB\-\-vst_plugindir\fR +Target location for VST Plugins (default: \fB~/Library/Audio/Plug\-Ins/VST\fR)\. . .TP -\fB\-\-vst3_plugindir=\fR -Target location for VST3 Plugins\. Default: \fB~/Library/Audio/Plug\-Ins/VST3\fR +\fB\-\-vst3_plugindir\fR +Target location for VST3 Plugins (default: \fB~/Library/Audio/Plug\-Ins/VST3\fR)\. . .TP -\fB\-\-screen_saverdir=\fR -Target location for Screen Savers\. Default: \fB~/Library/Screen Savers\fR +\fB\-\-screen_saverdir\fR +Target location for Screen Savers (default: \fB~/Library/Screen Savers\fR)\. . .TP \fB\-\-language\fR -Set language of the Cask to install\. The first matching language is used, otherwise the default language on the Cask\. The default value is the \fBlanguage of your system\fR +Comma\-separated list of language codes to prefer for cask installation\. The first matching language is used, otherwise it reverts to the cask\'s default language\. The default value is the language of your system\. . .SH "GLOBAL OPTIONS" These options are applicable across multiple subcommands\. @@ -1963,14 +1961,17 @@ Bundler for non\-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store a Install and upgrade (by default) all dependencies from the \fBBrewfile\fR\. . .P -You can skip the installation of dependencies by adding space\-separated values to one or more of the following environment variables: \fBHOMEBREW_BUNDLE_BREW_SKIP\fR, \fBHOMEBREW_BUNDLE_CASK_SKIP\fR, \fBHOMEBREW_BUNDLE_MAS_SKIP\fR, \fBHOMEBREW_BUNDLE_WHALEBREW_SKIP\fR, \fBHOMEBREW_BUNDLE_TAP_SKIP\fR +You can specify the \fBBrewfile\fR location using \fB\-\-file\fR or by setting the \fBHOMEBREW_BUNDLE_FILE\fR environment variable\. +. +.P +You can skip the installation of dependencies by adding space\-separated values to one or more of the following environment variables: \fBHOMEBREW_BUNDLE_BREW_SKIP\fR, \fBHOMEBREW_BUNDLE_CASK_SKIP\fR, \fBHOMEBREW_BUNDLE_MAS_SKIP\fR, \fBHOMEBREW_BUNDLE_WHALEBREW_SKIP\fR, \fBHOMEBREW_BUNDLE_TAP_SKIP\fR\. . .P \fBbrew bundle\fR will output a \fBBrewfile\.lock\.json\fR in the same directory as the \fBBrewfile\fR if all dependencies are installed successfully\. This contains dependency and system status information which can be useful in debugging \fBbrew bundle\fR failures and replicating a "last known good build" state\. You can opt\-out of this behaviour by setting the \fBHOMEBREW_BUNDLE_NO_LOCK\fR environment variable or passing the \fB\-\-no\-lock\fR option\. You may wish to check this file into the same version control system as your \fBBrewfile\fR (or ensure your version control system ignores it if you\'d prefer to rely on debugging information from a local machine)\. . .P \fBbrew bundle dump\fR - Write all installed casks/formulae/images/taps into a \fBBrewfile\fR\. + Write all installed casks/formulae/images/taps into a \fBBrewfile\fR in the current directory\. . .P \fBbrew bundle cleanup\fR @@ -1981,14 +1982,14 @@ This workflow is useful for maintainers or testers who regularly install lots of . .P \fBbrew bundle check\fR - Check if all dependencies are installed from the \fBBrewfile\fR \. + Check if all dependencies are installed from the \fBBrewfile\fR\. . .P This provides a successful exit code if everything is up\-to\-date, making it useful for scripting\. . .P \fBbrew bundle list\fR - List all dependencies present in a \fBBrewfile\fR\. + List all dependencies present in the \fBBrewfile\fR\. . .P By default, only Homebrew dependencies are listed\. @@ -2098,79 +2099,79 @@ If \fBsudo\fR is passed, operate on \fB/Library/LaunchDaemons\fR (started at boo \fB\-\-all\fR Run \fIsubcommand\fR on all services\. . -.SS "\fBtest\-bot\fR [\fIoptions\fR] [\fIformula\fR]:" -Tests the full lifecycle of a Homebrew change to a tap (Git repository)\. For example, for a GitHub Actions pull request that changes a formula \fBbrew test\-bot\fR will ensure the system is cleaned and setup to test the formula, install the formula, run various tests and checks on it, bottle (package) the binaries and test formulae that depend on it to ensure they aren\'t broken by these changes\. +.SS "\fBtest\-bot\fR [\fIoptions\fR] [\fIformula\fR]" +Tests the full lifecycle of a Homebrew change to a tap (Git repository)\. For example, for a GitHub Actions pull request that changes a formula \fBbrew test\-bot\fR will ensure the system is cleaned and set up to test the formula, install the formula, run various tests and checks on it, bottle (package) the binaries and test formulae that depend on it to ensure they aren\'t broken by these changes\. . .P Only supports GitHub Actions as a CI provider\. This is because Homebrew uses GitHub Actions and it\'s freely available for public and private use with macOS and Linux workers\. . .TP \fB\-\-dry\-run\fR -print what would be done rather than doing it\. +Print what would be done rather than doing it\. . .TP \fB\-\-cleanup\fR -clean all state from the Homebrew directory\. Use with care! +Clean all state from the Homebrew directory\. Use with care! . .TP \fB\-\-skip\-setup\fR -don\'t check if the local system is set up correctly\. +Don\'t check if the local system is set up correctly\. . .TP \fB\-\-keep\-old\fR -run \fBbrew bottle \-\-keep\-old\fR to build new bottles for a single platform\. +Run \fBbrew bottle \-\-keep\-old\fR to build new bottles for a single platform\. . .TP \fB\-\-skip\-relocation\fR -run \fBbrew bottle \-\-skip\-relocation\fR to build new bottles that don\'t require relocation\. +Run \fBbrew bottle \-\-skip\-relocation\fR to build new bottles that don\'t require relocation\. . .TP \fB\-\-local\fR -ask Homebrew to write verbose logs under \fB\./logs/\fR and set \fB$HOME\fR to \fB\./home/\fR +Ask Homebrew to write verbose logs under \fB\./logs/\fR and set \fB$HOME\fR to \fB\./home/\fR . .TP \fB\-\-tap\fR -use the \fBgit\fR repository of the given tap\. Defaults to the core tap for syntax checking\. +Use the Git repository of the given tap\. Defaults to the core tap for syntax checking\. . .TP \fB\-\-fail\-fast\fR -immediately exit on a failing step\. +Immediately exit on a failing step\. . .TP \fB\-v\fR, \fB\-\-verbose\fR -print test step output in real time\. Has the side effect of passing output as raw bytes instead of re\-encoding in UTF\-8\. +Print test step output in real time\. Has the side effect of passing output as raw bytes instead of re\-encoding in UTF\-8\. . .TP \fB\-\-test\-default\-formula\fR -use a default testing formula when not building a tap and no other formulae are specified\. +Use a default testing formula when not building a tap and no other formulae are specified\. . .TP \fB\-\-bintray\-org\fR -upload to the given Bintray organisation\. +Upload bottles to the given Bintray organisation\. . .TP \fB\-\-root\-url\fR -use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\. +Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\. . .TP \fB\-\-git\-name\fR -set the Git author/committer names to the given name\. +Set the Git author/committer names to the given name\. . .TP \fB\-\-git\-email\fR -set the Git author/committer email to the given email\. +Set the Git author/committer email to the given email\. . .TP \fB\-\-ci\-upload\fR -use the Homebrew CI bottle upload options\. +Use the Homebrew CI bottle upload options\. . .TP \fB\-\-publish\fR -publish the uploaded bottles\. +Publish the uploaded bottles\. . .TP \fB\-\-skip\-recursive\-dependents\fR -only test the direct dependents\. +Only test the direct dependents\. . .TP \fB\-\-only\-cleanup\-before\fR @@ -2221,17 +2222,23 @@ Note that environment variables must have a value set to be detected\. For examp . .TP \fBHOMEBREW_ARCH\fR -Linux only: Pass the set value to a type name representing the compiler\'s \fB\-march\fR option\. +. +.br +Linux only: Pass this value to a type name representing the compiler\'s \fB\-march\fR option\. . .IP \fIDefault:\fR \fBnative\fR\. . .TP \fBHOMEBREW_ARTIFACT_DOMAIN\fR +. +.br Prefix all download URLs, including those for bottles, with this variable\. For example, \fBHOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080\fR will cause a formula with the URL \fBhttps://example\.com/foo\.tar\.gz\fR to instead download from \fBhttp://localhost:8080/example\.com/foo\.tar\.gz\fR\. . .TP \fBHOMEBREW_AUTO_UPDATE_SECS\fR +. +.br Automatically check for updates once per this seconds interval\. . .IP @@ -2239,39 +2246,53 @@ Automatically check for updates once per this seconds interval\. . .TP \fBHOMEBREW_BAT\fR +. +.br If set, use \fBbat\fR for the \fBbrew cat\fR command\. . .TP \fBHOMEBREW_BAT_CONFIG_PATH\fR -Use the \fBbat\fR configuration file\. For example, \fBHOMEBREW_BAT=$HOME/\.bat/config\fR\. +. +.br +Use this as the \fBbat\fR configuration file\. . .IP -\fIDefault:\fR $HOME/\.bat/config +\fIDefault:\fR \fB$HOME/\.bat/config\fR\. . .TP \fBHOMEBREW_BINTRAY_KEY\fR +. +.br Use this API key when accessing the Bintray API (where bottles are stored)\. . .TP \fBHOMEBREW_BINTRAY_USER\fR +. +.br Use this username when accessing the Bintray API (where bottles are stored)\. . .TP \fBHOMEBREW_BOTTLE_DOMAIN\fR -Use the specified URL as the download mirror for bottles\. For example, \fBHOMEBREW_BOTTLE_DOMAIN=http://localhost:8080\fR will cause all bottles to download from the prefix \fBhttp://localhost:8080/\fR\. +. +.br +Use this URL as the download mirror for bottles\. For example, \fBHOMEBREW_BOTTLE_DOMAIN=http://localhost:8080\fR will cause all bottles to download from the prefix \fBhttp://localhost:8080/\fR\. . .IP \fIDefault:\fR macOS: \fBhttps://homebrew\.bintray\.com/\fR, Linux: \fBhttps://linuxbrew\.bintray\.com/\fR\. . .TP \fBHOMEBREW_BREW_GIT_REMOTE\fR -Use the specified URL as the Homebrew/brew \fBgit\fR(1) remote\. +. +.br +Use this URL as the Homebrew/brew \fBgit\fR(1) remote\. . .IP \fIDefault:\fR \fBhttps://github\.com/Homebrew/brew\fR\. . .TP \fBHOMEBREW_BROWSER\fR +. +.br Use this as the browser when opening project homepages\. . .IP @@ -2279,20 +2300,26 @@ Use this as the browser when opening project homepages\. . .TP \fBHOMEBREW_CACHE\fR -Use the specified directory as the download cache\. +. +.br +Use this directory as the download cache\. . .IP \fIDefault:\fR macOS: \fB$HOME/Library/Caches/Homebrew\fR, Linux: \fB$XDG_CACHE_HOME/Homebrew\fR or \fB$HOME/\.cache/Homebrew\fR\. . .TP \fBHOMEBREW_CASK_OPTS\fR -Options which should be used for 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 ~/\.profile, ~/\.bash_profile, or ~/\.zshenv: . -.P -\fBexport HOMEBREW_CASK_OPTS=\'\-\-appdir=~/Applications \-\-fontdir=/Library/Fonts\'\fR +.br +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: +. +.IP +\fBexport HOMEBREW_CASK_OPTS="\-\-appdir=~/Applications \-\-fontdir=/Library/Fonts"\fR . .TP \fBHOMEBREW_CLEANUP_MAX_AGE_DAYS\fR +. +.br Cleanup all cached files older than this many days\. . .IP @@ -2300,21 +2327,29 @@ Cleanup all cached files older than this many days\. . .TP \fBHOMEBREW_COLOR\fR +. +.br If set, force colour output on non\-TTY outputs\. . .TP \fBHOMEBREW_CORE_GIT_REMOTE\fR -Use the specified URL as the Homebrew/homebrew\-core \fBgit\fR(1) remote\. +. +.br +Use this URL as the Homebrew/homebrew\-core \fBgit\fR(1) remote\. . .IP \fIDefault:\fR macOS: \fBhttps://github\.com/Homebrew/homebrew\-core\fR, Linux: \fBhttps://github\.com/Homebrew/linuxbrew\-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_RETRIES\fR +. +.br Pass the given retry count to \fB\-\-retry\fR when invoking \fBcurl\fR(1)\. . .IP @@ -2322,18 +2357,26 @@ Pass the given retry count to \fB\-\-retry\fR when invoking \fBcurl\fR(1)\. . .TP \fBHOMEBREW_CURL_VERBOSE\fR +. +.br If set, pass \fB\-\-verbose\fR when invoking \fBcurl\fR(1)\. . .TP \fBHOMEBREW_DEVELOPER\fR +. +.br If set, tweak behaviour to be more relevant for Homebrew developers (active or budding) by e\.g\. turning warnings into errors\. . .TP \fBHOMEBREW_DISABLE_LOAD_FORMULA\fR +. +.br If set, refuse to load formulae\. This is useful when formulae are not trusted (such as in pull requests)\. . .TP \fBHOMEBREW_DISPLAY\fR +. +.br Use this X11 display when opening a page in a browser, for example with \fBbrew home\fR\. Primarily useful on Linux\. . .IP @@ -2341,10 +2384,14 @@ Use this X11 display when opening a page in a browser, for example with \fBbrew . .TP \fBHOMEBREW_DISPLAY_INSTALL_TIMES\fR +. +.br If set, print install times for each formula at the end of the run\. . .TP \fBHOMEBREW_EDITOR\fR +. +.br Use this editor when editing a single formula, or several formulae in the same directory\. . .IP @@ -2355,6 +2402,8 @@ Use this editor when editing a single formula, or several formulae in the same d . .TP \fBHOMEBREW_FAIL_LOG_LINES\fR +. +.br Output this many lines of output on formula \fBsystem\fR failures\. . .IP @@ -2362,49 +2411,71 @@ Output this many lines of output on formula \fBsystem\fR failures\. . .TP \fBHOMEBREW_FORBIDDEN_LICENSES\fR -A space\-separated list of licenses\. Homebrew will refuse to install a formula if that formula or any of its dependencies has a license on this list\. +. +.br +A space\-separated list of licenses\. Homebrew will refuse to install a formula if it or any of its dependencies has a license on this list\. . .TP \fBHOMEBREW_FORCE_BREWED_CURL\fR +. +.br If set, always use a Homebrew\-installed \fBcurl\fR(1) rather than the system version\. Automatically set if the system version of \fBcurl\fR is too old\. . .TP \fBHOMEBREW_FORCE_BREWED_GIT\fR +. +.br If set, always use a Homebrew\-installed \fBgit\fR(1) rather than the system version\. Automatically set if the system version of \fBgit\fR is too old\. . .TP \fBHOMEBREW_FORCE_HOMEBREW_ON_LINUX\fR +. +.br If set, running Homebrew on Linux will use URLs for macOS\. This is useful when merging pull requests for macOS while on Linux\. . .TP \fBHOMEBREW_FORCE_VENDOR_RUBY\fR +. +.br If set, always use Homebrew\'s vendored, relocatable Ruby version even if the system version of Ruby is new enough\. . .TP \fBHOMEBREW_GITHUB_API_PASSWORD\fR +. +.br Use this password for authentication with the GitHub API, for features such as \fBbrew search\fR\. This is deprecated in favour of using \fBHOMEBREW_GITHUB_API_TOKEN\fR\. . .TP \fBHOMEBREW_GITHUB_API_TOKEN\fR -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\. +. +.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_API_USERNAME\fR +. +.br Use this username for authentication with the GitHub API, for features such as \fBbrew search\fR\. This is deprecated in favour of using \fBHOMEBREW_GITHUB_API_TOKEN\fR\. . .TP \fBHOMEBREW_GIT_EMAIL\fR -Set the Git author and committer name to this value\. +. +.br +Set the Git author and committer email to this value\. . .TP \fBHOMEBREW_GIT_NAME\fR -Set the Git author and committer email to this value\. +. +.br +Set the Git author and committer name to this value\. . .TP \fBHOMEBREW_INSTALL_BADGE\fR +. +.br Print this text before the installation summary of each successful build\. . .IP @@ -2412,20 +2483,26 @@ Print this text before the installation summary of each successful build\. . .TP \fBHOMEBREW_LIVECHECK_WATCHLIST\fR -Use this file to get the list of default Formulae to check when no Formula argument is passed to \fBbrew livecheck\fR +. +.br +Consult this file for the list of formulae to check by default when no formula argument is passed to \fBbrew livecheck\fR\. . .IP \fIDefault:\fR \fB$HOME/\.brew_livecheck_watchlist\fR\. . .TP \fBHOMEBREW_LOGS\fR -Use the specified directory to store log files\. +. +.br +Use this directory to store log files\. . .IP \fIDefault:\fR macOS: \fB$HOME/Library/Logs/Homebrew\fR, Linux: \fB$XDG_CACHE_HOME/Homebrew/Logs\fR or \fB$HOME/\.cache/Homebrew/Logs\fR\. . .TP \fBHOMEBREW_MAKE_JOBS\fR +. +.br Use this value as the number of parallel jobs to run when building with \fBmake\fR(1)\. . .IP @@ -2433,22 +2510,32 @@ Use this value as the number of parallel jobs to run when building with \fBmake\ . .TP \fBHOMEBREW_NO_ANALYTICS\fR -If set, do not send analytics\. See: \fIhttps://docs\.brew\.sh/Analytics\fR\. +. +.br +If set, do not send analytics\. For more information, see: \fIhttps://docs\.brew\.sh/Analytics\fR . .TP \fBHOMEBREW_NO_AUTO_UPDATE\fR +. +.br If set, do not automatically update before running \fBbrew install\fR, \fBbrew upgrade\fR or \fBbrew tap\fR\. . .TP \fBHOMEBREW_NO_BOTTLE_SOURCE_FALLBACK\fR +. +.br If set, fail on the failure of installation from a bottle rather than falling back to building from source\. . .TP \fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fR +. +.br If set, do not check for broken dependents after installing, upgrading or reinstalling formulae\. . .TP \fBHOMEBREW_NO_COLOR\fR +. +.br If set, do not print text with colour added\. . .IP @@ -2456,44 +2543,62 @@ If set, do not print text with colour added\. . .TP \fBHOMEBREW_NO_COMPAT\fR +. +.br If set, disable all use of legacy compatibility code\. . .TP \fBHOMEBREW_NO_EMOJI\fR +. +.br If set, do not print \fBHOMEBREW_INSTALL_BADGE\fR on a successful build\. . .IP -\fINote:\fR Only tries to print emoji on OS X Lion or newer\. +\fINote:\fR Will only try to print emoji on OS X Lion or newer\. . .TP \fBHOMEBREW_NO_GITHUB_API\fR -If set, do not use the GitHub API, e\.g\. for searches or fetching relevant issues on a failed install\. +. +.br +If set, do not use the GitHub API, e\.g\. for searches or fetching relevant issues after a failed install\. . .TP \fBHOMEBREW_NO_INSECURE_REDIRECT\fR +. +.br If set, forbid redirects from secure HTTPS to insecure HTTP\. . .IP -\fINote:\fR While ensuring your downloads are fully secure, this is likely to cause from\-source SourceForge, some GNU & GNOME based formulae to fail to download\. +\fINote:\fR While ensuring your downloads are fully secure, this is likely to cause from\-source SourceForge, some GNU & GNOME\-hosted formulae to fail to download\. . .TP \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 30 days\. . .TP \fBHOMEBREW_PRY\fR +. +.br If set, use Pry for the \fBbrew irb\fR command\. . .TP \fBHOMEBREW_SKIP_OR_LATER_BOTTLES\fR -If set with \fBHOMEBREW_DEVELOPER\fR, do not use bottles from older versions of macOS\. This is useful in development on new macOS versions\. +. +.br +If set along with \fBHOMEBREW_DEVELOPER\fR, do not use bottles from older versions of macOS\. This is useful in development on new macOS versions\. . .TP \fBHOMEBREW_SORBET_RUNTIME\fR -Enable runtime typechecking using Sorbet\. +. +.br +If set, enable runtime typechecking using Sorbet\. . .TP \fBHOMEBREW_SVN\fR +. +.br Use this as the \fBsvn\fR(1) binary\. . .IP @@ -2501,6 +2606,8 @@ Use this as the \fBsvn\fR(1) binary\. . .TP \fBHOMEBREW_TEMP\fR +. +.br Use this path as the temporary directory for building packages\. Changing this may be needed if your system temporary directory and Homebrew prefix are on different volumes, as macOS has trouble moving symlinks across volumes when the target does not yet exist\. This issue typically occurs when using FileVault or custom SSD configurations\. . .IP @@ -2508,47 +2615,69 @@ Use this path as the temporary directory for building packages\. Changing this m . .TP \fBHOMEBREW_UPDATE_REPORT_ONLY_INSTALLED\fR -If set, \fBbrew update\fR only outputs updates to installed software\. +. +.br +If set, \fBbrew update\fR only lists updates to installed software\. . .TP \fBHOMEBREW_UPDATE_TO_TAG\fR +. +.br If set, always use the latest stable tag (even if developer commands have been run)\. . .TP \fBHOMEBREW_VERBOSE\fR +. +.br 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 \fBall_proxy\fR +. +.br Use this SOCKS5 proxy for \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\. . .TP \fBftp_proxy\fR +. +.br Use this FTP proxy for \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\. . .TP \fBhttp_proxy\fR +. +.br Use this HTTP proxy for \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\. . .TP \fBhttps_proxy\fR +. +.br Use this HTTPS proxy for \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\. . .TP \fBno_proxy\fR +. +.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 -When this variable is set, the \fB\-A\fR option is passed when calling \fBsudo\fR(8) +. +.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\. @@ -2613,13 +2742,19 @@ See our issues on GitHub: . .TP \fBHomebrew/brew\fR +. +.br \fIhttps://github\.com/Homebrew/brew/issues\fR . .TP \fBHomebrew/homebrew\-core\fR +. +.br \fIhttps://github\.com/Homebrew/homebrew\-core/issues\fR . .TP \fBHomebrew/homebrew\-cask\fR +. +.br \fIhttps://github\.com/Homebrew/homebrew\-cask/issues\fR From c1ff5efb5ae95cc721218833bf0b8485d8295221 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Mon, 16 Nov 2020 13:59:45 +0000 Subject: [PATCH 5/5] docs/vale-styles/Homebrew/Titles: fix Linux reference. --- docs/vale-styles/Homebrew/Titles.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/vale-styles/Homebrew/Titles.yml b/docs/vale-styles/Homebrew/Titles.yml index 2853a268f118f..7f9248291516e 100644 --- a/docs/vale-styles/Homebrew/Titles.yml +++ b/docs/vale-styles/Homebrew/Titles.yml @@ -9,3 +9,4 @@ exceptions: - macOS - Homebrew/homebrew-core - Homebrew/linuxbrew-core + - (or Linux)