admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #2876 from VonUniGE/patch-1

Browse Source 
Update documentation of brew install syntax to match its actual behav…
This commit is contained in:
Mike McQuaid 2017-07-13 21:22:55 +01:00 committed by GitHub
commit 4ca2efb12d
4 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Library/Homebrew/cmd/install.rb
View File

@ -1,4 +1,4 @@
#: * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=`<compiler>] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] <formula>: #: * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=`<compiler>] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] <formula> [<options> ...]:
#: Install <formula>. #: Install <formula>.
#: #:
#: <formula> is usually the name of the formula to install, but it can be specified #: <formula> is usually the name of the formula to install, but it can be specified
@ -47,6 +47,9 @@
#: If `--build-bottle` is passed, prepare the formula for eventual bottling #: If `--build-bottle` is passed, prepare the formula for eventual bottling
#: during installation. #: during installation.
#: #:
#: Installation options specific to <formula> may be appended to the command,
#: and can be listed with `brew options` <formula>.
#:
#: * `install` `--interactive` [`--git`] <formula>: #: * `install` `--interactive` [`--git`] <formula>:
#: If `--interactive` (or `-i`) is passed, download and patch <formula>, then #: If `--interactive` (or `-i`) is passed, download and patch <formula>, then
#: open a shell. This allows the user to run `./configure --help` and #: open a shell. This allows the user to run `./configure --help` and

5
docs/Manpage.md
View File

@ -198,7 +198,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
See the docs for examples of using the JSON output: See the docs for examples of using the JSON output:
<http://docs.brew.sh/Querying-Brew.html> <http://docs.brew.sh/Querying-Brew.html>
* `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=``compiler`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] `formula`: * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=``compiler`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] `formula` [`options` ...]:
Install `formula`. Install `formula`.
`formula` is usually the name of the formula to install, but it can be specified `formula` is usually the name of the formula to install, but it can be specified
@ -247,6 +247,9 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
If `--build-bottle` is passed, prepare the formula for eventual bottling If `--build-bottle` is passed, prepare the formula for eventual bottling
during installation. during installation.
Installation options specific to `formula` may be appended to the command,
and can be listed with `brew options` `formula`.
* `install` `--interactive` [`--git`] `formula`: * `install` `--interactive` [`--git`] `formula`:
If `--interactive` (or `-i`) is passed, download and patch `formula`, then If `--interactive` (or `-i`) is passed, download and patch `formula`, then
open a shell. This allows the user to run `./configure --help` and open a shell. This allows the user to run `./configure --help` and

2
manpages/brew-cask.1
View File

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "BREW\-CASK" "1" "June 2017" "Homebrew" "brew-cask" .TH "BREW\-CASK" "1" "July 2017" "Homebrew" "brew-cask"
. .
.SH "NAME" .SH "NAME"
\fBbrew\-cask\fR \- a friendly binary installer for macOS \fBbrew\-cask\fR \- a friendly binary installer for macOS

7
manpages/brew.1
View File

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "BREW" "1" "June 2017" "Homebrew" "brew" .TH "BREW" "1" "July 2017" "Homebrew" "brew"
. .
.SH "NAME" .SH "NAME"
\fBbrew\fR \- The missing package manager for macOS \fBbrew\fR \- The missing package manager for macOS
@ -216,7 +216,7 @@ Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to
See the docs for examples of using the JSON output: \fIhttp://docs\.brew\.sh/Querying\-Brew\.html\fR See the docs for examples of using the JSON output: \fIhttp://docs\.brew\.sh/Querying\-Brew\.html\fR
. .
.TP .TP
\fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR(\fBstd\fR|\fBsuper\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] [\fB\-\-keep\-tmp\fR] [\fB\-\-build\-bottle\fR] \fIformula\fR \fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR(\fBstd\fR|\fBsuper\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] [\fB\-\-keep\-tmp\fR] [\fB\-\-build\-bottle\fR] \fIformula\fR [\fIoptions\fR \.\.\.]
Install \fIformula\fR\. Install \fIformula\fR\.
. .
.IP .IP
@ -261,6 +261,9 @@ If \fB\-\-keep\-tmp\fR is passed, the temporary files created during installatio
.IP .IP
If \fB\-\-build\-bottle\fR is passed, prepare the formula for eventual bottling during installation\. If \fB\-\-build\-bottle\fR is passed, prepare the formula for eventual bottling during installation\.
. .
.IP
Installation options specific to \fIformula\fR may be appended to the command, and can be listed with \fBbrew options\fR \fIformula\fR\.
.
.TP .TP
\fBinstall\fR \fB\-\-interactive\fR [\fB\-\-git\fR] \fIformula\fR \fBinstall\fR \fB\-\-interactive\fR [\fB\-\-git\fR] \fIformula\fR
If \fB\-\-interactive\fR (or \fB\-i\fR) is passed, 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\. If \fB\-\-interactive\fR (or \fB\-i\fR) is passed, 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\.