diff options
| author | Adam Vandenberg | 2011-05-31 12:20:06 -0700 |
|---|---|---|
| committer | Adam Vandenberg | 2011-05-31 12:20:06 -0700 |
| commit | 2492cbd9ccc3c745c70ff13509ba6a7ce5976e17 (patch) | |
| tree | 7a3aba6b480b98a4ea251305a24b7abc9bd93045 /Library | |
| parent | 93c2e9741f9beca6779a4b0df4731c86b3e8fc71 (diff) | |
| download | homebrew-2492cbd9ccc3c745c70ff13509ba6a7ce5976e17.tar.bz2 | |
Alpahabetize commands on man page
Diffstat (limited to 'Library')
| -rw-r--r-- | Library/Contributions/manpages/brew.1.md | 258 |
1 files changed, 129 insertions, 129 deletions
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md index c7fcc6835..036917370 100644 --- a/Library/Contributions/manpages/brew.1.md +++ b/Library/Contributions/manpages/brew.1.md @@ -39,8 +39,80 @@ For the full command list, see the COMMANDS section. ## COMMANDS - * `-v`, `--version`: - Print the version number of brew to standard error and exit. + * `audit [--strict]` [<formulae>]: + Check <formulae> for Homebrew coding style violations. This should be + run before submitting a new formula. + + If no <formulae> are provided, all of them are checked. + + If `--strict` is passed, perform additional stricter checks that may not need + to be fixed before submitting. + + `audit` exits with a non-zero status if any errors are found. This is useful, + for instance, for implementing pre-commit hooks. + + * `cat` <formula>: + Display the source to <formula>. + + * `cleanup [--force]` [<formula>]: + For all installed or specific formulae, remove any older versions from the + cellar. By default, does not remove out-of-date keg-only brews, as other + software may link directly to specific versions. + + 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 + $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. + + 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]` <formula>: + Show <formula>'s dependencies. + + If `--1` is passed, only show dependencies one level down, instead of + recursing. + + * `doctor`: + Check your system for potential problems. + + * `edit`: + Open all of Homebrew for editing in TextMate. + + * `edit` <formula>: + Open <formula> in $EDITOR. + + * `fetch [--force] [-v] [--HEAD] [--deps]` <formulae>: + Download the source packages for the given <formulae>. + For tarballs, also print MD5 and SHA1 checksums. + + If `--HEAD` is passed, download the HEAD versions of <formulae> instead. `-v` + may also be passed to make the VCS checkout verbose, useful for seeing if + an existing HEAD cache has been updated. + + If `--force` is passed, remove a previously cached version and re-fetch. + + If `--deps` is passed, also download dependencies for any listed <formulae>. + + * `home`: + Open Homebrew's own homepage in a browser. + + * `home` <formula>: + Open <formula>'s homepage in a browser. + + * `info` <formula>: + Display information about <formula>. + + * `info --github` <formula>: + Open a browser to the GitHub History page for formula <formula>. + + To view formula history locally: `brew log -p <formula>`. + + * `info` <URL>: + Print the name and version that will be detected for <URL>. * `install [--force] [--debug] [--ignore-dependencies] [--use-llvm] [--use-gcc] [--HEAD]` <formula>: Install <formula>. @@ -80,130 +152,29 @@ For the full command list, see the COMMANDS section. If `--git` is passed, Homebrew will create a Git repository, useful for creating patches to the software. - * `search`, `-S` <text>|/<text>/: - Perform a substring search of formula names for <text>. If <text> is - surrounded with slashes, then it is interpreted as a regular expression. - If no search term is given, all available formula are displayed. - - * `search --macports`|`--fink` <text>: - Search for <text> on the MacPorts or Fink package search page. - - * `update`: - Fetch the newest version of Homebrew from GitHub using `git`(1). - - * `list`: - List all installed formulae. - - * `list` <formula>: - List the installed files for <formula>. - - * `info` <formula>: - Display information about <formula>. - - * `info --github` <formula>: - Open a browser to the GitHub History page for formula <formula>. - - To view formula history locally: `brew log -p <formula>`. - - * `info` <URL>: - Print the name and version that will be detected for <URL>. - - * `home`: - Open Homebrew's own homepage in a browser. - - * `home` <formula>: - Open <formula>'s homepage in a browser. - - * `rm`, `remove`, `uninstall [--force]` <formula>: - Uninstall <formula>. - - If `--force` is passed, and there are multiple versions of <formula> - installed, delete all installed versions. - - * `create [--no-fetch]` <URL>: - Generate a formula for the downloadable file at <URL> and opens 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. - - 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. - - * `edit` <formula>: - Open <formula> in $EDITOR. - - * `edit`: - Open all of Homebrew for editing in TextMate. - * `ln`, `link` <formula>: Symlink all of <formula>'s installed files into the Homebrew prefix. This is done automatically when you install formula. It is useful for DIY installation, or in cases where you want to swap out different versions of the same package that you have installed at the same time. - * `unlink` <formula>: - Unsymlink <formula> from the Homebrew prefix. This can be useful for - temporarily disabling a formula: `brew unlink foo && commands && brew link foo`. - - * `prune`: - Remove dead symlinks from the Homebrew prefix. This is generally not - needed, but can be useful when doing DIY installations. - - * `outdated`: - Show formula that have an updated version available. - - * `deps [--1]` <formula>: - Show <formula>'s dependencies. - - If `--1` is passed, only show dependencies one level down, instead of - recursing. - - * `uses [--installed]` <formula>: - 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. - - * `doctor`: - Check your system for potential problems. - - * `cat` <formula>: - Display the source to <formula>. - - * `cleanup [--force]` [<formula>]: - For all installed or specific formulae, remove any older versions from the - cellar. By default, does not remove out-of-date keg-only brews, as other - software may link directly to specific versions. + * `list`: + List all installed formulae. - If `--force` is passed, remove out-of-date keg-only brews as well. + * `list` <formula>: + List the installed files for <formula>. * `log [git-log-options]` <formula> ...: Show the git log for the given formulae. Options that `git-log`(1) recognizes can be passed before the formula list. - * `fetch [--force] [-v] [--HEAD] [--deps]` <formulae>: - Download the source packages for the given <formulae>. - For tarballs, also print MD5 and SHA1 checksums. - - If `--HEAD` is passed, download the HEAD versions of <formulae> instead. `-v` - may also be passed to make the VCS checkout verbose, useful for seeing if - an existing HEAD cache has been updated. - - If `--force` is passed, remove a previously cached version and re-fetch. - - If `--deps` is passed, also download dependencies for any listed <formulae>. - - * `audit [--strict]` [<formulae>]: - Check <formulae> for Homebrew coding style violations. This should be - run before submitting a new formula. - - If no <formulae> are provided, all of them are checked. + * `man`: + Regenerate this man page using [`ronn`][ronn]. See `man brew-man` for details. - If `--strict` is passed, perform additional stricter checks that may not need - to be fixed before submitting. + * `missing` [<formulae>]: + Check the given <formulae> for missing dependencies. - `audit` exits with a non-zero status if any errors are found. This is useful, - for instance, for implementing pre-commit hooks. + If no <formulae> are given, check all installed brews. * `options [--compact] [--all]` <formula>: Display install options specific to <formula>. @@ -213,10 +184,26 @@ For the full command list, see the COMMANDS section. If `--all` is passed, show options for all formulae. - * `missing` [<formulae>]: - Check the given <formulae> for missing dependencies. + * `outdated`: + Show formula that have an updated version available. - If no <formulae> are given, check all installed brews. + * `prune`: + Remove dead symlinks from the Homebrew prefix. This is generally not + needed, but can be useful when doing DIY installations. + + * `rm`, `remove`, `uninstall [--force]` <formula>: + Uninstall <formula>. + + If `--force` is passed, and there are multiple versions of <formula> + installed, delete all installed versions. + + * `search`, `-S` <text>|/<text>/: + Perform a substring search of formula names for <text>. If <text> is + surrounded with slashes, then it is interpreted as a regular expression. + If no search term is given, all available formula are displayed. + + * `search --macports`|`--fink` <text>: + Search for <text> on the MacPorts or Fink package search page. * `server`: Start a local web app that lets you browse available formulae, similar @@ -230,19 +217,24 @@ For the full command list, see the COMMANDS section. Example: `brew install jruby && brew test jruby` - * `man`: - Regenerate this man page using [`ronn`][ronn]. See `man brew-man` for details. + * `unlink` <formula>: + Unsymlink <formula> from the Homebrew prefix. This can be useful for + temporarily disabling a formula: `brew unlink foo && commands && brew link foo`. - * `--config`: - Show Homebrew and system configuration useful for debugging. If you file - a bug report, you will likely be asked for this information if you do not - provide it. + * `update`: + Fetch the newest version of Homebrew from GitHub using `git`(1). - * `--prefix`: - Display Homebrew's install path. *Default:* `/usr/local` + * `uses [--installed]` <formula>: + Show the formulas that specify <formula> as a dependency. The list is + not recursive; only one level of dependencies is resolved. - * `--prefix` <formula>: - Display the location in the cellar where <formula> is or would be installed. + If `--installed` is passed, only lists installed formulae. + + * `--cache`: + Display Homebrew's download cache. *Default:* `~/Library/Cache/Homebrew` + + * `--cache` <formula>: + Display the file or folder used to cache <formula>. * `--cellar`: Display Homebrew's Cellar path. *Default:* `/usr/local/Cellar` @@ -251,16 +243,24 @@ For the full command list, see the COMMANDS section. Display the location in the cellar where <formula> would be installed, without any sort of versioned folder as the last path. - * `--cache`: - Display Homebrew's download cache. *Default:* `~/Library/Cache/Homebrew` + * `--config`: + Show Homebrew and system configuration useful for debugging. If you file + a bug report, you will likely be asked for this information if you do not + provide it. - * `--cache` <formula>: - Display the file or folder used to cache <formula>. + * `--prefix`: + Display Homebrew's install path. *Default:* `/usr/local` + + * `--prefix` <formula>: + Display the location in the cellar where <formula> is or would be installed. * `--repository`: Display where Homebrew's `.git` folder is located. For standard installs, the `prefix` and `repository` are the same folder. + * `-v`, `--version`: + Print the version number of brew to standard error and exit. + ## EXTERNAL COMMANDS Homebrew allows external commands to be defined by putting a +x file named |
