mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
Update manpage and completions.
Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
This commit is contained in:
BrewTestBot
parent
81313133f1
commit
3bb7db20a2
@ -643,6 +643,41 @@ _brew_bump_unversioned_casks() {
|
||||
__brew_complete_tapped
|
||||
}
|
||||
|
||||
_brew_bundle() {
|
||||
local cur="${COMP_WORDS[COMP_CWORD]}"
|
||||
case "${cur}" in
|
||||
-*)
|
||||
__brewcomp "
|
||||
--all
|
||||
--cask
|
||||
--cleanup
|
||||
--debug
|
||||
--describe
|
||||
--file
|
||||
--force
|
||||
--formula
|
||||
--global
|
||||
--help
|
||||
--install
|
||||
--mas
|
||||
--no-restart
|
||||
--no-upgrade
|
||||
--no-vscode
|
||||
--quiet
|
||||
--tap
|
||||
--upgrade
|
||||
--verbose
|
||||
--vscode
|
||||
--whalebrew
|
||||
--zap
|
||||
"
|
||||
return
|
||||
;;
|
||||
*) ;;
|
||||
esac
|
||||
__brewcomp "install dump cleanup check exec list sh env edit"
|
||||
}
|
||||
|
||||
_brew_casks() {
|
||||
local cur="${COMP_WORDS[COMP_CWORD]}"
|
||||
case "${cur}" in
|
||||
@ -3081,6 +3116,7 @@ _brew() {
|
||||
bump-formula-pr) _brew_bump_formula_pr ;;
|
||||
bump-revision) _brew_bump_revision ;;
|
||||
bump-unversioned-casks) _brew_bump_unversioned_casks ;;
|
||||
bundle) _brew_bundle ;;
|
||||
casks) _brew_casks ;;
|
||||
cat) _brew_cat ;;
|
||||
cleanup) _brew_cleanup ;;
|
||||
|
||||
@ -493,6 +493,40 @@ __fish_brew_complete_arg 'bump-unversioned-casks' -a '(__fish_brew_suggest_casks
|
||||
__fish_brew_complete_arg 'bump-unversioned-casks' -a '(__fish_brew_suggest_taps_installed)'
|
||||
|
||||
|
||||
__fish_brew_complete_cmd 'bundle' 'Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store, Whalebrew and Visual Studio Code'
|
||||
__fish_brew_complete_sub_cmd 'bundle' 'install'
|
||||
__fish_brew_complete_sub_cmd 'bundle' 'dump'
|
||||
__fish_brew_complete_sub_cmd 'bundle' 'cleanup'
|
||||
__fish_brew_complete_sub_cmd 'bundle' 'check'
|
||||
__fish_brew_complete_sub_cmd 'bundle' 'exec'
|
||||
__fish_brew_complete_sub_cmd 'bundle' 'list'
|
||||
__fish_brew_complete_sub_cmd 'bundle' 'sh'
|
||||
__fish_brew_complete_sub_cmd 'bundle' 'env'
|
||||
__fish_brew_complete_sub_cmd 'bundle' 'edit'
|
||||
__fish_brew_complete_arg 'bundle' -l all -d '`list` all dependencies'
|
||||
__fish_brew_complete_arg 'bundle' -l cask -d '`list` or `dump` Homebrew cask dependencies'
|
||||
__fish_brew_complete_arg 'bundle' -l cleanup -d '`install` performs cleanup operation, same as running `cleanup --force`. This is enabled by default if `$HOMEBREW_BUNDLE_INSTALL_CLEANUP` is set and `--global` is passed'
|
||||
__fish_brew_complete_arg 'bundle' -l debug -d 'Display any debugging information'
|
||||
__fish_brew_complete_arg 'bundle' -l describe -d '`dump` adds a description comment above each line, unless the dependency does not have a description. This is enabled by default if `$HOMEBREW_BUNDLE_DUMP_DESCRIBE` is set'
|
||||
__fish_brew_complete_arg 'bundle' -l file -d 'Read from or write to the `Brewfile` from this location. Use `--file=-` to pipe to stdin/stdout'
|
||||
__fish_brew_complete_arg 'bundle' -l force -d '`install` runs with `--force`/`--overwrite`. `dump` overwrites an existing `Brewfile`. `cleanup` actually performs its cleanup operations'
|
||||
__fish_brew_complete_arg 'bundle' -l formula -d '`list` or `dump` Homebrew formula dependencies'
|
||||
__fish_brew_complete_arg 'bundle' -l global -d 'Read from or write to the `Brewfile` from `$HOMEBREW_BUNDLE_FILE_GLOBAL` (if set), `${XDG_CONFIG_HOME}/homebrew/Brewfile` (if `$XDG_CONFIG_HOME` is set), `~/.homebrew/Brewfile` or `~/.Brewfile` otherwise'
|
||||
__fish_brew_complete_arg 'bundle' -l help -d 'Show this message'
|
||||
__fish_brew_complete_arg 'bundle' -l install -d 'Run `install` before continuing to other operations e.g. `exec`'
|
||||
__fish_brew_complete_arg 'bundle' -l mas -d '`list` or `dump` Mac App Store dependencies'
|
||||
__fish_brew_complete_arg 'bundle' -l no-restart -d '`dump` does not add `restart_service` to formula lines'
|
||||
__fish_brew_complete_arg 'bundle' -l no-upgrade -d '`install` does not run `brew upgrade` on outdated dependencies. `check` does not check for outdated dependencies. Note they may still be upgraded by `brew install` if needed. This is enabled by default if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set'
|
||||
__fish_brew_complete_arg 'bundle' -l no-vscode -d '`dump` without VSCode extensions. This is enabled by default if `$HOMEBREW_BUNDLE_DUMP_NO_VSCODE` is set'
|
||||
__fish_brew_complete_arg 'bundle' -l quiet -d 'Make some output more quiet'
|
||||
__fish_brew_complete_arg 'bundle' -l tap -d '`list` or `dump` Homebrew tap dependencies'
|
||||
__fish_brew_complete_arg 'bundle' -l upgrade -d '`install` runs `brew upgrade` on outdated dependencies, even if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set. '
|
||||
__fish_brew_complete_arg 'bundle' -l verbose -d '`install` prints output from commands as they are run. `check` lists all missing dependencies'
|
||||
__fish_brew_complete_arg 'bundle' -l vscode -d '`list` or `dump` VSCode extensions'
|
||||
__fish_brew_complete_arg 'bundle' -l whalebrew -d '`list` or `dump` Whalebrew dependencies'
|
||||
__fish_brew_complete_arg 'bundle' -l zap -d '`cleanup` casks using the `zap` command instead of `uninstall`'
|
||||
|
||||
|
||||
__fish_brew_complete_cmd 'casks' 'List all locally installable casks including short names'
|
||||
__fish_brew_complete_arg 'casks' -l debug -d 'Display any debugging information'
|
||||
__fish_brew_complete_arg 'casks' -l help -d 'Show this message'
|
||||
@ -563,7 +597,7 @@ __fish_brew_complete_arg 'contributions' -l debug -d 'Display any debugging info
|
||||
__fish_brew_complete_arg 'contributions' -l from -d 'Date (ISO-8601 format) to start searching contributions. Omitting this flag searches the last year'
|
||||
__fish_brew_complete_arg 'contributions' -l help -d 'Show this message'
|
||||
__fish_brew_complete_arg 'contributions' -l quiet -d 'Make some output more quiet'
|
||||
__fish_brew_complete_arg 'contributions' -l repositories -d 'Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `bundle`, `command-not-found` and `test-bot`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: brew,core,cask. Specifying `--repositories=all`, searches all repositories. '
|
||||
__fish_brew_complete_arg 'contributions' -l repositories -d 'Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `command-not-found` and `test-bot`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: brew,core,cask. Specifying `--repositories=all`, searches all repositories. '
|
||||
__fish_brew_complete_arg 'contributions' -l to -d 'Date (ISO-8601 format) to stop searching contributions'
|
||||
__fish_brew_complete_arg 'contributions' -l user -d 'Specify a comma-separated list of GitHub usernames or email addresses to find contributions from. Omitting this flag searches maintainers'
|
||||
__fish_brew_complete_arg 'contributions' -l verbose -d 'Make some output more verbose'
|
||||
|
||||
@ -20,6 +20,7 @@ bump-cask-pr
|
||||
bump-formula-pr
|
||||
bump-revision
|
||||
bump-unversioned-casks
|
||||
bundle
|
||||
casks
|
||||
cat
|
||||
cleanup
|
||||
|
||||
@ -149,6 +149,7 @@ __brew_internal_commands() {
|
||||
'bump-formula-pr:Create a pull request to update formula with a new URL or a new tag'
|
||||
'bump-revision:Create a commit to increment the revision of formula'
|
||||
'bump-unversioned-casks:Check all casks with unversioned URLs in a given tap for updates'
|
||||
'bundle:Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store, Whalebrew and Visual Studio Code'
|
||||
'casks:List all locally installable casks including short names'
|
||||
'cat:Display the source of a formula or cask'
|
||||
'cleanup:Remove stale lock files and outdated downloads for all formulae and casks, and remove old versions of installed formulae'
|
||||
@ -641,6 +642,35 @@ _brew_bump_unversioned_casks() {
|
||||
'*::tap:__brew_any_tap'
|
||||
}
|
||||
|
||||
# brew bundle
|
||||
_brew_bundle() {
|
||||
_arguments \
|
||||
'(--no-vscode)--all[`list` all dependencies]' \
|
||||
'--cask[`list` or `dump` Homebrew cask dependencies]' \
|
||||
'--cleanup[`install` performs cleanup operation, same as running `cleanup --force`. This is enabled by default if `$HOMEBREW_BUNDLE_INSTALL_CLEANUP` is set and `--global` is passed]' \
|
||||
'--debug[Display any debugging information]' \
|
||||
'--describe[`dump` adds a description comment above each line, unless the dependency does not have a description. This is enabled by default if `$HOMEBREW_BUNDLE_DUMP_DESCRIBE` is set]' \
|
||||
'--file[Read from or write to the `Brewfile` from this location. Use `--file=-` to pipe to stdin/stdout]' \
|
||||
'--force[`install` runs with `--force`/`--overwrite`. `dump` overwrites an existing `Brewfile`. `cleanup` actually performs its cleanup operations]' \
|
||||
'--formula[`list` or `dump` Homebrew formula dependencies]' \
|
||||
'--global[Read from or write to the `Brewfile` from `$HOMEBREW_BUNDLE_FILE_GLOBAL` (if set), `${XDG_CONFIG_HOME}/homebrew/Brewfile` (if `$XDG_CONFIG_HOME` is set), `~/.homebrew/Brewfile` or `~/.Brewfile` otherwise]' \
|
||||
'--help[Show this message]' \
|
||||
'(--upgrade)--install[Run `install` before continuing to other operations e.g. `exec`]' \
|
||||
'--mas[`list` or `dump` Mac App Store dependencies]' \
|
||||
'--no-restart[`dump` does not add `restart_service` to formula lines]' \
|
||||
'--no-upgrade[`install` does not run `brew upgrade` on outdated dependencies. `check` does not check for outdated dependencies. Note they may still be upgraded by `brew install` if needed. This is enabled by default if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set]' \
|
||||
'(--all --vscode)--no-vscode[`dump` without VSCode extensions. This is enabled by default if `$HOMEBREW_BUNDLE_DUMP_NO_VSCODE` is set]' \
|
||||
'--quiet[Make some output more quiet]' \
|
||||
'--tap[`list` or `dump` Homebrew tap dependencies]' \
|
||||
'(--install)--upgrade[`install` runs `brew upgrade` on outdated dependencies, even if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set. ]' \
|
||||
'--verbose[`install` prints output from commands as they are run. `check` lists all missing dependencies]' \
|
||||
'(--no-vscode)--vscode[`list` or `dump` VSCode extensions]' \
|
||||
'--whalebrew[`list` or `dump` Whalebrew dependencies]' \
|
||||
'--zap[`cleanup` casks using the `zap` command instead of `uninstall`]' \
|
||||
- subcommand \
|
||||
'*::subcommand:(install dump cleanup check exec list sh env edit)'
|
||||
}
|
||||
|
||||
# brew casks
|
||||
_brew_casks() {
|
||||
_arguments \
|
||||
@ -731,7 +761,7 @@ _brew_contributions() {
|
||||
'--from[Date (ISO-8601 format) to start searching contributions. Omitting this flag searches the last year]' \
|
||||
'--help[Show this message]' \
|
||||
'--quiet[Make some output more quiet]' \
|
||||
'--repositories[Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `bundle`, `command-not-found` and `test-bot`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: brew,core,cask. Specifying `--repositories=all`, searches all repositories. ]' \
|
||||
'--repositories[Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `command-not-found` and `test-bot`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: brew,core,cask. Specifying `--repositories=all`, searches all repositories. ]' \
|
||||
'--to[Date (ISO-8601 format) to stop searching contributions]' \
|
||||
'--user[Specify a comma-separated list of GitHub usernames or email addresses to find contributions from. Omitting this flag searches maintainers]' \
|
||||
'--verbose[Make some output more verbose]'
|
||||
|
||||
360
docs/Manpage.md
360
docs/Manpage.md
@ -133,6 +133,182 @@ and are now no longer needed.
|
||||
|
||||
: List what would be uninstalled, but do not actually uninstall anything.
|
||||
|
||||
### `bundle` \[*`subcommand`*\]
|
||||
|
||||
Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store,
|
||||
Whalebrew and Visual Studio Code.
|
||||
|
||||
`brew bundle` \[`install`\]
|
||||
|
||||
: Install and upgrade (by default) all dependencies from the `Brewfile`.
|
||||
|
||||
You can specify the `Brewfile` location using `--file` or by setting the
|
||||
`$HOMEBREW_BUNDLE_FILE` environment variable.
|
||||
|
||||
You can skip the installation of dependencies by adding space-separated values
|
||||
to one or more of the following environment variables:
|
||||
`$HOMEBREW_BUNDLE_BREW_SKIP`, `$HOMEBREW_BUNDLE_CASK_SKIP`,
|
||||
`$HOMEBREW_BUNDLE_MAS_SKIP`, `$HOMEBREW_BUNDLE_WHALEBREW_SKIP`,
|
||||
`$HOMEBREW_BUNDLE_TAP_SKIP`.
|
||||
|
||||
`brew bundle upgrade`
|
||||
|
||||
: Shorthand for `brew bundle install --upgrade`.
|
||||
|
||||
`brew bundle dump`
|
||||
|
||||
: Write all installed casks/formulae/images/taps into a `Brewfile` in the
|
||||
current directory or to a custom file specified with the `--file` option.
|
||||
|
||||
`brew bundle cleanup`
|
||||
|
||||
: Uninstall all dependencies not present in the `Brewfile`.
|
||||
|
||||
This workflow is useful for maintainers or testers who regularly install lots of
|
||||
formulae.
|
||||
|
||||
Unless `--force` is passed, this returns a 1 exit code if anything would be
|
||||
removed.
|
||||
|
||||
`brew bundle check`
|
||||
|
||||
: Check if all dependencies present in the `Brewfile` are installed.
|
||||
|
||||
This provides a successful exit code if everything is up-to-date, making it
|
||||
useful for scripting.
|
||||
|
||||
`brew bundle list`
|
||||
|
||||
: List all dependencies present in the `Brewfile`.
|
||||
|
||||
By default, only Homebrew formula dependencies are listed.
|
||||
|
||||
`brew bundle edit`
|
||||
|
||||
: Edit the `Brewfile` in your editor.
|
||||
|
||||
`brew bundle add` *`name`* \[...\]
|
||||
|
||||
: Add entries to your `Brewfile`. Adds formulae by default. Use `--cask`,
|
||||
`--tap`, `--whalebrew` or `--vscode` to add the corresponding entry instead.
|
||||
|
||||
`brew bundle remove` *`name`* \[...\]
|
||||
|
||||
: Remove entries that match `name` from your `Brewfile`. Use `--formula`,
|
||||
`--cask`, `--tap`, `--mas`, `--whalebrew` or `--vscode` to remove only entries
|
||||
of the corresponding type. Passing `--formula` also removes matches against
|
||||
formula aliases and old formula names.
|
||||
|
||||
`brew bundle exec` *`command`*
|
||||
|
||||
: Run an external command in an isolated build environment based on the
|
||||
`Brewfile` dependencies.
|
||||
|
||||
This sanitized build environment ignores unrequested dependencies, which makes
|
||||
sure that things you didn't specify in your `Brewfile` won't get picked up by
|
||||
commands like `bundle install`, `npm install`, etc. It will also add compiler
|
||||
flags which will help with finding keg-only dependencies like `openssl`,
|
||||
`icu4c`, etc.
|
||||
|
||||
`brew bundle sh`
|
||||
|
||||
: Run your shell in a `brew bundle exec` environment.
|
||||
|
||||
`brew bundle env`
|
||||
|
||||
: Print the environment variables that would be set in a `brew bundle exec`
|
||||
environment.
|
||||
|
||||
`--file`
|
||||
|
||||
: Read from or write to the `Brewfile` from this location. Use `--file=-` to
|
||||
pipe to stdin/stdout.
|
||||
|
||||
`--global`
|
||||
|
||||
: Read from or write to the `Brewfile` from `$HOMEBREW_BUNDLE_FILE_GLOBAL` (if
|
||||
set), `${XDG_CONFIG_HOME}/homebrew/Brewfile` (if `$XDG_CONFIG_HOME` is set),
|
||||
`~/.homebrew/Brewfile` or `~/.Brewfile` otherwise.
|
||||
|
||||
`-v`, `--verbose`
|
||||
|
||||
: `install` prints output from commands as they are run. `check` lists all
|
||||
missing dependencies.
|
||||
|
||||
`--no-upgrade`
|
||||
|
||||
: `install` does not run `brew upgrade` on outdated dependencies. `check` does
|
||||
not check for outdated dependencies. Note they may still be upgraded by `brew
|
||||
install` if needed. This is enabled by default if
|
||||
`$HOMEBREW_BUNDLE_NO_UPGRADE` is set.
|
||||
|
||||
`--upgrade`
|
||||
|
||||
: `install` runs `brew upgrade` on outdated dependencies, even if
|
||||
`$HOMEBREW_BUNDLE_NO_UPGRADE` is set.
|
||||
|
||||
`--install`
|
||||
|
||||
: Run `install` before continuing to other operations e.g. `exec`.
|
||||
|
||||
`-f`, `--force`
|
||||
|
||||
: `install` runs with `--force`/`--overwrite`. `dump` overwrites an existing
|
||||
`Brewfile`. `cleanup` actually performs its cleanup operations.
|
||||
|
||||
`--cleanup`
|
||||
|
||||
: `install` performs cleanup operation, same as running `cleanup --force`. This
|
||||
is enabled by default if `$HOMEBREW_BUNDLE_INSTALL_CLEANUP` is set and
|
||||
`--global` is passed.
|
||||
|
||||
`--all`
|
||||
|
||||
: `list` all dependencies.
|
||||
|
||||
`--formula`
|
||||
|
||||
: `list` or `dump` Homebrew formula dependencies.
|
||||
|
||||
`--cask`
|
||||
|
||||
: `list` or `dump` Homebrew cask dependencies.
|
||||
|
||||
`--tap`
|
||||
|
||||
: `list` or `dump` Homebrew tap dependencies.
|
||||
|
||||
`--mas`
|
||||
|
||||
: `list` or `dump` Mac App Store dependencies.
|
||||
|
||||
`--whalebrew`
|
||||
|
||||
: `list` or `dump` Whalebrew dependencies.
|
||||
|
||||
`--vscode`
|
||||
|
||||
: `list` or `dump` VSCode extensions.
|
||||
|
||||
`--no-vscode`
|
||||
|
||||
: `dump` without VSCode extensions. This is enabled by default if
|
||||
`$HOMEBREW_BUNDLE_DUMP_NO_VSCODE` is set.
|
||||
|
||||
`--describe`
|
||||
|
||||
: `dump` adds a description comment above each line, unless the dependency does
|
||||
not have a description. This is enabled by default if
|
||||
`$HOMEBREW_BUNDLE_DUMP_DESCRIBE` is set.
|
||||
|
||||
`--no-restart`
|
||||
|
||||
: `dump` does not add `restart_service` to formula lines.
|
||||
|
||||
`--zap`
|
||||
|
||||
: `cleanup` casks using the `zap` command instead of `uninstall`.
|
||||
|
||||
### `casks`
|
||||
|
||||
List all locally installable casks including short names.
|
||||
@ -2166,10 +2342,10 @@ Summarise contributions to Homebrew repositories.
|
||||
`--repositories`
|
||||
|
||||
: Specify a comma-separated list of repositories to search. Supported
|
||||
repositories: `brew`, `core`, `cask`, `bundle`, `command-not-found` and
|
||||
`test-bot`. Omitting this flag, or specifying `--repositories=primary`,
|
||||
searches only the main repositories: brew,core,cask. Specifying
|
||||
`--repositories=all`, searches all repositories.
|
||||
repositories: `brew`, `core`, `cask`, `command-not-found` and `test-bot`.
|
||||
Omitting this flag, or specifying `--repositories=primary`, searches only the
|
||||
main repositories: brew,core,cask. Specifying `--repositories=all`, searches
|
||||
all repositories.
|
||||
|
||||
`--from`
|
||||
|
||||
@ -3282,182 +3458,6 @@ These options are applicable across multiple subcommands.
|
||||
|
||||
## OFFICIAL EXTERNAL COMMANDS
|
||||
|
||||
### `bundle` \[*`subcommand`*\]
|
||||
|
||||
Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store,
|
||||
Whalebrew and Visual Studio Code.
|
||||
|
||||
`brew bundle` \[`install`\]
|
||||
|
||||
: Install and upgrade (by default) all dependencies from the `Brewfile`.
|
||||
|
||||
You can specify the `Brewfile` location using `--file` or by setting the
|
||||
`$HOMEBREW_BUNDLE_FILE` environment variable.
|
||||
|
||||
You can skip the installation of dependencies by adding space-separated values
|
||||
to one or more of the following environment variables:
|
||||
`$HOMEBREW_BUNDLE_BREW_SKIP`, `$HOMEBREW_BUNDLE_CASK_SKIP`,
|
||||
`$HOMEBREW_BUNDLE_MAS_SKIP`, `$HOMEBREW_BUNDLE_WHALEBREW_SKIP`,
|
||||
`$HOMEBREW_BUNDLE_TAP_SKIP`.
|
||||
|
||||
`brew bundle upgrade`
|
||||
|
||||
: Shorthand for `brew bundle install --upgrade`.
|
||||
|
||||
`brew bundle dump`
|
||||
|
||||
: Write all installed casks/formulae/images/taps into a `Brewfile` in the
|
||||
current directory or to a custom file specified with the `--file` option.
|
||||
|
||||
`brew bundle cleanup`
|
||||
|
||||
: Uninstall all dependencies not present in the `Brewfile`.
|
||||
|
||||
This workflow is useful for maintainers or testers who regularly install lots of
|
||||
formulae.
|
||||
|
||||
Unless `--force` is passed, this returns a 1 exit code if anything would be
|
||||
removed.
|
||||
|
||||
`brew bundle check`
|
||||
|
||||
: Check if all dependencies present in the `Brewfile` are installed.
|
||||
|
||||
This provides a successful exit code if everything is up-to-date, making it
|
||||
useful for scripting.
|
||||
|
||||
`brew bundle list`
|
||||
|
||||
: List all dependencies present in the `Brewfile`.
|
||||
|
||||
By default, only Homebrew formula dependencies are listed.
|
||||
|
||||
`brew bundle edit`
|
||||
|
||||
: Edit the `Brewfile` in your editor.
|
||||
|
||||
`brew bundle add` *`name`* \[...\]
|
||||
|
||||
: Add entries to your `Brewfile`. Adds formulae by default. Use `--cask`,
|
||||
`--tap`, `--whalebrew` or `--vscode` to add the corresponding entry instead.
|
||||
|
||||
`brew bundle remove` *`name`* \[...\]
|
||||
|
||||
: Remove entries that match `name` from your `Brewfile`. Use `--formula`,
|
||||
`--cask`, `--tap`, `--mas`, `--whalebrew` or `--vscode` to remove only entries
|
||||
of the corresponding type. Passing `--formula` also removes matches against
|
||||
formula aliases and old formula names.
|
||||
|
||||
`brew bundle exec` *`command`*
|
||||
|
||||
: Run an external command in an isolated build environment based on the
|
||||
`Brewfile` dependencies.
|
||||
|
||||
This sanitized build environment ignores unrequested dependencies, which makes
|
||||
sure that things you didn't specify in your `Brewfile` won't get picked up by
|
||||
commands like `bundle install`, `npm install`, etc. It will also add compiler
|
||||
flags which will help with finding keg-only dependencies like `openssl`,
|
||||
`icu4c`, etc.
|
||||
|
||||
`brew bundle sh`
|
||||
|
||||
: Run your shell in a `brew bundle exec` environment.
|
||||
|
||||
`brew bundle env`
|
||||
|
||||
: Print the environment variables that would be set in a `brew bundle exec`
|
||||
environment.
|
||||
|
||||
`--file`
|
||||
|
||||
: Read from or write to the `Brewfile` from this location. Use `--file=-` to
|
||||
pipe to stdin/stdout.
|
||||
|
||||
`--global`
|
||||
|
||||
: Read from or write to the `Brewfile` from `$HOMEBREW_BUNDLE_FILE_GLOBAL` (if
|
||||
set), `${XDG_CONFIG_HOME}/homebrew/Brewfile` (if `$XDG_CONFIG_HOME` is set),
|
||||
`~/.homebrew/Brewfile` or `~/.Brewfile` otherwise.
|
||||
|
||||
`-v`, `--verbose`
|
||||
|
||||
: `install` prints output from commands as they are run. `check` lists all
|
||||
missing dependencies.
|
||||
|
||||
`--no-upgrade`
|
||||
|
||||
: `install` does not run `brew upgrade` on outdated dependencies. `check` does
|
||||
not check for outdated dependencies. Note they may still be upgraded by `brew
|
||||
install` if needed. This is enabled by default if
|
||||
`$HOMEBREW_BUNDLE_NO_UPGRADE` is set.
|
||||
|
||||
`--upgrade`
|
||||
|
||||
: `install` runs `brew upgrade` on outdated dependencies, even if
|
||||
`$HOMEBREW_BUNDLE_NO_UPGRADE` is set.
|
||||
|
||||
`--install`
|
||||
|
||||
: Run `install` before continuing to other operations e.g. `exec`.
|
||||
|
||||
`-f`, `--force`
|
||||
|
||||
: `install` runs with `--force`/`--overwrite`. `dump` overwrites an existing
|
||||
`Brewfile`. `cleanup` actually performs its cleanup operations.
|
||||
|
||||
`--cleanup`
|
||||
|
||||
: `install` performs cleanup operation, same as running `cleanup --force`. This
|
||||
is enabled by default if `$HOMEBREW_BUNDLE_INSTALL_CLEANUP` is set and
|
||||
`--global` is passed.
|
||||
|
||||
`--all`
|
||||
|
||||
: `list` all dependencies.
|
||||
|
||||
`--formula`
|
||||
|
||||
: `list` or `dump` Homebrew formula dependencies.
|
||||
|
||||
`--cask`
|
||||
|
||||
: `list` or `dump` Homebrew cask dependencies.
|
||||
|
||||
`--tap`
|
||||
|
||||
: `list` or `dump` Homebrew tap dependencies.
|
||||
|
||||
`--mas`
|
||||
|
||||
: `list` or `dump` Mac App Store dependencies.
|
||||
|
||||
`--whalebrew`
|
||||
|
||||
: `list` or `dump` Whalebrew dependencies.
|
||||
|
||||
`--vscode`
|
||||
|
||||
: `list` or `dump` VSCode extensions.
|
||||
|
||||
`--no-vscode`
|
||||
|
||||
: `dump` without VSCode extensions. This is enabled by default if
|
||||
`$HOMEBREW_BUNDLE_DUMP_NO_VSCODE` is set.
|
||||
|
||||
`--describe`
|
||||
|
||||
: `dump` adds a description comment above each line, unless the dependency does
|
||||
not have a description. This is enabled by default if
|
||||
`$HOMEBREW_BUNDLE_DUMP_DESCRIBE` is set.
|
||||
|
||||
`--no-restart`
|
||||
|
||||
: `dump` does not add `restart_service` to formula lines.
|
||||
|
||||
`--zap`
|
||||
|
||||
: `cleanup` casks using the `zap` command instead of `uninstall`.
|
||||
|
||||
### `command-not-found-init`
|
||||
|
||||
Print instructions for setting up the command-not-found hook for your shell. If
|
||||
|
||||
220
manpages/brew.1
220
manpages/brew.1
@ -82,6 +82,115 @@ Uninstall formulae that were only installed as a dependency of another formula a
|
||||
.TP
|
||||
\fB\-n\fP, \fB\-\-dry\-run\fP
|
||||
List what would be uninstalled, but do not actually uninstall anything\.
|
||||
.SS "\fBbundle\fP \fR[\fIsubcommand\fP]"
|
||||
Bundler for non\-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store, Whalebrew and Visual Studio Code\.
|
||||
.TP
|
||||
\fBbrew bundle\fP [\fBinstall\fP]
|
||||
Install and upgrade (by default) all dependencies from the \fBBrewfile\fP\&\.
|
||||
.P
|
||||
You can specify the \fBBrewfile\fP location using \fB\-\-file\fP or by setting the \fB$HOMEBREW_BUNDLE_FILE\fP environment variable\.
|
||||
.P
|
||||
You can skip the installation of dependencies by adding space\-separated values to one or more of the following environment variables: \fB$HOMEBREW_BUNDLE_BREW_SKIP\fP, \fB$HOMEBREW_BUNDLE_CASK_SKIP\fP, \fB$HOMEBREW_BUNDLE_MAS_SKIP\fP, \fB$HOMEBREW_BUNDLE_WHALEBREW_SKIP\fP, \fB$HOMEBREW_BUNDLE_TAP_SKIP\fP\&\.
|
||||
.TP
|
||||
\fBbrew bundle upgrade\fP
|
||||
Shorthand for \fBbrew bundle install \-\-upgrade\fP\&\.
|
||||
.TP
|
||||
\fBbrew bundle dump\fP
|
||||
Write all installed casks/formulae/images/taps into a \fBBrewfile\fP in the current directory or to a custom file specified with the \fB\-\-file\fP option\.
|
||||
.TP
|
||||
\fBbrew bundle cleanup\fP
|
||||
Uninstall all dependencies not present in the \fBBrewfile\fP\&\.
|
||||
.P
|
||||
This workflow is useful for maintainers or testers who regularly install lots of formulae\.
|
||||
.P
|
||||
Unless \fB\-\-force\fP is passed, this returns a 1 exit code if anything would be removed\.
|
||||
.TP
|
||||
\fBbrew bundle check\fP
|
||||
Check if all dependencies present in the \fBBrewfile\fP are installed\.
|
||||
.P
|
||||
This provides a successful exit code if everything is up\-to\-date, making it useful for scripting\.
|
||||
.TP
|
||||
\fBbrew bundle list\fP
|
||||
List all dependencies present in the \fBBrewfile\fP\&\.
|
||||
.P
|
||||
By default, only Homebrew formula dependencies are listed\.
|
||||
.TP
|
||||
\fBbrew bundle edit\fP
|
||||
Edit the \fBBrewfile\fP in your editor\.
|
||||
.TP
|
||||
\fBbrew bundle add\fP \fIname\fP [\.\.\.]
|
||||
Add entries to your \fBBrewfile\fP\&\. Adds formulae by default\. Use \fB\-\-cask\fP, \fB\-\-tap\fP, \fB\-\-whalebrew\fP or \fB\-\-vscode\fP to add the corresponding entry instead\.
|
||||
.TP
|
||||
\fBbrew bundle remove\fP \fIname\fP [\.\.\.]
|
||||
Remove entries that match \fBname\fP from your \fBBrewfile\fP\&\. Use \fB\-\-formula\fP, \fB\-\-cask\fP, \fB\-\-tap\fP, \fB\-\-mas\fP, \fB\-\-whalebrew\fP or \fB\-\-vscode\fP to remove only entries of the corresponding type\. Passing \fB\-\-formula\fP also removes matches against formula aliases and old formula names\.
|
||||
.TP
|
||||
\fBbrew bundle exec\fP \fIcommand\fP
|
||||
Run an external command in an isolated build environment based on the \fBBrewfile\fP dependencies\.
|
||||
.P
|
||||
This sanitized build environment ignores unrequested dependencies, which makes sure that things you didn\[u2019]t specify in your \fBBrewfile\fP won\[u2019]t get picked up by commands like \fBbundle install\fP, \fBnpm install\fP, etc\. It will also add compiler flags which will help with finding keg\-only dependencies like \fBopenssl\fP, \fBicu4c\fP, etc\.
|
||||
.TP
|
||||
\fBbrew bundle sh\fP
|
||||
Run your shell in a \fBbrew bundle exec\fP environment\.
|
||||
.TP
|
||||
\fBbrew bundle env\fP
|
||||
Print the environment variables that would be set in a \fBbrew bundle exec\fP environment\.
|
||||
.TP
|
||||
\fB\-\-file\fP
|
||||
Read from or write to the \fBBrewfile\fP from this location\. Use \fB\-\-file=\-\fP to pipe to stdin/stdout\.
|
||||
.TP
|
||||
\fB\-\-global\fP
|
||||
Read from or write to the \fBBrewfile\fP from \fB$HOMEBREW_BUNDLE_FILE_GLOBAL\fP (if set), \fB${XDG_CONFIG_HOME}/homebrew/Brewfile\fP (if \fB$XDG_CONFIG_HOME\fP is set), \fB~/\.homebrew/Brewfile\fP or \fB~/\.Brewfile\fP otherwise\.
|
||||
.TP
|
||||
\fB\-v\fP, \fB\-\-verbose\fP
|
||||
\fBinstall\fP prints output from commands as they are run\. \fBcheck\fP lists all missing dependencies\.
|
||||
.TP
|
||||
\fB\-\-no\-upgrade\fP
|
||||
\fBinstall\fP does not run \fBbrew upgrade\fP on outdated dependencies\. \fBcheck\fP does not check for outdated dependencies\. Note they may still be upgraded by \fBbrew install\fP if needed\. This is enabled by default if \fB$HOMEBREW_BUNDLE_NO_UPGRADE\fP is set\.
|
||||
.TP
|
||||
\fB\-\-upgrade\fP
|
||||
\fBinstall\fP runs \fBbrew upgrade\fP on outdated dependencies, even if \fB$HOMEBREW_BUNDLE_NO_UPGRADE\fP is set\.
|
||||
.TP
|
||||
\fB\-\-install\fP
|
||||
Run \fBinstall\fP before continuing to other operations e\.g\. \fBexec\fP\&\.
|
||||
.TP
|
||||
\fB\-f\fP, \fB\-\-force\fP
|
||||
\fBinstall\fP runs with \fB\-\-force\fP/\fB\-\-overwrite\fP\&\. \fBdump\fP overwrites an existing \fBBrewfile\fP\&\. \fBcleanup\fP actually performs its cleanup operations\.
|
||||
.TP
|
||||
\fB\-\-cleanup\fP
|
||||
\fBinstall\fP performs cleanup operation, same as running \fBcleanup \-\-force\fP\&\. This is enabled by default if \fB$HOMEBREW_BUNDLE_INSTALL_CLEANUP\fP is set and \fB\-\-global\fP is passed\.
|
||||
.TP
|
||||
\fB\-\-all\fP
|
||||
\fBlist\fP all dependencies\.
|
||||
.TP
|
||||
\fB\-\-formula\fP
|
||||
\fBlist\fP or \fBdump\fP Homebrew formula dependencies\.
|
||||
.TP
|
||||
\fB\-\-cask\fP
|
||||
\fBlist\fP or \fBdump\fP Homebrew cask dependencies\.
|
||||
.TP
|
||||
\fB\-\-tap\fP
|
||||
\fBlist\fP or \fBdump\fP Homebrew tap dependencies\.
|
||||
.TP
|
||||
\fB\-\-mas\fP
|
||||
\fBlist\fP or \fBdump\fP Mac App Store dependencies\.
|
||||
.TP
|
||||
\fB\-\-whalebrew\fP
|
||||
\fBlist\fP or \fBdump\fP Whalebrew dependencies\.
|
||||
.TP
|
||||
\fB\-\-vscode\fP
|
||||
\fBlist\fP or \fBdump\fP VSCode extensions\.
|
||||
.TP
|
||||
\fB\-\-no\-vscode\fP
|
||||
\fBdump\fP without VSCode extensions\. This is enabled by default if \fB$HOMEBREW_BUNDLE_DUMP_NO_VSCODE\fP is set\.
|
||||
.TP
|
||||
\fB\-\-describe\fP
|
||||
\fBdump\fP adds a description comment above each line, unless the dependency does not have a description\. This is enabled by default if \fB$HOMEBREW_BUNDLE_DUMP_DESCRIBE\fP is set\.
|
||||
.TP
|
||||
\fB\-\-no\-restart\fP
|
||||
\fBdump\fP does not add \fBrestart_service\fP to formula lines\.
|
||||
.TP
|
||||
\fB\-\-zap\fP
|
||||
\fBcleanup\fP casks using the \fBzap\fP command instead of \fBuninstall\fP\&\.
|
||||
.SS "\fBcasks\fP"
|
||||
List all locally installable casks including short names\.
|
||||
.SS "\fBcleanup\fP \fR[\fIoptions\fP] \fR[\fIformula\fP|\fIcask\fP \.\.\.]"
|
||||
@ -1372,7 +1481,7 @@ Treat all named arguments as casks\.
|
||||
Summarise contributions to Homebrew repositories\.
|
||||
.TP
|
||||
\fB\-\-repositories\fP
|
||||
Specify a comma\-separated list of repositories to search\. Supported repositories: \fBbrew\fP, \fBcore\fP, \fBcask\fP, \fBbundle\fP, \fBcommand\-not\-found\fP and \fBtest\-bot\fP\&\. Omitting this flag, or specifying \fB\-\-repositories=primary\fP, searches only the main repositories: brew,core,cask\. Specifying \fB\-\-repositories=all\fP, searches all repositories\.
|
||||
Specify a comma\-separated list of repositories to search\. Supported repositories: \fBbrew\fP, \fBcore\fP, \fBcask\fP, \fBcommand\-not\-found\fP and \fBtest\-bot\fP\&\. Omitting this flag, or specifying \fB\-\-repositories=primary\fP, searches only the main repositories: brew,core,cask\. Specifying \fB\-\-repositories=all\fP, searches all repositories\.
|
||||
.TP
|
||||
\fB\-\-from\fP
|
||||
Date (ISO\-8601 format) to start searching contributions\. Omitting this flag searches the last year\.
|
||||
@ -2108,115 +2217,6 @@ Make some output more verbose\.
|
||||
\fB\-h\fP, \fB\-\-help\fP
|
||||
Show this message\.
|
||||
.SH "OFFICIAL EXTERNAL COMMANDS"
|
||||
.SS "\fBbundle\fP \fR[\fIsubcommand\fP]"
|
||||
Bundler for non\-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store, Whalebrew and Visual Studio Code\.
|
||||
.TP
|
||||
\fBbrew bundle\fP [\fBinstall\fP]
|
||||
Install and upgrade (by default) all dependencies from the \fBBrewfile\fP\&\.
|
||||
.P
|
||||
You can specify the \fBBrewfile\fP location using \fB\-\-file\fP or by setting the \fB$HOMEBREW_BUNDLE_FILE\fP environment variable\.
|
||||
.P
|
||||
You can skip the installation of dependencies by adding space\-separated values to one or more of the following environment variables: \fB$HOMEBREW_BUNDLE_BREW_SKIP\fP, \fB$HOMEBREW_BUNDLE_CASK_SKIP\fP, \fB$HOMEBREW_BUNDLE_MAS_SKIP\fP, \fB$HOMEBREW_BUNDLE_WHALEBREW_SKIP\fP, \fB$HOMEBREW_BUNDLE_TAP_SKIP\fP\&\.
|
||||
.TP
|
||||
\fBbrew bundle upgrade\fP
|
||||
Shorthand for \fBbrew bundle install \-\-upgrade\fP\&\.
|
||||
.TP
|
||||
\fBbrew bundle dump\fP
|
||||
Write all installed casks/formulae/images/taps into a \fBBrewfile\fP in the current directory or to a custom file specified with the \fB\-\-file\fP option\.
|
||||
.TP
|
||||
\fBbrew bundle cleanup\fP
|
||||
Uninstall all dependencies not present in the \fBBrewfile\fP\&\.
|
||||
.P
|
||||
This workflow is useful for maintainers or testers who regularly install lots of formulae\.
|
||||
.P
|
||||
Unless \fB\-\-force\fP is passed, this returns a 1 exit code if anything would be removed\.
|
||||
.TP
|
||||
\fBbrew bundle check\fP
|
||||
Check if all dependencies present in the \fBBrewfile\fP are installed\.
|
||||
.P
|
||||
This provides a successful exit code if everything is up\-to\-date, making it useful for scripting\.
|
||||
.TP
|
||||
\fBbrew bundle list\fP
|
||||
List all dependencies present in the \fBBrewfile\fP\&\.
|
||||
.P
|
||||
By default, only Homebrew formula dependencies are listed\.
|
||||
.TP
|
||||
\fBbrew bundle edit\fP
|
||||
Edit the \fBBrewfile\fP in your editor\.
|
||||
.TP
|
||||
\fBbrew bundle add\fP \fIname\fP [\.\.\.]
|
||||
Add entries to your \fBBrewfile\fP\&\. Adds formulae by default\. Use \fB\-\-cask\fP, \fB\-\-tap\fP, \fB\-\-whalebrew\fP or \fB\-\-vscode\fP to add the corresponding entry instead\.
|
||||
.TP
|
||||
\fBbrew bundle remove\fP \fIname\fP [\.\.\.]
|
||||
Remove entries that match \fBname\fP from your \fBBrewfile\fP\&\. Use \fB\-\-formula\fP, \fB\-\-cask\fP, \fB\-\-tap\fP, \fB\-\-mas\fP, \fB\-\-whalebrew\fP or \fB\-\-vscode\fP to remove only entries of the corresponding type\. Passing \fB\-\-formula\fP also removes matches against formula aliases and old formula names\.
|
||||
.TP
|
||||
\fBbrew bundle exec\fP \fIcommand\fP
|
||||
Run an external command in an isolated build environment based on the \fBBrewfile\fP dependencies\.
|
||||
.P
|
||||
This sanitized build environment ignores unrequested dependencies, which makes sure that things you didn\[u2019]t specify in your \fBBrewfile\fP won\[u2019]t get picked up by commands like \fBbundle install\fP, \fBnpm install\fP, etc\. It will also add compiler flags which will help with finding keg\-only dependencies like \fBopenssl\fP, \fBicu4c\fP, etc\.
|
||||
.TP
|
||||
\fBbrew bundle sh\fP
|
||||
Run your shell in a \fBbrew bundle exec\fP environment\.
|
||||
.TP
|
||||
\fBbrew bundle env\fP
|
||||
Print the environment variables that would be set in a \fBbrew bundle exec\fP environment\.
|
||||
.TP
|
||||
\fB\-\-file\fP
|
||||
Read from or write to the \fBBrewfile\fP from this location\. Use \fB\-\-file=\-\fP to pipe to stdin/stdout\.
|
||||
.TP
|
||||
\fB\-\-global\fP
|
||||
Read from or write to the \fBBrewfile\fP from \fB$HOMEBREW_BUNDLE_FILE_GLOBAL\fP (if set), \fB${XDG_CONFIG_HOME}/homebrew/Brewfile\fP (if \fB$XDG_CONFIG_HOME\fP is set), \fB~/\.homebrew/Brewfile\fP or \fB~/\.Brewfile\fP otherwise\.
|
||||
.TP
|
||||
\fB\-v\fP, \fB\-\-verbose\fP
|
||||
\fBinstall\fP prints output from commands as they are run\. \fBcheck\fP lists all missing dependencies\.
|
||||
.TP
|
||||
\fB\-\-no\-upgrade\fP
|
||||
\fBinstall\fP does not run \fBbrew upgrade\fP on outdated dependencies\. \fBcheck\fP does not check for outdated dependencies\. Note they may still be upgraded by \fBbrew install\fP if needed\. This is enabled by default if \fB$HOMEBREW_BUNDLE_NO_UPGRADE\fP is set\.
|
||||
.TP
|
||||
\fB\-\-upgrade\fP
|
||||
\fBinstall\fP runs \fBbrew upgrade\fP on outdated dependencies, even if \fB$HOMEBREW_BUNDLE_NO_UPGRADE\fP is set\.
|
||||
.TP
|
||||
\fB\-\-install\fP
|
||||
Run \fBinstall\fP before continuing to other operations e\.g\. \fBexec\fP\&\.
|
||||
.TP
|
||||
\fB\-f\fP, \fB\-\-force\fP
|
||||
\fBinstall\fP runs with \fB\-\-force\fP/\fB\-\-overwrite\fP\&\. \fBdump\fP overwrites an existing \fBBrewfile\fP\&\. \fBcleanup\fP actually performs its cleanup operations\.
|
||||
.TP
|
||||
\fB\-\-cleanup\fP
|
||||
\fBinstall\fP performs cleanup operation, same as running \fBcleanup \-\-force\fP\&\. This is enabled by default if \fB$HOMEBREW_BUNDLE_INSTALL_CLEANUP\fP is set and \fB\-\-global\fP is passed\.
|
||||
.TP
|
||||
\fB\-\-all\fP
|
||||
\fBlist\fP all dependencies\.
|
||||
.TP
|
||||
\fB\-\-formula\fP
|
||||
\fBlist\fP or \fBdump\fP Homebrew formula dependencies\.
|
||||
.TP
|
||||
\fB\-\-cask\fP
|
||||
\fBlist\fP or \fBdump\fP Homebrew cask dependencies\.
|
||||
.TP
|
||||
\fB\-\-tap\fP
|
||||
\fBlist\fP or \fBdump\fP Homebrew tap dependencies\.
|
||||
.TP
|
||||
\fB\-\-mas\fP
|
||||
\fBlist\fP or \fBdump\fP Mac App Store dependencies\.
|
||||
.TP
|
||||
\fB\-\-whalebrew\fP
|
||||
\fBlist\fP or \fBdump\fP Whalebrew dependencies\.
|
||||
.TP
|
||||
\fB\-\-vscode\fP
|
||||
\fBlist\fP or \fBdump\fP VSCode extensions\.
|
||||
.TP
|
||||
\fB\-\-no\-vscode\fP
|
||||
\fBdump\fP without VSCode extensions\. This is enabled by default if \fB$HOMEBREW_BUNDLE_DUMP_NO_VSCODE\fP is set\.
|
||||
.TP
|
||||
\fB\-\-describe\fP
|
||||
\fBdump\fP adds a description comment above each line, unless the dependency does not have a description\. This is enabled by default if \fB$HOMEBREW_BUNDLE_DUMP_DESCRIBE\fP is set\.
|
||||
.TP
|
||||
\fB\-\-no\-restart\fP
|
||||
\fBdump\fP does not add \fBrestart_service\fP to formula lines\.
|
||||
.TP
|
||||
\fB\-\-zap\fP
|
||||
\fBcleanup\fP casks using the \fBzap\fP command instead of \fBuninstall\fP\&\.
|
||||
.SS "\fBcommand\-not\-found\-init\fP"
|
||||
Print instructions for setting up the command\-not\-found hook for your shell\. If the output is not to a tty, print the appropriate handler script for your shell\.
|
||||
.SS "\fBtest\-bot\fP \fR[\fIoptions\fP] \fR[\fIformula\fP]"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user