aboutsummaryrefslogtreecommitdiffstats
path: root/Library
diff options
context:
space:
mode:
authorJack Nagel2012-03-25 15:54:38 -0500
committerJack Nagel2012-03-25 16:21:13 -0500
commit4360342947bc0b5a9fd4b4317c343735bc6c6d68 (patch)
treed87de6d8247ca9cc77fd9435987571fc3ecb49da /Library
parent1e55c1f580a2207f909884b43c16a2550b7c229e (diff)
downloadbrew-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 'Library')
-rw-r--r--Library/Contributions/manpages/brew.1.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md
index e7c63285d..5bd259de6 100644
--- a/Library/Contributions/manpages/brew.1.md
+++ b/Library/Contributions/manpages/brew.1.md
@@ -142,8 +142,8 @@ For the full command list, see the COMMANDS section.
* `install [--force] [--debug] [--ignore-dependencies] [--fresh] [--use-clang] [--use-gcc] [--use-llvm] [--build-from-source] [--devel] [--HEAD]` <formula>:
Install <formula>.
- <formula> is usually the name of the formula to install, but may also be
- the URL for an arbitrary formula.
+ <formula> is usually the name of the formula to install, but it can be specified
+ several different ways. See [SPECIFYING FORMULAE][].
If `--force` is passed, will install <formula> if it exists, even if it
is blacklisted.
@@ -338,6 +338,24 @@ 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>
+## SPECIFYING FORMULAE
+
+Many Homebrew commands accept one or more <formula> arguments. These arguments
+can take several different forms:
+
+ * The name of a formula:
+ e.g. `git`, `node`, `wget`.
+
+ * 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.
+ `homebrew/dupes/vim` or `homebrew/versions/node4`.
+
+ * An arbitrary URL:
+ Homebrew can install formulae via URL, e.g.
+ `https://raw.github.com/mxcl/homebrew/master/Library/Formula/git.rb`.
+ The formula file will be cached for later use.
+
## ENVIRONMENT
* HOMEBREW\_BUILD\_FROM\_SOURCE: