From 4360342947bc0b5a9fd4b4317c343735bc6c6d68 Mon Sep 17 00:00:00 2001 From: Jack Nagel Date: Sun, 25 Mar 2012 15:54:38 -0500 Subject: [PATCH] Document how formula arguments can be specified Closes Homebrew/homebrew#11037. Signed-off-by: Jack Nagel --- Library/Contributions/manpages/brew.1.md | 22 ++++++++++++++++++++-- share/man/man1/brew.1 | 17 ++++++++++++++++- 2 files changed, 36 insertions(+), 3 deletions(-) diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md index e7c63285dd..5bd259de6b 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]` : Install . - is usually the name of the formula to install, but may also be - the URL for an arbitrary 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 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: +## SPECIFYING FORMULAE + +Many Homebrew commands accept one or more 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: diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index 176197bdc8..e1c546cdcf 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