Skip to content

Commit 7d31a70

Browse files
authored
Merge pull request #1214 from MikeMcQuaid/official-external-commands-manpage
Add official external commands to manpage.
2 parents 564fa88 + 8eac531 commit 7d31a70

File tree

3 files changed

+46
-6
lines changed

3 files changed

+46
-6
lines changed

Library/Homebrew/manpages/brew.1.md.erb

+16-2
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,21 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
5454

5555
<%= developer_commands.join("\n") %>
5656

57-
## EXTERNAL COMMANDS
57+
## OFFICIAL EXTERNAL COMMANDS
58+
59+
* `bundle`:
60+
Bundler for non-Ruby dependencies from Homebrew:
61+
<https://github.com/Homebrew/homebrew-bundle>
62+
63+
* `cask`:
64+
Install macOS applications distributed as binaries:
65+
<https://github.com/caskroom/homebrew-cask>
66+
67+
* `services`:
68+
Integrates Homebrew formulae with macOS's `launchctl` manager:
69+
<https://github.com/Homebrew/homebrew-services>
70+
71+
## CUSTOM EXTERNAL COMMANDS
5872

5973
Homebrew, like `git`(1), supports external commands. These are executable
6074
scripts that reside somewhere in the `PATH`, named `brew-`<cmdname> or
@@ -251,7 +265,7 @@ If your proxy requires authentication:
251265

252266
Homebrew Documentation: <https://github.com/Homebrew/brew/blob/master/docs/>
253267

254-
`git`(1), `git-log`(1)
268+
`brew-cask`(1), `git`(1), `git-log`(1)
255269

256270
## AUTHORS
257271

docs/brew.1.html

+14-2
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,19 @@ <h2 id="DEVELOPER-COMMANDS">DEVELOPER COMMANDS</h2>
601601
</dl>
602602

603603

604-
<h2 id="EXTERNAL-COMMANDS">EXTERNAL COMMANDS</h2>
604+
<h2 id="OFFICIAL-EXTERNAL-COMMANDS">OFFICIAL EXTERNAL COMMANDS</h2>
605+
606+
<dl>
607+
<dt class="flush"><code>bundle</code></dt><dd><p>Bundler for non-Ruby dependencies from Homebrew:
608+
<a href="https://github.com/Homebrew/homebrew-bundle" data-bare-link="true">https://github.com/Homebrew/homebrew-bundle</a></p></dd>
609+
<dt class="flush"><code>cask</code></dt><dd><p>Install macOS applications distributed as binaries:
610+
<a href="https://github.com/caskroom/homebrew-cask" data-bare-link="true">https://github.com/caskroom/homebrew-cask</a></p></dd>
611+
<dt><code>services</code></dt><dd><p>Integrates Homebrew formulae with macOS's <code>launchctl</code> manager:
612+
<a href="https://github.com/Homebrew/homebrew-services" data-bare-link="true">https://github.com/Homebrew/homebrew-services</a></p></dd>
613+
</dl>
614+
615+
616+
<h2 id="CUSTOM-EXTERNAL-COMMANDS">CUSTOM EXTERNAL COMMANDS</h2>
605617

606618
<p>Homebrew, like <code>git</code>(1), supports external commands. These are executable
607619
scripts that reside somewhere in the <code>PATH</code>, named <code>brew-</code><var>cmdname</var> or
@@ -742,7 +754,7 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
742754

743755
<p>Homebrew Documentation: <a href="https://github.com/Homebrew/brew/blob/master/docs/" data-bare-link="true">https://github.com/Homebrew/brew/blob/master/docs/</a></p>
744756

745-
<p><code>git</code>(1), <code>git-log</code>(1)</p>
757+
<p><code>brew-cask</code>(1), <code>git</code>(1), <code>git-log</code>(1)</p>
746758

747759
<h2 id="AUTHORS">AUTHORS</h2>
748760

manpages/brew.1

+16-2
Original file line numberDiff line numberDiff line change
@@ -801,7 +801,21 @@ If \fB\-\-to\-tag\fR is passed, set HOMEBREW_UPDATE_TO_TAG to test updating betw
801801
.IP
802802
If \fB\-\-keep\-tmp\fR is passed, retain the temporary directory containing the new repository clone\.
803803
.
804-
.SH "EXTERNAL COMMANDS"
804+
.SH "OFFICIAL EXTERNAL COMMANDS"
805+
.
806+
.TP
807+
\fBbundle\fR
808+
Bundler for non\-Ruby dependencies from Homebrew: \fIhttps://github\.com/Homebrew/homebrew\-bundle\fR
809+
.
810+
.TP
811+
\fBcask\fR
812+
Install macOS applications distributed as binaries: \fIhttps://github\.com/caskroom/homebrew\-cask\fR
813+
.
814+
.TP
815+
\fBservices\fR
816+
Integrates Homebrew formulae with macOS\'s \fBlaunchctl\fR manager: \fIhttps://github\.com/Homebrew/homebrew\-services\fR
817+
.
818+
.SH "CUSTOM EXTERNAL COMMANDS"
805819
Homebrew, like \fBgit\fR(1), supports external commands\. These are executable scripts that reside somewhere in the \fBPATH\fR, named \fBbrew\-\fR\fIcmdname\fR or \fBbrew\-\fR\fIcmdname\fR\fB\.rb\fR, which can be invoked like \fBbrew\fR \fIcmdname\fR\. This allows you to create your own commands without modifying Homebrew\'s internals\.
806820
.
807821
.P
@@ -1007,7 +1021,7 @@ http_proxy=http://<user>:<password>@<host>:<port> brew install foo
10071021
Homebrew Documentation: \fIhttps://github\.com/Homebrew/brew/blob/master/docs/\fR
10081022
.
10091023
.P
1010-
\fBgit\fR(1), \fBgit\-log\fR(1)
1024+
\fBbrew\-cask\fR(1), \fBgit\fR(1), \fBgit\-log\fR(1)
10111025
.
10121026
.SH "AUTHORS"
10131027
Homebrew\'s lead maintainer is Mike McQuaid\.

0 commit comments

Comments
 (0)