manpage: improve synopsis for 'options' command

The options `--all`, `--installed`, and a list of formulae are mutually
exclusive arguments, of which exactly one is required.
This commit is contained in:
Martin Afanasjew 2016-01-06 07:45:38 +01:00
parent ae31b48510
commit aaefcb02b6
3 changed files with 6 additions and 6 deletions

View File

@ -315,8 +315,8 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
If `--force` is passed, then treat installed <formulae> and passed <formulae> If `--force` is passed, then treat installed <formulae> and passed <formulae>
like if they are from same taps and migrate them anyway. like if they are from same taps and migrate them anyway.
* `options` [`--compact`] [`--all`] [`--installed`] <formula>: * `options` [`--compact`] (`--all`|`--installed`|<formulae>):
Display install options specific to <formula>. Display install options specific to <formulae>.
If `--compact` is passed, show all options on a single line separated by If `--compact` is passed, show all options on a single line separated by
spaces. spaces.

View File

@ -249,7 +249,7 @@ packages.</p>
<p>If <code>--force</code> is passed, then treat installed <var>formulae</var> and passed <var>formulae</var> <p>If <code>--force</code> is passed, then treat installed <var>formulae</var> and passed <var>formulae</var>
like if they are from same taps and migrate them anyway.</p></dd> like if they are from same taps and migrate them anyway.</p></dd>
<dt><code>options</code> [<code>--compact</code>] [<code>--all</code>] [<code>--installed</code>] <var>formula</var></dt><dd><p>Display install options specific to <var>formula</var>.</p> <dt><code>options</code> [<code>--compact</code>] (<code>--all</code>|<code>--installed</code>|<var>formulae</var>)</dt><dd><p>Display install options specific to <var>formulae</var>.</p>
<p>If <code>--compact</code> is passed, show all options on a single line separated by <p>If <code>--compact</code> is passed, show all options on a single line separated by
spaces.</p> spaces.</p>

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" "December 2015" "Homebrew" "brew" .TH "BREW" "1" "January 2016" "Homebrew" "brew"
. .
.SH "NAME" .SH "NAME"
\fBbrew\fR \- The missing package manager for OS X \fBbrew\fR \- The missing package manager for OS X
@ -334,8 +334,8 @@ Migrate renamed packages to new name, where \fIformulae\fR are old names of pack
If \fB\-\-force\fR is passed, then treat installed \fIformulae\fR and passed \fIformulae\fR like if they are from same taps and migrate them anyway\. If \fB\-\-force\fR is passed, then treat installed \fIformulae\fR and passed \fIformulae\fR like if they are from same taps and migrate them anyway\.
. .
.TP .TP
\fBoptions\fR [\fB\-\-compact\fR] [\fB\-\-all\fR] [\fB\-\-installed\fR] \fIformula\fR \fBoptions\fR [\fB\-\-compact\fR] (\fB\-\-all\fR|\fB\-\-installed\fR|\fIformulae\fR)
Display install options specific to \fIformula\fR\. Display install options specific to \fIformulae\fR\.
. .
.IP .IP
If \fB\-\-compact\fR is passed, show all options on a single line separated by spaces\. If \fB\-\-compact\fR is passed, show all options on a single line separated by spaces\.