manpages: update command usage strings
This commit is contained in:
parent
6340792f78
commit
ee314617f7
@ -8,7 +8,7 @@ module Homebrew
|
|||||||
def __repository_args
|
def __repository_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`--repository` [<user>`/`<repo>]
|
`--repository`, `--repo` [<user>`/`<repo>]
|
||||||
|
|
||||||
Display where Homebrew's `.git` directory is located.
|
Display where Homebrew's `.git` directory is located.
|
||||||
|
|
||||||
|
|||||||
@ -8,7 +8,7 @@ module Homebrew
|
|||||||
def analytics_args
|
def analytics_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`analytics` [`on`|`off`|`state`|`regenerate-uuid`]
|
`analytics` [<subcommand>]
|
||||||
|
|
||||||
If `on` or `off` is passed, turn Homebrew's analytics on or off respectively.
|
If `on` or `off` is passed, turn Homebrew's analytics on or off respectively.
|
||||||
|
|
||||||
|
|||||||
@ -10,7 +10,7 @@ module Homebrew
|
|||||||
def deps_args
|
def deps_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`deps` [<options>] <formula>
|
`deps` [<options>] [<formula>]
|
||||||
|
|
||||||
Show dependencies for <formula>. Additional options specific to <formula>
|
Show dependencies for <formula>. Additional options specific to <formula>
|
||||||
may be appended to the command. When given multiple formula arguments,
|
may be appended to the command. When given multiple formula arguments,
|
||||||
|
|||||||
@ -10,7 +10,7 @@ module Homebrew
|
|||||||
def link_args
|
def link_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`ln`, `link` [<options>] <formula>
|
`link`, `ln` [<options>] <formula>
|
||||||
|
|
||||||
Symlink all of <formula>'s installed files into the Homebrew prefix. This
|
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
|
is done automatically when you install formulae but can be useful for DIY
|
||||||
|
|||||||
@ -10,7 +10,7 @@ module Homebrew
|
|||||||
def list_args
|
def list_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`list`, `ls` [<options>]
|
`list`, `ls` [<options>] [<formula>]
|
||||||
|
|
||||||
List all installed formulae.
|
List all installed formulae.
|
||||||
EOS
|
EOS
|
||||||
|
|||||||
@ -9,7 +9,7 @@ module Homebrew
|
|||||||
def log_args
|
def log_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`log` [<options>] <formula>
|
`log` [<options>] [<formula>]
|
||||||
|
|
||||||
Show the `git log` for the given <formula>.
|
Show the `git log` for the given <formula>.
|
||||||
EOS
|
EOS
|
||||||
|
|||||||
@ -11,7 +11,7 @@ module Homebrew
|
|||||||
def missing_args
|
def missing_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`missing` [<options>] [<formulae>]
|
`missing` [<options>] [<formula>]
|
||||||
|
|
||||||
Check the given <formula> for missing dependencies. If no <formula> are
|
Check the given <formula> for missing dependencies. If no <formula> are
|
||||||
given, check all installed brews.
|
given, check all installed brews.
|
||||||
|
|||||||
@ -10,7 +10,7 @@ module Homebrew
|
|||||||
def options_args
|
def options_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`options` [<options>] <formula>
|
`options` [<options>] [<formula>]
|
||||||
|
|
||||||
Display install options specific to <formula>.
|
Display install options specific to <formula>.
|
||||||
EOS
|
EOS
|
||||||
|
|||||||
@ -21,7 +21,7 @@ module Homebrew
|
|||||||
def update_report_args
|
def update_report_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`update_report` [`--preinstall`]
|
`update-report`
|
||||||
|
|
||||||
The Ruby implementation of `brew update`. Never called manually.
|
The Ruby implementation of `brew update`. Never called manually.
|
||||||
EOS
|
EOS
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
#: * `update` [<options>]
|
#: * `update`, `up` [<options>]
|
||||||
#:
|
#:
|
||||||
#: Fetch the newest version of Homebrew and all formulae from GitHub using `git`(1) and perform any necessary migrations.
|
#: Fetch the newest version of Homebrew and all formulae from GitHub using `git`(1) and perform any necessary migrations.
|
||||||
#:
|
#:
|
||||||
|
|||||||
@ -14,7 +14,7 @@ module Homebrew
|
|||||||
def upgrade_args
|
def upgrade_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`upgrade` [<options>] <formula>
|
`upgrade` [<options>] [<formula>]
|
||||||
|
|
||||||
Upgrade outdated, unpinned formulae (with existing and any appended brew formula options).
|
Upgrade outdated, unpinned formulae (with existing and any appended brew formula options).
|
||||||
|
|
||||||
|
|||||||
@ -18,7 +18,7 @@ module Homebrew
|
|||||||
def audit_args
|
def audit_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`audit` [<options>] <formula>
|
`audit` [<options>] [<formula>]
|
||||||
|
|
||||||
Check <formula> for Homebrew coding style violations. This should be run before
|
Check <formula> for Homebrew coding style violations. This should be run before
|
||||||
submitting a new formula. Will exit with a non-zero status if any errors are
|
submitting a new formula. Will exit with a non-zero status if any errors are
|
||||||
|
|||||||
@ -9,7 +9,7 @@ module Homebrew
|
|||||||
def bump_revision_args
|
def bump_revision_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`bump-revision` [<options>] [<formula>]
|
`bump-revision` [<options>] <formula>
|
||||||
|
|
||||||
Create a commit to increment the revision of <formula>. If no revision is
|
Create a commit to increment the revision of <formula>. If no revision is
|
||||||
present, "revision 1" will be added.
|
present, "revision 1" will be added.
|
||||||
|
|||||||
@ -8,7 +8,7 @@ module Homebrew
|
|||||||
def ruby_args
|
def ruby_args
|
||||||
Homebrew::CLI::Parser.new do
|
Homebrew::CLI::Parser.new do
|
||||||
usage_banner <<~EOS
|
usage_banner <<~EOS
|
||||||
`ruby` [`-e`]
|
`ruby` (`-e` <text>|<file>)
|
||||||
|
|
||||||
Run a Ruby instance with Homebrew's libraries loaded, e.g.
|
Run a Ruby instance with Homebrew's libraries loaded, e.g.
|
||||||
`brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`.
|
`brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user