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

Improve external command documentation

Browse Source 
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 <jacknagel@gmail.com>
This commit is contained in:
Jack Nagel 2011-09-19 18:20:52 -05:00
parent 6bd47cf0f9
commit 783b71fa5a
2 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Library/Contributions/manpages/brew.1.md
View File

@ -290,14 +290,20 @@ For the full command list, see the COMMANDS section.
## EXTERNAL COMMANDS ## EXTERNAL COMMANDS
Homebrew allows external commands to be defined by putting a +x file named Homebrew, like `git`(1), supports external commands. These are executable
`brew-<cmdname>` or `brew-<cmdname>.rb` on the PATH. This will cause Homebrew scripts that reside somewhere in the PATH, named `brew-<cmdname>` or
to recognize `brew cmdname`. `brew-<cmdname>.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 $ 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:
<http://wiki.github.com/mxcl/homebrew/External-Commands>
## ENVIRONMENT ## ENVIRONMENT
* HOMEBREW\_BUILD\_FROM\_SOURCE: * HOMEBREW\_BUILD\_FROM\_SOURCE:

7
share/man/man1/brew.1
View File

@ -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\. Print the version number of brew to standard error and exit\.
. .
.SH "EXTERNAL COMMANDS" .SH "EXTERNAL COMMANDS"
Homebrew allows external commands to be defined by putting a +x file named \fBbrew\-<cmdname>\fR or \fBbrew\-<cmdname>\.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\-<cmdname>\fR or \fBbrew\-<cmdname>\.rb\fR, which can be invoked like \fBbrew cmdname\fR\. This allows you to create your own commands without modifying Homebrew\'s internals\.
. .
.P .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 .IP "" 4
. .
@ -340,6 +340,9 @@ $ ls `brew \-\-repository`/Library/Contributions/examples
. .
.IP "" 0 .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" .SH "ENVIRONMENT"
. .
.TP .TP