mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update manpages using man brew

Browse Source 
Properly update man pages using the local brew executable (from the repo),
and copy the man pages to the repo.
This commit is contained in:
Afnan Enayet 2018-07-01 18:47:13 -04:00
parent 01a3422232
commit fa41a66907
No known key found for this signature in database
GPG Key ID: 9C669708328BC5A4
5 changed files with 52 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -22,7 +22,10 @@
#: If `--cc=`<compiler> is passed, attempt to compile using <compiler>. #: If `--cc=`<compiler> is passed, attempt to compile using <compiler>.
#: <compiler> should be the name of the compiler's executable, for instance #: <compiler> should be the name of the compiler's executable, for instance
#: `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC #: `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC
#: 4.9. #: 4.9. In order to use LLVM's clang, use `llvm_clang`. To specify the
#: Apple-provided clang, use `clang`. This parameter will only accept
#: compilers that are provided by Homebrew. Note that this will override
#: the value set by the `$HOMEBREW_CC` environment variable.
#: #:
#: If `--build-from-source` (or `-s`) is passed, compile the specified <formula> from #: If `--build-from-source` (or `-s`) is passed, compile the specified <formula> from
#: source even if a bottle is provided. Dependencies will still be installed #: source even if a bottle is provided. Dependencies will still be installed

9
Library/Homebrew/manpages/brew.1.md.erb
View File

@ -138,6 +138,15 @@ Note that environment variables must have a value set to be detected. For exampl
*Default:* `~/Library/Caches/Homebrew`. *Default:* `~/Library/Caches/Homebrew`.
* `HOMEBREW_CC`:
If set, instructs Homebrew to used the specified compiler to build a
package from source. In order to specify the Apple-provided clang,
set `clang`. For the clang provided from the LLVM package, use
`llvm_clang`. For versions of gcc, use the names of the executables from
the packages that Homebrew provides, e.g. for gcc 4.9, `gcc-4.9`, or for
gcc 8, `gcc-8`. Note that this variable can only be set to compilers that
are provided by Homebrew.
* `HOMEBREW_CURLRC`: * `HOMEBREW_CURLRC`:
If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables
the use of `curlrc`). the use of `curlrc`).

5
docs/Custom-GCC-and-cross-compilers.md
View File

@ -15,7 +15,8 @@ listing them on this page. If you come up with a formula for a new version of
GCC or cross-compiler suite, please link it in here. GCC or cross-compiler suite, please link it in here.
* Homebrew provides a `gcc` formula for use with Xcode 4.2+ or when needing * Homebrew provides a `gcc` formula for use with Xcode 4.2+ or when needing
C++11 support on earlier versions. C++11 support on earlier versions.
* Homebrew provides older GCC formulae, e.g. `gcc@4.8` and `gcc@6`. * Homebrew provides older GCC formulae, e.g. `gcc@4.8` and `gcc@6`.
* Homebrew provides the LLVM clang, which is bundled with the `llvm` formula.
* [RISC-V](https://github.com/riscv/homebrew-riscv) provides the RISC-V * [RISC-V](https://github.com/riscv/homebrew-riscv) provides the RISC-V
toolchain including binutils and GCC. toolchain including binutils and GCC.

61
docs/Manpage.md
View File

@ -240,9 +240,10 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
If `--cc=``compiler` is passed, attempt to compile using `compiler`. If `--cc=``compiler` is passed, attempt to compile using `compiler`.
`compiler` should be the name of the compiler's executable, for instance `compiler` should be the name of the compiler's executable, for instance
`gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC
4.9. In order to use the Homebrew-provided clang from the LLVM package, 4.9. In order to use LLVM's clang, use `llvm_clang`. To specify the
use `llvm_clang`. Note that this will override the `HOMEBREW_CC` Apple-provided clang, use `clang`. This parameter will only accept
environment variable. compilers that are provided by Homebrew. Note that this will override
the value set by the `$HOMEBREW_CC` environment variable.
If `--build-from-source` (or `-s`) is passed, compile the specified `formula` from If `--build-from-source` (or `-s`) is passed, compile the specified `formula` from
source even if a bottle is provided. Dependencies will still be installed source even if a bottle is provided. Dependencies will still be installed
@ -930,37 +931,37 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
Bundler for non-Ruby dependencies from Homebrew. Bundler for non-Ruby dependencies from Homebrew.
`bundle` [`install`] [`-v`|`--verbose`] [`--no-upgrade`] [`--file=``path`|`--global`]: `bundle` [`install`] [`-v`|`--verbose`] [`--no-upgrade`] [`--file=``path`|`--global`]:
Install or upgrade all dependencies in a Brewfile. Install or upgrade all dependencies in a Brewfile.
`brew bundle dump` [`--force`] [`--describe`] [`--file=``path`|`--global`] `brew bundle dump` [`--force`] [`--describe`] [`--file=``path`|`--global`]
Write all installed casks/formulae/taps into a Brewfile. Write all installed casks/formulae/taps into a Brewfile.
`brew bundle cleanup` [`--force`] [`--zap`] [`--file=``path`|`--global`] `brew bundle cleanup` [`--force`] [`--zap`] [`--file=``path`|`--global`]
Uninstall all dependencies not listed in a Brewfile. Uninstall all dependencies not listed in a Brewfile.
`brew bundle check` [`--no-upgrade`] [`--file`=`path`|`--global`] `brew bundle check` [`--no-upgrade`] [`--file`=`path`|`--global`]
Check if all dependencies are installed in a Brewfile. Check if all dependencies are installed in a Brewfile.
`brew bundle exec` `command` `brew bundle exec` `command`
Run an external command in an isolated build environment. Run an external command in an isolated build environment.
`brew bundle list` [`--all`|`--brews`|`--casks`|`--taps`|`--mas`] [`--file=``path`|`--global`] `brew bundle list` [`--all`|`--brews`|`--casks`|`--taps`|`--mas`] [`--file=``path`|`--global`]
@ -968,37 +969,37 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
By default, only brew dependencies are output. By default, only brew dependencies are output.
If `-v` or `--verbose` are passed, print verbose output. If `-v` or `--verbose` are passed, print verbose output.
If `--no-upgrade` is passed, don't run `brew upgrade` outdated dependencies. If `--no-upgrade` is passed, don't run `brew upgrade` outdated dependencies.
Note they may still be upgraded by `brew install` if needed. Note they may still be upgraded by `brew install` if needed.
If `--force` is passed, uninstall dependencies or overwrite an existing Brewfile. If `--force` is passed, uninstall dependencies or overwrite an existing Brewfile.
If `--file=`path is passed, the Brewfile path is set accordingly If `--file=`path is passed, the Brewfile path is set accordingly
Use `--file=-` to output to console. Use `--file=-` to output to console.
If `--global` is passed, set Brewfile path to `$HOME/.Brewfile`. If `--global` is passed, set Brewfile path to `$HOME/.Brewfile`.
If `--describe` is passed, output a description comment above each line. If `--describe` is passed, output a description comment above each line.
This comment will not be output if the dependency does not have a description. This comment will not be output if the dependency does not have a description.
If `-h` or `--help` are passed, print this help message and exit. If `-h` or `--help` are passed, print this help message and exit.
@ -1014,43 +1015,43 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
Integrates Homebrew formulae with macOS' `launchctl` manager. Integrates Homebrew formulae with macOS' `launchctl` manager.
[`sudo`] `brew services list` [`sudo`] `brew services list`
List all running services for the current user (or `root`) List all running services for the current user (or `root`)
[`sudo`] `brew services run` `formula|--all` [`sudo`] `brew services run` `formula|--all`
Run the service `formula` without starting at login (or boot). Run the service `formula` without starting at login (or boot).
[`sudo`] `brew services` `start` `formula|--all` [`sudo`] `brew services` `start` `formula|--all`
Start the service `formula` immediately and register it to launch at login (or `boot`). Start the service `formula` immediately and register it to launch at login (or `boot`).
[`sudo`] `brew services` `stop` `formula|--all` [`sudo`] `brew services` `stop` `formula|--all`
Stop the service `formula` immediately and unregister it from launching at login (or `boot`). Stop the service `formula` immediately and unregister it from launching at login (or `boot`).
[`sudo`] `brew services` `restart` `formula|--all` [`sudo`] `brew services` `restart` `formula|--all`
Stop (if necessary) and start the service immediately and register it to launch at login (or `boot`). Stop (if necessary) and start the service immediately and register it to launch at login (or `boot`).
[`sudo`] `brew services` `cleanup` [`sudo`] `brew services` `cleanup`
Remove all unused services. Remove all unused services.
If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot). If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot).
@ -1125,13 +1126,13 @@ Note that environment variables must have a value set to be detected. For exampl
*Default:* `~/Library/Caches/Homebrew`. *Default:* `~/Library/Caches/Homebrew`.
* `HOMEBREW_CC`: * `HOMEBREW_CC`:
If set, directs which compiler Homebrew will use to compile packages if it If set, instructs Homebrew to used the specified compiler to build a
builds them from source. If an installation command passes in a `--cc` package from source. In order to specify the Apple-provided clang,
flag, it will override the value set by `HOMEBREW_CC`. The only valid set `clang`. For the clang provided from the LLVM package, use
compilers are ones provided by Homebrew, or Apple's bundled clang. To use `llvm_clang`. For versions of gcc, use the names of the executables from
gcc for compilation, pass in the executable name, i.e. `gcc-4.9`, `gcc-8`. the packages that Homebrew provides, e.g. for gcc 4.9, `gcc-4.9`, or for
If you want to use Apple's provided clang, simply use `clang`. For gcc 8, `gcc-8`. Note that this variable can only be set to compilers that
Homebrew's clang from the LLVM package, use `llvm_clang`. are provided by Homebrew.
* `HOMEBREW_CURLRC`: * `HOMEBREW_CURLRC`:
If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables

6
manpages/brew.1
View File

@ -227,7 +227,7 @@ If \fB\-\-ignore\-dependencies\fR is passed, skip installing any dependencies of
If \fB\-\-only\-dependencies\fR is passed, install the dependencies with specified options but do not install the specified formula\. If \fB\-\-only\-dependencies\fR is passed, install the dependencies with specified options but do not install the specified formula\.
. .
.IP .IP
If \fB\-\-cc=\fR\fIcompiler\fR is passed, attempt to compile using \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-4\.2\fR for Apple\'s GCC 4\.2, or \fBgcc\-4\.9\fR for a Homebrew\-provided GCC 4\.9\. If \fB\-\-cc=\fR\fIcompiler\fR is passed, attempt to compile using \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-4\.2\fR for Apple\'s GCC 4\.2, or \fBgcc\-4\.9\fR for a Homebrew\-provided GCC 4\.9\. In order to use LLVM\'s clang, use \fBllvm_clang\fR\. To specify the Apple\-provided clang, use \fBclang\fR\. This parameter will only accept compilers that are provided by Homebrew\. Note that this will override the value set by the \fB$HOMEBREW_CC\fR environment variable\.
. .
.IP .IP
If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) is passed, compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\. If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) is passed, compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\.
@ -1069,6 +1069,10 @@ If set, instructs Homebrew to use the given directory as the download cache\.
\fIDefault:\fR \fB~/Library/Caches/Homebrew\fR\. \fIDefault:\fR \fB~/Library/Caches/Homebrew\fR\.
. .
.TP .TP
\fBHOMEBREW_CC\fR
If set, instructs Homebrew to used the specified compiler to build a package from source\. In order to specify the Apple\-provided clang, set \fBclang\fR\. For the clang provided from the LLVM package, use \fBllvm_clang\fR\. For versions of gcc, use the names of the executables from the packages that Homebrew provides, e\.g\. for gcc 4\.9, \fBgcc\-4\.9\fR, or for gcc 8, \fBgcc\-8\fR\. Note that this variable can only be set to compilers that are provided by Homebrew\.
.
.TP
\fBHOMEBREW_CURLRC\fR \fBHOMEBREW_CURLRC\fR
If set, Homebrew will not pass \fB\-q\fR when invoking \fBcurl\fR(1) (which disables the use of \fBcurlrc\fR)\. If set, Homebrew will not pass \fB\-q\fR when invoking \fBcurl\fR(1) (which disables the use of \fBcurlrc\fR)\.
. .