Skip to content

Commit be77491

Browse files
committed
Document how formula arguments can be specified
Closes Homebrew#11037. Signed-off-by: Jack Nagel <[email protected]>
1 parent 2e1082c commit be77491

File tree

2 files changed

+36
-3
lines changed

2 files changed

+36
-3
lines changed

Library/Contributions/manpages/brew.1.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,8 @@ For the full command list, see the COMMANDS section.
142142
* `install [--force] [--debug] [--ignore-dependencies] [--fresh] [--use-clang] [--use-gcc] [--use-llvm] [--build-from-source] [--devel] [--HEAD]` <formula>:
143143
Install <formula>.
144144

145-
<formula> is usually the name of the formula to install, but may also be
146-
the URL for an arbitrary formula.
145+
<formula> is usually the name of the formula to install, but it can be specified
146+
several different ways. See [SPECIFYING FORMULAE][].
147147

148148
If `--force` is passed, will install <formula> if it exists, even if it
149149
is blacklisted.
@@ -338,6 +338,24 @@ Documentation for the included external commands as well as instructions for
338338
creating your own can be found on the wiki:
339339
<http://wiki.github.com/mxcl/homebrew/External-Commands>
340340

341+
## SPECIFYING FORMULAE
342+
343+
Many Homebrew commands accept one or more <formula> arguments. These arguments
344+
can take several different forms:
345+
346+
* The name of a formula:
347+
e.g. `git`, `node`, `wget`.
348+
349+
* The fully-qualified name of a tapped formula:
350+
Sometimes a formula from a tapped repository may conflict with one in mxcl/master.
351+
You can still access these formulae by using a special syntax, e.g.
352+
`homebrew/dupes/vim` or `homebrew/versions/node4`.
353+
354+
* An arbitrary URL:
355+
Homebrew can install formulae via URL, e.g.
356+
`https://raw.github.com/mxcl/homebrew/master/Library/Formula/git.rb`.
357+
The formula file will be cached for later use.
358+
341359
## ENVIRONMENT
342360

343361
* HOMEBREW\_BUILD\_FROM\_SOURCE:

share/man/man1/brew.1

+16-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Print the name and version that will be detected for \fIURL\fR\.
165165
Install \fIformula\fR\.
166166
.
167167
.IP
168-
\fIformula\fR is usually the name of the formula to install, but may also be the URL for an arbitrary formula\.
168+
\fIformula\fR is usually the name of the formula to install, but it can be specified several different ways\. See \fISPECIFYING FORMULAE\fR\.
169169
.
170170
.IP
171171
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
379379
.P
380380
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
381381
.
382+
.SH "SPECIFYING FORMULAE"
383+
Many Homebrew commands accept one or more \fIformula\fR arguments\. These arguments can take several different forms:
384+
.
385+
.TP
386+
The name of a formula
387+
e\.g\. \fBgit\fR, \fBnode\fR, \fBwget\fR\.
388+
.
389+
.TP
390+
The fully\-qualified name of a tapped formula
391+
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\.
392+
.
393+
.TP
394+
An arbitrary URL
395+
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\.
396+
.
382397
.SH "ENVIRONMENT"
383398
.
384399
.TP

0 commit comments

Comments
 (0)