diff options
| author | Jack Nagel | 2011-10-12 02:20:07 -0500 |
|---|---|---|
| committer | Jack Nagel | 2011-10-12 02:53:40 -0500 |
| commit | 203b0df5967061062208449d1ed65082391478f8 (patch) | |
| tree | f667728d0eea17a08d38a8e357f65e5d3319dcf7 /Library | |
| parent | 017d8690d381a08d015cda3139471ff1093b859b (diff) | |
| download | brew-203b0df5967061062208449d1ed65082391478f8.tar.bz2 | |
man page: add some undocumented options
While updating the bash completion script, I encountered some options
that were previously undocumented.
I purposely did not document the --macports and --fink flags for `brew
create`, because the exact same functionality exists in `brew search`.
Perhaps we should remove it from create.
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
Diffstat (limited to 'Library')
| -rw-r--r-- | Library/Contributions/manpages/brew.1.md | 33 |
1 files changed, 23 insertions, 10 deletions
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md index 21a5f0703..cdef84a23 100644 --- a/Library/Contributions/manpages/brew.1.md +++ b/Library/Contributions/manpages/brew.1.md @@ -61,25 +61,31 @@ For the full command list, see the COMMANDS section. If `--force` is passed, remove out-of-date keg-only brews as well. - * `create [--no-fetch]` <URL>: - Generate a formula for the downloadable file at <URL> and opens it in + * `create [--autotools|--cmake] [--no-fetch]` <URL>: + Generate a formula for the downloadable file at <URL> and open it in $EDITOR. Homebrew will attempt to automatically derive the formula name - and version, if it fails, you'll have to make your own template. I suggest - copying wget's. + and version, but if it fails, you'll have to make your own template. The wget + formula serves as a simple example. + + If `--autotools` is passed, create a basic template for an Autotools-style build. + If `--cmake` is passed, create a basic template for a CMake-style build. If `--no-fetch` is passed, Homebrew will not download <URL> to the cache and will thus not add the MD5 to the formula for you. - * `deps [--1] [-n]` <formula>: + * `deps [--1] [-n] [--all]` <formula>: Show <formula>'s dependencies. If `--1` is passed, only show dependencies one level down, instead of recursing. - If `-n` is passed, shows dependencies in topological order. + If `-n` is passed, show dependencies in topological order. + + If `--all` is passed, show dependencies for all formulae. * `doctor`: - Check your system for potential problems. + Check your system for potential problems. Doctor exits with a non-zero status + if any problems are found. * `edit`: Open all of Homebrew for editing in TextMate. @@ -105,9 +111,11 @@ For the full command list, see the COMMANDS section. * `home` <formula>: Open <formula>'s homepage in a browser. - * `info` <formula>: + * `info [--all]` <formula>: Display information about <formula>. + If `--all` is passed, show info for all formulae. + * `info --github` <formula>: Open a browser to the GitHub History page for formula <formula>. @@ -164,10 +172,15 @@ For the full command list, see the COMMANDS section. is done automatically when you install formula, but can be useful for DIY installations. - * `list [--versions]` [<formulae>]: + * `ls, list [--unbrewed] [--versions]` [<formulae>]: Without any arguments, list all installed formulae. If <formulae> are given, list the installed files for <formulae>. + Combined with `--verbose`, recursively list the contents of all subdirectories + in each <formula>'s keg. + + If `--unbrewed` is passed, list all files in the Homebrew prefix not installed + by Homebrew. If `--versions` is passed, show the version number for installed formulae, or only the specified formulae if <formulae> are given. @@ -237,7 +250,7 @@ For the full command list, see the COMMANDS section. Show the formulas that specify <formula> as a dependency. The list is not recursive; only one level of dependencies is resolved. - If `--installed` is passed, only lists installed formulae. + If `--installed` is passed, only list installed formulae. * `versions` <formulae>: List previous versions of <formulae>, along with a command to checkout |
