admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Update manpage

Browse Source 
Pull in changes from
https://github.com/Homebrew/homebrew-services/pull/174 and some missing
changes from https://github.com/Homebrew/brew/pull/5089.
This commit is contained in:
Mike McQuaid 2018-10-23 15:52:18 +01:00
parent 4b7a0f9588
commit fe9a9fd883
No known key found for this signature in database
GPG Key ID: 48A898132FD8EE70
2 changed files with 33 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/Manpage.md
View File

@ -177,7 +177,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
current or newest version of macOS, even if it would not be used during current or newest version of macOS, even if it would not be used during
installation. installation.
* `gist-logs` [`--new-issue`|`-n`] *`formula`*: * `gist-logs` [`--new-issue`|`-n`] [`--private`|`-p`] *`formula`*:
Upload logs for a failed build of *`formula`* to a new Gist. Upload logs for a failed build of *`formula`* to a new Gist.
*`formula`* is usually the name of the formula to install, but it can be specified *`formula`* is usually the name of the formula to install, but it can be specified
@ -188,6 +188,9 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
If `--new-issue` is passed, automatically create a new issue in the appropriate If `--new-issue` is passed, automatically create a new issue in the appropriate
GitHub repository as well as creating the Gist. GitHub repository as well as creating the Gist.
If `--private` is passed, the Gist will be marked private and will not
appear in listings but will be accessible with the link.
If no logs are found, an error message is presented. If no logs are found, an error message is presented.
* `home`: * `home`:
@ -1044,26 +1047,26 @@ These options are applicable across all sub-commands.
* `services` *`command`*: * `services` *`command`*:
Integrates Homebrew formulae with macOS' `launchctl` manager. Integrates Homebrew formulae with macOS' `launchctl` manager.
[*`sudo`*] `brew services list` [`sudo`] `brew services list`:
List all running services for the current user (or *`root`*) List all running services for the current user (or root).
[*`sudo`*] `brew services run` *`formula|--all`* [`sudo`] `brew services run` (*`formula`*|`--all`):
Run the service *`formula`* without starting at login (or boot). Run the service *`formula`* without registering to launch at login (or boot).
[*`sudo`*] `brew services` `start` *`formula|--all`* [`sudo`] `brew services start` (*`formula`*|`--all`):
Start the service *`formula`* immediately and register it to launch at login (or *`boot`*). Start the service *`formula`* immediately and register it to launch at login (or boot).
[*`sudo`*] `brew services` `stop` *`formula|--all`* [`sudo`] `brew services stop` (*`formula`*|`--all`):
Stop the service *`formula`* immediately and unregister it from launching at login (or *`boot`*). Stop the service *`formula`* immediately and unregister it from launching at login (or boot).
[*`sudo`*] `brew services` `restart` *`formula|--all`* [`sudo`] `brew services restart` (*`formula`*|`--all`):
Stop (if necessary) and start the service immediately and register it to launch at login (or *`boot`*). Stop (if necessary) and start the service *`formula`* immediately and register it to launch at login (or boot).
[*`sudo`*] `brew services` `cleanup` [`sudo`] `brew services cleanup`:
Remove all unused services. Remove all unused services.
If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot). If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot).
Otherwise, operate on `~/Library/LaunchAgents (started at login)`. Otherwise, operate on `~/Library/LaunchAgents` (started at login).
**Homebrew/homebrew-services**: <https://github.com/Homebrew/homebrew-services> **Homebrew/homebrew-services**: <https://github.com/Homebrew/homebrew-services>

25
manpages/brew.1
View File

@ -180,7 +180,7 @@ If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) is passed, download the source r
If \fB\-\-force\-bottle\fR is passed, download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation\. If \fB\-\-force\-bottle\fR is passed, download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation\.
. .
.TP .TP
\fBgist\-logs\fR [\fB\-\-new\-issue\fR|\fB\-n\fR] \fIformula\fR \fBgist\-logs\fR [\fB\-\-new\-issue\fR|\fB\-n\fR] [\fB\-\-private\fR|\fB\-p\fR] \fIformula\fR
Upload logs for a failed build of \fIformula\fR to a new Gist\. Upload logs for a failed build of \fIformula\fR to a new Gist\.
. .
.IP .IP
@ -193,6 +193,9 @@ If \fB\-\-with\-hostname\fR is passed, include the hostname in the Gist\.
If \fB\-\-new\-issue\fR is passed, automatically create a new issue in the appropriate GitHub repository as well as creating the Gist\. If \fB\-\-new\-issue\fR is passed, automatically create a new issue in the appropriate GitHub repository as well as creating the Gist\.
. .
.IP .IP
If \fB\-\-private\fR is passed, the Gist will be marked private and will not appear in listings but will be accessible with the link\.
.
.IP
If no logs are found, an error message is presented\. If no logs are found, an error message is presented\.
. .
.TP .TP
@ -1173,25 +1176,31 @@ Install macOS applications distributed as binaries\.
Integrates Homebrew formulae with macOS\' \fBlaunchctl\fR manager\. Integrates Homebrew formulae with macOS\' \fBlaunchctl\fR manager\.
. .
.IP .IP
[\fIsudo\fR] \fBbrew services list\fR List all running services for the current user (or \fIroot\fR) [\fBsudo\fR] \fBbrew services list\fR
List all running services for the current user (or root)\.
. .
.IP .IP
[\fIsudo\fR] \fBbrew services run\fR \fIformula|\-\-all\fR Run the service \fIformula\fR without starting at login (or boot)\. [\fBsudo\fR] \fBbrew services run\fR (\fIformula\fR|\fB\-\-all\fR)
Run the service \fIformula\fR without registering to launch at login (or boot)\.
. .
.IP .IP
[\fIsudo\fR] \fBbrew services\fR \fBstart\fR \fIformula|\-\-all\fR Start the service \fIformula\fR immediately and register it to launch at login (or \fIboot\fR)\. [\fBsudo\fR] \fBbrew services start\fR (\fIformula\fR|\fB\-\-all\fR)
Start the service \fIformula\fR immediately and register it to launch at login (or boot)\.
. .
.IP .IP
[\fIsudo\fR] \fBbrew services\fR \fBstop\fR \fIformula|\-\-all\fR Stop the service \fIformula\fR immediately and unregister it from launching at login (or \fIboot\fR)\. [\fBsudo\fR] \fBbrew services stop\fR (\fIformula\fR|\fB\-\-all\fR)
Stop the service \fIformula\fR immediately and unregister it from launching at login (or boot)\.
. .
.IP .IP
[\fIsudo\fR] \fBbrew services\fR \fBrestart\fR \fIformula|\-\-all\fR Stop (if necessary) and start the service immediately and register it to launch at login (or \fIboot\fR)\. [\fBsudo\fR] \fBbrew services restart\fR (\fIformula\fR|\fB\-\-all\fR)
Stop (if necessary) and start the service \fIformula\fR immediately and register it to launch at login (or boot)\.
. .
.IP .IP
[\fIsudo\fR] \fBbrew services\fR \fBcleanup\fR Remove all unused services\. [\fBsudo\fR] \fBbrew services cleanup\fR
Remove all unused services\.
. .
.IP .IP
If \fBsudo\fR is passed, operate on \fB/Library/LaunchDaemons\fR (started at boot)\. Otherwise, operate on \fB~/Library/LaunchAgents (started at login)\fR\. If \fBsudo\fR is passed, operate on \fB/Library/LaunchDaemons\fR (started at boot)\. Otherwise, operate on \fB~/Library/LaunchAgents\fR (started at login)\.
. .
.IP .IP
\fBHomebrew/homebrew\-services\fR \fBHomebrew/homebrew\-services\fR