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

Merge pull request #6385 from EricFromCanada/man-page-text

Browse Source 
manpages: fixes and rewording
This commit is contained in:
Mike McQuaid 2019-08-20 15:43:18 +01:00 committed by GitHub
commit 84c5f40793
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
63 changed files with 660 additions and 667 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Library/Homebrew/cmd/--env.rb
View File

@ -13,16 +13,16 @@ module Homebrew
usage_banner <<~EOS
`--env` [<options>]
Show a summary of the Homebrew build environment as a plain list.
Summarize Homebrew's build environment as a plain list.
If the command's output is sent through a pipe and no shell is specified,
the list is formatted for export to `bash`(1) unless `--plain` is passed.
EOS
flag "--shell=",
description: "Generate a list of environment variables for the specified shell, " \
"or `--shell=auto` to detect the current shell."
flag "--shell=",
description: "Generate a list of environment variables for the specified shell, " \
"or `--shell=auto` to detect the current shell."
switch "--plain",
description: "Plain output even when piped."
description: "Generate plain output even when piped."
end
end

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

@ -8,7 +8,7 @@ module Homebrew
def __repository_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`--repository` [<user>`/`<repo>]
`--repository`, `--repo` [<user>`/`<repo>]
Display where Homebrew's `.git` directory is located.

4
Library/Homebrew/cmd/--version.rb
View File

@ -10,8 +10,8 @@ module Homebrew
usage_banner <<~EOS
`--version`
Print the version number of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask
(if tapped) to standard output and exit.
Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask
(if tapped) to standard output.
EOS
end
end

6
Library/Homebrew/cmd/analytics.rb
View File

@ -8,14 +8,14 @@ module Homebrew
def analytics_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`analytics` [`on`|`off`|`state`|`regenerate-uuid`]
`analytics` [<subcommand>]
If `on` or `off` is passed, turn Homebrew's analytics on or off respectively.
If `state` is passed, display anonymous user behaviour analytics state.
If `state` is passed, display the current anonymous user behaviour analytics state.
Read more at <https://docs.brew.sh/Analytics>.
If `regenerate-uuid` is passed, regenerate UUID used in Homebrew's analytics.
If `regenerate-uuid` is passed, regenerate the UUID used in Homebrew's analytics.
EOS
switch :verbose
switch :debug

5
Library/Homebrew/cmd/cleanup.rb
View File

@ -11,11 +11,10 @@ module Homebrew
usage_banner <<~EOS
`cleanup` [<options>] [<formula>|<cask>]
Remove stale lock files and outdated downloads for formulae and casks,
Remove stale lock files and outdated downloads for all formulae and casks,
and remove old versions of installed formulae. If arguments are specified,
only do this for the specified formulae and casks.
only do this for the given formulae and casks.
EOS
flag "--prune=",
description: "Remove all cache files older than specified <days>."
switch "-n", "--dry-run",

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

@ -11,7 +11,7 @@ module Homebrew
usage_banner <<~EOS
`command` <cmd>
Display the path to the file which is used when invoking `brew` <cmd>.
Display the path to the file being used when invoking `brew` <cmd>.
EOS
switch :verbose
switch :debug

6
Library/Homebrew/cmd/commands.rb
View File

@ -10,13 +10,13 @@ module Homebrew
usage_banner <<~EOS
`commands` [<options>]
Show a list of built-in and external commands.
Show lists of built-in and external commands.
EOS
switch "--quiet",
description: "List only the names of commands without the header."
description: "List only the names of commands without category headers."
switch "--include-aliases",
depends_on: "--quiet",
description: "Include the aliases of internal commands."
description: "Include aliases of internal commands."
switch :verbose
switch :debug
end

5
Library/Homebrew/cmd/config.rb
View File

@ -11,9 +11,8 @@ module Homebrew
usage_banner <<~EOS
`config`
Show Homebrew and system configuration useful for debugging. If you file
a bug report, you will likely be asked for this information if you do not
provide it.
Show Homebrew and system configuration info useful for debugging. If you file
a bug report, you will be required to provide this information.
EOS
switch :verbose
switch :debug

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

@ -10,14 +10,14 @@ module Homebrew
def deps_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`deps` [<options>] <formula>
`deps` [<options>] [<formula>]
Show dependencies for <formula>. Additional options specific to <formula>
may be appended to the command. When given multiple formula arguments,
show the intersection of dependencies for each formula.
EOS
switch "-n",
description: "Show dependencies in topological order."
description: "Sort dependencies in topological order."
switch "--1",
description: "Only show dependencies one level down, instead of recursing."
switch "--union",
@ -47,7 +47,7 @@ module Homebrew
description: "List dependencies for all available formulae."
switch "--for-each",
description: "Switch into the mode used by the `--all` option, but only list dependencies "\
"for the specified <formula>, one formula per line. This is used for "\
"for each provided <formula>, one formula per line. This is used for "\
"debugging the `--installed`/`--all` display mode."
switch :verbose
switch :debug

18
Library/Homebrew/cmd/desc.rb
View File

@ -19,15 +19,15 @@ module Homebrew
Formula descriptions are cached; the cache is created on the
first search, making that search slower than subsequent ones.
EOS
flag "-s", "--search=",
description: "Search both name and description for provided <text>. If <text> is flanked by "\
"slashes, it is interpreted as a regular expression."
flag "-n", "--name=",
description: "Search just the names for provided <text>. If <text> is flanked by slashes, it is "\
"interpreted as a regular expression."
flag "-d", "--description=",
description: "Search just the descriptions for provided <text>. If <text> is flanked by slashes, "\
"it is interpreted as a regular expression."
flag "-s", "--search=",
description: "Search both names and descriptions for <text>. If <text> is flanked by "\
"slashes, it is interpreted as a regular expression."
flag "-n", "--name=",
description: "Search just names for <text>. If <text> is flanked by slashes, it is "\
"interpreted as a regular expression."
flag "-d", "--description=",
description: "Search just descriptions for <text>. If <text> is flanked by slashes, "\
"it is interpreted as a regular expression."
switch :verbose
conflicts "--search=", "--name=", "--description="
end

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

@ -15,10 +15,10 @@ module Homebrew
Using the output from this command, you can install your own software into
the Cellar and then link it into Homebrew's prefix with `brew link`.
EOS
flag "--name=",
description: "Explicitly set the provided <name> of the package being installed."
flag "--version=",
description: "Explicitly set the provided <version> of the package being installed."
flag "--name=",
description: "Explicitly set the <name> of the package being installed."
flag "--version=",
description: "Explicitly set the <version> of the package being installed."
switch :verbose
switch :debug
end

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

@ -11,7 +11,7 @@ module Homebrew
usage_banner <<~EOS
`doctor` [<options>]
Check your system for potential problems. Doctor exits with a non-zero status
Check your system for potential problems. Will exit with a non-zero status
if any potential problems are found. Please note that these warnings are just
used to help the Homebrew maintainers with debugging if you file an issue. If
everything you use Homebrew for is working fine: please don't worry or file

17
Library/Homebrew/cmd/fetch.rb
View File

@ -12,31 +12,30 @@ module Homebrew
usage_banner <<~EOS
`fetch` [<options>] <formula>
Download the source packages for the given <formula>.
Download a bottle (if available) or source packages for <formula>.
For tarballs, also print SHA-256 checksums.
EOS
switch "--HEAD",
description: "Fetch HEAD version instead of stable version."
switch "--devel",
description: "Fetch development version instead of stable version."
switch :force,
description: "Remove a previously cached version and re-fetch."
switch :verbose,
description: "Do a verbose VCS checkout, if the URL represents a VCS. This is useful for "\
"seeing if an existing VCS cache has been updated."
switch :force,
description: "Remove a previously cached version and re-fetch."
switch "--retry",
description: "Retry if a download fails or re-download if the checksum of a previously cached "\
"version no longer matches."
description: "Retry if downloading fails or re-download if the checksum of a previously cached "\
"version no longer matches."
switch "--deps",
description: "Download dependencies for any listed <formula>."
description: "Also download dependencies for any listed <formula>."
switch "-s", "--build-from-source",
description: "Download the source for rather than a bottle."
description: "Download source packages rather than a bottle."
switch "--build-bottle",
description: "Download the source (for eventual bottling) rather than a bottle."
description: "Download source packages (for eventual bottling) rather than a bottle."
switch "--force-bottle",
description: "Download a bottle if it exists for the current or newest version of macOS, "\
"even if it would not be used during installation."
switch :verbose
switch :debug
conflicts "--devel", "--HEAD"
conflicts "--build-from-source", "--build-bottle", "--force-bottle"

14
Library/Homebrew/cmd/gist-logs.rb
View File

@ -15,21 +15,17 @@ module Homebrew
usage_banner <<~EOS
`gist-logs` [<options>] <formula>
Upload logs for a failed build of <formula> to a new Gist.
<formula> is usually the name of the formula to install, but it can be specified
in several different ways.
If no logs are found, an error message is presented.
Upload logs for a failed build of <formula> to a new Gist. Presents an
error message if no logs are found.
EOS
switch "--with-hostname",
description: "Include the hostname in the Gist."
switch "-n", "--new-issue",
description: "Automatically create a new issue in the appropriate GitHub repository as "\
"well as creating the Gist."
description: "Automatically create a new issue in the appropriate GitHub repository "\
"after creating the Gist."
switch "-p", "--private",
description: "The Gist will be marked private and will not appear in listings but will "\
"be accessible with the link."
"be accessible with its link."
switch :verbose
switch :debug
end

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

@ -10,8 +10,8 @@ module Homebrew
usage_banner <<~EOS
`home` [<formula>]
Open <formula>'s homepage in a browser. If no formula is provided,
open Homebrew's own homepage in a browser.
Open <formula>'s homepage in a browser, or open Homebrew's own homepage
if no formula is provided.
EOS
switch :debug
end

14
Library/Homebrew/cmd/info.rb
View File

@ -19,10 +19,10 @@ module Homebrew
Display brief statistics for your Homebrew installation.
If <formula> is specified, show summary of information about <formula>.
If <formula> is provided, show summary of information about <formula>.
EOS
switch "--analytics",
description: "Display global Homebrew analytics data or, if specified, installation and "\
description: "List global Homebrew analytics data or, if specified, installation and "\
"build error data for <formula> (provided neither `HOMEBREW_NO_ANALYTICS` "\
"nor `HOMEBREW_NO_GITHUB_API` are set)."
flag "--days",
@ -35,12 +35,12 @@ module Homebrew
"The value for <category> must be `install`, `install-on-request`, "\
"`cask-install`, `build-error` or `os-version`. The default is `install`."
switch "--github",
description: "Open a browser to the GitHub source page for <formula>. "\
description: "Open the GitHub source page for <formula> in a browser. "\
"To view formula history locally: `brew log -p` <formula>"
flag "--json",
description: "Print a JSON representation of <formula>. Currently the default and only accepted "\
"value for <version> is `v1`. See the docs for examples of using the JSON "\
"output: <https://docs.brew.sh/Querying-Brew>"
flag "--json",
description: "Print a JSON representation of <formula>. Currently the default and only accepted "\
"value for <version> is `v1`. See the docs for examples of using the JSON "\
"output: <https://docs.brew.sh/Querying-Brew>"
switch "--installed",
depends_on: "--json",
description: "Print JSON of formulae that are currently installed."

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

@ -18,21 +18,18 @@ module Homebrew
usage_banner <<~EOS
`install` [<options>] <formula>
Install <formula>.
Install <formula>. Additional options specific to <formula> may be appended to the command.
<formula> is usually the name of the formula to install, but it can be specified
in several different ways.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the installed formulae or, every 30 days, for all formulae.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the
installed formulae or, every 30 days, for all formulae.
EOS
switch :debug,
description: "If brewing fails, open an interactive debugging session with access to IRB "\
"or a shell inside the temporary build directory"
flag "--env=",
description: "If `std` is passed, use the standard build environment instead of superenv."\
"If `super` is passed, use superenv even if the formula specifies the "\
"standard build environment."
"or a shell inside the temporary build directory."
flag "--env=",
description: "If `std` is passed, use the standard build environment instead of superenv. "\
"If `super` is passed, use superenv even if the formula specifies the "\
"standard build environment."
switch "--ignore-dependencies",
description: "An unsupported Homebrew development flag to skip installing any dependencies of "\
"any kind. If the dependencies are not already present, the formula will have issues. "\
@ -40,38 +37,39 @@ module Homebrew
"using this flag."
switch "--only-dependencies",
description: "Install the dependencies with specified options but do not install the "\
"specified formula."
flag "--cc=",
description: "Attempt to compile using provided <compiler>. <compiler> should be the "\
"name of the compiler's executable, for instance `gcc-7` for GCC 7. "\
"In order to use LLVM's clang, use `llvm_clang`. To specify the "\
"Apple-provided clang, use `clang`. This parameter will only accept "\
"compilers that are provided by Homebrew or bundled with macOS. "\
"Please do not file issues if you encounter errors while using this flag."
"formula itself."
flag "--cc=",
description: "Attempt to compile using the specified <compiler>, which should be the "\
"name of the compiler's executable, e.g. `gcc-7` for GCC 7. "\
"In order to use LLVM's clang, specify `llvm_clang`. To use the "\
"Apple-provided clang, specify `clang`. This option will only accept "\
"compilers that are provided by Homebrew or bundled with macOS. "\
"Please do not file issues if you encounter errors while using this option."
switch "-s", "--build-from-source",
description: "Compile the specified <formula> from source even if a bottle is provided. "\
description: "Compile <formula> from source even if a bottle is provided. "\
"Dependencies will still be installed from bottles if they are available."
switch "--force-bottle",
description: "Install from a bottle if it exists for the current or newest version of "\
"macOS, even if it would not normally be used for installation."
switch "--include-test",
description: "Install testing dependencies required to run `brew test`."
description: "Install testing dependencies required to run `brew test` <formula>."
switch "--devel",
description: "If <formula> defines it, install the development version."
switch "--HEAD",
description: "If <formula> defines it, install the HEAD version, aka. master, trunk, unstable."
switch "--fetch-HEAD",
description: "Fetch the upstream repository to detect if the HEAD installation of the "\
"formula is outdated. Otherwise, the repository's HEAD will be checked for "\
"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 "--keep-tmp",
description: "Don't delete the temporary files created during installation."
description: "Retain the temporary files created during installation."
switch "--build-bottle",
description: "Prepare the formula for eventual bottling during installation."
flag "--bottle-arch=",
depends_on: "--build-bottle",
description: "Optimise bottles for the given architecture rather than the oldest "\
"architecture supported by the version of macOS the bottles are built on."
description: "Prepare the formula for eventual bottling during installation, skipping any "\
"post-install steps."
flag "--bottle-arch=",
depends_on: "--build-bottle",
description: "Optimise bottles for the specified architecture rather than the oldest "\
"architecture supported by the version of macOS the bottles are built on."
switch :force,
description: "Install without checking for previously installed keg-only or "\
"non-migrated versions."
@ -230,7 +228,7 @@ module Homebrew
opoo msg
elsif f.migration_needed? && !args.force?
# Check if the formula we try to install is the same as installed
# but not migrated one. If --force passed then install anyway.
# but not migrated one. If --force is passed then install anyway.
opoo <<~EOS
#{f.oldname} is already installed, it's just not migrated
You can migrate this formula with `brew migrate #{f}`

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

@ -12,7 +12,7 @@ module Homebrew
usage_banner <<~EOS
`leaves`
Show installed formulae that are not dependencies of another installed formula.
List installed formulae that are not dependencies of another installed formula.
EOS
switch :debug
end

10
Library/Homebrew/cmd/link.rb
View File

@ -10,17 +10,17 @@ module Homebrew
def link_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`ln`, `link` [<options>] <formula>
`link`, `ln` [<options>] <formula>
Symlink all of <formula>'s installed files into the Homebrew prefix. This
Symlink all of <formula>'s installed files into Homebrew's prefix. This
is done automatically when you install formulae but can be useful for DIY
installations.
EOS
switch "--overwrite",
description: "Delete files already existing in the prefix while linking."
description: "Delete files that already exist in the prefix while linking."
switch "-n", "--dry-run",
description: "List all files which would be linked or deleted by "\
"`brew link --overwrite`, but will not actually link or delete any files."
description: "List files which would be linked or deleted by "\
"`brew link --overwrite` without actually linking or deleting any files."
switch :force,
description: "Allow keg-only formulae to be linked."
switch :verbose

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

@ -10,36 +10,38 @@ module Homebrew
def list_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`list`, `ls` [<options>]
`list`, `ls` [<options>] [<formula>]
List all installed formulae.
If <formula> is provided, summarize the paths within its current keg.
EOS
switch "--full-name",
description: "Print formulae with fully-qualified names. If `--full-name` is not "\
"passed, other options (i.e. `-1`, `-l`, `-t` and `-r`) are passed to `ls` "\
"passed, other options (i.e. `-1`, `-l`, `-r` and `-t`) are passed to `ls`(1) "\
"which produces the actual output."
switch "--unbrewed",
description: "List all files in the Homebrew prefix not installed by Homebrew."
description: "List files in Homebrew's prefix not installed by Homebrew."
switch "--versions",
description: "Show the version number for installed formulae, or only the specified "\
"formulae if <formula> are given."
"formulae if <formula> are provided."
switch "--multiple",
depends_on: "--versions",
description: "Only show formulae with multiple versions installed."
switch "--pinned",
description: "Show the versions of pinned formulae, or only the specified (pinned) "\
"formulae if <formula> are given. See also `pin`, `unpin`."
"formulae if <formula> are provided. See also `pin`, `unpin`."
# passed through to ls
switch "-1",
description: "Force output to be one entry per line. " \
"This is the default when output is not to a terminal."
switch "-l",
description: "List in long format. If the output is to a terminal, "\
"a total sum for all the file sizes is output on a line before the long listing."
"a total sum for all the file sizes is printed before the long listing."
switch "-r",
description: "Reverse the order of the sort to get the oldest entries first."
description: "Reverse the order of the sort to list the oldest entries first."
switch "-t",
description: "Sort by time modified (most recently modified first)."
description: "Sort by time modified, listing most recently modified first."
switch :verbose
switch :debug
end

15
Library/Homebrew/cmd/log.rb
View File

@ -9,18 +9,19 @@ module Homebrew
def log_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`log` [<options>] <formula>
`log` [<options>] [<formula>]
Show the `git log` for the given <formula>.
Show the `git log` for <formula>, or show the log for the Homebrew repository
if no formula is provided.
EOS
switch "-p", "-u", "--patch",
description: "Also output patch from commit."
description: "Also print patch from commit."
switch "--stat",
description: "Also output diffstat from commit."
description: "Also print diffstat from commit."
switch "--oneline",
description: "Output only one line per commit."
switch "-1", "--max-count=1",
description: "Output only one commit."
description: "Print only one line per commit."
flag "-1", "--max-count",
description: "Print only one or a specified number of commits."
end
end

6
Library/Homebrew/cmd/migrate.rb
View File

@ -11,12 +11,12 @@ module Homebrew
usage_banner <<~EOS
`migrate` [<options>] <formula>
Migrate renamed packages to new name, where <formula> are old names of
Migrate renamed packages to new names, where <formula> are old names of
packages.
EOS
switch :force,
description: "Treat installed <formula> and passed <formula> like if they are from "\
"same taps and migrate them anyway."
description: "Treat installed <formula> and provided <formula> as if they are from "\
"the same taps and migrate them anyway."
switch :verbose
switch :debug
end

13
Library/Homebrew/cmd/missing.rb
View File

@ -11,16 +11,15 @@ module Homebrew
def missing_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`missing` [<options>] [<formulae>]
`missing` [<options>] [<formula>]
Check the given <formula> for missing dependencies. If no <formula> are
given, check all installed brews.
`missing` exits with a non-zero status if any formulae are missing dependencies.
Check the given <formula> kegs for missing dependencies. If no <formula> are
provided, check all kegs. Will exit with a non-zero status if any kegs are found
to be missing dependencies.
EOS
comma_array "--hide",
description: "Act as if none of the provided <hidden> are installed. <hidden> should be "\
"comma-separated list of formulae."
description: "Act as if none of the specified <hidden> are installed. <hidden> should be "\
"a comma-separated list of formulae."
switch :verbose
switch :debug
end

12
Library/Homebrew/cmd/options.rb
View File

@ -10,18 +10,18 @@ module Homebrew
def options_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`options` [<options>] <formula>
`options` [<options>] [<formula>]
Display install options specific to <formula>
Show install options specific to <formula>.
EOS
switch "--compact",
description: "Show all options on a single line separated by spaces."
switch "--all",
description: "Show options for all formulae."
switch "--installed",
description: "Show options for all installed formulae."
description: "Show options for formulae that are currently installed."
switch "--all",
description: "Show options for all available formulae."
switch :debug
conflicts "--all", "--installed"
conflicts "--installed", "--all"
end
end

20
Library/Homebrew/cmd/outdated.rb
View File

@ -12,22 +12,20 @@ module Homebrew
usage_banner <<~EOS
`outdated` [<options>]
Show formulae that have an updated version available.
By default, version information is displayed in interactive shells, and
suppressed otherwise.
List installed formulae that have an updated version available. By default, version
information is displayed in interactive shells, and suppressed otherwise.
EOS
switch :quiet,
description: "List only the names of outdated brews (takes precedence over `--verbose`)."
description: "List only the names of outdated kegs (takes precedence over `--verbose`)."
switch :verbose,
description: "Display detailed version information."
flag "--json",
description: "Print output in JSON format. Currently the default and only accepted "\
"value for <version> is `v1`. See the docs for examples of using the JSON "\
"output: <https://docs.brew.sh/Querying-Brew>"
description: "Include detailed version information."
flag "--json",
description: "Print output in JSON format. Currently the default and only accepted "\
"value for <version> is `v1`. See the docs for examples of using the JSON "\
"output: <https://docs.brew.sh/Querying-Brew>"
switch "--fetch-HEAD",
description: "Fetch the upstream repository to detect if the HEAD installation of the "\
"formula is outdated. Otherwise, the repository's HEAD will be checked for "\
"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 :debug
conflicts "--quiet", "--verbose", "--json"

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

@ -14,8 +14,8 @@ module Homebrew
Rerun the post-install steps for <formula>.
EOS
switch :verbose
switch :force
switch :verbose
switch :debug
end
end

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

@ -11,7 +11,7 @@ module Homebrew
usage_banner <<~EOS
`readall` [<options>] [<tap>]
Import all formulae from specified <tap> (defaults to all installed taps).
Import all formulae from the specified <tap>, or from all installed taps if none is provided.
This can be useful for debugging issues across all formulae when making
significant changes to `formula.rb`, testing the performance of loading
all formulae or to determine if any current formulae have Ruby issues.

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

@ -15,20 +15,22 @@ module Homebrew
usage_banner <<~EOS
`reinstall` [<options>] <formula>
Uninstall and then install <formula> (with existing and any appended install options).
Uninstall and then install <formula> using the same options it was originally
installed with, plus any appended brew formula options.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the reinstalled formulae or, every 30 days, for all formulae.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the
reinstalled formulae or, every 30 days, for all formulae.
EOS
switch :debug,
description: "If brewing fails, open an interactive debugging session with access to IRB "\
"or a shell inside the temporary build directory"
"or a shell inside the temporary build directory."
switch "-s", "--build-from-source",
description: "Compile <formula> from source even if a bottle is available."
switch "--force-bottle",
description: "Install from a bottle if it exists for the current or newest version of "\
"macOS, even if it would not normally be used for installation."
switch "--keep-tmp",
description: "Don't delete the temporary files created during installation."
description: "Retain the temporary files created during installation."
switch :force,
description: "Install without checking for previously installed keg-only or "\
"non-migrated versions."

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

@ -30,17 +30,17 @@ module Homebrew
`search` [<options>] [<text>|`/`<text>`/`]
Perform a substring search of cask tokens and formula names for <text>. If <text>
is surrounded with slashes, then it is interpreted as a regular expression.
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 <text> is passed, display all locally available formulae (including tapped ones).
If no <text> is provided, list all locally available formulae (including tapped ones).
No online search is performed.
EOS
switch "--casks",
description: "Display all locally available casks (including tapped ones). "\
description: "List all locally available casks (including tapped ones). "\
"No online search is performed."
switch "--desc",
description: "search formulae with a description matching <text> and casks with "\
description: "Search for formulae with a description matching <text> and casks with "\
"a name matching <text>."
package_manager_switches = PACKAGE_MANAGERS.keys.map { |name| "--#{name}" }

6
Library/Homebrew/cmd/sh.rb
View File

@ -16,10 +16,10 @@ module Homebrew
Homebrew build logic to help your `./configure && make && make install`
or even your `gem install` succeed. Especially handy if you run Homebrew
in an Xcode-only configuration since it adds tools like `make` to your `PATH`
which otherwise build systems would not find.
which build systems would not find otherwise.
EOS
flag "--env=",
description: "Use the standard `PATH` instead of superenv's, when <std> is passed"
flag "--env=",
description: "Use the standard `PATH` instead of superenv's when `std` is passed."
switch :verbose
switch :debug
end

7
Library/Homebrew/cmd/shellenv.sh
View File

@ -1,10 +1,9 @@
#: * `shellenv`
#:
#: Prints export statements - run them in a shell and this installation of Homebrew will be included into your `PATH`, `MANPATH` and `INFOPATH`.
#: Print export statements. When run in a shell, this installation of Homebrew will be added to your `PATH`, `MANPATH`, and `INFOPATH`.
#:
#: `HOMEBREW_PREFIX`, `HOMEBREW_CELLAR` and `HOMEBREW_REPOSITORY` are also exported to save multiple queries of those variables.
#:
#: Consider adding evaluating the output in your dotfiles (e.g. `~/.profile`) with `eval $(brew shellenv)`
#: The variables `HOMEBREW_PREFIX`, `HOMEBREW_CELLAR` and `HOMEBREW_REPOSITORY` are also exported to avoid querying them multiple times.
#: Consider adding evaluation of this command's output to your dotfiles (e.g. `~/.profile`) with: `eval $(brew shellenv)`
homebrew-shellenv() {
case "$SHELL" in

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

@ -12,7 +12,7 @@ module Homebrew
usage_banner <<~EOS
`switch` <formula> <version>
Symlink all of the specific <version> of <formula>'s install to Homebrew prefix.
Symlink all of the specified <version> of <formula>'s installation into Homebrew's prefix.
EOS
switch_option :verbose
switch_option :debug

15
Library/Homebrew/cmd/tap-info.rb
View File

@ -10,15 +10,16 @@ module Homebrew
usage_banner <<~EOS
`tap-info` [<options>] [<tap>]
Display detailed information about one or more provided <tap>.
Display a brief summary of all installed taps if no <tap> are passed.
Show detailed information about one or more <tap>s.
If no <tap> names are provided, display brief statistics for all installed taps.
EOS
switch "--installed",
description: "Display information on all installed taps."
flag "--json",
description: "Print a JSON representation of <taps>. Currently the default and only accepted "\
"value for <version> is `v1`. See the docs for examples of using the JSON "\
"output: <https://docs.brew.sh/Querying-Brew>"
description: "Show information on each installed tap."
flag "--json",
description: "Print a JSON representation of <tap>. Currently the default and only accepted "\
"value for <version> is `v1`. See the docs for examples of using the JSON "\
"output: <https://docs.brew.sh/Querying-Brew>"
switch :debug
end
end

12
Library/Homebrew/cmd/tap.rb
View File

@ -12,22 +12,22 @@ module Homebrew
Tap a formula repository.
List all installed taps when no arguments are passed.
If no arguments are provided, list all installed taps.
With <URL> unspecified, taps a formula repository from GitHub using HTTPS.
With <URL> unspecified, tap a formula repository from GitHub using HTTPS.
Since so many taps are hosted on GitHub, this command is a shortcut for
`brew tap` <user>`/`<repo> `https://github.com/`<user>`/homebrew-`<repo>.
With <URL> specified, taps a formula repository from anywhere, using
any transport protocol that `git` handles. The one-argument form of `tap`
With <URL> specified, tap a formula repository from anywhere, using
any transport protocol that `git`(1) handles. The one-argument form of `tap`
simplifies but also limits. This two-argument command makes no
assumptions, so taps can be cloned from places other than GitHub and
using protocols other than HTTPS, e.g., SSH, GIT, HTTP, FTP(S), RSYNC.
using protocols other than HTTPS, e.g. SSH, GIT, HTTP, FTP(S), RSYNC.
EOS
switch "--full",
description: "Use a full clone when tapping a repository. By default, the repository is "\
"cloned as a shallow copy (`--depth=1`). To convert a shallow copy to a "\
"full copy, you can retap passing `--full` without first untapping."
"full copy, you can retap by passing `--full` without first untapping."
switch "--force-auto-update",
description: "Auto-update tap even if it is not hosted on GitHub. By default, only taps "\
"hosted on GitHub are auto-updated (for performance reasons)."

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

@ -17,7 +17,7 @@ module Homebrew
Uninstall <formula>.
EOS
switch :force,
description: "Delete all installed versions of the <formula>"
description: "Delete all installed versions of <formula>."
switch "--ignore-dependencies",
description: "Don't fail uninstall, even if <formula> is a dependency of any installed "\
"formulae."

6
Library/Homebrew/cmd/unlink.rb
View File

@ -11,13 +11,13 @@ module Homebrew
usage_banner <<~EOS
`unlink` [<options>] <formula>
Remove symlinks for <formula> from the Homebrew prefix. This can be useful
Remove symlinks for <formula> from Homebrew's prefix. This can be useful
for temporarily disabling a formula:
`brew unlink` <formula> `&&` <commands> `&& brew link` <formula>
EOS
switch "-n", "--dry-run",
description: "List all files which would be unlinked, but will not actually unlink or "\
"delete any files."
description: "List files which would be unlinked without actually unlinking or "\
"deleting any files."
switch :verbose
switch :debug
end

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

@ -15,8 +15,8 @@ module Homebrew
Unpack the source files for <formula> into subdirectories of the current
working directory.
EOS
flag "--destdir=",
description: "Create subdirectories in the directory named by <path> instead."
flag "--destdir=",
description: "Create subdirectories in the directory named by <path> instead."
switch "--patch",
description: "Patches for <formula> will be applied to the unpacked source."
switch "-g", "--git",

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

@ -10,7 +10,7 @@ module Homebrew
usage_banner <<~EOS
`untap` <tap>
Remove a tapped repository.
Remove a tapped formula repository.
EOS
switch :debug
end

4
Library/Homebrew/cmd/update-report.rb
View File

@ -21,7 +21,7 @@ module Homebrew
def update_report_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`update_report` [`--preinstall`]
`update-report`
The Ruby implementation of `brew update`. Never called manually.
EOS
@ -29,8 +29,8 @@ module Homebrew
description: "Run in 'auto-update' mode (faster, less output)."
switch :force
switch :quiet
switch :debug
switch :verbose
switch :debug
hide_from_man_page!
end
end

4
Library/Homebrew/cmd/update-reset.sh
View File

@ -1,6 +1,8 @@
#: * `update-reset` [<repository>]
#:
#: Fetches and resets Homebrew and all tap repositories (or any specified `repository`) using `git`(1) to their latest `origin/master`. Note this will destroy all your uncommitted or committed changes.
#: Fetch and reset Homebrew and all tap repositories (or any specified <repository>) using `git`(1) to their latest `origin/master`.
#:
#: *Note:* this will destroy all your uncommitted or committed changes.
homebrew-update-reset() {
local DIR

4
Library/Homebrew/cmd/update.sh
View File

@ -1,8 +1,8 @@
#: * `update` [<options>]
#: * `update`, `up` [<options>]
#:
#: Fetch the newest version of Homebrew and all formulae from GitHub using `git`(1) and perform any necessary migrations.
#:
#: --merge `git merge` is used to include updates (rather than `git rebase`).
#: --merge Use `git merge` to apply updates (rather than `git rebase`).
#: -f, --force Always do a slower, full update check (even if unnecessary).
#: -v, --verbose Print the directories checked and `git` operations performed.
#: -d, --debug Display a trace of all shell commands as they are executed.

20
Library/Homebrew/cmd/upgrade.rb
View File

@ -14,18 +14,18 @@ module Homebrew
def upgrade_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`upgrade` [<options>] <formula>
`upgrade` [<options>] [<formula>]
Upgrade outdated, unpinned formulae (with existing and any appended brew formula options).
Upgrade outdated, unpinned formulae using the same options they were originally
installed with, plus any appended brew formula options. If <formula> are specified,
upgrade only the given <formula> kegs (unless they are pinned; see `pin`, `unpin`).
If <formula> are given, upgrade only the specified brews (unless they
are pinned; see `pin`, `unpin`).
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the upgraded formulae or, every 30 days, for all formulae.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the
upgraded formulae or, every 30 days, for all formulae.
EOS
switch :debug,
description: "If brewing fails, open an interactive debugging session with access to IRB "\
"or a shell inside the temporary build directory"
"or a shell inside the temporary build directory."
switch "-s", "--build-from-source",
description: "Compile <formula> from source even if a bottle is available."
switch "--force-bottle",
@ -33,12 +33,12 @@ module Homebrew
"macOS, even if it would not normally be used for installation."
switch "--fetch-HEAD",
description: "Fetch the upstream repository to detect if the HEAD installation of the "\
"formula is outdated. Otherwise, the repository's HEAD will be checked for "\
"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 0 exit code even if pinned formulae are not upgraded."
description: "Set a successful exit status even if pinned formulae are not upgraded."
switch "--keep-tmp",
description: "Don't delete the temporary files created during installation."
description: "Retain the temporary files created during installation."
switch :force,
description: "Install without checking for previously installed keg-only or "\
"non-migrated versions."

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

@ -15,19 +15,15 @@ module Homebrew
usage_banner <<~EOS
`uses` [<options>] <formula>
Show the formulae that specify <formula> as a dependency. When given
multiple formula arguments, show the intersection of formulae that use
<formula>.
Show formulae that specify <formula> as a dependency. When given multiple
formula arguments, show the intersection of formulae that use <formula>.
By default, `uses` shows all formulae that specify <formula> as a required
or recommended dependency.
By default, `uses` shows usage of <formula> by stable builds.
or recommended dependency for their stable builds.
EOS
switch "--recursive",
description: "Resolve more than one level of dependencies."
switch "--installed",
description: "Only list installed formulae."
description: "Only list formulae that are currently installed."
switch "--include-build",
description: "Include all formulae that specify <formula> as `:build` type dependency."
switch "--include-test",
@ -37,9 +33,9 @@ module Homebrew
switch "--skip-recommended",
description: "Skip all formulae that specify <formula> as `:recommended` type dependency."
switch "--devel",
description: "Show usage of <formula> by development build."
description: "Show usage of <formula> by development builds."
switch "--HEAD",
description: "Show usage of <formula> by HEAD build."
description: "Show usage of <formula> by HEAD builds."
switch :debug
conflicts "--devel", "--HEAD"
end

8
Library/Homebrew/dev-cmd/audit.rb
View File

@ -18,12 +18,12 @@ module Homebrew
def audit_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`audit` [<options>] <formula>
`audit` [<options>] [<formula>]
Check <formula> for Homebrew coding style violations. This should be run before
submitting a new formula. Will exit with a non-zero status if any errors are
submitting a new formula. If no <formula> are provided, check all locally
available formulae. Will exit with a non-zero status if any errors are
found, which can be useful for implementing pre-commit hooks.
If no <formula> are provided, all of them are checked.
EOS
switch "--strict",
description: "Run additional style checks, including RuboCop style checks."
@ -38,7 +38,7 @@ module Homebrew
switch "--display-cop-names",
description: "Include the RuboCop cop name for each violation in the output."
switch "--display-filename",
description: "Prefix every line of output with name of the file or formula being audited, to "\
description: "Prefix every line of output with the file or formula name being audited, to "\
"make output easy to grep."
switch "-D", "--audit-debug",
description: "Enable debugging and profiling of audit methods."

6
Library/Homebrew/dev-cmd/bottle.rb
View File

@ -64,15 +64,15 @@ module Homebrew
description: "If the formula specifies a rebuild version, attempt to preserve its value in the "\
"generated DSL."
switch "--json",
description: "Write bottle information to a JSON file, which can be used as the argument for "\
description: "Write bottle information to a JSON file, which can be used as the value for "\
"`--merge`."
switch "--merge",
description: "Generate an updated bottle block for a formula and optionally merge it into the "\
"formula file. Instead of a formula name, requires a JSON file generated with "\
"formula file. Instead of a formula name, requires the path to a JSON file generated with "\
"`brew bottle --json` <formula>."
switch "--write",
depends_on: "--merge",
description: "Write the changes to the formula file. A new commit will be generated unless "\
description: "Write changes to the formula file. A new commit will be generated unless "\
"`--no-commit` is passed."
switch "--no-commit",
depends_on: "--write",

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

@ -11,7 +11,7 @@ module Homebrew
usage_banner <<~EOS
`bump-formula-pr` [<options>] [<formula>]
Create a pull request to update a formula with a new URL or a new tag.
Create a pull request to update <formula> with a new URL or a new tag.
If a <URL> is specified, the <SHA-256> checksum of the new download should also
be specified. A best effort to determine the <SHA-256> and <formula> name will
@ -22,8 +22,7 @@ module Homebrew
*Note:* this command cannot be used to transition a formula from a
URL-and-SHA-256 style specification into a tag-and-revision style specification,
nor vice versa. It must use whichever style specification the preexisting
formula already uses.
nor vice versa. It must use whichever style specification the formula already uses.
EOS
switch "--devel",
description: "Bump the development rather than stable version. The development spec must already exist."
@ -40,13 +39,13 @@ module Homebrew
switch "--no-browse",
description: "Print the pull request URL instead of opening in a browser."
flag "--mirror=",
description: "Use the provided <URL> as a mirror URL."
description: "Use the specified <URL> as a mirror URL."
flag "--version=",
description: "Use the provided <version> to override the value parsed from the URL or tag. Note "\
description: "Use the specified <version> to override the value parsed from the URL or tag. Note "\
"that `--version=0` can be used to delete an existing version override from a "\
"formula if it has become redundant."
flag "--message=",
description: "Append the provided <message> to the default PR message."
description: "Append <message> to the default pull request message."
flag "--url=",
description: "Specify the <URL> for the new download. If a <URL> is specified, the <SHA-256> "\
"checksum of the new download should also be specified."
@ -57,8 +56,7 @@ module Homebrew
description: "Specify the new git commit <tag> for the formula."
flag "--revision=",
required_for: "--tag=",
description: "Specify the new git commit <revision> corresponding to a specified <tag>."
description: "Specify the new git commit <revision> corresponding to the specified <tag>."
switch :force
switch :quiet
switch :verbose

11
Library/Homebrew/dev-cmd/bump-revision.rb
View File

@ -9,16 +9,15 @@ module Homebrew
def bump_revision_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bump-revision` [<options>] [<formula>]
`bump-revision` [<options>] <formula>
Create a commit to increment the revision of the formula. If no revision is
present, "revision 1" will be added.
Create a commit to increment the revision of <formula>. If no revision is
present, "revision 1" will be added.
EOS
switch "-n", "--dry-run",
description: "Print what would be done rather than doing it."
flag "--message=",
description: "Append the provided <message> to the default commit message."
flag "--message=",
description: "Append <message> to the default commit message."
switch :force
switch :quiet
switch :verbose

8
Library/Homebrew/dev-cmd/create.rb
View File

@ -26,17 +26,17 @@ module Homebrew
switch "--meson",
description: "Create a basic template for a Meson-style build."
switch "--no-fetch",
description: "Homebrew will not download <URL> to the cache and will thus not add the SHA-256 "\
description: "Homebrew will not download <URL> to the cache and will thus not add its SHA-256 "\
"to the formula for you, nor will it check the GitHub API for GitHub projects "\
"(to fill out its description and homepage)."
switch "--HEAD",
description: "Indicate that <URL> points to the package's repository rather than a file."
flag "--set-name=",
description: "Set the name of the new formula to the provided <name>."
description: "Explicitly set the <name> of the new formula."
flag "--set-version=",
description: "Set the version of the new formula to the provided <version>."
description: "Explicitly set the <version> of the new formula."
flag "--tap=",
description: "Generate the new formula in the provided tap, specified as <user>`/`<repo>."
description: "Generate the new formula within the given tap, specified as <user>`/`<repo>."
switch :force
switch :verbose
switch :debug

4
Library/Homebrew/dev-cmd/edit.rb
View File

@ -11,8 +11,8 @@ module Homebrew
usage_banner <<~EOS
`edit` [<formula>]
Open a formula in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the
Homebrew repository for editing if no <formula> is provided.
Open <formula> in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the
Homebrew repository for editing if no formula is provided.
EOS
switch :force
switch :verbose

8
Library/Homebrew/dev-cmd/extract.rb
View File

@ -84,11 +84,11 @@ module Homebrew
Look through repository history to find the most recent version of <formula> and
create a copy in <tap>`/Formula/`<formula>`@`<version>`.rb`. If the tap is not
installed yet, attempt to install/clone the tap before continuing. To extract
a <formula> from a tap that is not homebrew/core use <user>/<repo>/<formula>.
a formula from a tap that is not `homebrew/core` use its fully-qualified form of
<user>`/`<repo>`/`<formula>.
EOS
flag "--version=",
description: "Extract the provided <version> of <formula> instead of the most recent."
flag "--version=",
description: "Extract the specified <version> of <formula> instead of the most recent."
switch :force
switch :debug
end

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

@ -11,7 +11,7 @@ module Homebrew
usage_banner <<~EOS
`formula` <formula>
Display the path where a formula is located.
Display the path where <formula> is located.
EOS
switch :verbose
switch :debug

6
Library/Homebrew/dev-cmd/linkage.rb
View File

@ -12,11 +12,11 @@ module Homebrew
usage_banner <<~EOS
`linkage` [<options>] [<formula>]
Check the library links for kegs of installed formulae.
Raises an error if run on uninstalled formulae.
Check the library links from the given <formula> kegs. If no <formula> are
provided, check all kegs. Raises an error if run on uninstalled formulae.
EOS
switch "--test",
description: "Display only missing libraries and exit with a non-zero status if any missing "\
description: "Show only missing libraries and exit with a non-zero status if any missing "\
"libraries are found."
switch "--reverse",
description: "For every library that a keg references, print its dylib path followed by the "\

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

@ -25,7 +25,7 @@ module Homebrew
EOS
switch "--fail-if-changed",
description: "Return a failing status code if changes are detected in the manpage outputs. This "\
"can be used for CI to be notified when the manpages are out of date. Additionally, "\
"can be used to notify CI when the manpages are out of date. Additionally, "\
"the date used in new manpages will match those in the existing manpages (to allow "\
"comparison without factoring in the date)."
switch "--link",

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

@ -10,7 +10,7 @@ module Homebrew
usage_banner <<~EOS
`prof` <command>
Run Homebrew with the Ruby profiler e.g. `brew prof readall`.
Run Homebrew with the Ruby profiler, e.g. `brew prof readall`.
EOS
end
end

10
Library/Homebrew/dev-cmd/pull.rb
View File

@ -32,10 +32,10 @@ module Homebrew
`pull` [<options>] <patch>
Get a patch from a GitHub commit or pull request and apply it to Homebrew.
Optionally, publish updated bottles for the formulae changed by the patch.
Optionally, publish updated bottles for any formulae changed by the patch.
Each <patch> may be the number of a PR in `homebrew/core`, the URL of a PR
on GitHub, the URL of a commit on GitHub or a "https://jenkins.brew.sh/job/..." testing job URL.
Each <patch> may be the number of a pull request in `homebrew/core`, the URL of any pull request
or commit on GitHub or a "https://jenkins.brew.sh/job/..." testing job URL.
EOS
switch "--bottle",
description: "Handle bottles, pulling the bottle-update commit and publishing files on Bintray."
@ -57,9 +57,9 @@ module Homebrew
switch "--warn-on-publish-failure",
description: "Do not exit if there's a failure publishing bottles on Bintray."
flag "--bintray-org=",
description: "Publish bottles at the provided Bintray <organisation>."
description: "Publish bottles to the specified Bintray <organisation>."
flag "--test-bot-user=",
description: "Pull the bottle block commit from the provided <user> on GitHub."
description: "Pull the bottle block commit from the specified <user> on GitHub."
switch :verbose
switch :debug
end

8
Library/Homebrew/dev-cmd/ruby.rb
View File

@ -8,13 +8,13 @@ module Homebrew
def ruby_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`ruby` [`-e`]:
`ruby` (`-e` <text>|<file>)
Run a Ruby instance with Homebrew's libraries loaded e.g.
`brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`
Run a Ruby instance with Homebrew's libraries loaded, e.g.
`brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`.
EOS
switch "-e",
description: "Execute the provided string argument as a script."
description: "Execute the given text string as a script."
switch :verbose
switch :debug
end

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

@ -24,7 +24,7 @@ module Homebrew
switch "--HEAD",
description: "Test the head version of a formula."
switch "--keep-tmp",
description: "Keep the temporary files created for the test."
description: "Retain the temporary files created for the test."
switch :verbose
switch :debug
conflicts "--devel", "--HEAD"

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

@ -26,7 +26,7 @@ module Homebrew
description: "Run only <test_script>`_spec.rb`. Appending `:`<line_number> will start at a "\
"specific line."
flag "--seed=",
description: "Randomise tests with the provided <value> instead of a random seed."
description: "Randomise tests with the specified <value> instead of a random seed."
switch :verbose
switch :debug
end

6
Library/Homebrew/dev-cmd/update-test.rb
View File

@ -11,16 +11,16 @@ module Homebrew
`update-test` [<options>]
Run a test of `brew update` with a new repository clone.
If no arguments are passed, use `origin/master` as the start commit.
If no options are passed, use `origin/master` as the start commit.
EOS
switch "--to-tag",
description: "Set `HOMEBREW_UPDATE_TO_TAG` to test updating between tags."
switch "--keep-tmp",
description: "Retain the temporary directory containing the new repository clone."
flag "--commit=",
description: "Use provided <commit> as the start commit."
description: "Use the specified <commit> as the start commit."
flag "--before=",
description: "Use the commit at provided <date> as the start commit."
description: "Use the commit at the specified <date> as the start commit."
switch :verbose
switch :debug
end

2
Library/Homebrew/diagnostic.rb
View File

@ -105,7 +105,7 @@ module Homebrew
You will encounter build failures with some formulae.
Please create pull requests instead of asking for help on Homebrew's GitHub,
Discourse, Twitter or IRC. You are responsible for resolving any issues you
experience, as you are running this #{what}.
experience while you are running this #{what}.
EOS
end

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

@ -26,13 +26,16 @@ didn't include with macOS.
For the full command list, see the [COMMANDS](#commands) section.
With `--verbose` or `-v`, many commands print extra debugging information. Note that
these flags 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>.
<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>.
@ -42,10 +45,11 @@ Uninstall <formula>.
List all installed formulae.
### `search` (<text>|`/`<text>`/`):
Perform a substring search of cask tokens and formula names for <text>. If <text>
is surrounded with slashes, then it is interpreted as a regular expression.
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 given, all locally available formulae are listed.
If no search term is provided, all locally available formulae are listed.
## COMMANDS
@ -63,19 +67,21 @@ If no search term is given, all locally available formulae are listed.
### `bundle` <subcommand>:
Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask and the Mac App Store. See `brew bundle --help`.
Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask and the Mac App Store.
See `brew bundle --help`.
**Homebrew/homebrew-bundle**: <https://github.com/Homebrew/homebrew-bundle>
### `cask` <subcommand>:
Install macOS applications distributed as binaries. See brew-cask(1).
Install macOS applications distributed as binaries. See `brew-cask`(1).
**Homebrew/homebrew-cask**: <https://github.com/Homebrew/homebrew-cask>
### `services` <subcommand>:
Manage background services with macOS' `launchctl`(1) daemon manager. See `brew services --help`.
Manage background services with macOS' `launchctl`(1) daemon manager.
See `brew services --help`.
**Homebrew/homebrew-services**: <https://github.com/Homebrew/homebrew-services>
@ -106,17 +112,18 @@ can take several different forms:
* An arbitrary file or URL:
Homebrew can install formulae via URL, e.g.
`https://raw.githubusercontent.com/Homebrew/homebrew-core/master/Formula/git.rb`,
or from a local path. It could point to either a formula file or a bottle.
or from a local path. It can point to either a formula file or a bottle.
In the case of a URL, the downloaded file will be cached for later use.
## ENVIRONMENT
Note that environment variables must have a value set to be detected. For example,
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: If set, Homebrew will pass the set value to type name to the compiler's `-march` option instead of using the default (`-march=native`).
Linux only: If set, Homebrew will pass the set value to type name to the compiler's
`-march` option instead of using the default (`-march=native`).
* `HOMEBREW_ARTIFACT_DOMAIN`:
If set, instructs Homebrew to prefix all download URLs, including those for bottles,
@ -152,8 +159,8 @@ Note that environment variables must have a value set to be detected. For exampl
*Default:* `~/Library/Caches/Homebrew`.
* `HOMEBREW_CURLRC`:
If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables
the use of `curlrc`).
If set, Homebrew will not pass `-q` when invoking `curl`(1), which disables
the use of `curlrc`.
* `HOMEBREW_CURL_VERBOSE`:
If set, Homebrew will pass `--verbose` when invoking `curl`(1).
@ -194,7 +201,7 @@ Note that environment variables must have a value set to be detected. For exampl
even if the system version of Ruby is new enough.
* `HOMEBREW_FORCE_BREWED_GIT`:
If set, Homebrew will always use a Homebrew-installed `git` rather than the
If set, Homebrew will always use a Homebrew-installed `git`(1) rather than the
system version. Automatically set if the system version of `git` is too old.
* `HOMEBREW_GITHUB_API_TOKEN`:
@ -319,6 +326,8 @@ And for an authenticated HTTP proxy:
Homebrew Documentation: <https://docs.brew.sh>
Homebrew API: <https://rubydoc.brew.sh>
`brew-cask`(1), `git`(1), `git-log`(1)
## AUTHORS

437
docs/Manpage.md
View File

@ -15,13 +15,16 @@ didn't include with macOS.
For the full command list, see the [COMMANDS](#commands) section.
With `--verbose` or `-v`, many commands print extra debugging information. Note that
these flags 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`*.
*`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`*.
@ -31,21 +34,23 @@ Uninstall *`formula`*.
List all installed formulae.
### `search` (*`text`*|`/`*`text`*`/`):
Perform a substring search of cask tokens and formula names for *`text`*. If *`text`*
is surrounded with slashes, then it is interpreted as a regular expression.
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 given, all locally available formulae are listed.
If no search term is provided, all locally available formulae are listed.
## COMMANDS
### `analytics` [`on`|`off`|`state`|`regenerate-uuid`]
### `analytics` [*`subcommand`*]
If `on` or `off` is passed, turn Homebrew's analytics on or off respectively.
If `state` is passed, display anonymous user behaviour analytics state. Read
more at <https://docs.brew.sh/Analytics>.
If `state` is passed, display the current anonymous user behaviour analytics
state. Read more at <https://docs.brew.sh/Analytics>.
If `regenerate-uuid` is passed, regenerate UUID used in Homebrew's analytics.
If `regenerate-uuid` is passed, regenerate the UUID used in Homebrew's
analytics.
### `cat` *`formula`*
@ -53,9 +58,9 @@ Display the source of *`formula`*.
### `cleanup` [*`options`*] [*`formula`*|*`cask`*]
Remove stale lock files and outdated downloads for formulae and casks, and
Remove stale lock files and outdated downloads for all formulae and casks, and
remove old versions of installed formulae. If arguments are specified, only do
this for the specified formulae and casks.
this for the given formulae and casks.
* `--prune`:
Remove all cache files older than specified *`days`*.
@ -68,28 +73,28 @@ this for the specified formulae and casks.
### `command` *`cmd`*
Display the path to the file which is used when invoking `brew` *`cmd`*.
Display the path to the file being used when invoking `brew` *`cmd`*.
### `commands` [*`options`*]
Show a list of built-in and external commands.
Show lists of built-in and external commands.
* `--include-aliases`:
Include the aliases of internal commands.
Include aliases of internal commands.
### `config`
Show Homebrew and system configuration useful for debugging. If you file a bug
report, you will likely be asked for this information if you do not provide it.
Show Homebrew and system configuration info useful for debugging. If you file a
bug report, you will be required to provide this information.
### `deps` [*`options`*] *`formula`*
### `deps` [*`options`*] [*`formula`*]
Show dependencies for *`formula`*. Additional options specific to *`formula`* may be
appended to the command. When given multiple formula arguments, show the
intersection of dependencies for each formula.
* `-n`:
Show dependencies in topological order.
Sort dependencies in topological order.
* `--1`:
Only show dependencies one level down, instead of recursing.
* `--union`:
@ -115,7 +120,7 @@ intersection of dependencies for each formula.
* `--all`:
List dependencies for all available formulae.
* `--for-each`:
Switch into the mode used by the `--all` option, but only list dependencies for the specified *`formula`*, one formula per line. This is used for debugging the `--installed`/`--all` display mode.
Switch into the mode used by the `--all` option, but only list dependencies for each provided *`formula`*, one formula per line. This is used for debugging the `--installed`/`--all` display mode.
### `desc` [*`options`*] (*`text`*|`/`*`text`*`/`|*`formula`*)
@ -124,11 +129,11 @@ cached; the cache is created on the first search, making that search slower than
subsequent ones.
* `-s`, `--search`:
Search both name and description for provided *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression.
Search both names and descriptions for *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression.
* `-n`, `--name`:
Search just the names for provided *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression.
Search just names for *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression.
* `-d`, `--description`:
Search just the descriptions for provided *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression.
Search just descriptions for *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression.
### `diy` [*`options`*]
@ -137,13 +142,13 @@ the output from this command, you can install your own software into the Cellar
and then link it into Homebrew's prefix with `brew link`.
* `--name`:
Explicitly set the provided *`name`* of the package being installed.
Explicitly set the *`name`* of the package being installed.
* `--version`:
Explicitly set the provided *`version`* of the package being installed.
Explicitly set the *`version`* of the package being installed.
### `doctor` [*`options`*]
Check your system for potential problems. Doctor exits with a non-zero status if
Check your system for potential problems. Will exit with a non-zero status if
any potential problems are found. Please note that these warnings are just used
to help the Homebrew maintainers with debugging if you file an issue. If
everything you use Homebrew for is working fine: please don't worry or file an
@ -156,59 +161,55 @@ issue; just ignore this.
### `fetch` [*`options`*] *`formula`*
Download the source packages for the given *`formula`*. For tarballs, also print
SHA-256 checksums.
Download a bottle (if available) or source packages for *`formula`*. For tarballs,
also print SHA-256 checksums.
* `--HEAD`:
Fetch HEAD version instead of stable version.
* `--devel`:
Fetch development version instead of stable version.
* `--retry`:
Retry if a download fails or re-download if the checksum of a previously cached version no longer matches.
Retry if downloading fails or re-download if the checksum of a previously cached version no longer matches.
* `--deps`:
Download dependencies for any listed *`formula`*.
Also download dependencies for any listed *`formula`*.
* `-s`, `--build-from-source`:
Download the source for rather than a bottle.
Download source packages rather than a bottle.
* `--build-bottle`:
Download the source (for eventual bottling) rather than a bottle.
Download source packages (for eventual bottling) rather than a bottle.
* `--force-bottle`:
Download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation.
### `gist-logs` [*`options`*] *`formula`*
Upload logs for a failed build of *`formula`* to a new Gist.
*`formula`* is usually the name of the formula to install, but it can be specified
in several different ways.
If no logs are found, an error message is presented.
Upload logs for a failed build of *`formula`* to a new Gist. Presents an error
message if no logs are found.
* `--with-hostname`:
Include the hostname in the Gist.
* `-n`, `--new-issue`:
Automatically create a new issue in the appropriate GitHub repository as well as creating the Gist.
Automatically create a new issue in the appropriate GitHub repository after creating the Gist.
* `-p`, `--private`:
The Gist will be marked private and will not appear in listings but will be accessible with the link.
The Gist will be marked private and will not appear in listings but will be accessible with its link.
### `home` [*`formula`*]
Open *`formula`*'s homepage in a browser. If no formula is provided, open
Homebrew's own homepage in a browser.
Open *`formula`*'s homepage in a browser, or open Homebrew's own homepage if no
formula is provided.
### `info` [*`options`*] [*`formula`*]
Display brief statistics for your Homebrew installation.
If *`formula`* is specified, show summary of information about *`formula`*.
If *`formula`* is provided, show summary of information about *`formula`*.
* `--analytics`:
Display global Homebrew analytics data or, if specified, installation and build error data for *`formula`* (provided neither `HOMEBREW_NO_ANALYTICS` nor `HOMEBREW_NO_GITHUB_API` are set).
List global Homebrew analytics data or, if specified, installation and build error data for *`formula`* (provided neither `HOMEBREW_NO_ANALYTICS` nor `HOMEBREW_NO_GITHUB_API` are set).
* `--days`:
How many days of global analytics data to retrieve. The value for *`days`* must be `30`, `90` or `365`. The default is `30`.
* `--category`:
Which type of global analytics data to retrieve. The value for *`category`* must be `install`, `install-on-request`, `cask-install`, `build-error` or `os-version`. The default is `install`.
* `--github`:
Open a browser to the GitHub source page for *`formula`*. To view formula history locally: `brew log -p` *`formula`*
Open the GitHub source page for *`formula`* in a browser. To view formula history locally: `brew log -p` *`formula`*
* `--json`:
Print a JSON representation of *`formula`*. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew>
* `--installed`:
@ -218,40 +219,38 @@ If *`formula`* is specified, show summary of information about *`formula`*.
### `install` [*`options`*] *`formula`*
Install *`formula`*.
Install *`formula`*. Additional options specific to *`formula`* may be appended to
the command.
*`formula`* is usually the name of the formula to install, but it can be specified
in several different ways.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the
installed formulae or, every 30 days, for all formulae.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for
the installed formulae or, every 30 days, for all formulae.
* `--env`:
If `std` is passed, use the standard build environment instead of superenv.If `super` is passed, use superenv even if the formula specifies the standard build environment.
If `std` is passed, use the standard build environment instead of superenv. If `super` is passed, use superenv even if the formula specifies the standard build environment.
* `--ignore-dependencies`:
An unsupported Homebrew development flag to skip installing any dependencies of any kind. If the dependencies are not already present, the formula will have issues. If you're not developing Homebrew, consider adjusting your PATH rather than using this flag.
* `--only-dependencies`:
Install the dependencies with specified options but do not install the specified formula.
Install the dependencies with specified options but do not install the formula itself.
* `--cc`:
Attempt to compile using provided *`compiler`*. *`compiler`* should be the name of the compiler's executable, for instance `gcc-7` for GCC 7. In order to use LLVM's clang, use `llvm_clang`. To specify the Apple-provided clang, use `clang`. This parameter will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this flag.
Attempt to compile using the specified *`compiler`*, which should be the name of the compiler's executable, e.g. `gcc-7` for GCC 7. In order to use LLVM's clang, specify `llvm_clang`. To use the Apple-provided clang, specify `clang`. This option will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this option.
* `-s`, `--build-from-source`:
Compile the specified *`formula`* from source even if a bottle is provided. Dependencies will still be installed from bottles if they are available.
Compile *`formula`* from source even if a bottle is provided. Dependencies will still be installed from bottles if they are available.
* `--force-bottle`:
Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation.
* `--include-test`:
Install testing dependencies required to run `brew test`.
Install testing dependencies required to run `brew test` *`formula`*.
* `--devel`:
If *`formula`* defines it, install the development version.
* `--HEAD`:
If *`formula`* defines it, install the HEAD version, aka. master, trunk, unstable.
* `--fetch-HEAD`:
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository's HEAD will be checked for updates when a new stable or development version has been released.
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.
* `--keep-tmp`:
Don't delete the temporary files created during installation.
Retain the temporary files created during installation.
* `--build-bottle`:
Prepare the formula for eventual bottling during installation.
Prepare the formula for eventual bottling during installation, skipping any post-install steps.
* `--bottle-arch`:
Optimise bottles for the given architecture rather than the oldest architecture supported by the version of macOS the bottles are built on.
Optimise bottles for the specified architecture rather than the oldest architecture supported by the version of macOS the bottles are built on.
* `--display-times`:
Print install times for each formula at the end of the run.
* `-i`, `--interactive`:
@ -261,91 +260,92 @@ installed formulae or, every 30 days, for all formulae.
### `leaves`
Show installed formulae that are not dependencies of another installed formula.
List installed formulae that are not dependencies of another installed formula.
### `ln`, `link` [*`options`*] *`formula`*
### `link`, `ln` [*`options`*] *`formula`*
Symlink all of *`formula`*'s installed files into the Homebrew prefix. This is
done automatically when you install formulae but can be useful for DIY
installations.
Symlink all of *`formula`*'s installed files into Homebrew's prefix. This is done
automatically when you install formulae but can be useful for DIY installations.
* `--overwrite`:
Delete files already existing in the prefix while linking.
Delete files that already exist in the prefix while linking.
* `-n`, `--dry-run`:
List all files which would be linked or deleted by `brew link --overwrite`, but will not actually link or delete any files.
List files which would be linked or deleted by `brew link --overwrite` without actually linking or deleting any files.
### `list`, `ls` [*`options`*]
### `list`, `ls` [*`options`*] [*`formula`*]
List all installed formulae.
If *`formula`* is provided, summarize the paths within its current keg.
* `--full-name`:
Print formulae with fully-qualified names. If `--full-name` is not passed, other options (i.e. `-1`, `-l`, `-t` and `-r`) are passed to `ls` which produces the actual output.
Print formulae with fully-qualified names. If `--full-name` is not passed, other options (i.e. `-1`, `-l`, `-r` and `-t`) are passed to `ls`(1) which produces the actual output.
* `--unbrewed`:
List all files in the Homebrew prefix not installed by Homebrew.
List files in Homebrew's prefix not installed by Homebrew.
* `--versions`:
Show the version number for installed formulae, or only the specified formulae if *`formula`* are given.
Show the version number for installed formulae, or only the specified formulae if *`formula`* are provided.
* `--multiple`:
Only show formulae with multiple versions installed.
* `--pinned`:
Show the versions of pinned formulae, or only the specified (pinned) formulae if *`formula`* are given. See also `pin`, `unpin`.
Show the versions of pinned formulae, or only the specified (pinned) formulae if *`formula`* are provided. See also `pin`, `unpin`.
* `-1`:
Force output to be one entry per line. This is the default when output is not to a terminal.
* `-l`:
List in long format. If the output is to a terminal, a total sum for all the file sizes is output on a line before the long listing.
List in long format. If the output is to a terminal, a total sum for all the file sizes is printed before the long listing.
* `-r`:
Reverse the order of the sort to get the oldest entries first.
Reverse the order of the sort to list the oldest entries first.
* `-t`:
Sort by time modified (most recently modified first).
Sort by time modified, listing most recently modified first.
### `log` [*`options`*] *`formula`*
### `log` [*`options`*] [*`formula`*]
Show the `git log` for the given *`formula`*.
Show the `git log` for *`formula`*, or show the log for the Homebrew repository if
no formula is provided.
* `-p`, `--patch`:
Also output patch from commit.
Also print patch from commit.
* `--stat`:
Also output diffstat from commit.
Also print diffstat from commit.
* `--oneline`:
Output only one line per commit.
Print only one line per commit.
* `-1`, `--max-count`:
Output only one commit.
Print only one or a specified number of commits.
### `migrate` [*`options`*] *`formula`*
Migrate renamed packages to new name, where *`formula`* are old names of packages.
Migrate renamed packages to new names, where *`formula`* are old names of
packages.
### `missing` [*`options`*] [*`formulae`*]
### `missing` [*`options`*] [*`formula`*]
Check the given *`formula`* for missing dependencies. If no *`formula`* are given,
check all installed brews.
`missing` exits with a non-zero status if any formulae are missing dependencies.
Check the given *`formula`* kegs for missing dependencies. If no *`formula`* are
provided, check all kegs. Will exit with a non-zero status if any kegs are found
to be missing dependencies.
* `--hide`:
Act as if none of the provided *`hidden`* are installed. *`hidden`* should be comma-separated list of formulae.
Act as if none of the specified *`hidden`* are installed. *`hidden`* should be a comma-separated list of formulae.
### `options` [*`options`*] *`formula`*
### `options` [*`options`*] [*`formula`*]
Display install options specific to *`formula`*
Show install options specific to *`formula`*.
* `--compact`:
Show all options on a single line separated by spaces.
* `--all`:
Show options for all formulae.
* `--installed`:
Show options for all installed formulae.
Show options for formulae that are currently installed.
* `--all`:
Show options for all available formulae.
### `outdated` [*`options`*]
Show formulae that have an updated version available.
By default, version information is displayed in interactive shells, and
suppressed otherwise.
List installed formulae that have an updated version available. By default,
version information is displayed in interactive shells, and suppressed
otherwise.
* `--json`:
Print output in JSON format. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew>
* `--fetch-HEAD`:
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository's HEAD will be checked for updates when a new stable or development version has been released.
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.
### `pin` *`formula`*
@ -358,10 +358,10 @@ Rerun the post-install steps for *`formula`*.
### `readall` [*`options`*] [*`tap`*]
Import all formulae from specified *`tap`* (defaults to all installed taps). This
can be useful for debugging issues across all formulae when making significant
changes to `formula.rb`, testing the performance of loading all formulae or to
determine if any current formulae have Ruby issues.
Import all formulae from the specified *`tap`*, or from all installed taps if none
is provided. This can be useful for debugging issues across all formulae when
making significant changes to `formula.rb`, testing the performance of loading
all formulae or to determine if any current formulae have Ruby issues.
* `--aliases`:
Verify any alias symlinks in each tap.
@ -370,35 +370,34 @@ determine if any current formulae have Ruby issues.
### `reinstall` [*`options`*] *`formula`*
Uninstall and then install *`formula`* (with existing and any appended install
options).
Uninstall and then install *`formula`* using the same options it was originally
installed with, plus any appended brew formula options.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the
reinstalled formulae or, every 30 days, for all formulae.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for
the reinstalled formulae or, every 30 days, for all formulae.
* `-s`, `--build-from-source`:
Compile *`formula`* from source even if a bottle is available.
* `--force-bottle`:
Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation.
* `--keep-tmp`:
Don't delete the temporary files created during installation.
Retain the temporary files created during installation.
* `--display-times`:
Print install times for each formula at the end of the run.
### `search` [*`options`*] [*`text`*|`/`*`text`*`/`]
Perform a substring search of cask tokens and formula names for *`text`*. If
*`text`* is surrounded with slashes, then it is interpreted as a regular
expression. The search for *`text`* is extended online to `homebrew/core` and
`homebrew/cask`.
*`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 *`text`* is passed, display all locally available formulae (including tapped
If no *`text`* is provided, list all locally available formulae (including tapped
ones). No online search is performed.
* `--casks`:
Display all locally available casks (including tapped ones). No online search is performed.
List all locally available casks (including tapped ones). No online search is performed.
* `--desc`:
search formulae with a description matching *`text`* and casks with a name matching *`text`*.
Search for formulae with a description matching *`text`* and casks with a name matching *`text`*.
* `--macports`:
Search for *`text`* in the given package manager's list.
* `--fink`:
@ -418,17 +417,17 @@ Start a Homebrew build environment shell. Uses our years-battle-hardened
Homebrew build logic to help your `./configure && make && make install` or even
your `gem install` succeed. Especially handy if you run Homebrew in an
Xcode-only configuration since it adds tools like `make` to your `PATH` which
otherwise build systems would not find.
build systems would not find otherwise.
* `--env`:
Use the standard `PATH` instead of superenv's, when *`std`* is passed
Use the standard `PATH` instead of superenv's when `std` is passed.
### `shellenv`
Prints export statements - run them in a shell and this installation of Homebrew will be included into your `PATH`, `MANPATH` and `INFOPATH`.
Print export statements. When run in a shell, this installation of Homebrew will be added to your `PATH`, `MANPATH`, and `INFOPATH`.
`HOMEBREW_PREFIX`, `HOMEBREW_CELLAR` and `HOMEBREW_REPOSITORY` are also exported to save multiple queries of those variables.
The variables `HOMEBREW_PREFIX`, `HOMEBREW_CELLAR` and `HOMEBREW_REPOSITORY` are also exported to avoid querying them multiple times.
Consider adding evaluating the output in your dotfiles (e.g. `~/.profile`) with `eval $(brew shellenv)`
Consider adding evaluation of this command's output to your dotfiles (e.g. `~/.profile`) with: `eval $(brew shellenv)`
### `style` [*`options`*] [*`file`*|*`tap`*|*`formula`*]
@ -449,26 +448,27 @@ and all formulae.
### `switch` *`formula`* *`version`*
Symlink all of the specific *`version`* of *`formula`*'s install to Homebrew prefix.
Symlink all of the specified *`version`* of *`formula`*'s installation into
Homebrew's prefix.
### `tap` [*`options`*] *`user`*`/`*`repo`* [*`URL`*]
Tap a formula repository.
List all installed taps when no arguments are passed.
If no arguments are provided, list all installed taps.
With *`URL`* unspecified, taps a formula repository from GitHub using HTTPS. Since
With *`URL`* unspecified, tap a formula repository from GitHub using HTTPS. Since
so many taps are hosted on GitHub, this command is a shortcut for `brew tap`
*`user`*`/`*`repo`* `https://github.com/`*`user`*`/homebrew-`*`repo`*.
With *`URL`* specified, taps a formula repository from anywhere, using any
transport protocol that `git` handles. The one-argument form of `tap` simplifies
but also limits. This two-argument command makes no assumptions, so taps can be
cloned from places other than GitHub and using protocols other than HTTPS, e.g.,
SSH, GIT, HTTP, FTP(S), RSYNC.
With *`URL`* specified, tap a formula repository from anywhere, using any
transport protocol that `git`(1) handles. The one-argument form of `tap`
simplifies but also limits. This two-argument command makes no assumptions, so
taps can be cloned from places other than GitHub and using protocols other than
HTTPS, e.g. SSH, GIT, HTTP, FTP(S), RSYNC.
* `--full`:
Use a full clone when tapping a repository. By default, the repository is cloned as a shallow copy (`--depth=1`). To convert a shallow copy to a full copy, you can retap passing `--full` without first untapping.
Use a full clone when tapping a repository. By default, the repository is cloned as a shallow copy (`--depth=1`). To convert a shallow copy to a full copy, you can retap by passing `--full` without first untapping.
* `--force-auto-update`:
Auto-update tap even if it is not hosted on GitHub. By default, only taps hosted on GitHub are auto-updated (for performance reasons).
* `--repair`:
@ -480,13 +480,14 @@ SSH, GIT, HTTP, FTP(S), RSYNC.
### `tap-info` [*`options`*] [*`tap`*]
Display detailed information about one or more provided *`tap`*. Display a brief
summary of all installed taps if no *`tap`* are passed.
Show detailed information about one or more *`tap`*s.
If no *`tap`* names are provided, display brief statistics for all installed taps.
* `--installed`:
Display information on all installed taps.
Show information on each installed tap.
* `--json`:
Print a JSON representation of *`taps`*. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew>
Print a JSON representation of *`tap`*. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew>
### `uninstall`, `rm`, `remove` [*`options`*] *`formula`*
@ -497,12 +498,12 @@ Uninstall *`formula`*.
### `unlink` [*`options`*] *`formula`*
Remove symlinks for *`formula`* from the Homebrew prefix. This can be useful for
Remove symlinks for *`formula`* from Homebrew's prefix. This can be useful for
temporarily disabling a formula: `brew unlink` *`formula`* `&&` *`commands`* `&&
brew link` *`formula`*
* `-n`, `--dry-run`:
List all files which would be unlinked, but will not actually unlink or delete any files.
List files which would be unlinked without actually unlinking or deleting any files.
### `unpack` [*`options`*] *`formula`*
@ -523,38 +524,39 @@ also `pin`.
### `untap` *`tap`*
Remove a tapped repository.
Remove a tapped formula repository.
### `update` [*`options`*]
### `update`, `up` [*`options`*]
Fetch the newest version of Homebrew and all formulae from GitHub using `git`(1) and perform any necessary migrations.
* `--merge`:
`git merge` is used to include updates (rather than `git rebase`).
Use `git merge` to apply updates (rather than `git rebase`).
### `update-reset` [*`repository`*]
Fetches and resets Homebrew and all tap repositories (or any specified `repository`) using `git`(1) to their latest `origin/master`. Note this will destroy all your uncommitted or committed changes.
Fetch and reset Homebrew and all tap repositories (or any specified *`repository`*) using `git`(1) to their latest `origin/master`.
### `upgrade` [*`options`*] *`formula`*
*Note:* this will destroy all your uncommitted or committed changes.
Upgrade outdated, unpinned formulae (with existing and any appended brew formula
options).
### `upgrade` [*`options`*] [*`formula`*]
If *`formula`* are given, upgrade only the specified brews (unless they are
pinned; see `pin`, `unpin`).
Upgrade outdated, unpinned formulae using the same options they were originally
installed with, plus any appended brew formula options. If *`formula`* are
specified, upgrade only the given *`formula`* kegs (unless they are pinned; see
`pin`, `unpin`).
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the
upgraded formulae or, every 30 days, for all formulae.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for
the upgraded formulae or, every 30 days, for all formulae.
* `-s`, `--build-from-source`:
Compile *`formula`* from source even if a bottle is available.
* `--force-bottle`:
Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation.
* `--fetch-HEAD`:
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository's HEAD will be checked for updates when a new stable or development version has been released.
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.
* `--ignore-pinned`:
Set a 0 exit code even if pinned formulae are not upgraded.
Set a successful exit status even if pinned formulae are not upgraded.
* `--keep-tmp`:
Don't delete the temporary files created during installation.
Retain the temporary files created during installation.
* `--display-times`:
Print install times for each formula at the end of the run.
* `--dry-run`:
@ -562,18 +564,15 @@ upgraded formulae or, every 30 days, for all formulae.
### `uses` [*`options`*] *`formula`*
Show the formulae that specify *`formula`* as a dependency. When given multiple
formula arguments, show the intersection of formulae that use *`formula`*.
By default, `uses` shows all formulae that specify *`formula`* as a required or
recommended dependency.
By default, `uses` shows usage of *`formula`* by stable builds.
Show formulae that specify *`formula`* as a dependency. When given multiple
formula arguments, show the intersection of formulae that use *`formula`*. By
default, `uses` shows all formulae that specify *`formula`* as a required or
recommended dependency for their stable builds.
* `--recursive`:
Resolve more than one level of dependencies.
* `--installed`:
Only list installed formulae.
Only list formulae that are currently installed.
* `--include-build`:
Include all formulae that specify *`formula`* as `:build` type dependency.
* `--include-test`:
@ -583,9 +582,9 @@ By default, `uses` shows usage of *`formula`* by stable builds.
* `--skip-recommended`:
Skip all formulae that specify *`formula`* as `:recommended` type dependency.
* `--devel`:
Show usage of *`formula`* by development build.
Show usage of *`formula`* by development builds.
* `--HEAD`:
Show usage of *`formula`* by HEAD build.
Show usage of *`formula`* by HEAD builds.
### `--cache` [*`options`*] [*`formula`*]
@ -608,7 +607,7 @@ would be installed, without any sort of versioned directory as the last path.
### `--env` [*`options`*]
Show a summary of the Homebrew build environment as a plain list.
Summarize Homebrew's build environment as a plain list.
If the command's output is sent through a pipe and no shell is specified, the
list is formatted for export to `bash`(1) unless `--plain` is passed.
@ -616,7 +615,7 @@ list is formatted for export to `bash`(1) unless `--plain` is passed.
* `--shell`:
Generate a list of environment variables for the specified shell, or `--shell=auto` to detect the current shell.
* `--plain`:
Plain output even when piped.
Generate plain output even when piped.
### `--prefix` [*`formula`*]
@ -626,7 +625,7 @@ Display Homebrew's install path. *Default:* `/usr/local` on macOS and
If *`formula`* is provided, display the location in the cellar where *`formula`* is
or would be installed.
### `--repository` [*`user`*`/`*`repo`*]
### `--repository`, `--repo` [*`user`*`/`*`repo`*]
Display where Homebrew's `.git` directory is located.
@ -635,17 +634,17 @@ is located.
### `--version`
Print the version number of Homebrew, Homebrew/homebrew-core and
Homebrew/homebrew-cask (if tapped) to standard output and exit.
Print the version numbers of Homebrew, Homebrew/homebrew-core and
Homebrew/homebrew-cask (if tapped) to standard output.
## DEVELOPER COMMANDS
### `audit` [*`options`*] *`formula`*
### `audit` [*`options`*] [*`formula`*]
Check *`formula`* for Homebrew coding style violations. This should be run before
submitting a new formula. Will exit with a non-zero status if any errors are
found, which can be useful for implementing pre-commit hooks. If no *`formula`*
are provided, all of them are checked.
submitting a new formula. If no *`formula`* are provided, check all locally
available formulae. Will exit with a non-zero status if any errors are found,
which can be useful for implementing pre-commit hooks.
* `--strict`:
Run additional style checks, including RuboCop style checks.
@ -658,7 +657,7 @@ are provided, all of them are checked.
* `--display-cop-names`:
Include the RuboCop cop name for each violation in the output.
* `--display-filename`:
Prefix every line of output with name of the file or formula being audited, to make output easy to grep.
Prefix every line of output with the file or formula name being audited, to make output easy to grep.
* `-D`, `--audit-debug`:
Enable debugging and profiling of audit methods.
* `--only`:
@ -688,11 +687,11 @@ at its original value, while `--no-rebuild` will remove it.
* `--keep-old`:
If the formula specifies a rebuild version, attempt to preserve its value in the generated DSL.
* `--json`:
Write bottle information to a JSON file, which can be used as the argument for `--merge`.
Write bottle information to a JSON file, which can be used as the value for `--merge`.
* `--merge`:
Generate an updated bottle block for a formula and optionally merge it into the formula file. Instead of a formula name, requires a JSON file generated with `brew bottle --json` *`formula`*.
Generate an updated bottle block for a formula and optionally merge it into the formula file. Instead of a formula name, requires the path to a JSON file generated with `brew bottle --json` *`formula`*.
* `--write`:
Write the changes to the formula file. A new commit will be generated unless `--no-commit` is passed.
Write changes to the formula file. A new commit will be generated unless `--no-commit` is passed.
* `--no-commit`:
When passed with `--write`, a new commit will not generated after writing changes to the formula file.
* `--root-url`:
@ -700,7 +699,7 @@ at its original value, while `--no-rebuild` will remove it.
### `bump-formula-pr` [*`options`*] [*`formula`*]
Create a pull request to update a formula with a new URL or a new tag.
Create a pull request to update *`formula`* with a new URL or a new tag.
If a *`URL`* is specified, the *`SHA-256`* checksum of the new download should also
be specified. A best effort to determine the *`SHA-256`* and *`formula`* name will
@ -711,8 +710,8 @@ must also be specified.
*Note:* this command cannot be used to transition a formula from a
URL-and-SHA-256 style specification into a tag-and-revision style specification,
nor vice versa. It must use whichever style specification the preexisting
formula already uses.
nor vice versa. It must use whichever style specification the formula already
uses.
* `--devel`:
Bump the development rather than stable version. The development spec must already exist.
@ -727,11 +726,11 @@ formula already uses.
* `--no-browse`:
Print the pull request URL instead of opening in a browser.
* `--mirror`:
Use the provided *`URL`* as a mirror URL.
Use the specified *`URL`* as a mirror URL.
* `--version`:
Use the provided *`version`* to override the value parsed from the URL or tag. Note that `--version=0` can be used to delete an existing version override from a formula if it has become redundant.
Use the specified *`version`* to override the value parsed from the URL or tag. Note that `--version=0` can be used to delete an existing version override from a formula if it has become redundant.
* `--message`:
Append the provided *`message`* to the default PR message.
Append *`message`* to the default pull request message.
* `--url`:
Specify the *`URL`* for the new download. If a *`URL`* is specified, the *`SHA-256`* checksum of the new download should also be specified.
* `--sha256`:
@ -739,17 +738,17 @@ formula already uses.
* `--tag`:
Specify the new git commit *`tag`* for the formula.
* `--revision`:
Specify the new git commit *`revision`* corresponding to a specified *`tag`*.
Specify the new git commit *`revision`* corresponding to the specified *`tag`*.
### `bump-revision` [*`options`*] [*`formula`*]
### `bump-revision` [*`options`*] *`formula`*
Create a commit to increment the revision of the formula. If no revision is
present, "revision 1" will be added.
Create a commit to increment the revision of *`formula`*. If no revision is
present, "revision 1" will be added.
* `-n`, `--dry-run`:
Print what would be done rather than doing it.
* `--message`:
Append the provided *`message`* to the default commit message.
Append *`message`* to the default commit message.
### `create` [*`options`*] *`URL`*
@ -766,34 +765,35 @@ a simple example. For the complete API, see:
* `--meson`:
Create a basic template for a Meson-style build.
* `--no-fetch`:
Homebrew will not download *`URL`* to the cache and will thus not add the SHA-256 to the formula for you, nor will it check the GitHub API for GitHub projects (to fill out its description and homepage).
Homebrew will not download *`URL`* to the cache and will thus not add its SHA-256 to the formula for you, nor will it check the GitHub API for GitHub projects (to fill out its description and homepage).
* `--HEAD`:
Indicate that *`URL`* points to the package's repository rather than a file.
* `--set-name`:
Set the name of the new formula to the provided *`name`*.
Explicitly set the *`name`* of the new formula.
* `--set-version`:
Set the version of the new formula to the provided *`version`*.
Explicitly set the *`version`* of the new formula.
* `--tap`:
Generate the new formula in the provided tap, specified as *`user`*`/`*`repo`*.
Generate the new formula within the given tap, specified as *`user`*`/`*`repo`*.
### `edit` [*`formula`*]
Open a formula in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the
Homebrew repository for editing if no *`formula`* is provided.
Open *`formula`* in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the
Homebrew repository for editing if no formula is provided.
### `extract` [*`options`*] *`formula`* *`tap`*
Look through repository history to find the most recent version of *`formula`* and
create a copy in *`tap`*`/Formula/`*`formula`*`@`*`version`*`.rb`. If the tap is not
installed yet, attempt to install/clone the tap before continuing. To extract a
*`formula`* from a tap that is not homebrew/core use *`user`*/*`repo`*/*`formula`*.
formula from a tap that is not `homebrew/core` use its fully-qualified form of
*`user`*`/`*`repo`*`/`*`formula`*.
* `--version`:
Extract the provided *`version`* of *`formula`* instead of the most recent.
Extract the specified *`version`* of *`formula`* instead of the most recent.
### `formula` *`formula`*
Display the path where a formula is located.
Display the path where *`formula`* is located.
### `irb` [*`options`*]
@ -806,11 +806,11 @@ Enter the interactive Homebrew Ruby shell.
### `linkage` [*`options`*] [*`formula`*]
Check the library links for kegs of installed formulae. Raises an error if run
on uninstalled formulae.
Check the library links from the given *`formula`* kegs. If no *`formula`* are
provided, check all kegs. Raises an error if run on uninstalled formulae.
* `--test`:
Display only missing libraries and exit with a non-zero status if any missing libraries are found.
Show only missing libraries and exit with a non-zero status if any missing libraries are found.
* `--reverse`:
For every library that a keg references, print its dylib path followed by the binaries that link to it.
* `--cached`:
@ -821,21 +821,21 @@ on uninstalled formulae.
Generate Homebrew's manpages.
* `--fail-if-changed`:
Return a failing status code if changes are detected in the manpage outputs. This can be used for CI to be notified when the manpages are out of date. Additionally, the date used in new manpages will match those in the existing manpages (to allow comparison without factoring in the date).
Return a failing status code if changes are detected in the manpage outputs. This can be used to notify CI when the manpages are out of date. Additionally, the date used in new manpages will match those in the existing manpages (to allow comparison without factoring in the date).
* `--link`:
This is now done automatically by `brew update`.
### `prof` *`command`*
Run Homebrew with the Ruby profiler e.g. `brew prof readall`.
Run Homebrew with the Ruby profiler, e.g. `brew prof readall`.
### `pull` [*`options`*] *`patch`*
Get a patch from a GitHub commit or pull request and apply it to Homebrew.
Optionally, publish updated bottles for the formulae changed by the patch.
Optionally, publish updated bottles for any formulae changed by the patch.
Each *`patch`* may be the number of a PR in `homebrew/core`, the URL of a PR on
GitHub, the URL of a commit on GitHub or a "https://jenkins.brew.sh/job/..."
Each *`patch`* may be the number of a pull request in `homebrew/core`, the URL of
any pull request or commit on GitHub or a "https://jenkins.brew.sh/job/..."
testing job URL.
* `--bottle`:
@ -857,9 +857,9 @@ testing job URL.
* `--warn-on-publish-failure`:
Do not exit if there's a failure publishing bottles on Bintray.
* `--bintray-org`:
Publish bottles at the provided Bintray *`organisation`*.
Publish bottles to the specified Bintray *`organisation`*.
* `--test-bot-user`:
Pull the bottle block commit from the provided *`user`* on GitHub.
Pull the bottle block commit from the specified *`user`* on GitHub.
### `release-notes` [*`options`*] [*`previous_tag`*] [*`end_ref`*]
@ -870,13 +870,13 @@ provided it defaults to `origin/master`.
* `--markdown`:
Print as a Markdown list.
### `ruby` [`-e`]:
### `ruby` (`-e` *`text`*|*`file`*)
Run a Ruby instance with Homebrew's libraries loaded e.g. `brew ruby -e "puts
:gcc.f.deps"` or `brew ruby script.rb`
Run a Ruby instance with Homebrew's libraries loaded, e.g. `brew ruby -e "puts
:gcc.f.deps"` or `brew ruby script.rb`.
* `-e`:
Execute the provided string argument as a script.
Execute the given text string as a script.
### `tap-new` *`user`*`/`*`repo`*
@ -895,7 +895,7 @@ wrong with the installed formula.
* `--HEAD`:
Test the head version of a formula.
* `--keep-tmp`:
Keep the temporary files created for the test.
Retain the temporary files created for the test.
### `tests` [*`options`*]
@ -912,11 +912,11 @@ Run Homebrew's unit and integration tests.
* `--only`:
Run only *`test_script`*`_spec.rb`. Appending `:`*`line_number`* will start at a specific line.
* `--seed`:
Randomise tests with the provided *`value`* instead of a random seed.
Randomise tests with the specified *`value`* instead of a random seed.
### `update-test` [*`options`*]
Run a test of `brew update` with a new repository clone. If no arguments are
Run a test of `brew update` with a new repository clone. If no options are
passed, use `origin/master` as the start commit.
* `--to-tag`:
@ -924,9 +924,9 @@ passed, use `origin/master` as the start commit.
* `--keep-tmp`:
Retain the temporary directory containing the new repository clone.
* `--commit`:
Use provided *`commit`* as the start commit.
Use the specified *`commit`* as the start commit.
* `--before`:
Use the commit at provided *`date`* as the start commit.
Use the commit at the specified *`date`* as the start commit.
### `vendor-gems`
@ -952,19 +952,21 @@ These options are applicable across all sub-commands.
### `bundle` *`subcommand`*:
Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask and the Mac App Store. See `brew bundle --help`.
Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask and the Mac App Store.
See `brew bundle --help`.
**Homebrew/homebrew-bundle**: <https://github.com/Homebrew/homebrew-bundle>
### `cask` *`subcommand`*:
Install macOS applications distributed as binaries. See brew-cask(1).
Install macOS applications distributed as binaries. See `brew-cask`(1).
**Homebrew/homebrew-cask**: <https://github.com/Homebrew/homebrew-cask>
### `services` *`subcommand`*:
Manage background services with macOS' `launchctl`(1) daemon manager. See `brew services --help`.
Manage background services with macOS' `launchctl`(1) daemon manager.
See `brew services --help`.
**Homebrew/homebrew-services**: <https://github.com/Homebrew/homebrew-services>
@ -995,17 +997,18 @@ can take several different forms:
* An arbitrary file or URL:
Homebrew can install formulae via URL, e.g.
`https://raw.githubusercontent.com/Homebrew/homebrew-core/master/Formula/git.rb`,
or from a local path. It could point to either a formula file or a bottle.
or from a local path. It can point to either a formula file or a bottle.
In the case of a URL, the downloaded file will be cached for later use.
## ENVIRONMENT
Note that environment variables must have a value set to be detected. For example,
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: If set, Homebrew will pass the set value to type name to the compiler's `-march` option instead of using the default (`-march=native`).
Linux only: If set, Homebrew will pass the set value to type name to the compiler's
`-march` option instead of using the default (`-march=native`).
* `HOMEBREW_ARTIFACT_DOMAIN`:
If set, instructs Homebrew to prefix all download URLs, including those for bottles,
@ -1041,8 +1044,8 @@ Note that environment variables must have a value set to be detected. For exampl
*Default:* `~/Library/Caches/Homebrew`.
* `HOMEBREW_CURLRC`:
If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables
the use of `curlrc`).
If set, Homebrew will not pass `-q` when invoking `curl`(1), which disables
the use of `curlrc`.
* `HOMEBREW_CURL_VERBOSE`:
If set, Homebrew will pass `--verbose` when invoking `curl`(1).
@ -1083,7 +1086,7 @@ Note that environment variables must have a value set to be detected. For exampl
even if the system version of Ruby is new enough.
* `HOMEBREW_FORCE_BREWED_GIT`:
If set, Homebrew will always use a Homebrew-installed `git` rather than the
If set, Homebrew will always use a Homebrew-installed `git`(1) rather than the
system version. Automatically set if the system version of `git` is too old.
* `HOMEBREW_GITHUB_API_TOKEN`:
@ -1208,6 +1211,8 @@ And for an authenticated HTTP proxy:
Homebrew Documentation: <https://docs.brew.sh>
Homebrew API: <https://rubydoc.brew.sh>
`brew-cask`(1), `git`(1), `git-log`(1)
## AUTHORS

353
manpages/brew.1
View File

@ -19,11 +19,14 @@ Homebrew is the easiest and most flexible way to install the UNIX tools Apple di
For the full command list, see the \fICOMMANDS\fR section\.
.
.P
With \fB\-\-verbose\fR or \fB\-v\fR, many commands print extra debugging information\. Note that these flags should only appear after a command\.
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:"
Install \fIformula\fR\.
.
.P
\fIformula\fR is usually the name of the formula to install, but it has other syntaxes which are listed in the \fISPECIFYING FORMULAE\fR section\.
.
.SS "\fBuninstall\fR \fIformula\fR:"
Uninstall \fIformula\fR\.
.
@ -31,24 +34,24 @@ Uninstall \fIformula\fR\.
List all installed formulae\.
.
.SS "\fBsearch\fR (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR):"
Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then 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 given, all locally available formulae are listed\.
Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\. The search for \fItext\fR is extended online to \fBhomebrew/core\fR and \fBhomebrew/cask\fR\. If no search term is provided, all locally available formulae are listed\.
.
.SH "COMMANDS"
.
.SS "\fBanalytics\fR [\fBon\fR|\fBoff\fR|\fBstate\fR|\fBregenerate\-uuid\fR]"
.SS "\fBanalytics\fR [\fIsubcommand\fR]"
If \fBon\fR or \fBoff\fR is passed, turn Homebrew\'s analytics on or off respectively\.
.
.P
If \fBstate\fR is passed, display anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\.
If \fBstate\fR is passed, display the current anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\.
.
.P
If \fBregenerate\-uuid\fR is passed, regenerate UUID used in Homebrew\'s analytics\.
If \fBregenerate\-uuid\fR is passed, regenerate the UUID used in Homebrew\'s analytics\.
.
.SS "\fBcat\fR \fIformula\fR"
Display the source of \fIformula\fR\.
.
.SS "\fBcleanup\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]"
Remove stale lock files and outdated downloads for formulae and casks, and remove old versions of installed formulae\. If arguments are specified, only do this for the specified formulae and casks\.
Remove stale lock files and outdated downloads for all formulae and casks, and remove old versions of installed formulae\. If arguments are specified, only do this for the given formulae and casks\.
.
.TP
\fB\-\-prune\fR
@ -67,24 +70,24 @@ Scrub the cache, including downloads for even the latest versions\. Note downloa
Only prune the symlinks and directories from the prefix and remove no other files\.
.
.SS "\fBcommand\fR \fIcmd\fR"
Display the path to the file which is used when invoking \fBbrew\fR \fIcmd\fR\.
Display the path to the file being used when invoking \fBbrew\fR \fIcmd\fR\.
.
.SS "\fBcommands\fR [\fIoptions\fR]"
Show a list of built\-in and external commands\.
Show lists of built\-in and external commands\.
.
.TP
\fB\-\-include\-aliases\fR
Include the aliases of internal commands\.
Include aliases of internal commands\.
.
.SS "\fBconfig\fR"
Show Homebrew and system configuration useful for debugging\. If you file a bug report, you will likely be asked for this information if you do not provide it\.
Show Homebrew and system configuration info useful for debugging\. If you file a bug report, you will be required to provide this information\.
.
.SS "\fBdeps\fR [\fIoptions\fR] \fIformula\fR"
.SS "\fBdeps\fR [\fIoptions\fR] [\fIformula\fR]"
Show dependencies for \fIformula\fR\. Additional options specific to \fIformula\fR may be appended to the command\. When given multiple formula arguments, show the intersection of dependencies for each formula\.
.
.TP
\fB\-n\fR
Show dependencies in topological order\.
Sort dependencies in topological order\.
.
.TP
\fB\-\-1\fR
@ -136,36 +139,36 @@ List dependencies for all available formulae\.
.
.TP
\fB\-\-for\-each\fR
Switch into the mode used by the \fB\-\-all\fR option, but only list dependencies for the specified \fIformula\fR, one formula per line\. This is used for debugging the \fB\-\-installed\fR/\fB\-\-all\fR display mode\.
Switch into the mode used by the \fB\-\-all\fR option, but only list dependencies for each provided \fIformula\fR, one formula per line\. This is used for debugging the \fB\-\-installed\fR/\fB\-\-all\fR display mode\.
.
.SS "\fBdesc\fR [\fIoptions\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR|\fIformula\fR)"
Display \fIformula\fR\'s name and one\-line description\. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones\.
.
.TP
\fB\-s\fR, \fB\-\-search\fR
Search both name and description for provided \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
Search both names and descriptions for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
.
.TP
\fB\-n\fR, \fB\-\-name\fR
Search just the names for provided \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
Search just names for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
.
.TP
\fB\-d\fR, \fB\-\-description\fR
Search just the descriptions for provided \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
Search just descriptions for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
.
.SS "\fBdiy\fR [\fIoptions\fR]"
Automatically determine the installation prefix for non\-Homebrew software\. Using the output from this command, you can install your own software into the Cellar and then link it into Homebrew\'s prefix with \fBbrew link\fR\.
.
.TP
\fB\-\-name\fR
Explicitly set the provided \fIname\fR of the package being installed\.
Explicitly set the \fIname\fR of the package being installed\.
.
.TP
\fB\-\-version\fR
Explicitly set the provided \fIversion\fR of the package being installed\.
Explicitly set the \fIversion\fR of the package being installed\.
.
.SS "\fBdoctor\fR [\fIoptions\fR]"
Check your system for potential problems\. Doctor exits with a non\-zero status if any potential problems are found\. Please note that these warnings are just used to help the Homebrew maintainers with debugging if you file an issue\. If everything you use Homebrew for is working fine: please don\'t worry or file an issue; just ignore this\.
Check your system for potential problems\. Will exit with a non\-zero status if any potential problems are found\. Please note that these warnings are just used to help the Homebrew maintainers with debugging if you file an issue\. If everything you use Homebrew for is working fine: please don\'t worry or file an issue; just ignore this\.
.
.TP
\fB\-\-list\-checks\fR
@ -176,7 +179,7 @@ List all audit methods\.
Enable debugging and profiling of audit methods\.
.
.SS "\fBfetch\fR [\fIoptions\fR] \fIformula\fR"
Download the source packages for the given \fIformula\fR\. For tarballs, also print SHA\-256 checksums\.
Download a bottle (if available) or source packages for \fIformula\fR\. For tarballs, also print SHA\-256 checksums\.
.
.TP
\fB\-\-HEAD\fR
@ -188,32 +191,26 @@ Fetch development version instead of stable version\.
.
.TP
\fB\-\-retry\fR
Retry if a download fails or re\-download if the checksum of a previously cached version no longer matches\.
Retry if downloading fails or re\-download if the checksum of a previously cached version no longer matches\.
.
.TP
\fB\-\-deps\fR
Download dependencies for any listed \fIformula\fR\.
Also download dependencies for any listed \fIformula\fR\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Download the source for rather than a bottle\.
Download source packages rather than a bottle\.
.
.TP
\fB\-\-build\-bottle\fR
Download the source (for eventual bottling) rather than a bottle\.
Download source packages (for eventual bottling) rather than a bottle\.
.
.TP
\fB\-\-force\-bottle\fR
Download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation\.
.
.SS "\fBgist\-logs\fR [\fIoptions\fR] \fIformula\fR"
Upload logs for a failed build of \fIformula\fR to a new Gist\.
.
.P
\fIformula\fR is usually the name of the formula to install, but it can be specified in several different ways\.
.
.P
If no logs are found, an error message is presented\.
Upload logs for a failed build of \fIformula\fR to a new Gist\. Presents an error message if no logs are found\.
.
.TP
\fB\-\-with\-hostname\fR
@ -221,24 +218,24 @@ Include the hostname in the Gist\.
.
.TP
\fB\-n\fR, \fB\-\-new\-issue\fR
Automatically create a new issue in the appropriate GitHub repository as well as creating the Gist\.
Automatically create a new issue in the appropriate GitHub repository after creating the Gist\.
.
.TP
\fB\-p\fR, \fB\-\-private\fR
The Gist will be marked private and will not appear in listings but will be accessible with the link\.
The Gist will be marked private and will not appear in listings but will be accessible with its link\.
.
.SS "\fBhome\fR [\fIformula\fR]"
Open \fIformula\fR\'s homepage in a browser\. If no formula is provided, open Homebrew\'s own homepage in a browser\.
Open \fIformula\fR\'s homepage in a browser, or open Homebrew\'s own homepage if no formula is provided\.
.
.SS "\fBinfo\fR [\fIoptions\fR] [\fIformula\fR]"
Display brief statistics for your Homebrew installation\.
.
.P
If \fIformula\fR is specified, show summary of information about \fIformula\fR\.
If \fIformula\fR is provided, show summary of information about \fIformula\fR\.
.
.TP
\fB\-\-analytics\fR
Display global Homebrew analytics data or, if specified, installation and build error data for \fIformula\fR (provided neither \fBHOMEBREW_NO_ANALYTICS\fR nor \fBHOMEBREW_NO_GITHUB_API\fR are set)\.
List global Homebrew analytics data or, if specified, installation and build error data for \fIformula\fR (provided neither \fBHOMEBREW_NO_ANALYTICS\fR nor \fBHOMEBREW_NO_GITHUB_API\fR are set)\.
.
.TP
\fB\-\-days\fR
@ -250,7 +247,7 @@ Which type of global analytics data to retrieve\. The value for \fIcategory\fR m
.
.TP
\fB\-\-github\fR
Open a browser to the GitHub source page for \fIformula\fR\. To view formula history locally: \fBbrew log \-p\fR \fIformula\fR
Open the GitHub source page for \fIformula\fR in a browser\. To view formula history locally: \fBbrew log \-p\fR \fIformula\fR
.
.TP
\fB\-\-json\fR
@ -265,17 +262,14 @@ Print JSON of formulae that are currently installed\.
Print JSON of all available formulae\.
.
.SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR"
Install \fIformula\fR\.
Install \fIformula\fR\. Additional options specific to \fIformula\fR may be appended to the command\.
.
.P
\fIformula\fR is usually the name of the formula to install, but it can be specified in several different ways\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will be run for the installed formulae or, every 30 days, for all formulae\.
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will then be run for the installed formulae or, every 30 days, for all formulae\.
.
.TP
\fB\-\-env\fR
If \fBstd\fR is passed, use the standard build environment instead of superenv\.If \fBsuper\fR is passed, use superenv even if the formula specifies the standard build environment\.
If \fBstd\fR is passed, use the standard build environment instead of superenv\. If \fBsuper\fR is passed, use superenv even if the formula specifies the standard build environment\.
.
.TP
\fB\-\-ignore\-dependencies\fR
@ -283,15 +277,15 @@ An unsupported Homebrew development flag to skip installing any dependencies of
.
.TP
\fB\-\-only\-dependencies\fR
Install the dependencies with specified options but do not install the specified formula\.
Install the dependencies with specified options but do not install the formula itself\.
.
.TP
\fB\-\-cc\fR
Attempt to compile using provided \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-7\fR for GCC 7\. In order to use LLVM\'s clang, use \fBllvm_clang\fR\. To specify the Apple\-provided clang, use \fBclang\fR\. This parameter will only accept compilers that are provided by Homebrew or bundled with macOS\. Please do not file issues if you encounter errors while using this flag\.
Attempt to compile using the specified \fIcompiler\fR, which should be the name of the compiler\'s executable, e\.g\. \fBgcc\-7\fR for GCC 7\. In order to use LLVM\'s clang, specify \fBllvm_clang\fR\. To use the Apple\-provided clang, specify \fBclang\fR\. This option will only accept compilers that are provided by Homebrew or bundled with macOS\. Please do not file issues if you encounter errors while using this option\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\.
Compile \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\.
.
.TP
\fB\-\-force\-bottle\fR
@ -299,7 +293,7 @@ Install from a bottle if it exists for the current or newest version of macOS, e
.
.TP
\fB\-\-include\-test\fR
Install testing dependencies required to run \fBbrew test\fR\.
Install testing dependencies required to run \fBbrew test\fR \fIformula\fR\.
.
.TP
\fB\-\-devel\fR
@ -311,19 +305,19 @@ If \fIformula\fR defines it, install the HEAD version, aka\. master, trunk, unst
.
.TP
\fB\-\-fetch\-HEAD\fR
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will be checked for updates when a new stable or development version has been released\.
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will only be checked for updates when a new stable or development version has been released\.
.
.TP
\fB\-\-keep\-tmp\fR
Don\'t delete the temporary files created during installation\.
Retain the temporary files created during installation\.
.
.TP
\fB\-\-build\-bottle\fR
Prepare the formula for eventual bottling during installation\.
Prepare the formula for eventual bottling during installation, skipping any post\-install steps\.
.
.TP
\fB\-\-bottle\-arch\fR
Optimise bottles for the given architecture rather than the oldest architecture supported by the version of macOS the bottles are built on\.
Optimise bottles for the specified architecture rather than the oldest architecture supported by the version of macOS the bottles are built on\.
.
.TP
\fB\-\-display\-times\fR
@ -338,33 +332,36 @@ Download and patch \fIformula\fR, then open a shell\. This allows the user to ru
Create a Git repository, useful for creating patches to the software\.
.
.SS "\fBleaves\fR"
Show installed formulae that are not dependencies of another installed formula\.
List installed formulae that are not dependencies of another installed formula\.
.
.SS "\fBln\fR, \fBlink\fR [\fIoptions\fR] \fIformula\fR"
Symlink all of \fIformula\fR\'s installed files into the Homebrew prefix\. This is done automatically when you install formulae but can be useful for DIY installations\.
.SS "\fBlink\fR, \fBln\fR [\fIoptions\fR] \fIformula\fR"
Symlink all of \fIformula\fR\'s installed files into Homebrew\'s prefix\. This is done automatically when you install formulae but can be useful for DIY installations\.
.
.TP
\fB\-\-overwrite\fR
Delete files already existing in the prefix while linking\.
Delete files that already exist in the prefix while linking\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
List all files which would be linked or deleted by \fBbrew link \-\-overwrite\fR, but will not actually link or delete any files\.
List files which would be linked or deleted by \fBbrew link \-\-overwrite\fR without actually linking or deleting any files\.
.
.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR]"
.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR] [\fIformula\fR]"
List all installed formulae\.
.
.P
If \fIformula\fR is provided, summarize the paths within its current keg\.
.
.TP
\fB\-\-full\-name\fR
Print formulae with fully\-qualified names\. If \fB\-\-full\-name\fR is not passed, other options (i\.e\. \fB\-1\fR, \fB\-l\fR, \fB\-t\fR and \fB\-r\fR) are passed to \fBls\fR which produces the actual output\.
Print formulae with fully\-qualified names\. If \fB\-\-full\-name\fR is not passed, other options (i\.e\. \fB\-1\fR, \fB\-l\fR, \fB\-r\fR and \fB\-t\fR) are passed to \fBls\fR(1) which produces the actual output\.
.
.TP
\fB\-\-unbrewed\fR
List all files in the Homebrew prefix not installed by Homebrew\.
List files in Homebrew\'s prefix not installed by Homebrew\.
.
.TP
\fB\-\-versions\fR
Show the version number for installed formulae, or only the specified formulae if \fIformula\fR are given\.
Show the version number for installed formulae, or only the specified formulae if \fIformula\fR are provided\.
.
.TP
\fB\-\-multiple\fR
@ -372,7 +369,7 @@ Only show formulae with multiple versions installed\.
.
.TP
\fB\-\-pinned\fR
Show the versions of pinned formulae, or only the specified (pinned) formulae if \fIformula\fR are given\. See also \fBpin\fR, \fBunpin\fR\.
Show the versions of pinned formulae, or only the specified (pinned) formulae if \fIformula\fR are provided\. See also \fBpin\fR, \fBunpin\fR\.
.
.TP
\fB\-1\fR
@ -380,68 +377,62 @@ Force output to be one entry per line\. This is the default when output is not t
.
.TP
\fB\-l\fR
List in long format\. If the output is to a terminal, a total sum for all the file sizes is output on a line before the long listing\.
List in long format\. If the output is to a terminal, a total sum for all the file sizes is printed before the long listing\.
.
.TP
\fB\-r\fR
Reverse the order of the sort to get the oldest entries first\.
Reverse the order of the sort to list the oldest entries first\.
.
.TP
\fB\-t\fR
Sort by time modified (most recently modified first)\.
Sort by time modified, listing most recently modified first\.
.
.SS "\fBlog\fR [\fIoptions\fR] \fIformula\fR"
Show the \fBgit log\fR for the given \fIformula\fR\.
.SS "\fBlog\fR [\fIoptions\fR] [\fIformula\fR]"
Show the \fBgit log\fR for \fIformula\fR, or show the log for the Homebrew repository if no formula is provided\.
.
.TP
\fB\-p\fR, \fB\-\-patch\fR
Also output patch from commit\.
Also print patch from commit\.
.
.TP
\fB\-\-stat\fR
Also output diffstat from commit\.
Also print diffstat from commit\.
.
.TP
\fB\-\-oneline\fR
Output only one line per commit\.
Print only one line per commit\.
.
.TP
\fB\-1\fR, \fB\-\-max\-count\fR
Output only one commit\.
Print only one or a specified number of commits\.
.
.SS "\fBmigrate\fR [\fIoptions\fR] \fIformula\fR"
Migrate renamed packages to new name, where \fIformula\fR are old names of packages\.
Migrate renamed packages to new names, where \fIformula\fR are old names of packages\.
.
.SS "\fBmissing\fR [\fIoptions\fR] [\fIformulae\fR]"
Check the given \fIformula\fR for missing dependencies\. If no \fIformula\fR are given, check all installed brews\.
.
.P
\fBmissing\fR exits with a non\-zero status if any formulae are missing dependencies\.
.SS "\fBmissing\fR [\fIoptions\fR] [\fIformula\fR]"
Check the given \fIformula\fR kegs for missing dependencies\. If no \fIformula\fR are provided, check all kegs\. Will exit with a non\-zero status if any kegs are found to be missing dependencies\.
.
.TP
\fB\-\-hide\fR
Act as if none of the provided \fIhidden\fR are installed\. \fIhidden\fR should be comma\-separated list of formulae\.
Act as if none of the specified \fIhidden\fR are installed\. \fIhidden\fR should be a comma\-separated list of formulae\.
.
.SS "\fBoptions\fR [\fIoptions\fR] \fIformula\fR"
Display install options specific to \fIformula\fR
.SS "\fBoptions\fR [\fIoptions\fR] [\fIformula\fR]"
Show install options specific to \fIformula\fR\.
.
.TP
\fB\-\-compact\fR
Show all options on a single line separated by spaces\.
.
.TP
\fB\-\-all\fR
Show options for all formulae\.
\fB\-\-installed\fR
Show options for formulae that are currently installed\.
.
.TP
\fB\-\-installed\fR
Show options for all installed formulae\.
\fB\-\-all\fR
Show options for all available formulae\.
.
.SS "\fBoutdated\fR [\fIoptions\fR]"
Show formulae that have an updated version available\.
.
.P
By default, version information is displayed in interactive shells, and suppressed otherwise\.
List installed formulae that have an updated version available\. By default, version information is displayed in interactive shells, and suppressed otherwise\.
.
.TP
\fB\-\-json\fR
@ -449,7 +440,7 @@ Print output in JSON format\. Currently the default and only accepted value for
.
.TP
\fB\-\-fetch\-HEAD\fR
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will be checked for updates when a new stable or development version has been released\.
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\.
.
.SS "\fBpin\fR \fIformula\fR"
Pin the specified \fIformula\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR \fIformula\fR command\. See also \fBunpin\fR\.
@ -458,7 +449,7 @@ Pin the specified \fIformula\fR, preventing them from being upgraded when issuin
Rerun the post\-install steps for \fIformula\fR\.
.
.SS "\fBreadall\fR [\fIoptions\fR] [\fItap\fR]"
Import all formulae from specified \fItap\fR (defaults to all installed taps)\. This can be useful for debugging issues across all formulae when making significant changes to \fBformula\.rb\fR, testing the performance of loading all formulae or to determine if any current formulae have Ruby issues\.
Import all formulae from the specified \fItap\fR, or from all installed taps if none is provided\. This can be useful for debugging issues across all formulae when making significant changes to \fBformula\.rb\fR, testing the performance of loading all formulae or to determine if any current formulae have Ruby issues\.
.
.TP
\fB\-\-aliases\fR
@ -469,10 +460,10 @@ Verify any alias symlinks in each tap\.
Syntax\-check all of Homebrew\'s Ruby files\.
.
.SS "\fBreinstall\fR [\fIoptions\fR] \fIformula\fR"
Uninstall and then install \fIformula\fR (with existing and any appended install options)\.
Uninstall and then install \fIformula\fR using the same options it was originally installed with, plus any appended brew formula options\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will be run for the reinstalled formulae or, every 30 days, for all formulae\.
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will then be run for the reinstalled formulae or, every 30 days, for all formulae\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
@ -484,25 +475,25 @@ Install from a bottle if it exists for the current or newest version of macOS, e
.
.TP
\fB\-\-keep\-tmp\fR
Don\'t delete the temporary files created during installation\.
Retain the temporary files created during installation\.
.
.TP
\fB\-\-display\-times\fR
Print install times for each formula at the end of the run\.
.
.SS "\fBsearch\fR [\fIoptions\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 surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to \fBhomebrew/core\fR and \fBhomebrew/cask\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\.
.
.P
If no \fItext\fR is passed, display all locally available formulae (including tapped ones)\. No online search is performed\.
If no \fItext\fR is provided, list all locally available formulae (including tapped ones)\. No online search is performed\.
.
.TP
\fB\-\-casks\fR
Display all locally available casks (including tapped ones)\. No online search is performed\.
List all locally available casks (including tapped ones)\. No online search is performed\.
.
.TP
\fB\-\-desc\fR
search formulae with a description matching \fItext\fR and casks with a name matching \fItext\fR\.
Search for formulae with a description matching \fItext\fR and casks with a name matching \fItext\fR\.
.
.TP
\fB\-\-macports\fR
@ -529,20 +520,20 @@ Search for \fItext\fR in the given package manager\'s list\.
Search for \fItext\fR in the given package manager\'s list\.
.
.SS "\fBsh\fR [\fIoptions\fR]"
Start a Homebrew build environment shell\. Uses our years\-battle\-hardened Homebrew build logic to help your \fB\./configure && make && make install\fR or even your \fBgem install\fR succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fR to your \fBPATH\fR which otherwise build systems would not find\.
Start a Homebrew build environment shell\. Uses our years\-battle\-hardened Homebrew build logic to help your \fB\./configure && make && make install\fR or even your \fBgem install\fR succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fR to your \fBPATH\fR which build systems would not find otherwise\.
.
.TP
\fB\-\-env\fR
Use the standard \fBPATH\fR instead of superenv\'s, when \fIstd\fR is passed
Use the standard \fBPATH\fR instead of superenv\'s when \fBstd\fR is passed\.
.
.SS "\fBshellenv\fR"
Prints export statements \- run them in a shell and this installation of Homebrew will be included into your \fBPATH\fR, \fBMANPATH\fR and \fBINFOPATH\fR\.
Print export statements\. When run in a shell, this installation of Homebrew will be added to your \fBPATH\fR, \fBMANPATH\fR, and \fBINFOPATH\fR\.
.
.P
\fBHOMEBREW_PREFIX\fR, \fBHOMEBREW_CELLAR\fR and \fBHOMEBREW_REPOSITORY\fR are also exported to save multiple queries of those variables\.
The variables \fBHOMEBREW_PREFIX\fR, \fBHOMEBREW_CELLAR\fR and \fBHOMEBREW_REPOSITORY\fR are also exported to avoid querying them multiple times\.
.
.P
Consider adding evaluating the output in your dotfiles (e\.g\. \fB~/\.profile\fR) with \fBeval $(brew shellenv)\fR
Consider adding evaluation of this command\'s output to your dotfiles (e\.g\. \fB~/\.profile\fR) with: \fBeval $(brew shellenv)\fR
.
.SS "\fBstyle\fR [\fIoptions\fR] [\fIfile\fR|\fItap\fR|\fIformula\fR]"
Check formulae or files for conformance to Homebrew style guidelines\.
@ -567,23 +558,23 @@ Specify a comma\-separated \fIcops\fR list to check for violations of only the l
Specify a comma\-separated \fIcops\fR list to skip checking for violations of the listed RuboCop cops\.
.
.SS "\fBswitch\fR \fIformula\fR \fIversion\fR"
Symlink all of the specific \fIversion\fR of \fIformula\fR\'s install to Homebrew prefix\.
Symlink all of the specified \fIversion\fR of \fIformula\fR\'s installation into Homebrew\'s prefix\.
.
.SS "\fBtap\fR [\fIoptions\fR] \fIuser\fR\fB/\fR\fIrepo\fR [\fIURL\fR]"
Tap a formula repository\.
.
.P
List all installed taps when no arguments are passed\.
If no arguments are provided, list all installed taps\.
.
.P
With \fIURL\fR unspecified, taps a formula repository from GitHub using HTTPS\. Since so many taps are hosted on GitHub, this command is a shortcut for \fBbrew tap\fR \fIuser\fR\fB/\fR\fIrepo\fR \fBhttps://github\.com/\fR\fIuser\fR\fB/homebrew\-\fR\fIrepo\fR\.
With \fIURL\fR unspecified, tap a formula repository from GitHub using HTTPS\. Since so many taps are hosted on GitHub, this command is a shortcut for \fBbrew tap\fR \fIuser\fR\fB/\fR\fIrepo\fR \fBhttps://github\.com/\fR\fIuser\fR\fB/homebrew\-\fR\fIrepo\fR\.
.
.P
With \fIURL\fR specified, taps a formula repository from anywhere, using any transport protocol that \fBgit\fR handles\. The one\-argument form of \fBtap\fR simplifies but also limits\. This two\-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e\.g\., SSH, GIT, HTTP, FTP(S), RSYNC\.
With \fIURL\fR specified, tap a formula repository from anywhere, using any transport protocol that \fBgit\fR(1) handles\. The one\-argument form of \fBtap\fR simplifies but also limits\. This two\-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e\.g\. SSH, GIT, HTTP, FTP(S), RSYNC\.
.
.TP
\fB\-\-full\fR
Use a full clone when tapping a repository\. By default, the repository is cloned as a shallow copy (\fB\-\-depth=1\fR)\. To convert a shallow copy to a full copy, you can retap passing \fB\-\-full\fR without first untapping\.
Use a full clone when tapping a repository\. By default, the repository is cloned as a shallow copy (\fB\-\-depth=1\fR)\. To convert a shallow copy to a full copy, you can retap by passing \fB\-\-full\fR without first untapping\.
.
.TP
\fB\-\-force\-auto\-update\fR
@ -602,15 +593,18 @@ List all pinned taps\.
Suppress any warnings\.
.
.SS "\fBtap\-info\fR [\fIoptions\fR] [\fItap\fR]"
Display detailed information about one or more provided \fItap\fR\. Display a brief summary of all installed taps if no \fItap\fR are passed\.
Show detailed information about one or more \fItap\fRs\.
.
.P
If no \fItap\fR names are provided, display brief statistics for all installed taps\.
.
.TP
\fB\-\-installed\fR
Display information on all installed taps\.
Show information on each installed tap\.
.
.TP
\fB\-\-json\fR
Print a JSON representation of \fItaps\fR\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
Print a JSON representation of \fItap\fR\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
.
.SS "\fBuninstall\fR, \fBrm\fR, \fBremove\fR [\fIoptions\fR] \fIformula\fR"
Uninstall \fIformula\fR\.
@ -620,11 +614,11 @@ Uninstall \fIformula\fR\.
Don\'t fail uninstall, even if \fIformula\fR is a dependency of any installed formulae\.
.
.SS "\fBunlink\fR [\fIoptions\fR] \fIformula\fR"
Remove symlinks for \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink\fR \fIformula\fR \fB&&\fR \fIcommands\fR \fB&& brew link\fR \fIformula\fR
Remove symlinks for \fIformula\fR from Homebrew\'s prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink\fR \fIformula\fR \fB&&\fR \fIcommands\fR \fB&& brew link\fR \fIformula\fR
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
List all files which would be unlinked, but will not actually unlink or delete any files\.
List files which would be unlinked without actually unlinking or deleting any files\.
.
.SS "\fBunpack\fR [\fIoptions\fR] \fIformula\fR"
Unpack the source files for \fIformula\fR into subdirectories of the current working directory\.
@ -645,26 +639,26 @@ Initialise a Git repository in the unpacked source\. This is useful for creating
Unpin \fIformula\fR, allowing them to be upgraded by \fBbrew upgrade\fR \fIformula\fR\. See also \fBpin\fR\.
.
.SS "\fBuntap\fR \fItap\fR"
Remove a tapped repository\.
Remove a tapped formula repository\.
.
.SS "\fBupdate\fR [\fIoptions\fR]"
.SS "\fBupdate\fR, \fBup\fR [\fIoptions\fR]"
Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1) and perform any necessary migrations\.
.
.TP
\fB\-\-merge\fR
\fBgit merge\fR is used to include updates (rather than \fBgit rebase\fR)\.
Use \fBgit merge\fR to apply updates (rather than \fBgit rebase\fR)\.
.
.SS "\fBupdate\-reset\fR [\fIrepository\fR]"
Fetches and resets Homebrew and all tap repositories (or any specified \fBrepository\fR) using \fBgit\fR(1) to their latest \fBorigin/master\fR\. Note this will destroy all your uncommitted or committed changes\.
.
.SS "\fBupgrade\fR [\fIoptions\fR] \fIformula\fR"
Upgrade outdated, unpinned formulae (with existing and any appended brew formula options)\.
Fetch and reset Homebrew and all tap repositories (or any specified \fIrepository\fR) using \fBgit\fR(1) to their latest \fBorigin/master\fR\.
.
.P
If \fIformula\fR are given, upgrade only the specified brews (unless they are pinned; see \fBpin\fR, \fBunpin\fR)\.
\fINote:\fR this will destroy all your uncommitted or committed changes\.
.
.SS "\fBupgrade\fR [\fIoptions\fR] [\fIformula\fR]"
Upgrade outdated, unpinned formulae using the same options they were originally installed with, plus any appended brew formula options\. If \fIformula\fR are specified, upgrade only the given \fIformula\fR kegs (unless they are pinned; see \fBpin\fR, \fBunpin\fR)\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will be run for the upgraded formulae or, every 30 days, for all formulae\.
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will then be run for the upgraded formulae or, every 30 days, for all formulae\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
@ -676,15 +670,15 @@ Install from a bottle if it exists for the current or newest version of macOS, e
.
.TP
\fB\-\-fetch\-HEAD\fR
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will be checked for updates when a new stable or development version has been released\.
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will only be checked for updates when a new stable or development version has been released\.
.
.TP
\fB\-\-ignore\-pinned\fR
Set a 0 exit code even if pinned formulae are not upgraded\.
Set a successful exit status even if pinned formulae are not upgraded\.
.
.TP
\fB\-\-keep\-tmp\fR
Don\'t delete the temporary files created during installation\.
Retain the temporary files created during installation\.
.
.TP
\fB\-\-display\-times\fR
@ -695,13 +689,7 @@ Print install times for each formula at the end of the run\.
Show what would be upgraded, but do not actually upgrade anything\.
.
.SS "\fBuses\fR [\fIoptions\fR] \fIformula\fR"
Show the formulae that specify \fIformula\fR as a dependency\. When given multiple formula arguments, show the intersection of formulae that use \fIformula\fR\.
.
.P
By default, \fBuses\fR shows all formulae that specify \fIformula\fR as a required or recommended dependency\.
.
.P
By default, \fBuses\fR shows usage of \fIformula\fR by stable builds\.
Show formulae that specify \fIformula\fR as a dependency\. When given multiple formula arguments, show the intersection of formulae that use \fIformula\fR\. By default, \fBuses\fR shows all formulae that specify \fIformula\fR as a required or recommended dependency for their stable builds\.
.
.TP
\fB\-\-recursive\fR
@ -709,7 +697,7 @@ Resolve more than one level of dependencies\.
.
.TP
\fB\-\-installed\fR
Only list installed formulae\.
Only list formulae that are currently installed\.
.
.TP
\fB\-\-include\-build\fR
@ -729,11 +717,11 @@ Skip all formulae that specify \fIformula\fR as \fB:recommended\fR type dependen
.
.TP
\fB\-\-devel\fR
Show usage of \fIformula\fR by development build\.
Show usage of \fIformula\fR by development builds\.
.
.TP
\fB\-\-HEAD\fR
Show usage of \fIformula\fR by HEAD build\.
Show usage of \fIformula\fR by HEAD builds\.
.
.SS "\fB\-\-cache\fR [\fIoptions\fR] [\fIformula\fR]"
Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\.
@ -756,7 +744,7 @@ Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB$(brew \-\-prefix)/Cellar\fR
If \fIformula\fR is provided, display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned directory as the last path\.
.
.SS "\fB\-\-env\fR [\fIoptions\fR]"
Show a summary of the Homebrew build environment as a plain list\.
Summarize Homebrew\'s build environment as a plain list\.
.
.P
If the command\'s output is sent through a pipe and no shell is specified, the list is formatted for export to \fBbash\fR(1) unless \fB\-\-plain\fR is passed\.
@ -767,7 +755,7 @@ Generate a list of environment variables for the specified shell, or \fB\-\-shel
.
.TP
\fB\-\-plain\fR
Plain output even when piped\.
Generate plain output even when piped\.
.
.SS "\fB\-\-prefix\fR [\fIformula\fR]"
Display Homebrew\'s install path\. \fIDefault:\fR \fB/usr/local\fR on macOS and \fB/home/linuxbrew/\.linuxbrew\fR on Linux\.
@ -775,19 +763,19 @@ Display Homebrew\'s install path\. \fIDefault:\fR \fB/usr/local\fR on macOS and
.P
If \fIformula\fR is provided, display the location in the cellar where \fIformula\fR is or would be installed\.
.
.SS "\fB\-\-repository\fR [\fIuser\fR\fB/\fR\fIrepo\fR]"
.SS "\fB\-\-repository\fR, \fB\-\-repo\fR [\fIuser\fR\fB/\fR\fIrepo\fR]"
Display where Homebrew\'s \fB\.git\fR directory is located\.
.
.P
If \fIuser\fR\fB/\fR\fIrepo\fR are provided, display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\.
.
.SS "\fB\-\-version\fR"
Print the version number of Homebrew, Homebrew/homebrew\-core and Homebrew/homebrew\-cask (if tapped) to standard output and exit\.
Print the version numbers of Homebrew, Homebrew/homebrew\-core and Homebrew/homebrew\-cask (if tapped) to standard output\.
.
.SH "DEVELOPER COMMANDS"
.
.SS "\fBaudit\fR [\fIoptions\fR] \fIformula\fR"
Check \fIformula\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. Will exit with a non\-zero status if any errors are found, which can be useful for implementing pre\-commit hooks\. If no \fIformula\fR are provided, all of them are checked\.
.SS "\fBaudit\fR [\fIoptions\fR] [\fIformula\fR]"
Check \fIformula\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. If no \fIformula\fR are provided, check all locally available formulae\. Will exit with a non\-zero status if any errors are found, which can be useful for implementing pre\-commit hooks\.
.
.TP
\fB\-\-strict\fR
@ -811,7 +799,7 @@ Include the RuboCop cop name for each violation in the output\.
.
.TP
\fB\-\-display\-filename\fR
Prefix every line of output with name of the file or formula being audited, to make output easy to grep\.
Prefix every line of output with the file or formula name being audited, to make output easy to grep\.
.
.TP
\fB\-D\fR, \fB\-\-audit\-debug\fR
@ -858,15 +846,15 @@ If the formula specifies a rebuild version, attempt to preserve its value in the
.
.TP
\fB\-\-json\fR
Write bottle information to a JSON file, which can be used as the argument for \fB\-\-merge\fR\.
Write bottle information to a JSON file, which can be used as the value for \fB\-\-merge\fR\.
.
.TP
\fB\-\-merge\fR
Generate an updated bottle block for a formula and optionally merge it into the formula file\. Instead of a formula name, requires a JSON file generated with \fBbrew bottle \-\-json\fR \fIformula\fR\.
Generate an updated bottle block for a formula and optionally merge it into the formula file\. Instead of a formula name, requires the path to a JSON file generated with \fBbrew bottle \-\-json\fR \fIformula\fR\.
.
.TP
\fB\-\-write\fR
Write the changes to the formula file\. A new commit will be generated unless \fB\-\-no\-commit\fR is passed\.
Write changes to the formula file\. A new commit will be generated unless \fB\-\-no\-commit\fR is passed\.
.
.TP
\fB\-\-no\-commit\fR
@ -877,7 +865,7 @@ When passed with \fB\-\-write\fR, a new commit will not generated after writing
Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\.
.
.SS "\fBbump\-formula\-pr\fR [\fIoptions\fR] [\fIformula\fR]"
Create a pull request to update a formula with a new URL or a new tag\.
Create a pull request to update \fIformula\fR with a new URL or a new tag\.
.
.P
If a \fIURL\fR is specified, the \fISHA\-256\fR checksum of the new download should also be specified\. A best effort to determine the \fISHA\-256\fR and \fIformula\fR name will be made if either or both values are not supplied by the user\.
@ -886,7 +874,7 @@ If a \fIURL\fR is specified, the \fISHA\-256\fR checksum of the new download sho
If a \fItag\fR is specified, the Git commit \fIrevision\fR corresponding to that tag must also be specified\.
.
.P
\fINote:\fR this command cannot be used to transition a formula from a URL\-and\-SHA\-256 style specification into a tag\-and\-revision style specification, nor vice versa\. It must use whichever style specification the preexisting formula already uses\.
\fINote:\fR this command cannot be used to transition a formula from a URL\-and\-SHA\-256 style specification into a tag\-and\-revision style specification, nor vice versa\. It must use whichever style specification the formula already uses\.
.
.TP
\fB\-\-devel\fR
@ -914,15 +902,15 @@ Print the pull request URL instead of opening in a browser\.
.
.TP
\fB\-\-mirror\fR
Use the provided \fIURL\fR as a mirror URL\.
Use the specified \fIURL\fR as a mirror URL\.
.
.TP
\fB\-\-version\fR
Use the provided \fIversion\fR to override the value parsed from the URL or tag\. Note that \fB\-\-version=0\fR can be used to delete an existing version override from a formula if it has become redundant\.
Use the specified \fIversion\fR to override the value parsed from the URL or tag\. Note that \fB\-\-version=0\fR can be used to delete an existing version override from a formula if it has become redundant\.
.
.TP
\fB\-\-message\fR
Append the provided \fImessage\fR to the default PR message\.
Append \fImessage\fR to the default pull request message\.
.
.TP
\fB\-\-url\fR
@ -938,10 +926,10 @@ Specify the new git commit \fItag\fR for the formula\.
.
.TP
\fB\-\-revision\fR
Specify the new git commit \fIrevision\fR corresponding to a specified \fItag\fR\.
Specify the new git commit \fIrevision\fR corresponding to the specified \fItag\fR\.
.
.SS "\fBbump\-revision\fR [\fIoptions\fR] [\fIformula\fR]"
Create a commit to increment the revision of the formula\. If no revision is present, "revision 1" will be added\.
.SS "\fBbump\-revision\fR [\fIoptions\fR] \fIformula\fR"
Create a commit to increment the revision of \fIformula\fR\. If no revision is present, "revision 1" will be added\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
@ -949,7 +937,7 @@ Print what would be done rather than doing it\.
.
.TP
\fB\-\-message\fR
Append the provided \fImessage\fR to the default commit message\.
Append \fImessage\fR to the default commit message\.
.
.SS "\fBcreate\fR [\fIoptions\fR] \fIURL\fR"
Generate a formula for the downloadable file at \fIURL\fR and open it in the editor\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The \fBwget\fR formula serves as a simple example\. For the complete API, see: \fIhttp://www\.rubydoc\.info/github/Homebrew/brew/master/Formula\fR
@ -968,7 +956,7 @@ Create a basic template for a Meson\-style build\.
.
.TP
\fB\-\-no\-fetch\fR
Homebrew will not download \fIURL\fR to the cache and will thus not add the SHA\-256 to the formula for you, nor will it check the GitHub API for GitHub projects (to fill out its description and homepage)\.
Homebrew will not download \fIURL\fR to the cache and will thus not add its SHA\-256 to the formula for you, nor will it check the GitHub API for GitHub projects (to fill out its description and homepage)\.
.
.TP
\fB\-\-HEAD\fR
@ -976,28 +964,28 @@ Indicate that \fIURL\fR points to the package\'s repository rather than a file\.
.
.TP
\fB\-\-set\-name\fR
Set the name of the new formula to the provided \fIname\fR\.
Explicitly set the \fIname\fR of the new formula\.
.
.TP
\fB\-\-set\-version\fR
Set the version of the new formula to the provided \fIversion\fR\.
Explicitly set the \fIversion\fR of the new formula\.
.
.TP
\fB\-\-tap\fR
Generate the new formula in the provided tap, specified as \fIuser\fR\fB/\fR\fIrepo\fR\.
Generate the new formula within the given tap, specified as \fIuser\fR\fB/\fR\fIrepo\fR\.
.
.SS "\fBedit\fR [\fIformula\fR]"
Open a formula in the editor set by \fBEDITOR\fR or \fBHOMEBREW_EDITOR\fR, or open the Homebrew repository for editing if no \fIformula\fR is provided\.
Open \fIformula\fR in the editor set by \fBEDITOR\fR or \fBHOMEBREW_EDITOR\fR, or open the Homebrew repository for editing if no formula is provided\.
.
.SS "\fBextract\fR [\fIoptions\fR] \fIformula\fR \fItap\fR"
Look through repository history to find the most recent version of \fIformula\fR and create a copy in \fItap\fR\fB/Formula/\fR\fIformula\fR\fB@\fR\fIversion\fR\fB\.rb\fR\. If the tap is not installed yet, attempt to install/clone the tap before continuing\. To extract a \fIformula\fR from a tap that is not homebrew/core use \fIuser\fR/\fIrepo\fR/\fIformula\fR\.
Look through repository history to find the most recent version of \fIformula\fR and create a copy in \fItap\fR\fB/Formula/\fR\fIformula\fR\fB@\fR\fIversion\fR\fB\.rb\fR\. If the tap is not installed yet, attempt to install/clone the tap before continuing\. To extract a formula from a tap that is not \fBhomebrew/core\fR use its fully\-qualified form of \fIuser\fR\fB/\fR\fIrepo\fR\fB/\fR\fIformula\fR\.
.
.TP
\fB\-\-version\fR
Extract the provided \fIversion\fR of \fIformula\fR instead of the most recent\.
Extract the specified \fIversion\fR of \fIformula\fR instead of the most recent\.
.
.SS "\fBformula\fR \fIformula\fR"
Display the path where a formula is located\.
Display the path where \fIformula\fR is located\.
.
.SS "\fBirb\fR [\fIoptions\fR]"
Enter the interactive Homebrew Ruby shell\.
@ -1011,11 +999,11 @@ Show several examples\.
Use Pry instead of IRB\. Implied if \fBHOMEBREW_PRY\fR is set\.
.
.SS "\fBlinkage\fR [\fIoptions\fR] [\fIformula\fR]"
Check the library links for kegs of installed formulae\. Raises an error if run on uninstalled formulae\.
Check the library links from the given \fIformula\fR kegs\. If no \fIformula\fR are provided, check all kegs\. Raises an error if run on uninstalled formulae\.
.
.TP
\fB\-\-test\fR
Display only missing libraries and exit with a non\-zero status if any missing libraries are found\.
Show only missing libraries and exit with a non\-zero status if any missing libraries are found\.
.
.TP
\fB\-\-reverse\fR
@ -1030,20 +1018,20 @@ Generate Homebrew\'s manpages\.
.
.TP
\fB\-\-fail\-if\-changed\fR
Return a failing status code if changes are detected in the manpage outputs\. This can be used for CI to be notified when the manpages are out of date\. Additionally, the date used in new manpages will match those in the existing manpages (to allow comparison without factoring in the date)\.
Return a failing status code if changes are detected in the manpage outputs\. This can be used to notify CI when the manpages are out of date\. Additionally, the date used in new manpages will match those in the existing manpages (to allow comparison without factoring in the date)\.
.
.TP
\fB\-\-link\fR
This is now done automatically by \fBbrew update\fR\.
.
.SS "\fBprof\fR \fIcommand\fR"
Run Homebrew with the Ruby profiler e\.g\. \fBbrew prof readall\fR\.
Run Homebrew with the Ruby profiler, e\.g\. \fBbrew prof readall\fR\.
.
.SS "\fBpull\fR [\fIoptions\fR] \fIpatch\fR"
Get a patch from a GitHub commit or pull request and apply it to Homebrew\. Optionally, publish updated bottles for the formulae changed by the patch\.
Get a patch from a GitHub commit or pull request and apply it to Homebrew\. Optionally, publish updated bottles for any formulae changed by the patch\.
.
.P
Each \fIpatch\fR may be the number of a PR in \fBhomebrew/core\fR, the URL of a PR on GitHub, the URL of a commit on GitHub or a "https://jenkins\.brew\.sh/job/\.\.\." testing job URL\.
Each \fIpatch\fR may be the number of a pull request in \fBhomebrew/core\fR, the URL of any pull request or commit on GitHub or a "https://jenkins\.brew\.sh/job/\.\.\." testing job URL\.
.
.TP
\fB\-\-bottle\fR
@ -1083,11 +1071,11 @@ Do not exit if there\'s a failure publishing bottles on Bintray\.
.
.TP
\fB\-\-bintray\-org\fR
Publish bottles at the provided Bintray \fIorganisation\fR\.
Publish bottles to the specified Bintray \fIorganisation\fR\.
.
.TP
\fB\-\-test\-bot\-user\fR
Pull the bottle block commit from the provided \fIuser\fR on GitHub\.
Pull the bottle block commit from the specified \fIuser\fR on GitHub\.
.
.SS "\fBrelease\-notes\fR [\fIoptions\fR] [\fIprevious_tag\fR] [\fIend_ref\fR]"
Print the merged pull requests on Homebrew/brew between two Git refs\. If no \fIprevious_tag\fR is provided it defaults to the latest tag\. If no \fIend_ref\fR is provided it defaults to \fBorigin/master\fR\.
@ -1096,12 +1084,12 @@ Print the merged pull requests on Homebrew/brew between two Git refs\. If no \fI
\fB\-\-markdown\fR
Print as a Markdown list\.
.
.SS "\fBruby\fR [\fB\-e\fR]:"
Run a Ruby instance with Homebrew\'s libraries loaded e\.g\. \fBbrew ruby \-e "puts :gcc\.f\.deps"\fR or \fBbrew ruby script\.rb\fR
.SS "\fBruby\fR (\fB\-e\fR \fItext\fR|\fIfile\fR)"
Run a Ruby instance with Homebrew\'s libraries loaded, e\.g\. \fBbrew ruby \-e "puts :gcc\.f\.deps"\fR or \fBbrew ruby script\.rb\fR\.
.
.TP
\fB\-e\fR
Execute the provided string argument as a script\.
Execute the given text string as a script\.
.
.SS "\fBtap\-new\fR \fIuser\fR\fB/\fR\fIrepo\fR"
Generate the template files for a new tap\.
@ -1122,7 +1110,7 @@ Test the head version of a formula\.
.
.TP
\fB\-\-keep\-tmp\fR
Keep the temporary files created for the test\.
Retain the temporary files created for the test\.
.
.SS "\fBtests\fR [\fIoptions\fR]"
Run Homebrew\'s unit and integration tests\.
@ -1149,10 +1137,10 @@ Run only \fItest_script\fR\fB_spec\.rb\fR\. Appending \fB:\fR\fIline_number\fR w
.
.TP
\fB\-\-seed\fR
Randomise tests with the provided \fIvalue\fR instead of a random seed\.
Randomise tests with the specified \fIvalue\fR instead of a random seed\.
.
.SS "\fBupdate\-test\fR [\fIoptions\fR]"
Run a test of \fBbrew update\fR with a new repository clone\. If no arguments are passed, use \fBorigin/master\fR as the start commit\.
Run a test of \fBbrew update\fR with a new repository clone\. If no options are passed, use \fBorigin/master\fR as the start commit\.
.
.TP
\fB\-\-to\-tag\fR
@ -1164,11 +1152,11 @@ Retain the temporary directory containing the new repository clone\.
.
.TP
\fB\-\-commit\fR
Use provided \fIcommit\fR as the start commit\.
Use the specified \fIcommit\fR as the start commit\.
.
.TP
\fB\-\-before\fR
Use the commit at provided \fIdate\fR as the start commit\.
Use the commit at the specified \fIdate\fR as the start commit\.
.
.SS "\fBvendor\-gems\fR"
Install and commit Homebrew\'s vendored gems\.
@ -1202,7 +1190,7 @@ Bundler for non\-Ruby dependencies from Homebrew, Homebrew Cask and the Mac App
\fIhttps://github\.com/Homebrew/homebrew\-bundle\fR
.
.SS "\fBcask\fR \fIsubcommand\fR:"
Install macOS applications distributed as binaries\. See brew\-cask(1)\.
Install macOS applications distributed as binaries\. See \fBbrew\-cask\fR(1)\.
.
.P
\fBHomebrew/homebrew\-cask\fR
@ -1234,10 +1222,10 @@ Sometimes a formula from a tapped repository may conflict with one in \fBhomebre
.
.TP
An arbitrary file or URL
Homebrew can install formulae via URL, e\.g\. \fBhttps://raw\.githubusercontent\.com/Homebrew/homebrew\-core/master/Formula/git\.rb\fR, or from a local path\. It could point to either a formula file or a bottle\. In the case of a URL, the downloaded file will be cached for later use\.
Homebrew can install formulae via URL, e\.g\. \fBhttps://raw\.githubusercontent\.com/Homebrew/homebrew\-core/master/Formula/git\.rb\fR, or from a local path\. It can point to either a formula file or a bottle\. In the case of a URL, the downloaded file will be cached for later use\.
.
.SH "ENVIRONMENT"
Note that environment variables must have a value set to be detected\. For example, \fBexport HOMEBREW_NO_INSECURE_REDIRECT=1\fR rather than just \fBexport HOMEBREW_NO_INSECURE_REDIRECT\fR\.
Note that environment variables must have a value set to be detected\. For example, run \fBexport HOMEBREW_NO_INSECURE_REDIRECT=1\fR rather than just \fBexport HOMEBREW_NO_INSECURE_REDIRECT\fR\.
.
.TP
\fBHOMEBREW_ARCH\fR
@ -1275,7 +1263,7 @@ If set, instructs Homebrew to use the specified directory as the download cache\
.
.TP
\fBHOMEBREW_CURLRC\fR
If set, Homebrew will not pass \fB\-q\fR when invoking \fBcurl\fR(1) (which disables the use of \fBcurlrc\fR)\.
If set, Homebrew will not pass \fB\-q\fR when invoking \fBcurl\fR(1), which disables the use of \fBcurlrc\fR\.
.
.TP
\fBHOMEBREW_CURL_VERBOSE\fR
@ -1321,7 +1309,7 @@ If set, Homebrew will always use its vendored, relocatable Ruby version even if
.
.TP
\fBHOMEBREW_FORCE_BREWED_GIT\fR
If set, Homebrew will always use a Homebrew\-installed \fBgit\fR rather than the system version\. Automatically set if the system version of \fBgit\fR is too old\.
If set, Homebrew will 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_GITHUB_API_TOKEN\fR
@ -1467,6 +1455,9 @@ export http_proxy=http://$USER:$PASSWORD@$HOST:$PORT
Homebrew Documentation: \fIhttps://docs\.brew\.sh\fR
.
.P
Homebrew API: \fIhttps://rubydoc\.brew\.sh\fR
.
.P
\fBbrew\-cask\fR(1), \fBgit\fR(1), \fBgit\-log\fR(1)
.
.SH "AUTHORS"