Skip to content

Commit

Permalink
docs: update manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
XuehaiPan committed Oct 6, 2023
1 parent 6f0d87a commit 69d2804
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 27 deletions.
24 changes: 10 additions & 14 deletions docs/Manpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -667,8 +667,8 @@ Print export statements. When run in a shell, this installation of Homebrew will

The variables `HOMEBREW_PREFIX`, `HOMEBREW_CELLAR` and `HOMEBREW_REPOSITORY` are also exported to avoid querying them multiple times.
To help guarantee idempotence, this command produces no output when Homebrew's `bin` and `sbin` directories are first and second
respectively in your `PATH`. Consider adding evaluation of this command's output to your dotfiles (e.g. `~/.profile`,
`~/.bash_profile`, or `~/.zprofile`) with: `eval "$(brew shellenv)"`
respectively in your `PATH`. Consider adding evaluation of this command's output to your dotfiles (e.g. `~/.bash_profile` or
`~/.zprofile` on macOS and `~/.bashrc` or `~/.zshrc` on Linux) with: `eval "$(brew shellenv)"`

The shell can be specified explicitly with a supported shell name parameter. Unknown shells will output POSIX exports.

Expand Down Expand Up @@ -1848,15 +1848,15 @@ This sanitized build environment ignores unrequested dependencies, which makes s
* `--file`:
Read the `Brewfile` from this location. Use `--file=-` to pipe to stdin/stdout.
* `--global`:
Read the `Brewfile` from `~/.Brewfile` or the `HOMEBREW_BUNDLE_FILE_GLOBAL` environment variable, if set.
Read the `Brewfile` from `~/.Brewfile`.
* `-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.
* `-f`, `--force`:
`install` runs with `--force`/`--overwrite`. `dump` overwrites an existing `Brewfile`. `cleanup` actually performs its cleanup operations.
`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`.
* `--no-lock`:
`install` won't output a `Brewfile.lock.json`.
* `--all`:
Expand All @@ -1874,7 +1874,7 @@ This sanitized build environment ignores unrequested dependencies, which makes s
* `--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.
* `--no-restart`:
`dump` does not add `restart_service` to formula lines.
* `--zap`:
Expand All @@ -1887,15 +1887,13 @@ If the output is not to a tty, print the appropriate handler script for your she

### `services` [*`subcommand`*]

Manage background services with macOS' `launchctl`(1) daemon manager or
Linux's `systemctl`(1) service manager.
Manage background services with macOS' `launchctl`(1) daemon manager.

If `sudo` is passed, operate on `/Library/LaunchDaemons`/`/usr/lib/systemd/system` (started at boot).
Otherwise, operate on `~/Library/LaunchAgents`/`~/.config/systemd/user` (started at login).
If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot).
Otherwise, operate on `~/Library/LaunchAgents` (started at login).

[`sudo`] `brew services` [`list`] (`--json`) (`--debug`)
[`sudo`] `brew services` [`list`] (`--json`)
<br>List information about all managed services for the current user (or root).
Provides more output from Homebrew and `launchctl`(1) or `systemctl`(1) if run with `--debug`.

[`sudo`] `brew services info` (*`formula`*|`--all`|`--json`)
<br>List all managed services for the current user (or root).
Expand All @@ -1920,8 +1918,6 @@ Provides more output from Homebrew and `launchctl`(1) or `systemctl`(1) if run w

* `--file`:
Use the service file from this location to `start` the service.
* `--sudo-service-user`:
When run as root on macOS, run the service(s) as this user.
* `--all`:
Run *`subcommand`* on all services.
* `--json`:
Expand Down
22 changes: 9 additions & 13 deletions manpages/brew.1
Original file line number Diff line number Diff line change
Expand Up @@ -944,7 +944,7 @@ Search for \fItext\fR in the given database\.
Print export statements\. When run in a shell, this installation of Homebrew will be added to your \fBPATH\fR, \fBMANPATH\fR, and \fBINFOPATH\fR\.
.
.P
The variables \fBHOMEBREW_PREFIX\fR, \fBHOMEBREW_CELLAR\fR and \fBHOMEBREW_REPOSITORY\fR are also exported to avoid querying them multiple times\. To help guarantee idempotence, this command produces no output when Homebrew\'s \fBbin\fR and \fBsbin\fR directories are first and second respectively in your \fBPATH\fR\. Consider adding evaluation of this command\'s output to your dotfiles (e\.g\. \fB~/\.profile\fR, \fB~/\.bash_profile\fR, or \fB~/\.zprofile\fR) with: \fBeval "$(brew shellenv)"\fR
The variables \fBHOMEBREW_PREFIX\fR, \fBHOMEBREW_CELLAR\fR and \fBHOMEBREW_REPOSITORY\fR are also exported to avoid querying them multiple times\. To help guarantee idempotence, this command produces no output when Homebrew\'s \fBbin\fR and \fBsbin\fR directories are first and second respectively in your \fBPATH\fR\. Consider adding evaluation of this command\'s output to your dotfiles (e\.g\. \fB~/\.bash_profile\fR or \fB~/\.zprofile\fR on macOS and \fB~/\.bashrc\fR or \fB~/\.zshrc\fR on Linux) with: \fBeval "$(brew shellenv)"\fR
.
.P
The shell can be specified explicitly with a supported shell name parameter\. Unknown shells will output POSIX exports\.
Expand Down Expand Up @@ -2622,7 +2622,7 @@ Read the \fBBrewfile\fR from this location\. Use \fB\-\-file=\-\fR to pipe to st
.
.TP
\fB\-\-global\fR
Read the \fBBrewfile\fR from \fB~/\.Brewfile\fR or the \fBHOMEBREW_BUNDLE_FILE_GLOBAL\fR environment variable, if set\.
Read the \fBBrewfile\fR from \fB~/\.Brewfile\fR\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Expand All @@ -2634,11 +2634,11 @@ Read the \fBBrewfile\fR from \fB~/\.Brewfile\fR or the \fBHOMEBREW_BUNDLE_FILE_G
.
.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\.
\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\.
.
.TP
\fB\-\-no\-lock\fR
Expand Down Expand Up @@ -2674,7 +2674,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\.
.
.TP
\fB\-\-no\-restart\fR
Expand All @@ -2688,14 +2688,14 @@ Read the \fBBrewfile\fR from \fB~/\.Brewfile\fR or the \fBHOMEBREW_BUNDLE_FILE_G
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 "\fBservices\fR [\fIsubcommand\fR]"
Manage background services with macOS\' \fBlaunchctl\fR(1) daemon manager or Linux\'s \fBsystemctl\fR(1) service manager\.
Manage background services with macOS\' \fBlaunchctl\fR(1) daemon manager\.
.
.P
If \fBsudo\fR is passed, operate on \fB/Library/LaunchDaemons\fR/\fB/usr/lib/systemd/system\fR (started at boot)\. Otherwise, operate on \fB~/Library/LaunchAgents\fR/\fB~/\.config/systemd/user\fR (started at login)\.
If \fBsudo\fR is passed, operate on \fB/Library/LaunchDaemons\fR (started at boot)\. Otherwise, operate on \fB~/Library/LaunchAgents\fR (started at login)\.
.
.P
[\fBsudo\fR] \fBbrew services\fR [\fBlist\fR] (\fB\-\-json\fR) (\fB\-\-debug\fR)
List information about all managed services for the current user (or root)\. Provides more output from Homebrew and \fBlaunchctl\fR(1) or \fBsystemctl\fR(1) if run with \fB\-\-debug\fR\.
[\fBsudo\fR] \fBbrew services\fR [\fBlist\fR] (\fB\-\-json\fR)
List information about all managed services for the current user (or root)\.
.
.P
[\fBsudo\fR] \fBbrew services info\fR (\fIformula\fR|\fB\-\-all\fR|\fB\-\-json\fR)
Expand Down Expand Up @@ -2730,10 +2730,6 @@ If \fBsudo\fR is passed, operate on \fB/Library/LaunchDaemons\fR/\fB/usr/lib/sys
Use the service file from this location to \fBstart\fR the service\.
.
.TP
\fB\-\-sudo\-service\-user\fR
When run as root on macOS, run the service(s) as this user\.
.
.TP
\fB\-\-all\fR
Run \fIsubcommand\fR on all services\.
.
Expand Down

0 comments on commit 69d2804

Please sign in to comment.