Skip to content

Commit

Permalink
Merge pull request #16055 from Homebrew/sponsors-maintainers-man-comp…
Browse files Browse the repository at this point in the history
…letions

Update manpage and completions.
  • Loading branch information
Bo98 committed Sep 29, 2023
2 parents f2c8b2e + f47afa3 commit e7b0110
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 14 deletions.
18 changes: 11 additions & 7 deletions docs/Manpage.md
Original file line number Diff line number Diff line change
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`.
Read the `Brewfile` from `~/.Brewfile` or the `HOMEBREW_BUNDLE_FILE_GLOBAL` environment variable, if set.
* `-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`:
`dump` overwrites an existing `Brewfile`. `cleanup` actually performs its cleanup operations.
* `--cleanup`:
`install` performs cleanup operation, same as running `cleanup --force`.
`install` performs cleanup operation, same as running `cleanup --force`. This is enabled by default if HOMEBREW_BUNDLE_INSTALL_CLEANUP is set.
* `--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.
`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 All @@ -1887,13 +1887,15 @@ 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.
Manage background services with macOS' `launchctl`(1) daemon manager or
Linux's `systemctl`(1) service manager.

If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot).
Otherwise, operate on `~/Library/LaunchAgents` (started at login).
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).

[`sudo`] `brew services` [`list`] (`--json`)
[`sudo`] `brew services` [`list`] (`--json`) (`--debug`)
<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 @@ -1918,6 +1920,8 @@ Otherwise, operate on `~/Library/LaunchAgents` (started at login).

* `--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
18 changes: 11 additions & 7 deletions manpages/brew.1
Original file line number Diff line number Diff line change
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\.
Read the \fBBrewfile\fR from \fB~/\.Brewfile\fR or the \fBHOMEBREW_BUNDLE_FILE_GLOBAL\fR environment variable, if set\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Expand All @@ -2638,7 +2638,7 @@ Read the \fBBrewfile\fR from \fB~/\.Brewfile\fR\.
.
.TP
\fB\-\-cleanup\fR
\fBinstall\fR performs cleanup operation, same as running \fBcleanup \-\-force\fR\.
\fBinstall\fR performs cleanup operation, same as running \fBcleanup \-\-force\fR\. This is enabled by default if HOMEBREW_BUNDLE_INSTALL_CLEANUP is set\.
.
.TP
\fB\-\-no\-lock\fR
Expand Down Expand Up @@ -2674,7 +2674,7 @@ Read the \fBBrewfile\fR from \fB~/\.Brewfile\fR\.
.
.TP
\fB\-\-describe\fR
\fBdump\fR adds a description comment above each line, unless the dependency does not have a description\.
\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\.
.
.TP
\fB\-\-no\-restart\fR
Expand All @@ -2688,14 +2688,14 @@ Read the \fBBrewfile\fR from \fB~/\.Brewfile\fR\.
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\.
Manage background services with macOS\' \fBlaunchctl\fR(1) daemon manager or Linux\'s \fBsystemctl\fR(1) service manager\.
.
.P
If \fBsudo\fR is passed, operate on \fB/Library/LaunchDaemons\fR (started at boot)\. Otherwise, operate on \fB~/Library/LaunchAgents\fR (started at login)\.
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)\.
.
.P
[\fBsudo\fR] \fBbrew services\fR [\fBlist\fR] (\fB\-\-json\fR)
List information about all managed services for the current user (or root)\.
[\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\.
.
.P
[\fBsudo\fR] \fBbrew services info\fR (\fIformula\fR|\fB\-\-all\fR|\fB\-\-json\fR)
Expand Down Expand Up @@ -2730,6 +2730,10 @@ If \fBsudo\fR is passed, operate on \fB/Library/LaunchDaemons\fR (started at boo
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 e7b0110

Please sign in to comment.