From 783b71fa5a5d776660b95d6d35d4b11c53b1c4b3 Mon Sep 17 00:00:00 2001 From: Jack Nagel Date: Mon, 19 Sep 2011 18:20:52 -0500 Subject: [PATCH] Improve external command documentation In addition to a brief overview of what external commands are, add a link to the wiki page where the real documentation resides. Signed-off-by: Jack Nagel --- Library/Contributions/manpages/brew.1.md | 14 ++++++++++---- share/man/man1/brew.1 | 7 +++++-- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md index ab0081824b..948bf7ace1 100644 --- a/Library/Contributions/manpages/brew.1.md +++ b/Library/Contributions/manpages/brew.1.md @@ -290,14 +290,20 @@ For the full command list, see the COMMANDS section. ## EXTERNAL COMMANDS -Homebrew allows external commands to be defined by putting a +x file named -`brew-` or `brew-.rb` on the PATH. This will cause Homebrew -to recognize `brew cmdname`. +Homebrew, like `git`(1), supports external commands. These are executable +scripts that reside somewhere in the PATH, named `brew-` or +`brew-.rb`, which can be invoked like `brew cmdname`. This allows you +to create your own commands without modifying Homebrew's internals. -Some example commands ship with Homebrew and are enabled by default. +A number of (useful, but unsupported) example commands are included and enabled +by default: $ ls `brew --repository`/Library/Contributions/examples +Documentation for the included external commands as well as instructions for +creating your own can be found on the wiki: + + ## ENVIRONMENT * HOMEBREW\_BUILD\_FROM\_SOURCE: diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index d6c9870efa..8ec420ee86 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -325,10 +325,10 @@ Display where Homebrew\'s \fB\.git\fR folder is located\. For standard installs, Print the version number of brew to standard error and exit\. . .SH "EXTERNAL COMMANDS" -Homebrew allows external commands to be defined by putting a +x file named \fBbrew\-\fR or \fBbrew\-\.rb\fR on the PATH\. This will cause Homebrew to recognize \fBbrew cmdname\fR\. +Homebrew, like \fBgit\fR(1), supports external commands\. These are executable scripts that reside somewhere in the PATH, named \fBbrew\-\fR or \fBbrew\-\.rb\fR, which can be invoked like \fBbrew cmdname\fR\. This allows you to create your own commands without modifying Homebrew\'s internals\. . .P -Some example commands ship with Homebrew and are enabled by default\. +A number of (useful, but unsupported) example commands are included and enabled by default: . .IP "" 4 . @@ -340,6 +340,9 @@ $ ls `brew \-\-repository`/Library/Contributions/examples . .IP "" 0 . +.P +Documentation for the included external commands as well as instructions for creating your own can be found on the wiki: \fIhttp://wiki\.github\.com/mxcl/homebrew/External\-Commands\fR +. .SH "ENVIRONMENT" . .TP