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

info: update help text

Browse Source
This commit is contained in:
EricFromCanada 2019-03-11 12:59:39 -04:00
parent 705f03ef9f
commit be040f9c66
3 changed files with 39 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Library/Homebrew/cmd/info.rb
View File

@ -13,37 +13,42 @@ module Homebrew
def info_args def info_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`info` [<formula>] `info` [<options>] [<formula>]
Display brief statistics for your Homebrew installation. Display brief statistics for your Homebrew installation.
If <formula> is specified, show summary of information about <formula>.
EOS EOS
switch "--analytics", switch "--analytics",
description: "Display Homebrew analytics data (provided neither `HOMEBREW_NO_ANALYTICS` "\ description: "Display global Homebrew analytics data or, if specified, installation and "\
"or `HOMEBREW_NO_GITHUB_API` are set)." "build error data for <formula> (provided neither `HOMEBREW_NO_ANALYTICS` "\
"nor `HOMEBREW_NO_GITHUB_API` are set)."
flag "--days", flag "--days",
depends_on: "--analytics", depends_on: "--analytics",
description: "The value for `days` must be `30`, `90` or `365`. The default is `30`." description: "How many days of global analytics data to retrieve. "\
"The value for <days> must be `30`, `90` or `365`. The default is `30`."
flag "--category", flag "--category",
depends_on: "--analytics", depends_on: "--analytics",
description: "The value for `category` must be `install`, `install-on-request`, "\ description: "Which type of global analytics data to retrieve. "\
"The value for <category> must be `install`, `install-on-request`, "\
"`cask-install`, `build-error` or `os-version`. The default is `install`." "`cask-install`, `build-error` or `os-version`. The default is `install`."
switch "--github", switch "--github",
description: "Open a browser to the GitHub History page for provided <formula>. "\ description: "Open a browser to the GitHub source page for <formula>. "\
"To view formula history locally: `brew log -p` <formula>" "To view formula history locally: `brew log -p` <formula>"
flag "--json", flag "--json",
description: "Print a JSON representation of <formula>. Currently the default and only accepted "\ description: "Print a JSON representation of <formula>. Currently the default and only accepted "\
"value for <version> is `v1`. See the docs for examples of using the JSON "\ "value for <version> is `v1`. See the docs for examples of using the JSON "\
"output: <https://docs.brew.sh/Querying-Brew>" "output: <https://docs.brew.sh/Querying-Brew>"
switch "--all",
depends_on: "--json",
description: "Get information on all formulae."
switch "--installed", switch "--installed",
depends_on: "--json", depends_on: "--json",
description: "Get information on all installed formulae." description: "Print JSON of formulae that are currently installed."
switch "--all",
depends_on: "--json",
description: "Print JSON of all available formulae."
switch :verbose, switch :verbose,
description: "See more verbose analytics data." description: "Show more verbose analytics data for <formula>."
switch :debug switch :debug
conflicts "--all", "--installed" conflicts "--installed", "--all"
end end
end end

18
docs/Manpage.md
View File

@ -194,24 +194,26 @@ If no logs are found, an error message is presented.
Open *`formula`*'s homepage in a browser. If no formula is provided, open Open *`formula`*'s homepage in a browser. If no formula is provided, open
Homebrew's own homepage in a browser. Homebrew's own homepage in a browser.
### `info` [*`formula`*] ### `info` [*`options`*] [*`formula`*]
Display brief statistics for your Homebrew installation. Display brief statistics for your Homebrew installation.
If *`formula`* is specified, show summary of information about *`formula`*.
* `--analytics`: * `--analytics`:
Display Homebrew analytics data (provided neither `HOMEBREW_NO_ANALYTICS` or `HOMEBREW_NO_GITHUB_API` are set). Display global Homebrew analytics data or, if specified, installation and build error data for *`formula`* (provided neither `HOMEBREW_NO_ANALYTICS` nor `HOMEBREW_NO_GITHUB_API` are set).
* `--days`: * `--days`:
The value for `days` must be `30`, `90` or `365`. The default is `30`. How many days of global analytics data to retrieve. The value for *`days`* must be `30`, `90` or `365`. The default is `30`.
* `--category`: * `--category`:
The value for `category` must be `install`, `install-on-request`, `cask-install`, `build-error` or `os-version`. The default is `install`. Which type of global analytics data to retrieve. The value for *`category`* must be `install`, `install-on-request`, `cask-install`, `build-error` or `os-version`. The default is `install`.
* `--github`: * `--github`:
Open a browser to the GitHub History page for provided *`formula`*. To view formula history locally: `brew log -p` *`formula`* Open a browser to the GitHub source page for *`formula`*. To view formula history locally: `brew log -p` *`formula`*
* `--json`: * `--json`:
Print a JSON representation of *`formula`*. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew> Print a JSON representation of *`formula`*. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew>
* `--all`:
Get information on all formulae.
* `--installed`: * `--installed`:
Get information on all installed formulae. Print JSON of formulae that are currently installed.
* `--all`:
Print JSON of all available formulae.
### `install` [*`options`*] *`formula`* ### `install` [*`options`*] *`formula`*

21
manpages/brew.1
View File

@ -230,36 +230,39 @@ The Gist will be marked private and will not appear in listings but will be acce
.SS "\fBhome\fR [\fIformula\fR]" .SS "\fBhome\fR [\fIformula\fR]"
Open \fIformula\fR\'s homepage in a browser\. If no formula is provided, open Homebrew\'s own homepage in a browser\. Open \fIformula\fR\'s homepage in a browser\. If no formula is provided, open Homebrew\'s own homepage in a browser\.
. .
.SS "\fBinfo\fR [\fIformula\fR]" .SS "\fBinfo\fR [\fIoptions\fR] [\fIformula\fR]"
Display brief statistics for your Homebrew installation\. Display brief statistics for your Homebrew installation\.
. .
.P
If \fIformula\fR is specified, show summary of information about \fIformula\fR\.
.
.TP .TP
\fB\-\-analytics\fR \fB\-\-analytics\fR
Display Homebrew analytics data (provided neither \fBHOMEBREW_NO_ANALYTICS\fR or \fBHOMEBREW_NO_GITHUB_API\fR are set)\. Display global Homebrew analytics data or, if specified, installation and build error data for \fIformula\fR (provided neither \fBHOMEBREW_NO_ANALYTICS\fR nor \fBHOMEBREW_NO_GITHUB_API\fR are set)\.
. .
.TP .TP
\fB\-\-days\fR \fB\-\-days\fR
The value for \fBdays\fR must be \fB30\fR, \fB90\fR or \fB365\fR\. The default is \fB30\fR\. How many days of global analytics data to retrieve\. The value for \fIdays\fR must be \fB30\fR, \fB90\fR or \fB365\fR\. The default is \fB30\fR\.
. .
.TP .TP
\fB\-\-category\fR \fB\-\-category\fR
The value for \fBcategory\fR must be \fBinstall\fR, \fBinstall\-on\-request\fR, \fBcask\-install\fR, \fBbuild\-error\fR or \fBos\-version\fR\. The default is \fBinstall\fR\. Which type of global analytics data to retrieve\. The value for \fIcategory\fR must be \fBinstall\fR, \fBinstall\-on\-request\fR, \fBcask\-install\fR, \fBbuild\-error\fR or \fBos\-version\fR\. The default is \fBinstall\fR\.
. .
.TP .TP
\fB\-\-github\fR \fB\-\-github\fR
Open a browser to the GitHub History page for provided \fIformula\fR\. To view formula history locally: \fBbrew log \-p\fR \fIformula\fR Open a browser to the GitHub source page for \fIformula\fR\. To view formula history locally: \fBbrew log \-p\fR \fIformula\fR
. .
.TP .TP
\fB\-\-json\fR \fB\-\-json\fR
Print a JSON representation of \fIformula\fR\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR Print a JSON representation of \fIformula\fR\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
. .
.TP .TP
\fB\-\-all\fR \fB\-\-installed\fR
Get information on all formulae\. Print JSON of formulae that are currently installed\.
. .
.TP .TP
\fB\-\-installed\fR \fB\-\-all\fR
Get information on all installed formulae\. Print JSON of all available formulae\.
. .
.SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR" .SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR"
Install \fIformula\fR\. Install \fIformula\fR\.