cmd: remove --help headers and tweak docs.
This commit is contained in:
Mike McQuaid
parent
96c1dffb71
commit
6cb7a00f2d
@ -1,13 +1,3 @@
|
||||
#: * `analytics` [`state`]:
|
||||
#: Display anonymous user behaviour analytics state.
|
||||
#: Read more at <https://docs.brew.sh/Analytics>.
|
||||
#:
|
||||
#: * `analytics` (`on`|`off`):
|
||||
#: Turn on/off Homebrew's analytics.
|
||||
#:
|
||||
#: * `analytics` `regenerate-uuid`:
|
||||
#: Regenerate UUID used in Homebrew's analytics.
|
||||
|
||||
require "cli_parser"
|
||||
|
||||
module Homebrew
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
#: * `cat` <formula>:
|
||||
#: Display the source to <formula>.
|
||||
|
||||
require "cli_parser"
|
||||
|
||||
module Homebrew
|
||||
|
||||
@ -1,17 +1,3 @@
|
||||
#: * `cleanup` [`--prune=`<days>] [`--dry-run`] [`-s`] [<formulae>|<casks>]:
|
||||
#: 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.
|
||||
#:
|
||||
#: If `--prune=`<days> is specified, remove all cache files older than <days>.
|
||||
#:
|
||||
#: If `--dry-run` or `-n` is passed, show what would be removed, but do not
|
||||
#: actually remove anything.
|
||||
#:
|
||||
#: If `-s` is passed, scrub the cache, including downloads for even the latest
|
||||
#: versions. Note downloads for any installed formula or cask will still not
|
||||
#: be deleted. If you want to delete those too: `rm -rf "$(brew --cache)"`
|
||||
|
||||
require "cleanup"
|
||||
require "cli_parser"
|
||||
|
||||
@ -21,8 +7,7 @@ module Homebrew
|
||||
def cleanup_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`cleanup` [<options>] [<formulae>|<casks>]
|
||||
|
||||
`cleanup` [<options>] [<formula>|<cask>]
|
||||
|
||||
Remove stale lock files and outdated downloads for formulae and casks,
|
||||
and remove old versions of installed formulae. If arguments are specified,
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
#: * `command` <cmd>:
|
||||
#: Display the path to the file which is used when invoking `brew` <cmd>.
|
||||
|
||||
require "commands"
|
||||
require "cli_parser"
|
||||
|
||||
|
||||
@ -1,9 +1,3 @@
|
||||
#: * `commands` [`--quiet` [`--include-aliases`]]:
|
||||
#: Show a list of built-in and external commands.
|
||||
#:
|
||||
#: If `--quiet` is passed, list only the names of commands without the header.
|
||||
#: With `--include-aliases`, the aliases of internal commands will be included.
|
||||
|
||||
require "cli_parser"
|
||||
|
||||
module Homebrew
|
||||
|
||||
@ -1,8 +1,3 @@
|
||||
#: * `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.
|
||||
|
||||
require "system_config"
|
||||
require "cli_parser"
|
||||
|
||||
|
||||
@ -1,60 +1,3 @@
|
||||
#: * `deps` [`--1`] [`-n`] [`--union`] [`--full-name`] [`--installed`] [`--include-build`] [`--include-optional`] [`--skip-recommended`] [`--include-requirements`] <formula>:
|
||||
#: Show dependencies for <formula>. When given multiple formula arguments,
|
||||
#: show the intersection of dependencies for every formula.
|
||||
#:
|
||||
#: If `--1` is passed, only show dependencies one level down, instead of
|
||||
#: recursing.
|
||||
#:
|
||||
#: If `-n` is passed, show dependencies in topological order.
|
||||
#:
|
||||
#: If `--union` is passed, show the union of dependencies for <formula>,
|
||||
#: instead of the intersection.
|
||||
#:
|
||||
#: If `--full-name` is passed, list dependencies by their full name.
|
||||
#:
|
||||
#: If `--installed` is passed, only list those dependencies that are
|
||||
#: currently installed.
|
||||
#:
|
||||
#: By default, `deps` shows required and recommended dependencies for
|
||||
#: <formula>. To include the `:build` type dependencies, pass `--include-build`.
|
||||
#: Similarly, pass `--include-optional` to include `:optional` dependencies or
|
||||
#: `--include-test` to include (non-recursive) `:test` dependencies.
|
||||
#: To skip `:recommended` type dependencies, pass `--skip-recommended`.
|
||||
#: To include requirements in addition to dependencies, pass `--include-requirements`.
|
||||
#:
|
||||
#: * `deps` `--tree` [`--1`] [<filters>] [`--annotate`] (<formula>|`--installed`):
|
||||
#: Show dependencies as a tree. When given multiple formula arguments, output
|
||||
#: individual trees for every formula.
|
||||
#:
|
||||
#: If `--1` is passed, only one level of children is displayed.
|
||||
#:
|
||||
#: If `--installed` is passed, output a tree for every installed formula.
|
||||
#:
|
||||
#: The <filters> placeholder is any combination of options `--include-build`,
|
||||
#: `--include-optional`, `--include-test`, `--skip-recommended`, and
|
||||
#: `--include-requirements` as documented above.
|
||||
#:
|
||||
#: If `--annotate` is passed, the build, optional, and recommended dependencies
|
||||
#: are marked as such in the output.
|
||||
#:
|
||||
#: * `deps` [<filters>] (`--installed`|`--all`):
|
||||
#: Show dependencies for installed or all available formulae. Every line of
|
||||
#: output starts with the formula name, followed by a colon and all direct
|
||||
#: dependencies of that formula.
|
||||
#:
|
||||
#: The <filters> placeholder is any combination of options `--include-build`,
|
||||
#: `--include-optional`, `--include-test`, and `--skip-recommended` as
|
||||
#: documented above.
|
||||
#:
|
||||
#: Additional options specific to <formula> may be appended to the command,
|
||||
#: and can be listed with `brew options` <formula>.
|
||||
|
||||
# The undocumented `--for-each` option will switch into the mode used by `deps --all`,
|
||||
# but only list dependencies for specified formula, one specified formula per line.
|
||||
# This is used for debugging the `--installed`/`--all` display mode.
|
||||
|
||||
# encoding: UTF-8
|
||||
|
||||
require "formula"
|
||||
require "ostruct"
|
||||
require "cli_parser"
|
||||
@ -81,11 +24,11 @@ module Homebrew
|
||||
switch "--installed",
|
||||
description: "Only list those dependencies that are currently installed."
|
||||
switch "--all",
|
||||
description: "List all the dependencies for all available formuale."
|
||||
description: "List all the dependencies for all available formulae."
|
||||
switch "--include-build",
|
||||
description: "Show `:build` type dependencies for <formula>."
|
||||
switch "--include-optional",
|
||||
description: "Show `:optional` dependecies for <formula>."
|
||||
description: "Show `:optional` dependencies for <formula>."
|
||||
switch "--include-test",
|
||||
description: "Show `:test` dependencies for <formula> (non-recursive)."
|
||||
switch "--skip-recommended",
|
||||
|
||||
@ -1,13 +1,3 @@
|
||||
#: * `desc` <formula>:
|
||||
#: Display <formula>'s name and one-line description.
|
||||
#:
|
||||
#: * `desc` [`--search`|`--name`|`--description`] (<text>|`/`<text>`/`):
|
||||
#: Search both name and description (`--search` or `-s`), just the names
|
||||
#: (`--name` or `-n`), or just the descriptions (`--description` or `-d`) for
|
||||
#: <text>. If <text> is flanked by slashes, it is interpreted as a regular
|
||||
#: expression. Formula descriptions are cached; the cache is created on the
|
||||
#: first search, making that search slower than subsequent ones.
|
||||
|
||||
require "descriptions"
|
||||
require "search"
|
||||
require "description_cache_store"
|
||||
|
||||
@ -1,13 +1,3 @@
|
||||
#: * `diy` [`--name=`<name>] [`--version=`<version>]:
|
||||
#: 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 `brew link`.
|
||||
#:
|
||||
#: The options `--name=`<name> and `--version=`<version> each take an argument
|
||||
#: and allow you to explicitly set the name and version of the package you are
|
||||
#: installing.
|
||||
|
||||
require "formula"
|
||||
require "cli_parser"
|
||||
|
||||
|
||||
@ -1,14 +1,3 @@
|
||||
#: * `doctor`:
|
||||
#: 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.
|
||||
|
||||
# Undocumented options:
|
||||
# `-D` activates debugging and profiling of the audit methods (not the same as `--debug`)
|
||||
# `--list-checks` lists all audit methods
|
||||
|
||||
require "diagnostic"
|
||||
require "cli_parser"
|
||||
|
||||
@ -32,6 +21,10 @@ module Homebrew
|
||||
description: "Enable debugging and profiling of audit methods."
|
||||
switch :verbose
|
||||
switch :debug
|
||||
|
||||
# Undocumented options:
|
||||
# `-D` activates debugging and profiling of the doctor methods (not the same as `--debug`)
|
||||
# `--list-checks` lists all doctor methods
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@ -1,27 +1,3 @@
|
||||
#: * `fetch` [`--force`] [`--retry`] [`-v`] [`--devel`|`--HEAD`] [`--deps`] [`--build-from-source`|`--force-bottle`] <formulae>:
|
||||
#: Download the source packages for the given <formulae>.
|
||||
#: For tarballs, also print SHA-256 checksums.
|
||||
#:
|
||||
#: If `--HEAD` or `--devel` is passed, fetch that version instead of the
|
||||
#: stable version.
|
||||
#:
|
||||
#: If `-v` is passed, do a verbose VCS checkout, if the URL represents a VCS.
|
||||
#: This is useful for seeing if an existing VCS cache has been updated.
|
||||
#:
|
||||
#: If `--force` (or `-f`) is passed, remove a previously cached version and re-fetch.
|
||||
#:
|
||||
#: If `--retry` is passed, retry if a download fails or re-download if the
|
||||
#: checksum of a previously cached version no longer matches.
|
||||
#:
|
||||
#: If `--deps` is passed, also download dependencies for any listed <formulae>.
|
||||
#:
|
||||
#: If `--build-from-source` (or `-s`) or `--build-bottle` is passed, download the
|
||||
#: source rather than a bottle.
|
||||
#:
|
||||
#: If `--force-bottle` is passed, download a bottle if it exists for the
|
||||
#: current or newest version of macOS, even if it would not be used during
|
||||
#: installation.
|
||||
|
||||
require "formula"
|
||||
require "fetch"
|
||||
require "cli_parser"
|
||||
@ -32,15 +8,15 @@ module Homebrew
|
||||
def fetch_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`fetch` [<options>] <formulae>
|
||||
`fetch` [<options>] <formula>
|
||||
|
||||
Download the source packages for the given <formulae>.
|
||||
Download the source packages for the given <formula>.
|
||||
For tarballs, also print SHA-256 checksums.
|
||||
EOS
|
||||
switch "--HEAD",
|
||||
description: "Fetch HEAD version instead of stable version."
|
||||
switch "--devel",
|
||||
description: "Fetch devel version instead of stable version."
|
||||
description: "Fetch development version instead of stable version."
|
||||
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."
|
||||
@ -50,7 +26,7 @@ module Homebrew
|
||||
description: "Retry if a download fails or re-download if the checksum of a previously cached "\
|
||||
"version no longer matches."
|
||||
switch "--deps",
|
||||
description: "Download dependencies for any listed <formulae>."
|
||||
description: "Download dependencies for any listed <formula>."
|
||||
switch "-s", "--build-from-source",
|
||||
description: "Download the source for rather than a bottle."
|
||||
switch "--build-bottle",
|
||||
|
||||
@ -1,19 +1,3 @@
|
||||
#: * `gist-logs` [`--new-issue`|`-n`] [`--private`|`-p`] <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 `--with-hostname` is passed, include the hostname in the Gist.
|
||||
#:
|
||||
#: If `--new-issue` is passed, automatically create a new issue in the appropriate
|
||||
#: GitHub repository as well as creating the Gist.
|
||||
#:
|
||||
#: If `--private` is passed, the Gist will be marked private and will not
|
||||
#: appear in listings but will be accessible with the link.
|
||||
#:
|
||||
#: If no logs are found, an error message is presented.
|
||||
|
||||
require "formula"
|
||||
require "install"
|
||||
require "system_config"
|
||||
@ -27,7 +11,7 @@ module Homebrew
|
||||
def gist_logs_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`gist-logs` [<options>] <formula>:
|
||||
`gist-logs` [<options>] <formula>
|
||||
|
||||
Upload logs for a failed build of <formula> to a new Gist.
|
||||
|
||||
|
||||
@ -1,9 +1,3 @@
|
||||
#: * `home`:
|
||||
#: Open Homebrew's own homepage in a browser.
|
||||
#:
|
||||
#: * `home` <formula>:
|
||||
#: Open <formula>'s homepage in a browser.
|
||||
|
||||
require "cli_parser"
|
||||
|
||||
module Homebrew
|
||||
|
||||
@ -1,39 +1,3 @@
|
||||
#: * `info`:
|
||||
#: Display brief statistics for your Homebrew installation.
|
||||
#:
|
||||
#: * `info` `--analytics` [`--days=`<days>] [`--category=`<category>]:
|
||||
#: Display Homebrew analytics data (provided neither `HOMEBREW_NO_ANALYTICS`
|
||||
#: or `HOMEBREW_NO_GITHUB_API` are set)
|
||||
#:
|
||||
#: The value for `days` must be `30`, `90` or `365`. The default is `30`.
|
||||
#:
|
||||
#: The value for `category` must be `install`, `install-on-request`,
|
||||
#: `build-error` or `os-version`. The default is `install`.
|
||||
#:
|
||||
#: * `info` <formula> [`--analytics`]:
|
||||
#: Display information about <formula> and analytics data (provided neither
|
||||
#: `HOMEBREW_NO_ANALYTICS` or `HOMEBREW_NO_GITHUB_API` are set)
|
||||
#:
|
||||
#: Pass `--verbose` to see more verbose analytics data.
|
||||
#:
|
||||
#: Pass `--analytics` to see only more verbose analytics data instead of
|
||||
#: formula information.
|
||||
#:
|
||||
#: * `info` `--github` <formula>:
|
||||
#: Open a browser to the GitHub History page for <formula>.
|
||||
#:
|
||||
#: To view formula history locally: `brew log -p` <formula>
|
||||
#:
|
||||
#: * `info` `--json[=`<version>] (`--all`|`--installed`|<formulae>):
|
||||
#: Print a JSON representation of <formulae>. Currently the default and
|
||||
#: only accepted value for <version> is `v1`.
|
||||
#:
|
||||
#: Pass `--all` to get information on all formulae, or `--installed` to get
|
||||
#: information on all installed formulae.
|
||||
#:
|
||||
#: See the docs for examples of using the JSON output:
|
||||
#: <https://docs.brew.sh/Querying-Brew>
|
||||
|
||||
require "missing_formula"
|
||||
require "caveats"
|
||||
require "cli_parser"
|
||||
@ -49,7 +13,7 @@ module Homebrew
|
||||
def info_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`info [<formulae>]`
|
||||
`info` [<formula>]
|
||||
|
||||
Display brief statistics for your Homebrew installation.
|
||||
EOS
|
||||
@ -67,7 +31,7 @@ module Homebrew
|
||||
description: "Open a browser to the GitHub History page for provided <formula>. "\
|
||||
"To view formula history locally: `brew log -p` <formula>"
|
||||
flag "--json",
|
||||
description: "Print a JSON representation of <formulae>. Currently the default and only accepted "\
|
||||
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 "--all",
|
||||
|
||||
@ -1,74 +1,3 @@
|
||||
#: * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=`<compiler>] [`--build-from-source`|`--force-bottle`] [`--include-test`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] [`--force`] [`--verbose`] [`--display-times`] <formula> [<options> ...]:
|
||||
#: Install <formula>.
|
||||
#:
|
||||
#: <formula> is usually the name of the formula to install, but it can be specified
|
||||
#: in several different ways.
|
||||
#:
|
||||
#: If `--debug` (or `-d`) is passed and brewing fails, open an interactive debugging
|
||||
#: session with access to IRB or a shell inside the temporary build directory.
|
||||
#:
|
||||
#: If `--env=std` is passed, use the standard build environment instead of superenv.
|
||||
#:
|
||||
#: If `--env=super` is passed, use superenv even if the formula specifies the
|
||||
#: standard build environment.
|
||||
#:
|
||||
#: If `--ignore-dependencies` is passed, skip installing any dependencies of
|
||||
#: any kind. If they are not already present, the formula will probably fail
|
||||
#: to install.
|
||||
#:
|
||||
#: If `--only-dependencies` is passed, install the dependencies with specified
|
||||
#: options but do not install the specified formula.
|
||||
#:
|
||||
#: If `--cc=`<compiler> is passed, attempt to compile using <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.
|
||||
#:
|
||||
#: If `--build-from-source` (or `-s`) is passed, compile the specified <formula> from
|
||||
#: source even if a bottle is provided. Dependencies will still be installed
|
||||
#: from bottles if they are available.
|
||||
#:
|
||||
#: If `--force-bottle` is passed, 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.
|
||||
#:
|
||||
#: If `--include-test` is passed, install testing dependencies. These are only
|
||||
#: needed by formulae maintainers to run `brew test`.
|
||||
#:
|
||||
#: If `--devel` is passed, and <formula> defines it, install the development version.
|
||||
#:
|
||||
#: If `--HEAD` is passed, and <formula> defines it, install the HEAD version,
|
||||
#: aka. master, trunk, unstable.
|
||||
#:
|
||||
#: If `--keep-tmp` is passed, the temporary files created during installation
|
||||
#: are not deleted.
|
||||
#:
|
||||
#: If `--build-bottle` is passed, prepare the formula for eventual bottling
|
||||
#: during installation.
|
||||
#:
|
||||
#: If `--force` (or `-f`) is passed, install without checking for previously
|
||||
#: installed keg-only or non-migrated versions
|
||||
#:
|
||||
#: If `--verbose` (or `-v`) is passed, print the verification and postinstall steps.
|
||||
#:
|
||||
#: If `--display-times` is passed, install times for each formula are printed
|
||||
#: at the end of the run.
|
||||
#:
|
||||
#: Installation options specific to <formula> may be appended to the command,
|
||||
#: and can be listed with `brew options` <formula>.
|
||||
#:
|
||||
#: * `install` `--interactive` [`--git`] <formula>:
|
||||
#: If `--interactive` (or `-i`) is passed, download and patch <formula>, then
|
||||
#: open a shell. This allows the user to run `./configure --help` and
|
||||
#: otherwise determine how to turn the software package into a Homebrew
|
||||
#: formula.
|
||||
#:
|
||||
#: If `--git` (or `-g`) is passed, Homebrew will create a Git repository, useful for
|
||||
#: creating patches to the software.
|
||||
|
||||
require "missing_formula"
|
||||
require "formula_installer"
|
||||
require "development_tools"
|
||||
@ -128,9 +57,9 @@ module Homebrew
|
||||
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 "\
|
||||
"updates when a new stable or devel version has been released."
|
||||
"updates when a new stable or development version has been released."
|
||||
switch "--keep-tmp",
|
||||
description: "Dont delete the temporary files created during installation."
|
||||
description: "Don't delete the temporary files created during installation."
|
||||
switch "--build-bottle",
|
||||
description: "Prepare the formula for eventual bottling during installation."
|
||||
switch :force,
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
#: * `leaves`:
|
||||
#: Show installed formulae that are not dependencies of another installed formula.
|
||||
|
||||
require "formula"
|
||||
require "tab"
|
||||
require "cli_parser"
|
||||
|
||||
@ -1,17 +1,3 @@
|
||||
#: * `ln`, `link` [`--overwrite`] [`--dry-run`] [`--force`] <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.
|
||||
#:
|
||||
#: If `--overwrite` is passed, Homebrew will delete files which already exist in
|
||||
#: the prefix while linking.
|
||||
#:
|
||||
#: If `--dry-run` or `-n` is passed, Homebrew will list all files which would
|
||||
#: be linked or which would be deleted by `brew link --overwrite`, but will not
|
||||
#: actually link or delete any files.
|
||||
#:
|
||||
#: If `--force` (or `-f`) is passed, Homebrew will allow keg-only formulae to be linked.
|
||||
|
||||
require "ostruct"
|
||||
require "caveats"
|
||||
require "cli_parser"
|
||||
@ -22,7 +8,7 @@ module Homebrew
|
||||
def link_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`ln`, `link` <options> <formula>
|
||||
`ln`, `link` [<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
|
||||
|
||||
@ -1,23 +1,3 @@
|
||||
#: * `list`, `ls` [`--full-name`] [`-1`] [`-l`] [`-t`] [`-r`]:
|
||||
#: List all installed formulae. If `--full-name` is passed, 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.
|
||||
#:
|
||||
#: * `list`, `ls` `--unbrewed`:
|
||||
#: List all files in the Homebrew prefix not installed by Homebrew.
|
||||
#:
|
||||
#: * `list`, `ls` [`--verbose`] [`--versions` [`--multiple`]] [`--pinned`] [<formulae>]:
|
||||
#: List the installed files for <formulae>. Combined with `--verbose`, recursively
|
||||
#: list the contents of all subdirectories in each <formula>'s keg.
|
||||
#:
|
||||
#: If `--versions` is passed, show the version number for installed formulae,
|
||||
#: or only the specified formulae if <formulae> are given. With `--multiple`,
|
||||
#: only show formulae with multiple versions installed.
|
||||
#:
|
||||
#: If `--pinned` is passed, show the versions of pinned formulae, or only the
|
||||
#: specified (pinned) formulae if <formulae> are given.
|
||||
#: See also `pin`, `unpin`.
|
||||
|
||||
require "metafiles"
|
||||
require "formula"
|
||||
require "cli_parser"
|
||||
@ -28,7 +8,7 @@ module Homebrew
|
||||
def list_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`list`, `ls` [<options>] [`-1`] [`-l`] [`-t`] [`-r`]
|
||||
`list`, `ls` [<options>]
|
||||
|
||||
List all installed formulae.
|
||||
EOS
|
||||
@ -40,13 +20,13 @@ module Homebrew
|
||||
description: "List all files in the Homebrew prefix not installed by Homebrew."
|
||||
switch "--versions",
|
||||
description: "Show the version number for installed formulae, or only the specified "\
|
||||
"formulae if <formulae> are given."
|
||||
"formulae if <formula> are given."
|
||||
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 <formulae> are given. See also `pin`, `unpin`."
|
||||
"formulae if <formula> are given. See also `pin`, `unpin`."
|
||||
# passed through to ls
|
||||
switch "-1",
|
||||
description: "Force output to be one entry per line. " \
|
||||
|
||||
@ -1,10 +1,3 @@
|
||||
#: * `migrate` [`--force`] <formulae>:
|
||||
#: Migrate renamed packages to new name, where <formulae> are old names of
|
||||
#: packages.
|
||||
#:
|
||||
#: If `--force` (or `-f`) is passed, then treat installed <formulae> and passed <formulae>
|
||||
#: like if they are from same taps and migrate them anyway.
|
||||
|
||||
require "migrator"
|
||||
require "cli_parser"
|
||||
|
||||
@ -14,13 +7,13 @@ module Homebrew
|
||||
def migrate_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`migrate` [<options>] <formulae>
|
||||
`migrate` [<options>] <formula>
|
||||
|
||||
Migrate renamed packages to new name, where <formulae> are old names of
|
||||
Migrate renamed packages to new name, where <formula> are old names of
|
||||
packages.
|
||||
EOS
|
||||
switch :force,
|
||||
description: "Treat installed <formulae> and passed <formulae> like if they are from "\
|
||||
description: "Treat installed <formula> and passed <formula> like if they are from "\
|
||||
"same taps and migrate them anyway."
|
||||
switch :verbose
|
||||
switch :debug
|
||||
|
||||
@ -1,12 +1,3 @@
|
||||
#: * `missing` [`--hide=`<hidden>] [<formulae>]:
|
||||
#: Check the given <formulae> for missing dependencies. If no <formulae> are
|
||||
#: given, check all installed brews.
|
||||
#:
|
||||
#: If `--hide=`<hidden> is passed, act as if none of <hidden> are installed.
|
||||
#: <hidden> should be a comma-separated list of formulae.
|
||||
#:
|
||||
#: `missing` exits with a non-zero status if any formulae are missing dependencies.
|
||||
|
||||
require "formula"
|
||||
require "tab"
|
||||
require "diagnostic"
|
||||
@ -18,9 +9,9 @@ module Homebrew
|
||||
def missing_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`missing` [<options>] [<formulae>]
|
||||
`missing` [<options>] [<formule>]
|
||||
|
||||
Check the given <formulae> for missing dependencies. If no <formulae> are
|
||||
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.
|
||||
|
||||
@ -1,13 +1,3 @@
|
||||
#: * `options` [`--compact`] (`--all`|`--installed`|<formulae>):
|
||||
#: Display install options specific to <formulae>.
|
||||
#:
|
||||
#: If `--compact` is passed, show all options on a single line separated by
|
||||
#: spaces.
|
||||
#:
|
||||
#: If `--all` is passed, show options for all formulae.
|
||||
#:
|
||||
#: If `--installed` is passed, show options for all installed formulae.
|
||||
|
||||
require "formula"
|
||||
require "options"
|
||||
require "cli_parser"
|
||||
@ -18,9 +8,9 @@ module Homebrew
|
||||
def options_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`options` [<options>] <formulae>
|
||||
`options` [<options>] <formula>
|
||||
|
||||
Display install options specific to <formulae>
|
||||
Display install options specific to <formula>
|
||||
EOS
|
||||
switch "--compact",
|
||||
description: "Show all options on a single line separated by spaces."
|
||||
|
||||
@ -1,22 +1,3 @@
|
||||
#: * `outdated` [`--quiet`|`--verbose`|`--json=`<version>] [`--fetch-HEAD`]:
|
||||
#: Show formulae that have an updated version available.
|
||||
#:
|
||||
#: By default, version information is displayed in interactive shells, and
|
||||
#: suppressed otherwise.
|
||||
#:
|
||||
#: If `--quiet` is passed, list only the names of outdated brews (takes
|
||||
#: precedence over `--verbose`).
|
||||
#:
|
||||
#: If `--verbose` (or `-v`) is passed, display detailed version information.
|
||||
#:
|
||||
#: If `--json=`<version> is passed, the output will be in JSON format.
|
||||
#: Currently the only accepted value for <version> is `v1`.
|
||||
#:
|
||||
#: If `--fetch-HEAD` is passed, 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 devel
|
||||
#: version has been released.
|
||||
|
||||
require "formula"
|
||||
require "keg"
|
||||
require "cli_parser"
|
||||
@ -44,7 +25,7 @@ module Homebrew
|
||||
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 "\
|
||||
"updates when a new stable or devel version has been released."
|
||||
"updates when a new stable or development version has been released."
|
||||
switch :debug
|
||||
conflicts "--quiet", "--verbose", "--json="
|
||||
end
|
||||
|
||||
@ -1,7 +1,3 @@
|
||||
#: * `pin` <formulae>:
|
||||
#: Pin the specified <formulae>, preventing them from being upgraded when
|
||||
#: issuing the `brew upgrade` <formulae> command. See also `unpin`.
|
||||
|
||||
require "formula"
|
||||
require "cli_parser"
|
||||
|
||||
@ -11,10 +7,10 @@ module Homebrew
|
||||
def pin_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`pin` <formulae>
|
||||
`pin` <formula>
|
||||
|
||||
Pin the specified <formulae>, preventing them from being upgraded when
|
||||
issuing the `brew upgrade` <formulae> command. See also `unpin`.
|
||||
Pin the specified <formula>, preventing them from being upgraded when
|
||||
issuing the `brew upgrade` <formula> command. See also `unpin`.
|
||||
EOS
|
||||
switch :debug
|
||||
end
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
#: * `postinstall` <formula>:
|
||||
#: Rerun the post-install steps for <formula>.
|
||||
|
||||
require "sandbox"
|
||||
require "formula_installer"
|
||||
require "cli_parser"
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
#: * `prune` [`--dry-run`]:
|
||||
#: Deprecated. Use `brew cleanup` instead.
|
||||
|
||||
require "keg"
|
||||
require "cli_parser"
|
||||
require "cleanup"
|
||||
@ -19,6 +16,7 @@ module Homebrew
|
||||
description: "Show what would be removed, but do not actually remove anything."
|
||||
switch :verbose
|
||||
switch :debug
|
||||
hide_from_man_page!
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@ -1,14 +1,3 @@
|
||||
#: * `readall` [`--aliases`] [`--syntax`] [<taps>]:
|
||||
#: Import all formulae from specified <taps> (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.
|
||||
#:
|
||||
#: If `--aliases` is passed, also verify any alias symlinks in each tap.
|
||||
#:
|
||||
#: If `--syntax` is passed, also syntax-check all of Homebrew's Ruby files.
|
||||
|
||||
require "readall"
|
||||
require "cli_parser"
|
||||
|
||||
@ -18,9 +7,9 @@ module Homebrew
|
||||
def readall_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`readall` [<options>] [<taps>]
|
||||
`readall` [<options>] [<tap>]
|
||||
|
||||
Import all formulae from specified <taps> (defaults to all installed taps).
|
||||
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.
|
||||
|
||||
@ -1,31 +1,3 @@
|
||||
#: * `reinstall` [`--debug`] [`--build-from-source`|`--force-bottle`] [`--keep-tmp`] [`--force`] [`--verbose`] [`--display-times`] <formula>:
|
||||
#: Uninstall and then install <formula> (with existing and any appended install options).
|
||||
#:
|
||||
#: If `--debug` (or `-d`) is passed and brewing fails, open an interactive debugging
|
||||
#: session with access to IRB or a shell inside the temporary build directory.
|
||||
#:
|
||||
#: If `--build-from-source` (or `-s`) is passed, compile the specified <formula> from
|
||||
#: source even if a bottle is provided. Dependencies will still be installed
|
||||
#: from bottles if they are available.
|
||||
#:
|
||||
#: If `--force-bottle` is passed, 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.
|
||||
#:
|
||||
#: If `--keep-tmp` is passed, the temporary files created during installation
|
||||
#: are not deleted.
|
||||
#:
|
||||
#: If `--force` (or `-f`) is passed, install without checking for previously
|
||||
#: installed keg-only or non-migrated versions
|
||||
#:
|
||||
#: If `--verbose` (or `-v`) is passed, print the verification and postinstall steps.
|
||||
#:
|
||||
#: If `--display-times` is passed, install times for each formula are printed
|
||||
#: at the end of the run.
|
||||
#:
|
||||
#: Installation options specific to <formula> may be appended to the command,
|
||||
#: and can be listed with `brew options` <formula>.
|
||||
|
||||
require "formula_installer"
|
||||
require "development_tools"
|
||||
require "messages"
|
||||
@ -52,7 +24,7 @@ module Homebrew
|
||||
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: "Dont delete the temporary files created during installation."
|
||||
description: "Don't delete the temporary files created during installation."
|
||||
switch :force,
|
||||
description: "Install without checking for previously installed keg-only or "\
|
||||
"non-migrated versions."
|
||||
|
||||
@ -1,22 +1,3 @@
|
||||
#: * `search`, `-S`:
|
||||
#: Display all locally available formulae (including tapped ones).
|
||||
#: No online search is performed.
|
||||
#:
|
||||
#: * `search` `--casks`:
|
||||
#: Display all locally available casks (including tapped ones).
|
||||
#: No online search is performed.
|
||||
#:
|
||||
#: * `search` [`--desc`] (<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`.
|
||||
#:
|
||||
#: If `--desc` is passed, search formulae with a description matching <text> and
|
||||
#: casks with a name matching <text>.
|
||||
#:
|
||||
#: * `search` (`--debian`|`--fedora`|`--fink`|`--macports`|`--opensuse`|`--ubuntu`) <text>:
|
||||
#: Search for <text> in the given package manager's list.
|
||||
|
||||
require "formula"
|
||||
require "missing_formula"
|
||||
require "descriptions"
|
||||
@ -44,7 +25,7 @@ module Homebrew
|
||||
def search_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`search`, `-S` [<options>] (<text>|`/`<text>`/`)
|
||||
`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.
|
||||
|
||||
@ -1,12 +1,3 @@
|
||||
#: * `sh` [`--env=std`]:
|
||||
#: 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.
|
||||
#:
|
||||
#: If `--env=std` is passed, use the standard `PATH` instead of superenv's.
|
||||
|
||||
require "extend/ENV"
|
||||
require "formula"
|
||||
require "cli_parser"
|
||||
|
||||
@ -1,22 +1,3 @@
|
||||
#: * `style` [`--fix`] [`--display-cop-names`] [`--only-cops=`<cops>|`--except-cops=`<cops>] [<files>|<taps>|<formulae>]:
|
||||
#: Check formulae or files for conformance to Homebrew style guidelines.
|
||||
#:
|
||||
#: Lists of <files>, <taps> and <formulae> may not be combined. If none are
|
||||
#: provided, `style` will run style checks on the whole Homebrew library,
|
||||
#: including core code and all formulae.
|
||||
#:
|
||||
#: If `--fix` is passed, automatically fix style violations using RuboCop's
|
||||
#: auto-correct feature.
|
||||
#:
|
||||
#: If `--display-cop-names` is passed, include the RuboCop cop name for each
|
||||
#: violation in the output.
|
||||
#:
|
||||
#: Passing `--only-cops=`<cops> will check for violations of only the listed
|
||||
#: RuboCop <cops>, while `--except-cops=`<cops> will skip checking the listed
|
||||
#: <cops>. For either option <cops> should be a comma-separated list of cop names.
|
||||
#:
|
||||
#: Exits with a non-zero status if any style violations are found.
|
||||
|
||||
require "json"
|
||||
require "open3"
|
||||
require "style"
|
||||
@ -28,11 +9,11 @@ module Homebrew
|
||||
def style_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`style` [<options>] [<files>|<taps>|<formulae>]
|
||||
`style` [<options>] [<file>|<tap>|<formula>]
|
||||
|
||||
Check formulae or files for conformance to Homebrew style guidelines.
|
||||
|
||||
Lists of <files>, <taps> and <formulae> may not be combined. If none are
|
||||
Lists of <file>, <tap> and <formula> may not be combined. If none are
|
||||
provided, `style` will run style checks on the whole Homebrew library,
|
||||
including core code and all formulae.
|
||||
EOS
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
#: * `switch` <formula> <version>:
|
||||
#: Symlink all of the specific <version> of <formula>'s install to Homebrew prefix.
|
||||
|
||||
require "formula"
|
||||
require "keg"
|
||||
require "cli_parser"
|
||||
|
||||
@ -1,20 +1,3 @@
|
||||
#: * `tap-info`:
|
||||
#: Display a brief summary of all installed taps.
|
||||
#:
|
||||
#: * `tap-info` (`--installed`|<taps>):
|
||||
#: Display detailed information about one or more <taps>.
|
||||
#:
|
||||
#: Pass `--installed` to display information on all installed taps.
|
||||
#:
|
||||
#: * `tap-info` `--json=`<version> (`--installed`|<taps>):
|
||||
#: Print a JSON representation of <taps>. Currently the only accepted value
|
||||
#: for <version> is `v1`.
|
||||
#:
|
||||
#: Pass `--installed` to get information on installed taps.
|
||||
#:
|
||||
#: See the docs for examples of using the JSON output:
|
||||
#: <https://docs.brew.sh/Querying-Brew>
|
||||
|
||||
require "cli_parser"
|
||||
|
||||
module Homebrew
|
||||
@ -23,10 +6,10 @@ module Homebrew
|
||||
def tap_info_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`tap-info` [<options>] [<taps>]
|
||||
`tap-info` [<options>] [<tap>]
|
||||
|
||||
Display detailed information about one or more provided <taps>.
|
||||
Display a brief summary of all installed taps if no <taps> are passed.
|
||||
Display detailed information about one or more provided <tap>.
|
||||
Display a brief summary of all installed taps if no <tap> are passed.
|
||||
EOS
|
||||
switch "--installed",
|
||||
description: "Display information on all installed taps."
|
||||
|
||||
@ -1,7 +1,3 @@
|
||||
#: * `tap-pin` <tap>:
|
||||
#: Pin <tap>, prioritizing its formulae over core when formula names are supplied
|
||||
#: by the user. See also `tap-unpin`.
|
||||
|
||||
require "cli_parser"
|
||||
|
||||
module Homebrew
|
||||
@ -12,7 +8,7 @@ module Homebrew
|
||||
usage_banner <<~EOS
|
||||
`tap-pin` <tap>
|
||||
|
||||
Pin <tap>, prioritizing its formulae over core when formula names are supplied
|
||||
Pin <tap>, prioritising its formulae over core when formula names are supplied
|
||||
by the user. See also `tap-unpin`.
|
||||
EOS
|
||||
switch :debug
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
#: * `tap-unpin` <tap>:
|
||||
#: Unpin <tap> so its formulae are no longer prioritized. See also `tap-pin`.
|
||||
|
||||
require "cli_parser"
|
||||
|
||||
module Homebrew
|
||||
@ -11,7 +8,7 @@ module Homebrew
|
||||
usage_banner <<~EOS
|
||||
`tap-unpin` <tap>
|
||||
|
||||
Unpin <tap> so its formulae are no longer prioritized. See also `tap-pin`.
|
||||
Unpin <tap> so its formulae are no longer prioritised. See also `tap-pin`.
|
||||
EOS
|
||||
switch :debug
|
||||
end
|
||||
|
||||
@ -1,37 +1,3 @@
|
||||
#: * `tap`:
|
||||
#: List all installed taps.
|
||||
#:
|
||||
#: * `tap` [`--full`] [`--force-auto-update`] <user>`/`<repo> [<URL>]:
|
||||
#: Tap a formula repository.
|
||||
#:
|
||||
#: With <URL> unspecified, taps 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.
|
||||
#:
|
||||
#: By default, the repository is cloned as a shallow copy (`--depth=1`), but
|
||||
#: if `--full` is passed, a full clone will be used. To convert a shallow copy
|
||||
#: to a full copy, you can retap passing `--full` without first untapping.
|
||||
#:
|
||||
#: By default, only taps hosted on GitHub are auto-updated (for performance
|
||||
#: reasons). If `--force-auto-update` is passed, this tap will be auto-updated
|
||||
#: even if it is not hosted on GitHub.
|
||||
#:
|
||||
#: `tap` is re-runnable and exits successfully if there's nothing to do.
|
||||
#: However, retapping with a different <URL> will cause an exception, so first
|
||||
#: `untap` if you need to modify the <URL>.
|
||||
#:
|
||||
#: * `tap` `--repair`:
|
||||
#: Migrate tapped formulae from symlink-based to directory-based structure.
|
||||
#:
|
||||
#: * `tap` `--list-pinned`:
|
||||
#: List all pinned taps.
|
||||
|
||||
require "cli_parser"
|
||||
|
||||
module Homebrew
|
||||
|
||||
@ -1,12 +1,3 @@
|
||||
#: * `uninstall`, `rm`, `remove` [`--force`] [`--ignore-dependencies`] <formula>:
|
||||
#: Uninstall <formula>.
|
||||
#:
|
||||
#: If `--force` (or `-f`) is passed, and there are multiple versions of <formula>
|
||||
#: installed, delete all installed versions.
|
||||
#:
|
||||
#: If `--ignore-dependencies` is passed, uninstalling won't fail, even if
|
||||
#: formulae depending on <formula> would still be installed.
|
||||
|
||||
require "keg"
|
||||
require "formula"
|
||||
require "diagnostic"
|
||||
@ -26,7 +17,7 @@ module Homebrew
|
||||
switch :force,
|
||||
description: "Delete all installed versions of the <formula>"
|
||||
switch "--ignore-dependencies",
|
||||
description: "Dont fail uninstall, even if <formula> is a dependency of any installed "\
|
||||
description: "Don't fail uninstall, even if <formula> is a dependency of any installed "\
|
||||
"formulae."
|
||||
switch :debug
|
||||
end
|
||||
|
||||
@ -1,11 +1,3 @@
|
||||
#: * `unlink` [`--dry-run`] <formula>:
|
||||
#: Remove symlinks for <formula> from the Homebrew prefix. This can be useful
|
||||
#: for temporarily disabling a formula:
|
||||
#: `brew unlink` <formula> `&&` <commands> `&& brew link` <formula>
|
||||
#:
|
||||
#: If `--dry-run` or `-n` is passed, Homebrew will list all files which would
|
||||
#: be unlinked, but will not actually unlink or delete any files.
|
||||
|
||||
require "ostruct"
|
||||
require "cli_parser"
|
||||
|
||||
|
||||
@ -1,14 +1,3 @@
|
||||
#: * `unpack` [`--git`|`--patch`] [`--destdir=`<path>] <formulae>:
|
||||
#: Unpack the source files for <formulae> into subdirectories of the current
|
||||
#: working directory. If `--destdir=`<path> is given, the subdirectories will
|
||||
#: be created in the directory named by <path> instead.
|
||||
#:
|
||||
#: If `--patch` is passed, patches for <formulae> will be applied to the
|
||||
#: unpacked source.
|
||||
#:
|
||||
#: If `--git` (or `-g`) is passed, a Git repository will be initialized in the unpacked
|
||||
#: source. This is useful for creating patches for the software.
|
||||
|
||||
require "stringio"
|
||||
require "formula"
|
||||
require "cli_parser"
|
||||
@ -19,17 +8,17 @@ module Homebrew
|
||||
def unpack_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`usage` [<options>] <formulae>
|
||||
`unpack` [<options>] <formula>
|
||||
|
||||
Unpack the source files for <formulae> into subdirectories of the current
|
||||
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."
|
||||
switch "--patch",
|
||||
description: "Patches for <formulae> will be applied to the unpacked source."
|
||||
description: "Patches for <formula> will be applied to the unpacked source."
|
||||
switch "-g", "--git",
|
||||
description: "Initialize a Git repository in the unpacked source. This is useful for creating "\
|
||||
description: "Initialise a Git repository in the unpacked source. This is useful for creating "\
|
||||
"patches for the software."
|
||||
switch :force
|
||||
switch :verbose
|
||||
|
||||
@ -1,7 +1,3 @@
|
||||
#: * `unpin` <formulae>:
|
||||
#: Unpin <formulae>, allowing them to be upgraded by `brew upgrade` <formulae>.
|
||||
#: See also `pin`.
|
||||
|
||||
require "formula"
|
||||
require "cli_parser"
|
||||
|
||||
@ -11,9 +7,9 @@ module Homebrew
|
||||
def unpin_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`unpin` <formulae>
|
||||
`unpin` <formula>
|
||||
|
||||
Unpin <formulae>, allowing them to be upgraded by `brew upgrade` <formulae>.
|
||||
Unpin <formula>, allowing them to be upgraded by `brew upgrade` <formula>.
|
||||
See also `pin`.
|
||||
EOS
|
||||
switch :verbose
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
#: * `untap` <tap>:
|
||||
#: Remove a tapped repository.
|
||||
|
||||
require "cli_parser"
|
||||
|
||||
module Homebrew
|
||||
|
||||
@ -1,42 +1,3 @@
|
||||
#: * `upgrade` [`--debug`] [`--build-from-source`|`--force-bottle`] [`--fetch-HEAD`] [`--ignore-pinned`] [`--keep-tmp`] [`--force`] [`--verbose`] [`--display-times`] [<formula>] [<options> ...]:
|
||||
#: Upgrade outdated, unpinned brews (with existing and any appended install options).
|
||||
#:
|
||||
#: If <formula> are given, upgrade only the specified brews (unless they
|
||||
#: are pinned; see `pin`, `unpin`).
|
||||
#:
|
||||
#: If `--debug` (or `-d`) is passed and brewing fails, open an interactive debugging
|
||||
#: session with access to IRB or a shell inside the temporary build directory.
|
||||
#:
|
||||
#: If `--build-from-source` (or `-s`) is passed, compile the specified <formula> from
|
||||
#: source even if a bottle is provided. Dependencies will still be installed
|
||||
#: from bottles if they are available.
|
||||
#:
|
||||
#: If `--force-bottle` is passed, 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.
|
||||
#:
|
||||
#: If `--fetch-HEAD` is passed, 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 devel
|
||||
#: version has been released.
|
||||
#:
|
||||
#: If `--ignore-pinned` is passed, set a 0 exit code even if pinned formulae
|
||||
#: are not upgraded.
|
||||
#:
|
||||
#: If `--keep-tmp` is passed, the temporary files created during installation
|
||||
#: are not deleted.
|
||||
#:
|
||||
#: If `--force` (or `-f`) is passed, install without checking for previously
|
||||
#: installed keg-only or non-migrated versions
|
||||
#:
|
||||
#: If `--verbose` (or `-v`) is passed, print the verification and postinstall steps.
|
||||
#:
|
||||
#: If `--display-times` is passed, install times for each formula are printed
|
||||
#: at the end of the run.
|
||||
#:
|
||||
#: Additional options specific to <formula> may be appended to the command,
|
||||
#: and can be listed with `brew options` <formula>.
|
||||
|
||||
require "install"
|
||||
require "reinstall"
|
||||
require "formula_installer"
|
||||
@ -69,11 +30,11 @@ module Homebrew
|
||||
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 "\
|
||||
"updates when a new stable or devel version has been released."
|
||||
"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."
|
||||
switch "--keep-tmp",
|
||||
description: "Dont delete the temporary files created during installation."
|
||||
description: "Don't delete the temporary files created during installation."
|
||||
switch :force,
|
||||
description: "Install without checking for previously installed keg-only or "\
|
||||
"non-migrated versions."
|
||||
|
||||
@ -1,23 +1,3 @@
|
||||
#: * `uses` [`--installed`] [`--recursive`] [`--include-build`] [`--include-test`] [`--include-optional`] [`--skip-recommended`] [`--devel`|`--HEAD`] <formulae>:
|
||||
#: Show the formulae that specify <formulae> as a dependency. When given
|
||||
#: multiple formula arguments, show the intersection of formulae that use
|
||||
#: <formulae>.
|
||||
#:
|
||||
#: Use `--recursive` to resolve more than one level of dependencies.
|
||||
#:
|
||||
#: If `--installed` is passed, only list installed formulae.
|
||||
#:
|
||||
#: By default, `uses` shows all formulae that specify <formulae> as a required
|
||||
#: or recommended dependency. To include the `:build` type dependencies, pass
|
||||
#: `--include-build`, to include the `:test` type dependencies, pass
|
||||
#: `--include-test` and to include `:optional` dependencies pass
|
||||
#: `--include-optional`. To skip `:recommended` type dependencies, pass
|
||||
#: `--skip-recommended`.
|
||||
#:
|
||||
#: By default, `uses` shows usage of <formulae> by stable builds. To find
|
||||
#: cases where <formulae> is used by development or HEAD build, pass
|
||||
#: `--devel` or `--HEAD`.
|
||||
|
||||
require "formula"
|
||||
require "cli_parser"
|
||||
|
||||
@ -31,33 +11,33 @@ module Homebrew
|
||||
def uses_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
usage_banner <<~EOS
|
||||
`uses` [<options>] <formulae>
|
||||
`uses` [<options>] <formula>
|
||||
|
||||
Show the formulae that specify <formulae> as a dependency. When given
|
||||
Show the formulae that specify <formula> as a dependency. When given
|
||||
multiple formula arguments, show the intersection of formulae that use
|
||||
<formulae>.
|
||||
<formula>.
|
||||
|
||||
By default, `uses` shows all formulae that specify <formulae> as a required
|
||||
By default, `uses` shows all formulae that specify <formula> as a required
|
||||
or recommended dependency.
|
||||
|
||||
By default, `uses` shows usage of <formulae> by stable builds.
|
||||
By default, `uses` shows usage of <formula> by stable builds.
|
||||
EOS
|
||||
switch "--recursive",
|
||||
description: "Resolve more than one level of dependencies."
|
||||
switch "--installed",
|
||||
description: "Only list installed formulae."
|
||||
switch "--include-build",
|
||||
description: "Include all formulae that specify <formulae> as `:build` type dependency."
|
||||
description: "Include all formulae that specify <formula> as `:build` type dependency."
|
||||
switch "--include-test",
|
||||
description: "Include all formulae that specify <formulae> as `:test` type dependency."
|
||||
description: "Include all formulae that specify <formula> as `:test` type dependency."
|
||||
switch "--include-optional",
|
||||
description: "Include all formulae that specify <formulae> as `:optional` type dependency."
|
||||
description: "Include all formulae that specify <formula> as `:optional` type dependency."
|
||||
switch "--skip-recommended",
|
||||
description: "Skip all formulae that specify <formulae> as `:recommended` type dependency."
|
||||
description: "Skip all formulae that specify <formula> as `:recommended` type dependency."
|
||||
switch "--devel",
|
||||
description: "Show usage of <formulae> by development build."
|
||||
description: "Show usage of <formula> by development build."
|
||||
switch "--HEAD",
|
||||
description: "Show usage of <formulae> by HEAD build."
|
||||
description: "Show usage of <formula> by HEAD build."
|
||||
switch :debug
|
||||
conflicts "--devel", "--HEAD"
|
||||
end
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user