Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update manpage and completions. #16706

Merged
merged 1 commit into from
Feb 20, 2024
+36 −36
Merged

Update manpage and completions. #16706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions docs/Manpage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1800,27 +1800,27 @@ process has finished successfully.
<br>Cancel the autoupdate, delete the plist and logs.

`brew autoupdate status`
<br>Prints the current status of this tool.
<br>Print the current status of this tool.

`brew autoupdate version`
<br>Output this tool's current version, and a short changelog.

* `--upgrade`:
Automatically upgrade your installed formulae. If the Caskroom exists locally Casks will be upgraded as well. Must be passed with `start`.
Automatically upgrade your installed formulae. If the Caskroom exists locally then casks will be upgraded as well. Must be passed with `start`.
* `--greedy`:
Upgrade casks with --greedy (include auto-updating casks). Must be passed with `start`.
Upgrade casks with `--greedy` (include auto-updating casks). Must be passed with `start`.
* `--cleanup`:
Automatically clean brew's cache and logs. Must be passed with `start`.
Automatically clean Homebrew's cache and logs. Must be passed with `start`.
* `--enable-notification`:
Send a notification when the autoupdate process has finished successfully, if `terminal-notifier` is installed and found. Must be passed with `start`. Note: notifications are enabled by default on macOS Catalina and newer.
* `--immediate`:
Starts the autoupdate command immediately and on system boot, instead of waiting for one interval (24 hours by default) to pass first. Must be passed with `start`.
* `--sudo`:
If a Cask requires sudo, autoupdate will open a GUI to ask for the password. Requires https://formulae.brew.sh/formula/pinentry-mac to be installed.
If a cask requires `sudo`, autoupdate will open a GUI to ask for the password. Requires https://formulae.brew.sh/formula/pinentry-mac to be installed.

### `bundle` [*`subcommand`*]

Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store and Whalebrew.
Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store, Whalebrew and Visual Studio Code.

`brew bundle` [`install`]
<br>Install and upgrade (by default) all dependencies from the `Brewfile`.
Expand All @@ -1829,30 +1829,30 @@ You can specify the `Brewfile` location using `--file` or by setting the `HOMEBR

You can skip the installation of dependencies by adding space-separated values to one or more of the following environment variables: `HOMEBREW_BUNDLE_BREW_SKIP`, `HOMEBREW_BUNDLE_CASK_SKIP`, `HOMEBREW_BUNDLE_MAS_SKIP`, `HOMEBREW_BUNDLE_WHALEBREW_SKIP`, `HOMEBREW_BUNDLE_TAP_SKIP`.

`brew bundle` will output a `Brewfile.lock.json` in the same directory as the `Brewfile` if all dependencies are installed successfully. This contains dependency and system status information which can be useful in debugging `brew bundle` failures and replicating a "last known good build" state. You can opt-out of this behaviour by setting the `HOMEBREW_BUNDLE_NO_LOCK` environment variable or passing the `--no-lock` option. You may wish to check this file into the same version control system as your `Brewfile` (or ensure your version control system ignores it if you'd prefer to rely on debugging information from a local machine).
`brew bundle` will output a `Brewfile.lock.json` in the same directory as the `Brewfile` if all dependencies are installed successfully. This contains dependency and system status information which can be useful for debugging `brew bundle` failures and replicating a "last known good build" state. You can opt-out of this behaviour by setting the `HOMEBREW_BUNDLE_NO_LOCK` environment variable or passing the `--no-lock` option. You may wish to check this file into the same version control system as your `Brewfile` (or ensure your version control system ignores it if you'd prefer to rely on debugging information from a local machine).

`brew bundle dump`
<br>Write all installed casks/formulae/images/taps into a `Brewfile` in the current directory.

`brew bundle cleanup`
<br>Uninstall all dependencies not listed from the `Brewfile`.
<br>Uninstall all dependencies not present in the `Brewfile`.

This workflow is useful for maintainers or testers who regularly install lots of formulae.

`brew bundle check`
<br>Check if all dependencies are installed from the `Brewfile`.
<br>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`
<br>List all dependencies present in the `Brewfile`.

By default, only Homebrew dependencies are listed.
By default, only Homebrew formula dependencies are listed.

`brew bundle exec` *`command`*
<br>Run an external command in an isolated build environment based on the `Brewfile` dependencies.

This sanitized build environment ignores unrequested dependencies, which makes sure that things you didn't specify in your `Brewfile` won't get picked up by commands like `bundle install`, `npm install`, etc. It will also add compiler flags which will help find keg-only dependencies like `openssl`, `icu4c`, etc.
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.

* `--file`:
Read the `Brewfile` from this location. Use `--file=-` to pipe to stdin/stdout.
Expand All @@ -1861,29 +1861,29 @@ This sanitized build environment ignores unrequested dependencies, which makes s
* `-v`, `--verbose`:
`install` prints output from commands as they are run. `check` lists all missing dependencies.
* `--no-upgrade`:
`install` won't run `brew upgrade` on outdated dependencies. Note they may still be upgraded by `brew install` if needed.
`install` does not run `brew upgrade` on outdated dependencies. Note they may still be upgraded by `brew install` if needed.
* `-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.
`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.
* `--no-lock`:
`install` won't output a `Brewfile.lock.json`.
`install` does not output a `Brewfile.lock.json`.
* `--all`:
`list` all dependencies.
* `--formula`:
`list` Homebrew dependencies.
`list` Homebrew formula dependencies.
* `--cask`:
`list` Homebrew Cask dependencies.
`list` Homebrew cask dependencies.
* `--tap`:
`list` tap dependencies.
`list` Homebrew tap dependencies.
* `--mas`:
`list` Mac App Store dependencies.
* `--whalebrew`:
`list` Whalebrew dependencies.
* `--vscode`:
`list` VSCode extensions.
* `--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.
`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`:
Expand Down
36 changes: 18 additions & 18 deletions manpages/brew.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2544,23 +2544,23 @@ This script will run \fBbrew update\fR in the background once every 24 hours (by
.
.P
\fBbrew autoupdate status\fR
Prints the current status of this tool\.
Print the current status of this tool\.
.
.P
\fBbrew autoupdate version\fR
Output this tool\'s current version, and a short changelog\.
.
.TP
\fB\-\-upgrade\fR
Automatically upgrade your installed formulae\. If the Caskroom exists locally Casks will be upgraded as well\. Must be passed with \fBstart\fR\.
Automatically upgrade your installed formulae\. If the Caskroom exists locally then casks will be upgraded as well\. Must be passed with \fBstart\fR\.
.
.TP
\fB\-\-greedy\fR
Upgrade casks with \-\-greedy (include auto\-updating casks)\. Must be passed with \fBstart\fR\.
Upgrade casks with \fB\-\-greedy\fR (include auto\-updating casks)\. Must be passed with \fBstart\fR\.
.
.TP
\fB\-\-cleanup\fR
Automatically clean brew\'s cache and logs\. Must be passed with \fBstart\fR\.
Automatically clean Homebrew\'s cache and logs\. Must be passed with \fBstart\fR\.
.
.TP
\fB\-\-enable\-notification\fR
Expand All @@ -2572,10 +2572,10 @@ Starts the autoupdate command immediately and on system boot, instead of waiting
.
.TP
\fB\-\-sudo\fR
If a Cask requires sudo, autoupdate will open a GUI to ask for the password\. Requires https://formulae\.brew\.sh/formula/pinentry\-mac to be installed\.
If a cask requires \fBsudo\fR, autoupdate will open a GUI to ask for the password\. Requires https://formulae\.brew\.sh/formula/pinentry\-mac to be installed\.
.
.SS "\fBbundle\fR [\fIsubcommand\fR]"
Bundler for non\-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store and Whalebrew\.
Bundler for non\-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store, Whalebrew and Visual Studio Code\.
.
.P
\fBbrew bundle\fR [\fBinstall\fR]
Expand All @@ -2588,22 +2588,22 @@ You can specify the \fBBrewfile\fR location using \fB\-\-file\fR or by setting t
You can skip the installation of dependencies by adding space\-separated values to one or more of the following environment variables: \fBHOMEBREW_BUNDLE_BREW_SKIP\fR, \fBHOMEBREW_BUNDLE_CASK_SKIP\fR, \fBHOMEBREW_BUNDLE_MAS_SKIP\fR, \fBHOMEBREW_BUNDLE_WHALEBREW_SKIP\fR, \fBHOMEBREW_BUNDLE_TAP_SKIP\fR\.
.
.P
\fBbrew bundle\fR will output a \fBBrewfile\.lock\.json\fR in the same directory as the \fBBrewfile\fR if all dependencies are installed successfully\. This contains dependency and system status information which can be useful in debugging \fBbrew bundle\fR failures and replicating a "last known good build" state\. You can opt\-out of this behaviour by setting the \fBHOMEBREW_BUNDLE_NO_LOCK\fR environment variable or passing the \fB\-\-no\-lock\fR option\. You may wish to check this file into the same version control system as your \fBBrewfile\fR (or ensure your version control system ignores it if you\'d prefer to rely on debugging information from a local machine)\.
\fBbrew bundle\fR will output a \fBBrewfile\.lock\.json\fR in the same directory as the \fBBrewfile\fR if all dependencies are installed successfully\. This contains dependency and system status information which can be useful for debugging \fBbrew bundle\fR failures and replicating a "last known good build" state\. You can opt\-out of this behaviour by setting the \fBHOMEBREW_BUNDLE_NO_LOCK\fR environment variable or passing the \fB\-\-no\-lock\fR option\. You may wish to check this file into the same version control system as your \fBBrewfile\fR (or ensure your version control system ignores it if you\'d prefer to rely on debugging information from a local machine)\.
.
.P
\fBbrew bundle dump\fR
Write all installed casks/formulae/images/taps into a \fBBrewfile\fR in the current directory\.
.
.P
\fBbrew bundle cleanup\fR
Uninstall all dependencies not listed from the \fBBrewfile\fR\.
Uninstall all dependencies not present in the \fBBrewfile\fR\.
.
.P
This workflow is useful for maintainers or testers who regularly install lots of formulae\.
.
.P
\fBbrew bundle check\fR
Check if all dependencies are installed from the \fBBrewfile\fR\.
Check if all dependencies present in the \fBBrewfile\fR are installed\.
.
.P
This provides a successful exit code if everything is up\-to\-date, making it useful for scripting\.
Expand All @@ -2613,14 +2613,14 @@ This provides a successful exit code if everything is up\-to\-date, making it us
List all dependencies present in the \fBBrewfile\fR\.
.
.P
By default, only Homebrew dependencies are listed\.
By default, only Homebrew formula dependencies are listed\.
.
.P
\fBbrew bundle exec\fR \fIcommand\fR
Run an external command in an isolated build environment based on the \fBBrewfile\fR dependencies\.
.
.P
This sanitized build environment ignores unrequested dependencies, which makes sure that things you didn\'t specify in your \fBBrewfile\fR won\'t get picked up by commands like \fBbundle install\fR, \fBnpm install\fR, etc\. It will also add compiler flags which will help find keg\-only dependencies like \fBopenssl\fR, \fBicu4c\fR, etc\.
This sanitized build environment ignores unrequested dependencies, which makes sure that things you didn\'t specify in your \fBBrewfile\fR won\'t get picked up by commands like \fBbundle install\fR, \fBnpm install\fR, etc\. It will also add compiler flags which will help with finding keg\-only dependencies like \fBopenssl\fR, \fBicu4c\fR, etc\.
.
.TP
\fB\-\-file\fR
Expand All @@ -2636,35 +2636,35 @@ Read the \fBBrewfile\fR from \fB~/\.Brewfile\fR or the \fBHOMEBREW_BUNDLE_FILE_G
.
.TP
\fB\-\-no\-upgrade\fR
\fBinstall\fR won\'t run \fBbrew upgrade\fR on outdated dependencies\. Note they may still be upgraded by \fBbrew install\fR if needed\.
\fBinstall\fR does not run \fBbrew upgrade\fR on outdated dependencies\. Note they may still be upgraded by \fBbrew install\fR if needed\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
\fBinstall\fR runs with \fB\-\-force\fR/\fB\-\-overwrite\fR\. \fBdump\fR overwrites an existing \fBBrewfile\fR\. \fBcleanup\fR actually performs its cleanup operations\.
.
.TP
\fB\-\-cleanup\fR
\fBinstall\fR performs cleanup operation, same as running \fBcleanup \-\-force\fR\. This is enabled by default if HOMEBREW_BUNDLE_INSTALL_CLEANUP is set and \fB\-\-global\fR is passed\.
\fBinstall\fR performs cleanup operation, same as running \fBcleanup \-\-force\fR\. This is enabled by default if \fBHOMEBREW_BUNDLE_INSTALL_CLEANUP\fR is set and \fB\-\-global\fR is passed\.
.
.TP
\fB\-\-no\-lock\fR
\fBinstall\fR won\'t output a \fBBrewfile\.lock\.json\fR\.
\fBinstall\fR does not output a \fBBrewfile\.lock\.json\fR\.
.
.TP
\fB\-\-all\fR
\fBlist\fR all dependencies\.
.
.TP
\fB\-\-formula\fR
\fBlist\fR Homebrew dependencies\.
\fBlist\fR Homebrew formula dependencies\.
.
.TP
\fB\-\-cask\fR
\fBlist\fR Homebrew Cask dependencies\.
\fBlist\fR Homebrew cask dependencies\.
.
.TP
\fB\-\-tap\fR
\fBlist\fR tap dependencies\.
\fBlist\fR Homebrew tap dependencies\.
.
.TP
\fB\-\-mas\fR
Expand All @@ -2680,7 +2680,7 @@ Read the \fBBrewfile\fR from \fB~/\.Brewfile\fR or the \fBHOMEBREW_BUNDLE_FILE_G
.
.TP
\fB\-\-describe\fR
\fBdump\fR 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\.
\fBdump\fR adds a description comment above each line, unless the dependency does not have a description\. This is enabled by default if \fBHOMEBREW_BUNDLE_DUMP_DESCRIBE\fR is set\.
.
.TP
\fB\-\-no\-restart\fR
Expand Down
Loading