diff options
| author | Jack Nagel | 2011-09-19 18:20:52 -0500 |
|---|---|---|
| committer | Jack Nagel | 2011-09-19 18:24:03 -0500 |
| commit | 27fca5bd9293799a336b75b5ced2404e92db5221 (patch) | |
| tree | 9f77307058dcb7d2c53326333b41e5aeb90ceadb /Library/Contributions/manpages/brew.1.md | |
| parent | 06b554ac3f376da171ee68b627bb36a646c4826d (diff) | |
| download | homebrew-27fca5bd9293799a336b75b5ced2404e92db5221.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/Contributions/manpages/brew.1.md')
| -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: |
