diff options
| author | Jack Nagel | 2012-03-25 15:54:38 -0500 |
|---|---|---|
| committer | Jack Nagel | 2012-03-25 16:21:13 -0500 |
| commit | 4360342947bc0b5a9fd4b4317c343735bc6c6d68 (patch) | |
| tree | d87de6d8247ca9cc77fd9435987571fc3ecb49da /share/man/man1 | |
| parent | 1e55c1f580a2207f909884b43c16a2550b7c229e (diff) | |
| download | brew-4360342947bc0b5a9fd4b4317c343735bc6c6d68.tar.bz2 | |
Document how formula arguments can be specified
Closes Homebrew/homebrew#11037.
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
Diffstat (limited to 'share/man/man1')
| -rw-r--r-- | share/man/man1/brew.1 | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index 176197bdc..e1c546cdc 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -165,7 +165,7 @@ Print the name and version that will be detected for \fIURL\fR\. Install \fIformula\fR\. . .IP -\fIformula\fR is usually the name of the formula to install, but may also be the URL for an arbitrary formula\. +\fIformula\fR is usually the name of the formula to install, but it can be specified several different ways\. See \fISPECIFYING FORMULAE\fR\. . .IP If \fB\-\-force\fR is passed, will install \fIformula\fR if it exists, even if it is blacklisted\. @@ -379,6 +379,21 @@ $ ls `brew \-\-repository`/Library/Contributions/cmds .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 "SPECIFYING FORMULAE" +Many Homebrew commands accept one or more \fIformula\fR arguments\. These arguments can take several different forms: +. +.TP +The name of a formula +e\.g\. \fBgit\fR, \fBnode\fR, \fBwget\fR\. +. +.TP +The fully\-qualified name of a tapped formula +Sometimes a formula from a tapped repository may conflict with one in mxcl/master\. You can still access these formulae by using a special syntax, e\.g\. \fBhomebrew/dupes/vim\fR or \fBhomebrew/versions/node4\fR\. +. +.TP +An arbitrary URL +Homebrew can install formulae via URL, e\.g\. \fBhttps://raw\.github\.com/mxcl/homebrew/master/Library/Formula/git\.rb\fR\. The formula file will be cached for later use\. +. .SH "ENVIRONMENT" . .TP |