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

manpages: sentence rewording for readability

Browse Source 
Use active voice when applicable, better verbs & adjectives, preposition usage, proper tense, etc.
This commit is contained in:
EricFromCanada 2019-08-20 00:04:14 -04:00
parent b4303cd983
commit 8a8359cdd4
47 changed files with 131 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -13,7 +13,7 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`--env` [<options>] `--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, 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. the list is formatted for export to `bash`(1) unless `--plain` is passed.
@ -22,7 +22,7 @@ module Homebrew
description: "Generate a list of environment variables for the specified shell, " \ description: "Generate a list of environment variables for the specified shell, " \
"or `--shell=auto` to detect the current shell." "or `--shell=auto` to detect the current shell."
switch "--plain", switch "--plain",
description: "Plain output even when piped." description: "Generate plain output even when piped."
end end
end end

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

@ -11,7 +11,7 @@ module Homebrew
`--version` `--version`
Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask
(if tapped) to standard output and exit. (if tapped) to standard output.
EOS EOS
end end
end end

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

@ -12,7 +12,7 @@ module Homebrew
If `on` or `off` is passed, turn Homebrew's analytics on or off respectively. 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>. Read more at <https://docs.brew.sh/Analytics>.
If `regenerate-uuid` is passed, regenerate the UUID used in Homebrew's analytics. If `regenerate-uuid` is passed, regenerate the UUID used in Homebrew's analytics.

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

@ -11,9 +11,9 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`cleanup` [<options>] [<formula>|<cask>] `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, 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 EOS
flag "--prune=", flag "--prune=",
description: "Remove all cache files older than specified <days>." description: "Remove all cache files older than specified <days>."

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

@ -11,7 +11,7 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`command` <cmd> `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 EOS
switch :verbose switch :verbose
switch :debug switch :debug

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

@ -16,7 +16,7 @@ module Homebrew
description: "List only the names of commands without category headers." description: "List only the names of commands without category headers."
switch "--include-aliases", switch "--include-aliases",
depends_on: "--quiet", depends_on: "--quiet",
description: "Include the aliases of internal commands." description: "Include aliases of internal commands."
switch :verbose switch :verbose
switch :debug switch :debug
end end

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

@ -17,7 +17,7 @@ module Homebrew
show the intersection of dependencies for each formula. show the intersection of dependencies for each formula.
EOS EOS
switch "-n", switch "-n",
description: "Show dependencies in topological order." description: "Sort dependencies in topological order."
switch "--1", switch "--1",
description: "Only show dependencies one level down, instead of recursing." description: "Only show dependencies one level down, instead of recursing."
switch "--union", switch "--union",
@ -47,7 +47,7 @@ module Homebrew
description: "List dependencies for all available formulae." description: "List dependencies for all available formulae."
switch "--for-each", switch "--for-each",
description: "Switch into the mode used by the `--all` option, but only list dependencies "\ 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." "debugging the `--installed`/`--all` display mode."
switch :verbose switch :verbose
switch :debug switch :debug

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

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

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

@ -16,9 +16,9 @@ module Homebrew
the Cellar and then link it into Homebrew's prefix with `brew link`. the Cellar and then link it into Homebrew's prefix with `brew link`.
EOS EOS
flag "--name=", flag "--name=",
description: "Explicitly set the provided <name> of the package being installed." description: "Explicitly set the <name> of the package being installed."
flag "--version=", flag "--version=",
description: "Explicitly set the provided <version> of the package being installed." description: "Explicitly set the <version> of the package being installed."
switch :verbose switch :verbose
switch :debug switch :debug
end end

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

@ -11,7 +11,7 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`doctor` [<options>] `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 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 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 everything you use Homebrew for is working fine: please don't worry or file

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

@ -25,10 +25,10 @@ module Homebrew
description: "Do a verbose VCS checkout, if the URL represents a VCS. This is useful for "\ 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." "seeing if an existing VCS cache has been updated."
switch "--retry", switch "--retry",
description: "Retry if a download fails or re-download if the checksum of a previously cached "\ description: "Retry if downloading fails or re-download if the checksum of a previously cached "\
"version no longer matches." "version no longer matches."
switch "--deps", switch "--deps",
description: "Download dependencies for any listed <formula>." description: "Also download dependencies for any listed <formula>."
switch "-s", "--build-from-source", switch "-s", "--build-from-source",
description: "Download source packages rather than a bottle." description: "Download source packages rather than a bottle."
switch "--build-bottle", switch "--build-bottle",

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

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

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

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

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

@ -19,10 +19,10 @@ module Homebrew
Display brief statistics for your Homebrew installation. 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 EOS
switch "--analytics", 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` "\ "build error data for <formula> (provided neither `HOMEBREW_NO_ANALYTICS` "\
"nor `HOMEBREW_NO_GITHUB_API` are set)." "nor `HOMEBREW_NO_GITHUB_API` are set)."
flag "--days", flag "--days",
@ -35,7 +35,7 @@ module Homebrew
"The value for <category> must be `install`, `install-on-request`, "\ "The value for <category> must be `install`, `install-on-request`, "\
"`cask-install`, `build-error` or `os-version`. The default is `install`." "`cask-install`, `build-error` or `os-version`. The default is `install`."
switch "--github", 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>" "To view formula history locally: `brew log -p` <formula>"
flag "--json", flag "--json",
description: "Print a JSON representation of <formula>. Currently the default and only accepted "\ description: "Print a JSON representation of <formula>. Currently the default and only accepted "\

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

@ -20,7 +20,7 @@ module Homebrew
Install <formula>. Additional options specific to <formula> may be appended to the command. Install <formula>. Additional options specific to <formula> may be appended to the command.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the
installed formulae or, every 30 days, for all formulae. installed formulae or, every 30 days, for all formulae.
EOS EOS
switch :debug, switch :debug,
@ -37,16 +37,16 @@ module Homebrew
"using this flag." "using this flag."
switch "--only-dependencies", switch "--only-dependencies",
description: "Install the dependencies with specified options but do not install the "\ description: "Install the dependencies with specified options but do not install the "\
"specified formula." "formula itself."
flag "--cc=", flag "--cc=",
description: "Attempt to compile using provided <compiler>. <compiler> should be the "\ description: "Attempt to compile using the specified <compiler>, which should be the "\
"name of the compiler's executable, for instance `gcc-7` for GCC 7. "\ "name of the compiler's executable, e.g. `gcc-7` for GCC 7. "\
"In order to use LLVM's clang, use `llvm_clang`. To specify the "\ "In order to use LLVM's clang, specify `llvm_clang`. To use the "\
"Apple-provided clang, use `clang`. This option will only accept "\ "Apple-provided clang, specify `clang`. This option will only accept "\
"compilers that are provided by Homebrew or bundled with macOS. "\ "compilers that are provided by Homebrew or bundled with macOS. "\
"Please do not file issues if you encounter errors while using this option." "Please do not file issues if you encounter errors while using this option."
switch "-s", "--build-from-source", 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." "Dependencies will still be installed from bottles if they are available."
switch "--force-bottle", switch "--force-bottle",
description: "Install from a bottle if it exists for the current or newest version of "\ description: "Install from a bottle if it exists for the current or newest version of "\
@ -59,16 +59,16 @@ module Homebrew
description: "If <formula> defines it, install the HEAD version, aka. master, trunk, unstable." description: "If <formula> defines it, install the HEAD version, aka. master, trunk, unstable."
switch "--fetch-HEAD", switch "--fetch-HEAD",
description: "Fetch the upstream repository to detect if the HEAD installation of the "\ 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." "updates when a new stable or development version has been released."
switch "--keep-tmp", switch "--keep-tmp",
description: "Don't delete the temporary files created during installation." description: "Retain the temporary files created during installation."
switch "--build-bottle", switch "--build-bottle",
description: "Prepare the formula for eventual bottling during installation, skipping any "\ description: "Prepare the formula for eventual bottling during installation, skipping any "\
"post-install steps." "post-install steps."
flag "--bottle-arch=", flag "--bottle-arch=",
depends_on: "--build-bottle", depends_on: "--build-bottle",
description: "Optimise bottles for the given architecture rather than the oldest "\ description: "Optimise bottles for the specified architecture rather than the oldest "\
"architecture supported by the version of macOS the bottles are built on." "architecture supported by the version of macOS the bottles are built on."
switch :force, switch :force,
description: "Install without checking for previously installed keg-only or "\ description: "Install without checking for previously installed keg-only or "\

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

@ -12,15 +12,15 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`link`, `ln` [<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 is done automatically when you install formulae but can be useful for DIY
installations. installations.
EOS EOS
switch "--overwrite", 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", switch "-n", "--dry-run",
description: "List all files which would be linked or deleted by "\ description: "List files which would be linked or deleted by "\
"`brew link --overwrite`, but will not actually link or delete any files." "`brew link --overwrite` without actually linking or deleting any files."
switch :force, switch :force,
description: "Allow keg-only formulae to be linked." description: "Allow keg-only formulae to be linked."
switch :verbose switch :verbose

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

@ -21,27 +21,27 @@ module Homebrew
"passed, other options (i.e. `-1`, `-l`, `-r` and `-t`) are passed to `ls`(1) "\ "passed, other options (i.e. `-1`, `-l`, `-r` and `-t`) are passed to `ls`(1) "\
"which produces the actual output." "which produces the actual output."
switch "--unbrewed", 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", switch "--versions",
description: "Show the version number for installed formulae, or only the specified "\ description: "Show the version number for installed formulae, or only the specified "\
"formulae if <formula> are given." "formulae if <formula> are provided."
switch "--multiple", switch "--multiple",
depends_on: "--versions", depends_on: "--versions",
description: "Only show formulae with multiple versions installed." description: "Only show formulae with multiple versions installed."
switch "--pinned", switch "--pinned",
description: "Show the versions of pinned formulae, or only the specified (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 # passed through to ls
switch "-1", switch "-1",
description: "Force output to be one entry per line. " \ description: "Force output to be one entry per line. " \
"This is the default when output is not to a terminal." "This is the default when output is not to a terminal."
switch "-l", switch "-l",
description: "List in long format. If the output is to a terminal, "\ 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", 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", switch "-t",
description: "Sort by time modified (most recently modified first)." description: "Sort by time modified, listing most recently modified first."
switch :verbose switch :verbose
switch :debug switch :debug
end end

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

@ -15,11 +15,11 @@ module Homebrew
if no formula is provided. if no formula is provided.
EOS EOS
switch "-p", "-u", "--patch", switch "-p", "-u", "--patch",
description: "Also output patch from commit." description: "Also print patch from commit."
switch "--stat", switch "--stat",
description: "Also output diffstat from commit." description: "Also print diffstat from commit."
switch "--oneline", switch "--oneline",
description: "Output only one line per commit." description: "Print only one line per commit."
flag "-1", "--max-count", flag "-1", "--max-count",
description: "Print only one or a specified number of commits." description: "Print only one or a specified number of commits."
end end

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

@ -15,7 +15,7 @@ module Homebrew
packages. packages.
EOS EOS
switch :force, switch :force,
description: "Treat installed <formula> and passed <formula> as if they are from "\ description: "Treat installed <formula> and provided <formula> as if they are from "\
"the same taps and migrate them anyway." "the same taps and migrate them anyway."
switch :verbose switch :verbose
switch :debug switch :debug

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

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

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

@ -12,12 +12,12 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`options` [<options>] [<formula>] `options` [<options>] [<formula>]
Display install options specific to <formula>. Show install options specific to <formula>.
EOS EOS
switch "--compact", switch "--compact",
description: "Show all options on a single line separated by spaces." description: "Show all options on a single line separated by spaces."
switch "--installed", switch "--installed",
description: "Show options for all installed formulae." description: "Show options for formulae that are currently installed."
switch "--all", switch "--all",
description: "Show options for all available formulae." description: "Show options for all available formulae."
switch :debug switch :debug

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

@ -12,22 +12,20 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`outdated` [<options>] `outdated` [<options>]
List formulae that have an updated version available. List installed formulae that have an updated version available. By default, version
information is displayed in interactive shells, and suppressed otherwise.
By default, version information is displayed in interactive shells, and
suppressed otherwise.
EOS EOS
switch :quiet, 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, switch :verbose,
description: "Display detailed version information." description: "Include detailed version information."
flag "--json", flag "--json",
description: "Print output in JSON format. Currently the default and only accepted "\ 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 "\ "value for <version> is `v1`. See the docs for examples of using the JSON "\
"output: <https://docs.brew.sh/Querying-Brew>" "output: <https://docs.brew.sh/Querying-Brew>"
switch "--fetch-HEAD", switch "--fetch-HEAD",
description: "Fetch the upstream repository to detect if the HEAD installation of the "\ 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." "updates when a new stable or development version has been released."
switch :debug switch :debug
conflicts "--quiet", "--verbose", "--json" conflicts "--quiet", "--verbose", "--json"

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

@ -11,7 +11,7 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`readall` [<options>] [<tap>] `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 This can be useful for debugging issues across all formulae when making
significant changes to `formula.rb`, testing the performance of loading significant changes to `formula.rb`, testing the performance of loading
all formulae or to determine if any current formulae have Ruby issues. all formulae or to determine if any current formulae have Ruby issues.

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

@ -15,9 +15,10 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`reinstall` [<options>] <formula> `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 Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the
reinstalled formulae or, every 30 days, for all formulae. reinstalled formulae or, every 30 days, for all formulae.
EOS EOS
switch :debug, switch :debug,
@ -29,7 +30,7 @@ module Homebrew
description: "Install from a bottle if it exists for the current or newest version of "\ 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." "macOS, even if it would not normally be used for installation."
switch "--keep-tmp", switch "--keep-tmp",
description: "Don't delete the temporary files created during installation." description: "Retain the temporary files created during installation."
switch :force, switch :force,
description: "Install without checking for previously installed keg-only or "\ description: "Install without checking for previously installed keg-only or "\
"non-migrated versions." "non-migrated versions."

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

@ -30,14 +30,14 @@ module Homebrew
`search` [<options>] [<text>|`/`<text>`/`] `search` [<options>] [<text>|`/`<text>`/`]
Perform a substring search of cask tokens and formula names for <text>. If <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`. 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. No online search is performed.
EOS EOS
switch "--casks", 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." "No online search is performed."
switch "--desc", switch "--desc",
description: "Search for formulae with a description matching <text> and casks with "\ description: "Search for formulae with a description matching <text> and casks with "\

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

@ -16,7 +16,7 @@ module Homebrew
Homebrew build logic to help your `./configure && make && make install` Homebrew build logic to help your `./configure && make && make install`
or even your `gem install` succeed. Especially handy if you run Homebrew 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` 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 EOS
flag "--env=", flag "--env=",
description: "Use the standard `PATH` instead of superenv's when `std` is passed." description: "Use the standard `PATH` instead of superenv's when `std` is passed."

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

@ -1,10 +1,9 @@
#: * `shellenv` #: * `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 evaluation of this command's output to your dotfiles (e.g. `~/.profile`) with: `eval $(brew shellenv)`
#: Consider adding evaluating the output in your dotfiles (e.g. `~/.profile`) with `eval $(brew shellenv)`
homebrew-shellenv() { homebrew-shellenv() {
case "$SHELL" in case "$SHELL" in

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

@ -10,11 +10,12 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`tap-info` [<options>] [<tap>] `tap-info` [<options>] [<tap>]
Display detailed information about one or more provided <tap>. Show detailed information about one or more <tap>s.
Display a brief summary of all installed taps if no <tap> are passed.
If no <tap> names are provided, display brief statistics for all installed taps.
EOS EOS
switch "--installed", switch "--installed",
description: "Display information on all installed taps." description: "Show information on each installed tap."
flag "--json", flag "--json",
description: "Print a JSON representation of <tap>. Currently the default and only accepted "\ 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 "\ "value for <version> is `v1`. See the docs for examples of using the JSON "\

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

@ -12,7 +12,7 @@ module Homebrew
Tap a formula repository. 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, tap 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 Since so many taps are hosted on GitHub, this command is a shortcut for

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

@ -11,13 +11,13 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`unlink` [<options>] <formula> `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: for temporarily disabling a formula:
`brew unlink` <formula> `&&` <commands> `&& brew link` <formula> `brew unlink` <formula> `&&` <commands> `&& brew link` <formula>
EOS EOS
switch "-n", "--dry-run", switch "-n", "--dry-run",
description: "List all files which would be unlinked, but will not actually unlink or "\ description: "List files which would be unlinked without actually unlinking or "\
"delete any files." "deleting any files."
switch :verbose switch :verbose
switch :debug switch :debug
end end

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

@ -2,7 +2,7 @@
#: #:
#: Fetch the newest version of Homebrew and all formulae from GitHub using `git`(1) and perform any necessary migrations. #: 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). #: -f, --force Always do a slower, full update check (even if unnecessary).
#: -v, --verbose Print the directories checked and `git` operations performed. #: -v, --verbose Print the directories checked and `git` operations performed.
#: -d, --debug Display a trace of all shell commands as they are executed. #: -d, --debug Display a trace of all shell commands as they are executed.

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

@ -16,12 +16,11 @@ module Homebrew
usage_banner <<~EOS 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 Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the
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. upgraded formulae or, every 30 days, for all formulae.
EOS EOS
switch :debug, switch :debug,
@ -34,12 +33,12 @@ module Homebrew
"macOS, even if it would not normally be used for installation." "macOS, even if it would not normally be used for installation."
switch "--fetch-HEAD", switch "--fetch-HEAD",
description: "Fetch the upstream repository to detect if the HEAD installation of the "\ 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." "updates when a new stable or development version has been released."
switch "--ignore-pinned", 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", switch "--keep-tmp",
description: "Don't delete the temporary files created during installation." description: "Retain the temporary files created during installation."
switch :force, switch :force,
description: "Install without checking for previously installed keg-only or "\ description: "Install without checking for previously installed keg-only or "\
"non-migrated versions." "non-migrated versions."

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

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

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

@ -21,9 +21,9 @@ module Homebrew
`audit` [<options>] [<formula>] `audit` [<options>] [<formula>]
Check <formula> for Homebrew coding style violations. This should be run before 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. found, which can be useful for implementing pre-commit hooks.
If no <formula> are provided, all of them are checked.
EOS EOS
switch "--strict", switch "--strict",
description: "Run additional style checks, including RuboCop style checks." description: "Run additional style checks, including RuboCop style checks."

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

@ -72,7 +72,7 @@ module Homebrew
"`brew bottle --json` <formula>." "`brew bottle --json` <formula>."
switch "--write", switch "--write",
depends_on: "--merge", 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." "`--no-commit` is passed."
switch "--no-commit", switch "--no-commit",
depends_on: "--write", depends_on: "--write",

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

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

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

@ -17,7 +17,7 @@ module Homebrew
switch "-n", "--dry-run", switch "-n", "--dry-run",
description: "Print what would be done rather than doing it." description: "Print what would be done rather than doing it."
flag "--message=", flag "--message=",
description: "Append the provided <message> to the default commit message." description: "Append <message> to the default commit message."
switch :force switch :force
switch :quiet switch :quiet
switch :verbose switch :verbose

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

@ -26,17 +26,17 @@ module Homebrew
switch "--meson", switch "--meson",
description: "Create a basic template for a Meson-style build." description: "Create a basic template for a Meson-style build."
switch "--no-fetch", 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 the formula for you, nor will it check the GitHub API for GitHub projects "\
"(to fill out its description and homepage)." "(to fill out its description and homepage)."
switch "--HEAD", switch "--HEAD",
description: "Indicate that <URL> points to the package's repository rather than a file." description: "Indicate that <URL> points to the package's repository rather than a file."
flag "--set-name=", 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=", 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=", 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 :force
switch :verbose switch :verbose
switch :debug switch :debug

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

@ -84,10 +84,11 @@ module Homebrew
Look through repository history to find the most recent version of <formula> and 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 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 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 EOS
flag "--version=", flag "--version=",
description: "Extract the provided <version> of <formula> instead of the most recent." description: "Extract the specified <version> of <formula> instead of the most recent."
switch :force switch :force
switch :debug switch :debug
end end

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

@ -13,10 +13,10 @@ module Homebrew
`linkage` [<options>] [<formula>] `linkage` [<options>] [<formula>]
Check the library links from the given <formula> kegs. If no <formula> are Check the library links from the given <formula> kegs. If no <formula> are
specified, check all kegs. Raises an error if run on uninstalled formulae. provided, check all kegs. Raises an error if run on uninstalled formulae.
EOS EOS
switch "--test", 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." "libraries are found."
switch "--reverse", switch "--reverse",
description: "For every library that a keg references, print its dylib path followed by the "\ 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 EOS
switch "--fail-if-changed", switch "--fail-if-changed",
description: "Return a failing status code if changes are detected in the manpage outputs. This "\ 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 "\ "the date used in new manpages will match those in the existing manpages (to allow "\
"comparison without factoring in the date)." "comparison without factoring in the date)."
switch "--link", switch "--link",

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

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

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

@ -14,7 +14,7 @@ module Homebrew
`brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`. `brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`.
EOS EOS
switch "-e", switch "-e",
description: "Execute the provided string argument as a script." description: "Execute the given text string as a script."
switch :verbose switch :verbose
switch :debug switch :debug
end end

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

@ -24,7 +24,7 @@ module Homebrew
switch "--HEAD", switch "--HEAD",
description: "Test the head version of a formula." description: "Test the head version of a formula."
switch "--keep-tmp", switch "--keep-tmp",
description: "Keep the temporary files created for the test." description: "Retain the temporary files created for the test."
switch :verbose switch :verbose
switch :debug switch :debug
conflicts "--devel", "--HEAD" 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 "\ description: "Run only <test_script>`_spec.rb`. Appending `:`<line_number> will start at a "\
"specific line." "specific line."
flag "--seed=", 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 :verbose
switch :debug switch :debug
end end

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

@ -18,9 +18,9 @@ module Homebrew
switch "--keep-tmp", switch "--keep-tmp",
description: "Retain the temporary directory containing the new repository clone." description: "Retain the temporary directory containing the new repository clone."
flag "--commit=", flag "--commit=",
description: "Use provided <commit> as the start commit." description: "Use the specified <commit> as the start commit."
flag "--before=", 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 :verbose
switch :debug switch :debug
end end

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

@ -27,7 +27,7 @@ didn't include with macOS.
For the full command list, see the [COMMANDS](#commands) section. For the full command list, see the [COMMANDS](#commands) section.
With `--verbose` or `--debug`, many commands print extra debugging information. Note that With `--verbose` or `--debug`, many commands print extra debugging information. Note that
these flags should only appear after a command. these options should only appear after a command.
### `install` <formula>: ### `install` <formula>:
@ -47,9 +47,9 @@ List all installed formulae.
### `search` (<text>|`/`<text>`/`): ### `search` (<text>|`/`<text>`/`):
Perform a substring search of cask tokens and formula names for <text>. If <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`. 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 ## COMMANDS
@ -112,12 +112,12 @@ can take several different forms:
* An arbitrary file or URL: * An arbitrary file or URL:
Homebrew can install formulae via URL, e.g. Homebrew can install formulae via URL, e.g.
`https://raw.githubusercontent.com/Homebrew/homebrew-core/master/Formula/git.rb`, `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. In the case of a URL, the downloaded file will be cached for later use.
## ENVIRONMENT ## 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=1` rather than just
`export HOMEBREW_NO_INSECURE_REDIRECT`. `export HOMEBREW_NO_INSECURE_REDIRECT`.
@ -159,8 +159,8 @@ Note that environment variables must have a value set to be detected. For exampl
*Default:* `~/Library/Caches/Homebrew`. *Default:* `~/Library/Caches/Homebrew`.
* `HOMEBREW_CURLRC`: * `HOMEBREW_CURLRC`:
If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables If set, Homebrew will not pass `-q` when invoking `curl`(1), which disables
the use of `curlrc`). the use of `curlrc`.
* `HOMEBREW_CURL_VERBOSE`: * `HOMEBREW_CURL_VERBOSE`:
If set, Homebrew will pass `--verbose` when invoking `curl`(1). If set, Homebrew will pass `--verbose` when invoking `curl`(1).