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

man: Make command heading H3

Browse Source
This commit is contained in:
Gautham Goli 2018-10-01 10:54:49 +05:30
parent 4f58f2db99
commit e0e876cf37
No known key found for this signature in database
GPG Key ID: 6A9ABBC284468364
20 changed files with 62 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Library/Homebrew/dev-cmd/audit.rb
View File

@ -55,11 +55,10 @@ module Homebrew
def audit_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`audit` [<options>] [<formulae>]:
### audit [options] [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.
EOS
switch "--strict",

3
Library/Homebrew/dev-cmd/bottle.rb
View File

@ -72,11 +72,10 @@ module Homebrew
def bottle_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bottle` [<options>] [<formulae>]:
### bottle [options] [formulae]:
Generate a bottle (binary package) from a formula installed with
`--build-bottle`.
If the formula specifies a rebuild version, it will be incremented in the
generated DSL. Passing `--keep-old` will attempt to keep it at its
original value, while `--no-rebuild` will remove it.

2
Library/Homebrew/dev-cmd/bump-formula-pr.rb
View File

@ -50,7 +50,7 @@ module Homebrew
def bump_formula_pr_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bump-formula-pr` [<options>] <formula>:
### bump-formula-pr [options] [formula]:
Creates a pull request to update the formula with a new URL or a new tag.

2
Library/Homebrew/dev-cmd/create.rb
View File

@ -30,7 +30,7 @@ module Homebrew
def create_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`create` <URL> [<options>]:
### create URL [options]:
Generate a formula for the downloadable file at <URL> and open it in the editor.
Homebrew will attempt to automatically derive the formula name

4
Library/Homebrew/dev-cmd/edit.rb
View File

@ -13,10 +13,10 @@ module Homebrew
def edit_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
* `edit`:
### edit:
Open all of Homebrew for editing.
* `edit` <formula>:
### edit [formula]:
Open <formula> in the editor.
EOS
switch :force

2
Library/Homebrew/dev-cmd/formula.rb
View File

@ -10,7 +10,7 @@ module Homebrew
def formula_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`formula` <formula>:
### formula [formula]:
Display the path where <formula> is located.
EOS

2
Library/Homebrew/dev-cmd/irb.rb
View File

@ -25,7 +25,7 @@ module Homebrew
def irb_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`irb` [<options>]:
### irb [options]:
Enter the interactive Homebrew Ruby shell.
EOS

2
Library/Homebrew/dev-cmd/linkage.rb
View File

@ -22,7 +22,7 @@ module Homebrew
def linkage_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`linkage` [<options>] <formula>:
### linkage [options] [formula]:
Checks the library links of an installed formula.

2
Library/Homebrew/dev-cmd/man.rb
View File

@ -36,7 +36,7 @@ module Homebrew
def man_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`man` [<options>]:
### man [options]:
Generate Homebrew's manpages.
EOS

2
Library/Homebrew/dev-cmd/mirror.rb
View File

@ -10,7 +10,7 @@ module Homebrew
def mirror_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`mirror` [<formulae>]:
### mirror [formulae]:
Reuploads the stable URL for a formula to Bintray to use it as a mirror.
EOS

2
Library/Homebrew/dev-cmd/prof.rb
View File

@ -1,4 +1,4 @@
#: * `prof` [<ruby options>]:
#: ### prof [ruby options]:
#: Run Homebrew with the Ruby profiler.
#: For example:
# brew prof readall

2
Library/Homebrew/dev-cmd/pull.rb
View File

@ -75,7 +75,7 @@ module Homebrew
def pull_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bump-formula-pr` [<options>] <formula>:
### pull [options] [formula]:
Gets a patch from a GitHub commit or pull request and applies it to Homebrew.
Optionally, installs the formulae changed by the patch.

2
Library/Homebrew/dev-cmd/release-notes.rb
View File

@ -13,7 +13,7 @@ module Homebrew
def release_notes_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`release-notes` [<previous_tag>] [<end_ref>]:
### release-notes [previous_tag] [end_ref]:
Output the merged pull requests on Homebrew/brew between two Git refs.
If no <previous_tag> is provided it defaults to the latest tag.

2
Library/Homebrew/dev-cmd/tap-new.rb
View File

@ -18,7 +18,7 @@ module Homebrew
def tap_new_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`tap-new` <user>`/`<repo>:
### tap-new [user]/[repo]:
Generate the template files for a new tap.
EOS

2
Library/Homebrew/dev-cmd/test.rb
View File

@ -1,4 +1,4 @@
#: * `test` [`--devel`|`--HEAD`] [`--debug`] [`--keep-tmp`] <formula>:
#: ### test [--devel|--HEAD] [--debug] [--keep-tmp] [formula]:
#: Most 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

2
Library/Homebrew/dev-cmd/tests.rb
View File

@ -24,7 +24,7 @@ module Homebrew
def tests_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`tests` [<options>] <formula>:
### tests [options] [formula]:
Run Homebrew's unit and integration tests. If provided,
`--only=`<test_script> runs only <test_script>_spec.rb, and `--seed`

2
Library/Homebrew/dev-cmd/update-test.rb
View File

@ -22,7 +22,7 @@ module Homebrew
def update_test_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`update-test` [<options>]:
### update-test [options]:
Runs a test of `brew update` with a new repository clone.

38
docs/Manpage.md
View File

@ -663,11 +663,10 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
## DEVELOPER COMMANDS
`audit` [`options`] [`formulae`]:
### audit [options] [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.
* `--strict`:
@ -697,11 +696,10 @@ Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
`bottle` [`options`] [`formulae`]:
### bottle [options] [formulae]:
Generate a bottle (binary package) from a formula installed with
`--build-bottle`.
If the formula specifies a rebuild version, it will be incremented in the
generated DSL. Passing `--keep-old` will attempt to keep it at its
original value, while `--no-rebuild` will remove it.
@ -731,7 +729,7 @@ Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
`bump-formula-pr` [`options`] `formula`:
### bump-formula-pr [options] [formula]:
Creates a pull request to update the formula with a new URL or a new tag.
@ -782,7 +780,7 @@ Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
`create` `URL` [`options`]:
### create URL [options]:
Generate a formula for the downloadable file at `URL` and open it in the editor.
Homebrew will attempt to automatically derive the formula name
@ -813,10 +811,10 @@ Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
* `edit`:
### edit:
Open all of Homebrew for editing.
* `edit` `formula`:
### edit [formula]:
Open `formula` in the editor.
* `-f`, `--force`:
@ -826,7 +824,7 @@ Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
`formula` `formula`:
### formula [formula]:
Display the path where `formula` is located.
@ -835,7 +833,7 @@ Display any debugging information.
* `-v`, `--verbose`:
Make some output more verbose.
`irb` [`options`]:
### irb [options]:
Enter the interactive Homebrew Ruby shell.
@ -844,7 +842,7 @@ Show several examples.
* `--pry`:
Pry will be used instead of irb if `--pry` is passed or HOMEBREW_PRY is set.
`linkage` [`options`] `formula`:
### linkage [options] [formula]:
Checks the library links of an installed formula.
@ -862,7 +860,7 @@ Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
`man` [`options`]:
### man [options]:
Generate Homebrew's manpages.
@ -871,7 +869,7 @@ Return a failing status code if changes are detected in the manpage outputs. Thi
* `--link`:
It is now done automatically by `brew update`.
`mirror` [`formulae`]:
### mirror [formulae]:
Reuploads the stable URL for a formula to Bintray to use it as a mirror.
@ -880,11 +878,11 @@ Display any debugging information.
* `-v`, `--verbose`:
Make some output more verbose.
* `prof` [`ruby options`]:
### prof [ruby options]:
Run Homebrew with the Ruby profiler.
For example:
`bump-formula-pr` [`options`] `formula`:
### pull [options] [formula]:
Gets a patch from a GitHub commit or pull request and applies it to Homebrew.
Optionally, installs the formulae changed by the patch.
@ -929,7 +927,7 @@ Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
`release-notes` [`previous_tag`] [`end_ref`]:
### release-notes [previous_tag] [end_ref]:
Output the merged pull requests on Homebrew/brew between two Git refs.
If no `previous_tag` is provided it defaults to the latest tag.
@ -942,7 +940,7 @@ Output as a Markdown list.
Run a Ruby instance with Homebrew's libraries loaded.
For example:
`tap-new` `user``/``repo`:
### tap-new [user]/[repo]:
Generate the template files for a new tap.
@ -951,7 +949,7 @@ Display any debugging information.
* `-v`, `--verbose`:
Make some output more verbose.
* `test` [`--devel`|`--HEAD`] [`--debug`] [`--keep-tmp`] `formula`:
### test [--devel|--HEAD] [--debug] [--keep-tmp] [formula]:
Most 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
@ -968,7 +966,7 @@ Make some output more verbose.
Example: `brew install jruby && brew test jruby`
`tests` [`options`] `formula`:
### tests [options] [formula]:
Run Homebrew's unit and integration tests. If provided,
`--only=``test_script` runs only `test_script`_spec.rb, and `--seed`
@ -991,7 +989,7 @@ Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
`update-test` [`options`]:
### update-test [options]:
Runs a test of `brew update` with a new repository clone.

2
manpages/brew-cask.1
View File

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

98
manpages/brew.1
View File

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "BREW" "1" "September 2018" "Homebrew" "brew"
.TH "BREW" "1" "October 2018" "Homebrew" "brew"
.
.SH "NAME"
\fBbrew\fR \- The missing package manager for macOS
@ -620,13 +620,9 @@ If \fB\-\-merge\fR is specified then \fBgit merge\fR is used to include updates
If \fB\-\-force\fR (or \fB\-f\fR) is specified then always do a slower, full update check even if unnecessary\.
.
.SH "DEVELOPER COMMANDS"
\fBaudit\fR [\fIoptions\fR] [\fIformulae\fR]:
.
.P
Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\.
.
.P
If no \fIformulae\fR are provided, all of them are checked\.
.SS "audit [options] [formulae]:"
Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. If no \fIformulae\fR are provided, all of them are checked\.
.
.TP
\fB\-\-strict\fR
@ -680,14 +676,8 @@ Make some output more verbose\.
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBbottle\fR [\fIoptions\fR] [\fIformulae\fR]:
.
.P
Generate a bottle (binary package) from a formula installed with \fB\-\-build\-bottle\fR\.
.
.P
If the formula specifies a rebuild version, it will be incremented in the generated DSL\. Passing \fB\-\-keep\-old\fR will attempt to keep it at its original value, while \fB\-\-no\-rebuild\fR will remove it\.
.SS "bottle [options] [formulae]:"
Generate a bottle (binary package) from a formula installed with \fB\-\-build\-bottle\fR\. If the formula specifies a rebuild version, it will be incremented in the generated DSL\. Passing \fB\-\-keep\-old\fR will attempt to keep it at its original value, while \fB\-\-no\-rebuild\fR will remove it\.
.
.TP
\fB\-\-skip\-relocation\fR
@ -737,10 +727,7 @@ Make some output more verbose\.
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBbump\-formula\-pr\fR [\fIoptions\fR] \fIformula\fR:
.
.P
.SS "bump\-formula\-pr [options] [formula]:"
Creates a pull request to update the formula with a new URL or a new tag\.
.
.P
@ -823,10 +810,7 @@ Make some output more verbose\.
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBcreate\fR \fIURL\fR [\fIoptions\fR]:
.
.P
.SS "create URL [options]:"
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 \fIhttp://www\.rubydoc\.info/github/Homebrew/brew/master/Formula\fR\.
.
.TP
@ -873,12 +857,10 @@ Make some output more verbose\.
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.TP
\fBedit\fR
.SS "edit:"
Open all of Homebrew for editing\.
.
.TP
\fBedit\fR \fIformula\fR
.SS "edit [formula]:"
Open \fIformula\fR in the editor\.
.
.TP
@ -893,10 +875,7 @@ Make some output more verbose\.
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBformula\fR \fIformula\fR:
.
.P
.SS "formula [formula]:"
Display the path where \fIformula\fR is located\.
.
.TP
@ -907,10 +886,7 @@ Display any debugging information\.
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.P
\fBirb\fR [\fIoptions\fR]:
.
.P
.SS "irb [options]:"
Enter the interactive Homebrew Ruby shell\.
.
.TP
@ -921,10 +897,7 @@ Show several examples\.
\fB\-\-pry\fR
Pry will be used instead of irb if \fB\-\-pry\fR is passed or HOMEBREW_PRY is set\.
.
.P
\fBlinkage\fR [\fIoptions\fR] \fIformula\fR:
.
.P
.SS "linkage [options] [formula]:"
Checks the library links of an installed formula\.
.
.P
@ -950,10 +923,7 @@ Make some output more verbose\.
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBman\fR [\fIoptions\fR]:
.
.P
.SS "man [options]:"
Generate Homebrew\'s manpages\.
.
.TP
@ -964,10 +934,7 @@ Return a failing status code if changes are detected in the manpage outputs\. Th
\fB\-\-link\fR
It is now done automatically by \fBbrew update\fR\.
.
.P
\fBmirror\fR [\fIformulae\fR]:
.
.P
.SS "mirror [formulae]:"
Reuploads the stable URL for a formula to Bintray to use it as a mirror\.
.
.TP
@ -978,15 +945,12 @@ Display any debugging information\.
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fBprof\fR [\fIruby options\fR]
.SS "prof [ruby options]:"
.
.IP
Run Homebrew with the Ruby profiler\. For example:
.
.P
\fBbump\-formula\-pr\fR [\fIoptions\fR] \fIformula\fR:
.
.P
.SS "pull [options] [formula]:"
Gets a patch from a GitHub commit or pull request and applies it to Homebrew\. Optionally, installs the formulae changed by the patch\.
.
.P
@ -1056,10 +1020,7 @@ Make some output more verbose\.
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBrelease\-notes\fR [\fIprevious_tag\fR] [\fIend_ref\fR]:
.
.P
.SS "release\-notes [previous_tag] [end_ref]:"
Output the merged pull requests on Homebrew/brew between two Git refs\. If no \fIprevious_tag\fR is provided it defaults to the latest tag\. If no \fIend_ref\fR is provided it defaults to \fBorigin/master\fR\.
.
.TP
@ -1070,10 +1031,7 @@ Output as a Markdown list\.
\fBruby\fR [\fIruby options\fR]
Run a Ruby instance with Homebrew\'s libraries loaded\. For example:
.
.P
\fBtap\-new\fR \fIuser\fR\fB/\fR\fIrepo\fR:
.
.P
.SS "tap\-new [user]/[repo]:"
Generate the template files for a new tap\.
.
.TP
@ -1084,8 +1042,9 @@ Display any debugging information\.
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fBtest\fR [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-debug\fR] [\fB\-\-keep\-tmp\fR] \fIformula\fR
.SS "test [\-\-devel|\-\-HEAD] [\-\-debug] [\-\-keep\-tmp] [formula]:"
.
.IP
Most 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
@ -1099,12 +1058,8 @@ If \fB\-\-keep\-tmp\fR is passed, the temporary files created for the test are n
.
.IP
Example: \fBbrew install jruby && brew test jruby\fR
.
.P
\fBtests\fR [\fIoptions\fR] \fIformula\fR:
.
.P
.SS "tests [options] [formula]:"
Run Homebrew\'s unit and integration tests\. If provided, \fB\-\-only=\fR\fItest_script\fR runs only \fItest_script\fR_spec\.rb, and \fB\-\-seed\fR randomizes tests with the provided value instead of a random seed\.
.
.TP
@ -1139,10 +1094,7 @@ Make some output more verbose\.
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBupdate\-test\fR [\fIoptions\fR]:
.
.P
.SS "update\-test [options]:"
Runs a test of \fBbrew update\fR with a new repository clone\.
.
.P