diff --git a/Library/Homebrew/manpages/brew.1.md b/Library/Homebrew/manpages/brew.1.md index 135561145e..0fdde0b0cc 100644 --- a/Library/Homebrew/manpages/brew.1.md +++ b/Library/Homebrew/manpages/brew.1.md @@ -377,21 +377,21 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note * `switch` : Symlink all of the specific of 's install to Homebrew prefix. + * `tap`: + List all installed taps. + * `tap` [`--full`] `/` []: - Tap a formula repository or list existing taps. This command can be invoked - in three ways. + Tap a formula repository. - + `tap` without arguments displays existing taps. + With unspecified, taps a formula repository from GitHub using HTTPS. + Since so many taps are hosted on GitHub, this command is a shortcut for + `tap / https://github.com//homebrew-`. - + `tap` `/` taps a formula repository from GitHub using HTTPS. - Since so many taps are hosted on GitHub, this command is a shortcut for - `tap / https://github.com//homebrew-`. - - + `tap` `/` taps a formula repository from anywhere, using - any transport protocol that `git` handles. The one-argument form of `tap` - simplifies but also limits. This two-argument command makes no - assumptions, so taps can be cloned from places other than GitHub and - using protocols other than HTTPS, e.g., SSH, GIT, HTTP, FTP(S), RSYNC. + With specified, taps a formula repository from anywhere, using + any transport protocol that `git` handles. The one-argument form of `tap` + simplifies but also limits. This two-argument command makes no + assumptions, so taps can be cloned from places other than GitHub and + using protocols other than HTTPS, e.g., SSH, GIT, HTTP, FTP(S), RSYNC. By default, the repository is cloned as a shallow copy (`--depth=1`), but if `--full` is passed, a full clone will be used. diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html index 4a8b8bc2ec..6a45699a9d 100644 --- a/share/doc/homebrew/brew.1.html +++ b/share/doc/homebrew/brew.1.html @@ -34,9 +34,8 @@ If no search term is given, all locally available formulae are listed.

COMMANDS

-
    -

  • audit [--strict] [--online] [formulae]: -Check formulae for Homebrew coding style violations. This should be +

    +
    audit [--strict] [--online] [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.

    @@ -48,11 +47,9 @@ when creating for new formulae.

    connection are run. This should be used when creating for new formulae.

    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] [--prune=days] [-n] [-s] [formulae]: -For all installed or specific formulae, remove any older versions from the +for instance, for implementing pre-commit hooks.

    +
    cat formula

    Display the source to formula.

    +
    cleanup [--force] [--prune=days] [-n] [-s] [formulae]

    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. In addition, old downloads from the Homebrew download-cache are deleted.

    @@ -65,20 +62,16 @@ the Homebrew download-cache are deleted.

    If -s is passed, scrubs the cache, removing downloads for even the latest versions of formulae. Note downloads for any installed formulae will still not be -deleted. If you want to delete those too: rm -rf $(brew --cache)

    • -

  • command cmd: -Display the path to the file which is used when invoking brew cmd.

    • -

  • commands [--quiet [--include-aliases]]: -Show a list of built-in and external commands.

    +deleted. If you want to delete those too: rm -rf $(brew --cache)

    +
    command cmd

    Display the path to the file which is used when invoking brew cmd.

    +
    commands [--quiet [--include-aliases]]

    Show a list of built-in and external commands.

    If --quiet is passed, list only the names of commands without the header. -With --include-aliases, the aliases of internal commands will be included.

    • -

  • config: -Show Homebrew and system configuration useful for debugging. If you file +With --include-aliases, the aliases of internal commands will be included.

    +
    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.

    • -

  • create URL [--autotools|--cmake] [--no-fetch] [--set-name name] [--set-version version]: -Generate a formula for the downloadable file at URL and open it in the editor. +provide it.

    +
    create URL [--autotools|--cmake] [--no-fetch] [--set-name name] [--set-version version]

    Generate a formula for the downloadable file at URL and open it in the editor. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you'll have to make your own template. The wget formula serves as a simple example. For the complete API have a look at

    @@ -92,9 +85,8 @@ If --cmake is passed, create a basic template for a CMake-style bui will thus not add the SHA256 to the formula for you.

    The options --set-name and --set-version each take an argument and allow -you to explicitly set the name and version of the package you are creating.

    • -

  • deps [--1] [-n] [--union] [--tree] [--all] [--installed] [--skip-build] [--skip-optional] formulae: -Show dependencies for formulae. When given multiple formula arguments, +you to explicitly set the name and version of the package you are creating.

    +
    deps [--1] [-n] [--union] [--tree] [--all] [--installed] [--skip-build] [--skip-optional] formulae

    Show dependencies for formulae. When given multiple formula arguments, show the intersection of dependencies for formulae, except when passed --tree, --all, or --installed.

    @@ -114,33 +106,26 @@ instead of the intersection.

    By default, deps shows dependencies for formulae. To skip the :build type dependencies, pass --skip-build. Similarly, pass --skip-optional -to skip :optional dependencies.

    • -

  • desc formula: -Display formula's name and one-line description.

    • -

  • desc [-s|-n|-d] pattern: -Search both name and description (-s), just the names (-n), or just the +to skip :optional dependencies.

    +
    desc formula

    Display formula's name and one-line description.

    +
    desc [-s|-n|-d] pattern

    Search both name and description (-s), just the names (-n), or just the descriptions (-d) for <pattern>. <pattern> is by default interpreted as a literal string; if flanked by slashes, it is instead interpreted as a regular expression. Formula descriptions are cached; the cache is created on -the first search, making that search slower than subsequent ones.

    • -

  • diy [--name=name] [--version=version]: -Automatically determine the installation prefix for non-Homebrew software.

    +the first search, making that search slower than subsequent ones.

    +
    diy [--name=name] [--version=version]

    Automatically determine the installation prefix for non-Homebrew software.

    Using the output from this command, you can install your own software into the Cellar and then link it into Homebrew's prefix with brew link.

    The options --name=name and --version=version each take an argument and allow you to explicitly set the name and version of the package you are -installing.

    • -

  • doctor: -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.

    • -

  • edit formula: -Open formula in the editor.

    • -

  • fetch [--force] [-v] [--devel|--HEAD] [--deps] [--build-from-source|--force-bottle] formulae: -Download the source packages for the given formulae. +installing.

    +
    doctor

    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.

    +
    edit formula

    Open formula in the editor.

    +
    fetch [--force] [-v] [--devel|--HEAD] [--deps] [--build-from-source|--force-bottle] formulae

    Download the source packages for the given formulae. For tarballs, also print SHA-1 and SHA-256 checksums.

    If --HEAD or --devel is passed, fetch that version instead of the @@ -157,28 +142,22 @@ This is useful for seeing if an existing VCS cache has been updated.

    bottle.

    If --force-bottle is passed, download a bottle if it exists for the current -version of OS X, even if it would not be used during installation.

    • -

  • 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.

    +version of OS X, even if it would not be used during installation.

    +
    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 --json=version (--all|--installed|formulae): -Print a JSON representation of formulae. Currently the only accepted value +

    To view formula history locally: brew log -p <formula>.

    +
    info --json=version (--all|--installed|formulae)

    Print a JSON representation of formulae. Currently the only accepted value for version is v1.

    Pass --all to get information on all formulae, or --installed to get information on all installed formulae.

    See the docs for examples of using the JSON: -https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md

    • -

  • install [--debug] [--env=std|super] [--ignore-dependencies] [--only-dependencies] [--cc=compiler] [--build-from-source|--force-bottle] [--devel|--HEAD] formula: -Install formula.

    +https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md

    +
    install [--debug] [--env=std|super] [--ignore-dependencies] [--only-dependencies] [--cc=compiler] [--build-from-source|--force-bottle] [--devel|--HEAD] formula

    Install formula.

    formula is usually the name of the formula to install, but it can be specified several different ways. See SPECIFYING FORMULAE.

    @@ -215,22 +194,18 @@ for the current version of OS X, even if custom options are given.

    aka master, trunk, unstable.

    To install a newer version of HEAD use -brew rm <foo> && brew install --HEAD <foo>.

    • -

  • install --interactive [--git] formula: -Download and patch formula, then open a shell. This allows the user to +brew rm <foo> && brew install --HEAD <foo>.

    +
    install --interactive [--git] formula

    Download and patch formula, then open a shell. This allows the user to run ./configure --help and otherwise determine how to turn the software package into a Homebrew formula.

    If --git is passed, Homebrew will create a Git repository, useful for -creating patches to the software.

    • -

  • irb [--examples]: -Enter the interactive Homebrew Ruby shell.

    +creating patches to the software.

    +
    irb [--examples]

    Enter the interactive Homebrew Ruby shell.

    -

    If --examples is passed, several examples will be shown.

    • -

  • leaves: -Show installed formulae that are not dependencies of another installed formula.

    • -

  • ln, link [--overwrite] [--dry-run] [--force] formula: -Symlink all of formula's installed files into the Homebrew prefix. This +

    If --examples is passed, several examples will be shown.

    +
    leaves

    Show installed formulae that are not dependencies of another installed formula.

    +
    ln, link [--overwrite] [--dry-run] [--force] formula

    Symlink all of formula's installed files into the Homebrew prefix. This is done automatically when you install formulae but can be useful for DIY installations.

    @@ -241,23 +216,19 @@ the prefix while linking.

    be linked or which would be deleted by brew link --overwrite, but will not actually link or delete any files.

    -

    If --force is passed, Homebrew will allow keg-only formulae to be linked.

    • -

  • linkapps [--local] [formulae]: -Find installed formulae that have compiled .app-style "application" +

    If --force is passed, Homebrew will allow keg-only formulae to be linked.

    +
    linkapps [--local] [formulae]

    Find installed formulae that have compiled .app-style "application" packages for OS X, and symlink those apps into /Applications, allowing for easier access.

    If no formulae are provided, all of them will have their .apps symlinked.

    If provided, --local will move them into the user's ~/Applications -directory instead of the system directory. It may need to be created, first.

    • -

  • ls, list [--full-name]: -List all installed formulae. If --full-name is passed, print formulae with -full-qualified names.

    • -

  • ls, list --unbrewed: -List all files in the Homebrew prefix not installed by Homebrew.

    • -

  • ls, list [--versions [--multiple]] [--pinned] [formulae]: -List the installed files for formulae. Combined with --verbose, recursively +directory instead of the system directory. It may need to be created, first.

    +
    ls, list [--full-name]

    List all installed formulae. If --full-name is passed, print formulae with +full-qualified names.

    +
    ls, list --unbrewed

    List all files in the Homebrew prefix not installed by Homebrew.

    +
    ls, list [--versions [--multiple]] [--pinned] [formulae]

    List the installed files for formulae. Combined with --verbose, recursively list the contents of all subdirectories in each formula's keg.

    If --versions is passed, show the version number for installed formulae, @@ -266,31 +237,26 @@ only show formulae with multiple versions installed.

    If --pinned is passed, show the versions of pinned formulae, or only the specified (pinned) formulae if formulae are given. -See also pin, unpin.

    • -

  • 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.

    • -

  • missing [formulae]: -Check the given formulae for missing dependencies.

    +See also pin, unpin.

    +
    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.

    +
    missing [formulae]

    Check the given formulae for missing dependencies.

    -

    If no formulae are given, check all installed brews.

    • -

  • migrate [--force] formulae: -Migrate renamed packages to new name, where formulae are old names of +

    If no formulae are given, check all installed brews.

    +
    migrate [--force] formulae

    Migrate renamed packages to new name, where formulae are old names of packages.

    If --force is passed, then treat installed formulae and passed formulae -like if they are from same taps and migrate them anyway.

    • -

  • options [--compact] [--all] [--installed] formula: -Display install options specific to formula.

    +like if they are from same taps and migrate them anyway.

    +
    options [--compact] [--all] [--installed] formula

    Display install options specific to formula.

    If --compact is passed, show all options on a single line separated by spaces.

    If --all is passed, show options for all formulae.

    -

    If --installed is passed, show options for all installed formulae.

    • -

  • outdated [--quiet|--verbose|--json=v1]: -Show formulae that have an updated version available.

    +

    If --installed is passed, show options for all installed formulae.

    +
    outdated [--quiet|--verbose|--json=v1]

    Show formulae that have an updated version available.

    By default, version information is displayed in interactive shells, and suppressed otherwise.

    @@ -301,79 +267,58 @@ precedence over --verbose).

    If --verbose is passed, display detailed version information.

    If --json=version is passed, the output will be in JSON format. The only -valid version is v1.

    • -

  • pin formulae: -Pin the specified formulae, preventing them from being upgraded when -issuing the brew upgrade command. See also unpin.

    • -

  • prune: -Remove dead symlinks from the Homebrew prefix. This is generally not -needed, but can be useful when doing DIY installations.

    • -

  • reinstall formula: -Uninstall then install formula

    • -

  • rm, remove, uninstall [--force] formula: -Uninstall formula.

    +valid version is v1.

    +
    pin formulae

    Pin the specified formulae, preventing them from being upgraded when +issuing the brew upgrade command. See also unpin.

    +
    prune

    Remove dead symlinks from the Homebrew prefix. This is generally not +needed, but can be useful when doing DIY installations.

    +
    reinstall formula

    Uninstall then install formula

    +
    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: -Display all locally available formulae for brewing (including tapped ones). -No online search is performed if called without arguments.

    • -

  • search, -S text|/text/: -Perform a substring search of formula names for text. If text is +installed, delete all installed versions.

    +
    search, -S

    Display all locally available formulae for brewing (including tapped ones). +No online search is performed if called without arguments.

    +
    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. -The search for text is extended online to some popular taps.

    • -

  • search --debian|--fedora|--fink|--macports|--opensuse|--ubuntu text: -Search for text in the given package manager's list.

    • -

  • sh [--env=std]: -Instantiate a Homebrew build environment. Uses our years-battle-hardened +The search for text is extended online to some popular taps.

    +
    search --debian|--fedora|--fink|--macports|--opensuse|--ubuntu text

    Search for text in the given package manager's list.

    +
    sh [--env=std]

    Instantiate a Homebrew build environment. Uses our years-battle-hardened Homebrew build logic to help your ./configure && make && make install or even your gem install succeed. Especially handy if you run Homebrew in an Xcode-only configuration since it adds tools like make to your PATH -which otherwise build-systems would not find.

    • -

  • switch name version: -Symlink all of the specific version of name's install to Homebrew prefix.

    • -

  • tap [--full] user/repo [URL]: -Tap a formula repository or list existing taps. This command can be invoked -in three ways.

    +which otherwise build-systems would not find.

    +
    switch name version

    Symlink all of the specific version of name's install to Homebrew prefix.

    +
    tap

    List all installed taps.

    +
    tap [--full] user/repo [URL]

    Tap a formula repository.

    -
      -

    • tap without arguments displays existing taps.

      • -

    • tap user/repo taps a formula repository from GitHub using HTTPS. +

      With URL unspecified, taps a formula repository from GitHub using HTTPS. Since so many taps are hosted on GitHub, this command is a shortcut for -tap <user>/<repo> https://github.com/<user>/homebrew-<repo>.

      • -

    • tap user/repo URL taps a formula repository from anywhere, using -any transport protocol that git handles. The one-argument form of tap -simplifies but also limits. This two-argument command makes no -assumptions, so taps can be cloned from places other than GitHub and -using protocols other than HTTPS, e.g., SSH, GIT, HTTP, FTP(S), RSYNC.

      • -
    +tap <user>/<repo> https://github.com/<user>/homebrew-<repo>.

    +

    With URL specified, taps a formula repository from anywhere, using +any transport protocol that git handles. The one-argument form of tap +simplifies but also limits. This two-argument command makes no +assumptions, so taps can be cloned from places other than GitHub and +using protocols other than HTTPS, e.g., SSH, GIT, HTTP, FTP(S), RSYNC.

    By default, the repository is cloned as a shallow copy (--depth=1), but -if --full is passed, a full clone will be used.

    • -

  • tap --repair: -Migrate tapped formulae from symlink-based to directory-based structure.

    • -

  • tap --list-official: -List all official taps.

    • -

  • tap --list-pinned: -List all pinned taps.

    • -

  • tap-info tap: -Display information about tap.

    • -

  • tap-info --json=version (--installed|taps): -Print a JSON representation of taps. Currently the only accepted value +if --full is passed, a full clone will be used.

    +
    tap --repair

    Migrate tapped formulae from symlink-based to directory-based structure.

    +
    tap --list-official

    List all official taps.

    +
    tap --list-pinned

    List all pinned taps.

    +
    tap-info tap

    Display information about tap.

    +
    tap-info --json=version (--installed|taps)

    Print a JSON representation of taps. Currently the only accepted value for version is v1.

    Pass --installed to get information on installed taps.

    See the docs for examples of using the JSON: -https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md

    • -

  • tap-pin tap: -Pin tap, prioritizing its formulae over core when formula names are supplied -by the user. See also tap-unpin.

    • -

  • tap-unpin tap: -Unpin tap so its formulae are no longer prioritized. See also tap-pin.

    • -

  • test [--devel|--HEAD] [--debug] formula: -A few formulae provide a test method. brew test formula runs this +https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md

    +
    tap-pin tap

    Pin tap, prioritizing its formulae over core when formula names are supplied +by the user. See also tap-unpin.

    +
    tap-unpin tap

    Unpin tap so its formulae are no longer prioritized. See also tap-pin.

    +
    test [--devel|--HEAD] [--debug] formula

    A few formulae provide a test method. brew test formula runs this test method. There is no standard output or return code, but it should generally indicate to the user if something is wrong with the installed formula.

    @@ -384,20 +329,17 @@ formula.

    If --debug is passed and the test fails, an interactive debugger will be launched with access to IRB or a shell inside the temporary test directory.

    -

    Example: brew install jruby && brew test jruby

    • -

  • unlink [--dry-run] formula: -Remove symlinks for formula from the Homebrew prefix. This can be useful +

    Example: brew install jruby && brew test jruby

    +
    unlink [--dry-run] formula

    Remove symlinks for formula from the Homebrew prefix. This can be useful for temporarily disabling a formula: brew unlink foo && commands && brew link foo.

    If --dry-run or -n is passed, Homebrew will list all files which would -be unlinked, but will not actually unlink or delete any files.

    • -

  • unlinkapps [--local] [formulae]: -Removes links created by brew linkapps.

    +be unlinked, but will not actually unlink or delete any files.

    +
    unlinkapps [--local] [formulae]

    Removes links created by brew linkapps.

    -

    If no formulae are provided, all linked app will be removed.

    • -

  • unpack [--git|--patch] [--destdir=path] formulae: -Unpack the source files for formulae into subdirectories of the current +

    If no formulae are provided, all linked app will be removed.

    +
    unpack [--git|--patch] [--destdir=path] formulae

    Unpack the source files for formulae into subdirectories of the current working directory. If --destdir=path is given, the subdirectories will be created in the directory named by <path> instead.

    @@ -405,28 +347,23 @@ be created in the directory named by <path> instead.

    unpacked source.

    If --git is passed, a Git repository will be initalized in the unpacked -source. This is useful for creating patches for the software.

    • -

  • unpin formulae: -Unpin formulae, allowing them to be upgraded by brew upgrade. See also -pin.

    • -

  • untap tap: -Remove a tapped repository.

    • -

  • update [--rebase]: -Fetch the newest version of Homebrew and all formulae from GitHub using +source. This is useful for creating patches for the software.

    +
    unpin formulae

    Unpin formulae, allowing them to be upgraded by brew upgrade. See also +pin.

    +
    untap tap

    Remove a tapped repository.

    +
    update [--rebase]

    Fetch the newest version of Homebrew and all formulae from GitHub using git(1).

    -

    If --rebase is specified then git pull --rebase is used.

    • -

  • upgrade [install-options] [--cleanup] [formulae]: -Upgrade outdated, unpinned brews.

    +

    If --rebase is specified then git pull --rebase is used.

    +
    upgrade [install-options] [--cleanup] [formulae]

    Upgrade outdated, unpinned brews.

    Options for the install command are also valid here.

    If --cleanup is specified then remove previously installed formula version(s).

    If formulae are given, upgrade only the specified brews (but do so even -if they are pinned; see pin, unpin).

    • -

  • uses [--installed] [--recursive] [--skip-build] [--skip-optional] [--devel|--HEAD] formulae: -Show the formulae that specify formulae as a dependency. When given +if they are pinned; see pin, unpin).

    +
    uses [--installed] [--recursive] [--skip-build] [--skip-optional] [--devel|--HEAD] formulae

    Show the formulae that specify formulae as a dependency. When given multiple formula arguments, show the intersection of formulae that use formulae.

    @@ -440,29 +377,20 @@ To skip the :build type dependencies, pass --skip-buildBy default, uses shows usages of formula by stable builds. To find cases where formula is used by development or HEAD build, pass ---devel or --HEAD.

    • -

  • --cache: -Display Homebrew's download cache. See also HOMEBREW_CACHE.

    • -

  • --cache formula: -Display the file or directory used to cache formula.

    • -

  • --cellar: -Display Homebrew's Cellar path. Default: $(brew --prefix)/Cellar, or if -that directory doesn't exist, $(brew --repository)/Cellar.

    • -

  • --cellar formula: -Display the location in the cellar where formula would be installed, -without any sort of versioned directory as the last path.

    • -

  • --env: -Show a summary of the Homebrew build environment.

    • -

  • --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 directory is located. For standard installs, -the prefix and repository are the same directory.

    • -

  • --version: -Print the version number of brew to standard error and exit.

    • -
+--devel or --HEAD.

+
--cache

Display Homebrew's download cache. See also HOMEBREW_CACHE.

+
--cache formula

Display the file or directory used to cache formula.

+
--cellar

Display Homebrew's Cellar path. Default: $(brew --prefix)/Cellar, or if +that directory doesn't exist, $(brew --repository)/Cellar.

+
--cellar formula

Display the location in the cellar where formula would be installed, +without any sort of versioned directory as the last path.

+
--env

Show a summary of the Homebrew build environment.

+
--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 directory is located. For standard installs, +the prefix and repository are the same directory.

+
--version

Print the version number of brew to standard error and exit.

+

EXTERNAL COMMANDS

diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index 391bf0a94c..30f9f045e5 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -43,8 +43,9 @@ Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is su . .SH "COMMANDS" . -.IP "\(bu" 4 -\fBaudit\fR [\fB\-\-strict\fR] [\fB\-\-online\fR] [\fIformulae\fR]: Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. +.TP +\fBaudit\fR [\fB\-\-strict\fR] [\fB\-\-online\fR] [\fIformulae\fR] +Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. . .IP If no \fIformulae\fR are provided, all of them are checked\. @@ -58,11 +59,13 @@ If \fB\-\-online\fR is passed, additional slower checks that require a network c .IP \fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\. . -.IP "\(bu" 4 -\fBcat\fR \fIformula\fR: Display the source to \fIformula\fR\. +.TP +\fBcat\fR \fIformula\fR +Display the source to \fIformula\fR\. . -.IP "\(bu" 4 -\fBcleanup\fR [\fB\-\-force\fR] [\fB\-\-prune=\fR\fIdays\fR] [\fB\-n\fR] [\fB\-s\fR] [\fIformulae\fR]: 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\. In addition, old downloads from the Homebrew download\-cache are deleted\. +.TP +\fBcleanup\fR [\fB\-\-force\fR] [\fB\-\-prune=\fR\fIdays\fR] [\fB\-n\fR] [\fB\-s\fR] [\fIformulae\fR] +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\. In addition, old downloads from the Homebrew download\-cache are deleted\. . .IP If \fB\-\-force\fR is passed, remove out\-of\-date keg\-only brews as well\. @@ -76,20 +79,24 @@ If \fB\-n\fR is passed, show what would be removed, but do not actually remove a .IP If \fB\-s\fR is passed, scrubs the cache, removing downloads for even the latest versions of formulae\. Note downloads for any installed formulae will still not be deleted\. If you want to delete those too: \fBrm \-rf $(brew \-\-cache)\fR . -.IP "\(bu" 4 -\fBcommand\fR \fIcmd\fR: Display the path to the file which is used when invoking \fBbrew\fR \fIcmd\fR\. +.TP +\fBcommand\fR \fIcmd\fR +Display the path to the file which is used when invoking \fBbrew\fR \fIcmd\fR\. . -.IP "\(bu" 4 -\fBcommands\fR [\fB\-\-quiet\fR [\fB\-\-include\-aliases\fR]]: Show a list of built\-in and external commands\. +.TP +\fBcommands\fR [\fB\-\-quiet\fR [\fB\-\-include\-aliases\fR]] +Show a list of built\-in and external commands\. . .IP If \fB\-\-quiet\fR is passed, list only the names of commands without the header\. With \fB\-\-include\-aliases\fR, the aliases of internal commands will be included\. . -.IP "\(bu" 4 -\fBconfig\fR: 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\. +.TP +\fBconfig\fR +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\. . -.IP "\(bu" 4 -\fBcreate\fR \fIURL\fR [\fB\-\-autotools\fR|\fB\-\-cmake\fR] [\fB\-\-no\-fetch\fR] [\fB\-\-set\-name\fR \fIname\fR] [\fB\-\-set\-version\fR \fIversion\fR]: Generate a formula for the downloadable file at \fIURL\fR and open it in the editor\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The \fBwget\fR formula serves as a simple example\. For the complete API have a look at +.TP +\fBcreate\fR \fIURL\fR [\fB\-\-autotools\fR|\fB\-\-cmake\fR] [\fB\-\-no\-fetch\fR] [\fB\-\-set\-name\fR \fIname\fR] [\fB\-\-set\-version\fR \fIversion\fR] +Generate a formula for the downloadable file at \fIURL\fR and open it in the editor\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The \fBwget\fR formula serves as a simple example\. For the complete API have a look at . .IP \fIhttp://www\.rubydoc\.info/github/Homebrew/homebrew/master/Formula\fR @@ -103,8 +110,9 @@ If \fB\-\-no\-fetch\fR is passed, Homebrew will not download \fIURL\fR to the ca .IP The options \fB\-\-set\-name\fR and \fB\-\-set\-version\fR each take an argument and allow you to explicitly set the name and version of the package you are creating\. . -.IP "\(bu" 4 -\fBdeps\fR [\fB\-\-1\fR] [\fB\-n\fR] [\fB\-\-union\fR] [\fB\-\-tree\fR] [\fB\-\-all\fR] [\fB\-\-installed\fR] [\fB\-\-skip\-build\fR] [\fB\-\-skip\-optional\fR] \fIformulae\fR: Show dependencies for \fIformulae\fR\. When given multiple formula arguments, show the intersection of dependencies for \fIformulae\fR, except when passed \fB\-\-tree\fR, \fB\-\-all\fR, or \fB\-\-installed\fR\. +.TP +\fBdeps\fR [\fB\-\-1\fR] [\fB\-n\fR] [\fB\-\-union\fR] [\fB\-\-tree\fR] [\fB\-\-all\fR] [\fB\-\-installed\fR] [\fB\-\-skip\-build\fR] [\fB\-\-skip\-optional\fR] \fIformulae\fR +Show dependencies for \fIformulae\fR\. When given multiple formula arguments, show the intersection of dependencies for \fIformulae\fR, except when passed \fB\-\-tree\fR, \fB\-\-all\fR, or \fB\-\-installed\fR\. . .IP If \fB\-\-1\fR is passed, only show dependencies one level down, instead of recursing\. @@ -127,14 +135,17 @@ If \fB\-\-installed\fR is passed, show dependencies for all installed formulae\. .IP By default, \fBdeps\fR shows dependencies for \fIformulae\fR\. To skip the \fB:build\fR type dependencies, pass \fB\-\-skip\-build\fR\. Similarly, pass \fB\-\-skip\-optional\fR to skip \fB:optional\fR dependencies\. . -.IP "\(bu" 4 -\fBdesc\fR \fIformula\fR: Display \fIformula\fR\'s name and one\-line description\. +.TP +\fBdesc\fR \fIformula\fR +Display \fIformula\fR\'s name and one\-line description\. . -.IP "\(bu" 4 -\fBdesc\fR [\fB\-s\fR|\fB\-n\fR|\fB\-d\fR] \fIpattern\fR: Search both name and description (\fB\-s\fR), just the names (\fB\-n\fR), or just the descriptions (\fB\-d\fR) for \fB\fR\. \fB\fR is by default interpreted as a literal string; if flanked by slashes, it is instead interpreted as a regular expression\. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones\. +.TP +\fBdesc\fR [\fB\-s\fR|\fB\-n\fR|\fB\-d\fR] \fIpattern\fR +Search both name and description (\fB\-s\fR), just the names (\fB\-n\fR), or just the descriptions (\fB\-d\fR) for \fB\fR\. \fB\fR is by default interpreted as a literal string; if flanked by slashes, it is instead interpreted as a regular expression\. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones\. . -.IP "\(bu" 4 -\fBdiy\fR [\fB\-\-name=\fR\fIname\fR] [\fB\-\-version=\fR\fIversion\fR]: Automatically determine the installation prefix for non\-Homebrew software\. +.TP +\fBdiy\fR [\fB\-\-name=\fR\fIname\fR] [\fB\-\-version=\fR\fIversion\fR] +Automatically determine the installation prefix for non\-Homebrew software\. . .IP Using the output from this command, you can install your own software into the Cellar and then link it into Homebrew\'s prefix with \fBbrew link\fR\. @@ -142,17 +153,21 @@ Using the output from this command, you can install your own software into the C .IP The options \fB\-\-name=\fR\fIname\fR and \fB\-\-version=\fR\fIversion\fR each take an argument and allow you to explicitly set the name and version of the package you are installing\. . -.IP "\(bu" 4 -\fBdoctor\fR: Check your system for potential problems\. Doctor exits with a non\-zero status if any problems are found\. +.TP +\fBdoctor\fR +Check your system for potential problems\. Doctor exits with a non\-zero status if any problems are found\. . -.IP "\(bu" 4 -\fBedit\fR: Open all of Homebrew for editing\. +.TP +\fBedit\fR +Open all of Homebrew for editing\. . -.IP "\(bu" 4 -\fBedit\fR \fIformula\fR: Open \fIformula\fR in the editor\. +.TP +\fBedit\fR \fIformula\fR +Open \fIformula\fR in the editor\. . -.IP "\(bu" 4 -\fBfetch\fR [\fB\-\-force\fR] [\fB\-v\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-deps\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] \fIformulae\fR: Download the source packages for the given \fIformulae\fR\. For tarballs, also print SHA\-1 and SHA\-256 checksums\. +.TP +\fBfetch\fR [\fB\-\-force\fR] [\fB\-v\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-deps\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] \fIformulae\fR +Download the source packages for the given \fIformulae\fR\. For tarballs, also print SHA\-1 and SHA\-256 checksums\. . .IP If \fB\-\-HEAD\fR or \fB\-\-devel\fR is passed, fetch that version instead of the stable version\. @@ -172,23 +187,28 @@ If \fB\-\-build\-from\-source\fR is passed, download the source rather than a bo .IP If \fB\-\-force\-bottle\fR is passed, download a bottle if it exists for the current version of OS X, even if it would not be used during installation\. . -.IP "\(bu" 4 -\fBhome\fR: Open Homebrew\'s own homepage in a browser\. +.TP +\fBhome\fR +Open Homebrew\'s own homepage in a browser\. . -.IP "\(bu" 4 -\fBhome\fR \fIformula\fR: Open \fIformula\fR\'s homepage in a browser\. +.TP +\fBhome\fR \fIformula\fR +Open \fIformula\fR\'s homepage in a browser\. . -.IP "\(bu" 4 -\fBinfo\fR \fIformula\fR: Display information about \fIformula\fR\. +.TP +\fBinfo\fR \fIformula\fR +Display information about \fIformula\fR\. . -.IP "\(bu" 4 -\fBinfo\fR \fB\-\-github\fR \fIformula\fR: Open a browser to the GitHub History page for formula \fIformula\fR\. +.TP +\fBinfo\fR \fB\-\-github\fR \fIformula\fR +Open a browser to the GitHub History page for formula \fIformula\fR\. . .IP To view formula history locally: \fBbrew log \-p \fR\. . -.IP "\(bu" 4 -\fBinfo \-\-json=\fR\fIversion\fR (\fB\-\-all\fR|\fB\-\-installed\fR|\fIformulae\fR): Print a JSON representation of \fIformulae\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\. +.TP +\fBinfo \-\-json=\fR\fIversion\fR (\fB\-\-all\fR|\fB\-\-installed\fR|\fIformulae\fR) +Print a JSON representation of \fIformulae\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\. . .IP Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to get information on all installed formulae\. @@ -196,8 +216,9 @@ Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to .IP See the docs for examples of using the JSON: \fIhttps://github\.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying\-Brew\.md\fR . -.IP "\(bu" 4 -\fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR\fIstd\fR|\fIsuper\fR] [\fB\-\-ignore\-dependencies\fR] [\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] \fIformula\fR: Install \fIformula\fR\. +.TP +\fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR\fIstd\fR|\fIsuper\fR] [\fB\-\-ignore\-dependencies\fR] [\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] \fIformula\fR +Install \fIformula\fR\. . .IP \fIformula\fR is usually the name of the formula to install, but it can be specified several different ways\. See \fISPECIFYING FORMULAE\fR\. @@ -235,23 +256,27 @@ If \fB\-\-HEAD\fR is passed, and \fIformula\fR defines it, install the HEAD vers .IP To install a newer version of HEAD use \fBbrew rm && brew install \-\-HEAD \fR\. . -.IP "\(bu" 4 -\fBinstall \-\-interactive\fR [\fB\-\-git\fR] \fIformula\fR: Download and patch \fIformula\fR, then open a shell\. This allows the user to run \fB\./configure \-\-help\fR and otherwise determine how to turn the software package into a Homebrew formula\. +.TP +\fBinstall \-\-interactive\fR [\fB\-\-git\fR] \fIformula\fR +Download and patch \fIformula\fR, then open a shell\. This allows the user to run \fB\./configure \-\-help\fR and otherwise determine how to turn the software package into a Homebrew formula\. . .IP If \fB\-\-git\fR is passed, Homebrew will create a Git repository, useful for creating patches to the software\. . -.IP "\(bu" 4 -\fBirb\fR [\fB\-\-examples\fR]: Enter the interactive Homebrew Ruby shell\. +.TP +\fBirb\fR [\fB\-\-examples\fR] +Enter the interactive Homebrew Ruby shell\. . .IP If \fB\-\-examples\fR is passed, several examples will be shown\. . -.IP "\(bu" 4 -\fBleaves\fR: Show installed formulae that are not dependencies of another installed formula\. +.TP +\fBleaves\fR +Show installed formulae that are not dependencies of another installed formula\. . -.IP "\(bu" 4 -\fBln\fR, \fBlink\fR [\fB\-\-overwrite\fR] [\fB\-\-dry\-run\fR] [\fB\-\-force\fR] \fIformula\fR: Symlink all of \fIformula\fR\'s installed files into the Homebrew prefix\. This is done automatically when you install formulae but can be useful for DIY installations\. +.TP +\fBln\fR, \fBlink\fR [\fB\-\-overwrite\fR] [\fB\-\-dry\-run\fR] [\fB\-\-force\fR] \fIformula\fR +Symlink all of \fIformula\fR\'s installed files into the Homebrew prefix\. This is done automatically when you install formulae but can be useful for DIY installations\. . .IP If \fB\-\-overwrite\fR is passed, Homebrew will delete files which already exist in the prefix while linking\. @@ -262,8 +287,9 @@ If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, Homebrew will list all files which .IP If \fB\-\-force\fR is passed, Homebrew will allow keg\-only formulae to be linked\. . -.IP "\(bu" 4 -\fBlinkapps\fR [\fB\-\-local\fR] [\fIformulae\fR]: Find installed formulae that have compiled \fB\.app\fR\-style "application" packages for OS X, and symlink those apps into \fB/Applications\fR, allowing for easier access\. +.TP +\fBlinkapps\fR [\fB\-\-local\fR] [\fIformulae\fR] +Find installed formulae that have compiled \fB\.app\fR\-style "application" packages for OS X, and symlink those apps into \fB/Applications\fR, allowing for easier access\. . .IP If no \fIformulae\fR are provided, all of them will have their \.apps symlinked\. @@ -271,14 +297,17 @@ If no \fIformulae\fR are provided, all of them will have their \.apps symlinked\ .IP If provided, \fB\-\-local\fR will move them into the user\'s \fB~/Applications\fR directory instead of the system directory\. It may need to be created, first\. . -.IP "\(bu" 4 -\fBls\fR, \fBlist\fR [\fB\-\-full\-name\fR]: List all installed formulae\. If \fB\-\-full\-name\fR is passed, print formulae with full\-qualified names\. +.TP +\fBls\fR, \fBlist\fR [\fB\-\-full\-name\fR] +List all installed formulae\. If \fB\-\-full\-name\fR is passed, print formulae with full\-qualified names\. . -.IP "\(bu" 4 -\fBls\fR, \fBlist \-\-unbrewed\fR: List all files in the Homebrew prefix not installed by Homebrew\. +.TP +\fBls\fR, \fBlist \-\-unbrewed\fR +List all files in the Homebrew prefix not installed by Homebrew\. . -.IP "\(bu" 4 -\fBls\fR, \fBlist\fR [\fB\-\-versions\fR [\fB\-\-multiple\fR]] [\fB\-\-pinned\fR] [\fIformulae\fR]: List the installed files for \fIformulae\fR\. Combined with \fB\-\-verbose\fR, recursively list the contents of all subdirectories in each \fIformula\fR\'s keg\. +.TP +\fBls\fR, \fBlist\fR [\fB\-\-versions\fR [\fB\-\-multiple\fR]] [\fB\-\-pinned\fR] [\fIformulae\fR] +List the installed files for \fIformulae\fR\. Combined with \fB\-\-verbose\fR, recursively list the contents of all subdirectories in each \fIformula\fR\'s keg\. . .IP If \fB\-\-versions\fR is passed, show the version number for installed formulae, or only the specified formulae if \fIformulae\fR are given\. With \fB\-\-multiple\fR, only show formulae with multiple versions installed\. @@ -286,23 +315,27 @@ If \fB\-\-versions\fR is passed, show the version number for installed formulae, .IP If \fB\-\-pinned\fR is passed, show the versions of pinned formulae, or only the specified (pinned) formulae if \fIformulae\fR are given\. See also \fBpin\fR, \fBunpin\fR\. . -.IP "\(bu" 4 -\fBlog\fR [\fBgit\-log\-options\fR] \fIformula\fR \.\.\.: Show the git log for the given formulae\. Options that \fBgit\-log\fR(1) recognizes can be passed before the formula list\. +.TP +\fBlog\fR [\fBgit\-log\-options\fR] \fIformula\fR \.\.\. +Show the git log for the given formulae\. Options that \fBgit\-log\fR(1) recognizes can be passed before the formula list\. . -.IP "\(bu" 4 -\fBmissing\fR [\fIformulae\fR]: Check the given \fIformulae\fR for missing dependencies\. +.TP +\fBmissing\fR [\fIformulae\fR] +Check the given \fIformulae\fR for missing dependencies\. . .IP If no \fIformulae\fR are given, check all installed brews\. . -.IP "\(bu" 4 -\fBmigrate\fR [\fB\-\-force\fR] \fIformulae\fR: Migrate renamed packages to new name, where \fIformulae\fR are old names of packages\. +.TP +\fBmigrate\fR [\fB\-\-force\fR] \fIformulae\fR +Migrate renamed packages to new name, where \fIformulae\fR are old names of packages\. . .IP If \fB\-\-force\fR is passed, then treat installed \fIformulae\fR and passed \fIformulae\fR like if they are from same taps and migrate them anyway\. . -.IP "\(bu" 4 -\fBoptions\fR [\fB\-\-compact\fR] [\fB\-\-all\fR] [\fB\-\-installed\fR] \fIformula\fR: Display install options specific to \fIformula\fR\. +.TP +\fBoptions\fR [\fB\-\-compact\fR] [\fB\-\-all\fR] [\fB\-\-installed\fR] \fIformula\fR +Display install options specific to \fIformula\fR\. . .IP If \fB\-\-compact\fR is passed, show all options on a single line separated by spaces\. @@ -313,8 +346,9 @@ If \fB\-\-all\fR is passed, show options for all formulae\. .IP If \fB\-\-installed\fR is passed, show options for all installed formulae\. . -.IP "\(bu" 4 -\fBoutdated\fR [\fB\-\-quiet\fR|\fB\-\-verbose\fR|\fB\-\-json=v1\fR]: Show formulae that have an updated version available\. +.TP +\fBoutdated\fR [\fB\-\-quiet\fR|\fB\-\-verbose\fR|\fB\-\-json=v1\fR] +Show formulae that have an updated version available\. . .IP By default, version information is displayed in interactive shells, and suppressed otherwise\. @@ -328,67 +362,81 @@ If \fB\-\-verbose\fR is passed, display detailed version information\. .IP If \fB\-\-json=\fR\fIversion\fR is passed, the output will be in JSON format\. The only valid version is \fBv1\fR\. . -.IP "\(bu" 4 -\fBpin\fR \fIformulae\fR: Pin the specified \fIformulae\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR command\. See also \fBunpin\fR\. +.TP +\fBpin\fR \fIformulae\fR +Pin the specified \fIformulae\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR command\. See also \fBunpin\fR\. . -.IP "\(bu" 4 -\fBprune\fR: Remove dead symlinks from the Homebrew prefix\. This is generally not needed, but can be useful when doing DIY installations\. +.TP +\fBprune\fR +Remove dead symlinks from the Homebrew prefix\. This is generally not needed, but can be useful when doing DIY installations\. . -.IP "\(bu" 4 -\fBreinstall\fR \fIformula\fR: Uninstall then install \fIformula\fR +.TP +\fBreinstall\fR \fIformula\fR +Uninstall then install \fIformula\fR . -.IP "\(bu" 4 -\fBrm\fR, \fBremove\fR, \fBuninstall\fR [\fB\-\-force\fR] \fIformula\fR: Uninstall \fIformula\fR\. +.TP +\fBrm\fR, \fBremove\fR, \fBuninstall\fR [\fB\-\-force\fR] \fIformula\fR +Uninstall \fIformula\fR\. . .IP If \fB\-\-force\fR is passed, and there are multiple versions of \fIformula\fR installed, delete all installed versions\. . -.IP "\(bu" 4 -\fBsearch\fR, \fB\-S\fR: Display all locally available formulae for brewing (including tapped ones)\. No online search is performed if called without arguments\. +.TP +\fBsearch\fR, \fB\-S\fR +Display all locally available formulae for brewing (including tapped ones)\. No online search is performed if called without arguments\. . -.IP "\(bu" 4 -\fBsearch\fR, \fB\-S\fR \fItext\fR|\fB/\fR\fItext\fR\fB/\fR: Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to some popular taps\. +.TP +\fBsearch\fR, \fB\-S\fR \fItext\fR|\fB/\fR\fItext\fR\fB/\fR +Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to some popular taps\. . -.IP "\(bu" 4 -\fBsearch \-\-debian\fR|\fB\-\-fedora\fR|\fB\-\-fink\fR|\fB\-\-macports\fR|\fB\-\-opensuse\fR|\fB\-\-ubuntu\fR \fItext\fR: Search for \fItext\fR in the given package manager\'s list\. +.TP +\fBsearch \-\-debian\fR|\fB\-\-fedora\fR|\fB\-\-fink\fR|\fB\-\-macports\fR|\fB\-\-opensuse\fR|\fB\-\-ubuntu\fR \fItext\fR +Search for \fItext\fR in the given package manager\'s list\. . -.IP "\(bu" 4 -\fBsh\fR [\fB\-\-env=std\fR]: Instantiate a Homebrew build environment\. Uses our years\-battle\-hardened Homebrew build logic to help your \fB\./configure && make && make install\fR or even your \fBgem install\fR succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fR to your \fBPATH\fR which otherwise build\-systems would not find\. +.TP +\fBsh\fR [\fB\-\-env=std\fR] +Instantiate a Homebrew build environment\. Uses our years\-battle\-hardened Homebrew build logic to help your \fB\./configure && make && make install\fR or even your \fBgem install\fR succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fR to your \fBPATH\fR which otherwise build\-systems would not find\. . -.IP "\(bu" 4 -\fBswitch\fR \fIname\fR \fIversion\fR: Symlink all of the specific \fIversion\fR of \fIname\fR\'s install to Homebrew prefix\. +.TP +\fBswitch\fR \fIname\fR \fIversion\fR +Symlink all of the specific \fIversion\fR of \fIname\fR\'s install to Homebrew prefix\. . -.IP "\(bu" 4 -\fBtap\fR [\fB\-\-full\fR] \fIuser\fR\fB/\fR\fIrepo\fR [\fIURL\fR]: Tap a formula repository or list existing taps\. This command can be invoked in three ways\. +.TP +\fBtap\fR +List all installed taps\. . -.IP "\(bu" 4 -\fBtap\fR without arguments displays existing taps\. +.TP +\fBtap\fR [\fB\-\-full\fR] \fIuser\fR\fB/\fR\fIrepo\fR [\fIURL\fR] +Tap a formula repository\. . -.IP "\(bu" 4 -\fBtap\fR \fIuser\fR\fB/\fR\fIrepo\fR taps a formula repository from GitHub using HTTPS\. Since so many taps are hosted on GitHub, this command is a shortcut for \fBtap / https://github\.com//homebrew\-\fR\. +.IP +With \fIURL\fR unspecified, taps a formula repository from GitHub using HTTPS\. Since so many taps are hosted on GitHub, this command is a shortcut for \fBtap / https://github\.com//homebrew\-\fR\. . -.IP "\(bu" 4 -\fBtap\fR \fIuser\fR\fB/\fR\fIrepo\fR \fIURL\fR taps a formula repository from anywhere, using any transport protocol that \fBgit\fR handles\. The one\-argument form of \fBtap\fR simplifies but also limits\. This two\-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e\.g\., SSH, GIT, HTTP, FTP(S), RSYNC\. -. -.IP "" 0 +.IP +With \fIURL\fR specified, taps a formula repository from anywhere, using any transport protocol that \fBgit\fR handles\. The one\-argument form of \fBtap\fR simplifies but also limits\. This two\-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e\.g\., SSH, GIT, HTTP, FTP(S), RSYNC\. . .IP By default, the repository is cloned as a shallow copy (\fB\-\-depth=1\fR), but if \fB\-\-full\fR is passed, a full clone will be used\. . -.IP "\(bu" 4 -\fBtap \-\-repair\fR: Migrate tapped formulae from symlink\-based to directory\-based structure\. +.TP +\fBtap \-\-repair\fR +Migrate tapped formulae from symlink\-based to directory\-based structure\. . -.IP "\(bu" 4 -\fBtap \-\-list\-official\fR: List all official taps\. +.TP +\fBtap \-\-list\-official\fR +List all official taps\. . -.IP "\(bu" 4 -\fBtap \-\-list\-pinned\fR: List all pinned taps\. +.TP +\fBtap \-\-list\-pinned\fR +List all pinned taps\. . -.IP "\(bu" 4 -\fBtap\-info\fR \fItap\fR: Display information about \fItap\fR\. +.TP +\fBtap\-info\fR \fItap\fR +Display information about \fItap\fR\. . -.IP "\(bu" 4 -\fBtap\-info\fR \fB\-\-json=\fR\fIversion\fR (\fB\-\-installed\fR|\fItaps\fR): Print a JSON representation of \fItaps\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\. +.TP +\fBtap\-info\fR \fB\-\-json=\fR\fIversion\fR (\fB\-\-installed\fR|\fItaps\fR) +Print a JSON representation of \fItaps\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\. . .IP Pass \fB\-\-installed\fR to get information on installed taps\. @@ -396,14 +444,17 @@ Pass \fB\-\-installed\fR to get information on installed taps\. .IP See the docs for examples of using the JSON: \fIhttps://github\.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying\-Brew\.md\fR . -.IP "\(bu" 4 -\fBtap\-pin\fR \fItap\fR: Pin \fItap\fR, prioritizing its formulae over core when formula names are supplied by the user\. See also \fBtap\-unpin\fR\. +.TP +\fBtap\-pin\fR \fItap\fR +Pin \fItap\fR, prioritizing its formulae over core when formula names are supplied by the user\. See also \fBtap\-unpin\fR\. . -.IP "\(bu" 4 -\fBtap\-unpin\fR \fItap\fR: Unpin \fItap\fR so its formulae are no longer prioritized\. See also \fBtap\-pin\fR\. +.TP +\fBtap\-unpin\fR \fItap\fR +Unpin \fItap\fR so its formulae are no longer prioritized\. See also \fBtap\-pin\fR\. . -.IP "\(bu" 4 -\fBtest\fR [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-debug\fR] \fIformula\fR: A few formulae provide a test method\. \fBbrew test\fR \fIformula\fR runs this test method\. There is no standard output or return code, but it should generally indicate to the user if something is wrong with the installed formula\. +.TP +\fBtest\fR [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-debug\fR] \fIformula\fR +A few formulae provide a test method\. \fBbrew test\fR \fIformula\fR runs this test method\. There is no standard output or return code, but it should generally indicate to the user if something is wrong with the installed formula\. . .IP To test the development or head version of a formula, use \fB\-\-devel\fR or \fB\-\-HEAD\fR\. @@ -414,20 +465,23 @@ If \fB\-\-debug\fR is passed and the test fails, an interactive debugger will be .IP Example: \fBbrew install jruby && brew test jruby\fR . -.IP "\(bu" 4 -\fBunlink\fR [\fB\-\-dry\-run\fR] \fIformula\fR: Remove symlinks for \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink foo && commands && brew link foo\fR\. +.TP +\fBunlink\fR [\fB\-\-dry\-run\fR] \fIformula\fR +Remove symlinks for \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink foo && commands && brew link foo\fR\. . .IP If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, Homebrew will list all files which would be unlinked, but will not actually unlink or delete any files\. . -.IP "\(bu" 4 -\fBunlinkapps\fR [\fB\-\-local\fR] [\fIformulae\fR]: Removes links created by \fBbrew linkapps\fR\. +.TP +\fBunlinkapps\fR [\fB\-\-local\fR] [\fIformulae\fR] +Removes links created by \fBbrew linkapps\fR\. . .IP If no \fIformulae\fR are provided, all linked app will be removed\. . -.IP "\(bu" 4 -\fBunpack\fR [\fB\-\-git\fR|\fB\-\-patch\fR] [\fB\-\-destdir=\fR\fIpath\fR] \fIformulae\fR: Unpack the source files for \fIformulae\fR into subdirectories of the current working directory\. If \fB\-\-destdir=\fR\fIpath\fR is given, the subdirectories will be created in the directory named by \fB\fR instead\. +.TP +\fBunpack\fR [\fB\-\-git\fR|\fB\-\-patch\fR] [\fB\-\-destdir=\fR\fIpath\fR] \fIformulae\fR +Unpack the source files for \fIformulae\fR into subdirectories of the current working directory\. If \fB\-\-destdir=\fR\fIpath\fR is given, the subdirectories will be created in the directory named by \fB\fR instead\. . .IP If \fB\-\-patch\fR is passed, patches for \fIformulae\fR will be applied to the unpacked source\. @@ -435,20 +489,24 @@ If \fB\-\-patch\fR is passed, patches for \fIformulae\fR will be applied to the .IP If \fB\-\-git\fR is passed, a Git repository will be initalized in the unpacked source\. This is useful for creating patches for the software\. . -.IP "\(bu" 4 -\fBunpin\fR \fIformulae\fR: Unpin \fIformulae\fR, allowing them to be upgraded by \fBbrew upgrade\fR\. See also \fBpin\fR\. +.TP +\fBunpin\fR \fIformulae\fR +Unpin \fIformulae\fR, allowing them to be upgraded by \fBbrew upgrade\fR\. See also \fBpin\fR\. . -.IP "\(bu" 4 -\fBuntap\fR \fItap\fR: Remove a tapped repository\. +.TP +\fBuntap\fR \fItap\fR +Remove a tapped repository\. . -.IP "\(bu" 4 -\fBupdate\fR [\fB\-\-rebase\fR]: Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1)\. +.TP +\fBupdate\fR [\fB\-\-rebase\fR] +Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1)\. . .IP If \fB\-\-rebase\fR is specified then \fBgit pull \-\-rebase\fR is used\. . -.IP "\(bu" 4 -\fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fIformulae\fR]: Upgrade outdated, unpinned brews\. +.TP +\fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fIformulae\fR] +Upgrade outdated, unpinned brews\. . .IP Options for the \fBinstall\fR command are also valid here\. @@ -459,8 +517,9 @@ If \fB\-\-cleanup\fR is specified then remove previously installed \fIformula\fR .IP If \fIformulae\fR are given, upgrade only the specified brews (but do so even if they are pinned; see \fBpin\fR, \fBunpin\fR)\. . -.IP "\(bu" 4 -\fBuses\fR [\fB\-\-installed\fR] [\fB\-\-recursive\fR] [\fB\-\-skip\-build\fR] [\fB\-\-skip\-optional\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] \fIformulae\fR: Show the formulae that specify \fIformulae\fR as a dependency\. When given multiple formula arguments, show the intersection of formulae that use \fIformulae\fR\. +.TP +\fBuses\fR [\fB\-\-installed\fR] [\fB\-\-recursive\fR] [\fB\-\-skip\-build\fR] [\fB\-\-skip\-optional\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] \fIformulae\fR +Show the formulae that specify \fIformulae\fR as a dependency\. When given multiple formula arguments, show the intersection of formulae that use \fIformulae\fR\. . .IP Use \fB\-\-recursive\fR to resolve more than one level of dependencies\. @@ -474,34 +533,41 @@ By default, \fBuses\fR shows all formulae that specify \fIformulae\fR as a depen .IP By default, \fBuses\fR shows usages of \fBformula\fR by stable builds\. To find cases where \fBformula\fR is used by development or HEAD build, pass \fB\-\-devel\fR or \fB\-\-HEAD\fR\. . -.IP "\(bu" 4 -\fB\-\-cache\fR: Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\. +.TP +\fB\-\-cache\fR +Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\. . -.IP "\(bu" 4 -\fB\-\-cache\fR \fIformula\fR: Display the file or directory used to cache \fIformula\fR\. +.TP +\fB\-\-cache\fR \fIformula\fR +Display the file or directory used to cache \fIformula\fR\. . -.IP "\(bu" 4 -\fB\-\-cellar\fR: Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB$(brew \-\-prefix)/Cellar\fR, or if that directory doesn\'t exist, \fB$(brew \-\-repository)/Cellar\fR\. +.TP +\fB\-\-cellar\fR +Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB$(brew \-\-prefix)/Cellar\fR, or if that directory doesn\'t exist, \fB$(brew \-\-repository)/Cellar\fR\. . -.IP "\(bu" 4 -\fB\-\-cellar\fR \fIformula\fR: Display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned directory as the last path\. +.TP +\fB\-\-cellar\fR \fIformula\fR +Display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned directory as the last path\. . -.IP "\(bu" 4 -\fB\-\-env\fR: Show a summary of the Homebrew build environment\. +.TP +\fB\-\-env\fR +Show a summary of the Homebrew build environment\. . -.IP "\(bu" 4 -\fB\-\-prefix\fR: Display Homebrew\'s install path\. \fIDefault:\fR \fB/usr/local\fR +.TP +\fB\-\-prefix\fR +Display Homebrew\'s install path\. \fIDefault:\fR \fB/usr/local\fR . -.IP "\(bu" 4 -\fB\-\-prefix\fR \fIformula\fR: Display the location in the cellar where \fIformula\fR is or would be installed\. +.TP +\fB\-\-prefix\fR \fIformula\fR +Display the location in the cellar where \fIformula\fR is or would be installed\. . -.IP "\(bu" 4 -\fB\-\-repository\fR: Display where Homebrew\'s \fB\.git\fR directory is located\. For standard installs, the \fBprefix\fR and \fBrepository\fR are the same directory\. +.TP +\fB\-\-repository\fR +Display where Homebrew\'s \fB\.git\fR directory is located\. For standard installs, the \fBprefix\fR and \fBrepository\fR are the same directory\. . -.IP "\(bu" 4 -\fB\-\-version\fR: Print the version number of brew to standard error and exit\. -. -.IP "" 0 +.TP +\fB\-\-version\fR +Print the version number of brew to standard error and exit\. . .SH "EXTERNAL COMMANDS" Homebrew, like \fBgit\fR(1), supports external commands\. These are executable scripts that reside somewhere in the \fBPATH\fR, named \fBbrew\-\fR\fIcmdname\fR or \fBbrew\-\fR\fIcmdname\fR\fB\.rb\fR, which can be invoked like \fBbrew\fR \fIcmdname\fR\. This allows you to create your own commands without modifying Homebrew\'s internals\.