diff options
| author | Jack Nagel | 2011-09-19 18:20:52 -0500 |
|---|---|---|
| committer | Jack Nagel | 2011-09-19 18:24:03 -0500 |
| commit | 783b71fa5a5d776660b95d6d35d4b11c53b1c4b3 (patch) | |
| tree | 092af3a6d3cf0bd26dd987147ef817a62ea30d15 /Library | |
| parent | 6bd47cf0f96447e5ee0925eea34e406bdaed7ffa (diff) | |
| download | brew-783b71fa5a5d776660b95d6d35d4b11c53b1c4b3.tar.bz2 | |
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 <jacknagel@gmail.com>
Diffstat (limited to 'Library')
| -rw-r--r-- | Library/Contributions/manpages/brew.1.md | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md index ab0081824..948bf7ace 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-<cmdname>` or `brew-<cmdname>.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-<cmdname>` or +`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 +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 * HOMEBREW\_BUILD\_FROM\_SOURCE: |