Skip to content

Commit

Permalink
Update manpage and completions.
Browse files Browse the repository at this point in the history
Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
  • Loading branch information
BrewTestBot committed Jan 24, 2025
1 parent dcf744d commit b7a92f4
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 2 deletions.
25 changes: 24 additions & 1 deletion docs/Manpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -3086,6 +3086,10 @@ to one or more of the following environment variables:
`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
Expand Down Expand Up @@ -3114,6 +3118,10 @@ useful for scripting.

By default, only Homebrew formula dependencies are listed.

`brew bundle edit`

: Edit the `Brewfile` in your editor.

`brew bundle exec` *`command`*

: Run an external command in an isolated build environment based on the
Expand All @@ -3125,6 +3133,15 @@ 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 the `Brewfile` from this location. Use `--file=-` to pipe to
Expand All @@ -3144,7 +3161,13 @@ flags which will help with finding keg-only dependencies like `openssl`,

: `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.
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.

`-f`, `--force`

Expand Down
17 changes: 16 additions & 1 deletion manpages/brew.1
Original file line number Diff line number Diff line change
Expand Up @@ -1979,6 +1979,9 @@ You can specify the \fBBrewfile\fP location using \fB\-\-file\fP or by setting t
.P
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\fP, \fBHOMEBREW_BUNDLE_CASK_SKIP\fP, \fBHOMEBREW_BUNDLE_MAS_SKIP\fP, \fBHOMEBREW_BUNDLE_WHALEBREW_SKIP\fP, \fBHOMEBREW_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\.
.TP
Expand All @@ -1999,11 +2002,20 @@ 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 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 the \fBBrewfile\fP from this location\. Use \fB\-\-file=\-\fP to pipe to stdin/stdout\.
.TP
Expand All @@ -2014,7 +2026,10 @@ Read the \fBBrewfile\fP from \fB~/\.Brewfile\fP or the \fBHOMEBREW_BUNDLE_FILE_G
\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\.
\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 \fBHOMEBREW_BUNDLE_NO_UPGRADE\fP is set\.
.TP
\fB\-\-upgrade\fP
\fBinstall\fP runs \fBbrew upgrade\fP on outdated dependencies, even if \fBHOMEBREW_BUNDLE_NO_UPGRADE\fP is set\.
.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\.
Expand Down

0 comments on commit b7a92f4

Please sign in to comment.