manpage: document '--dry-run' for 'prune' command

This commit is contained in:
Martin Afanasjew 2016-01-06 08:14:27 +01:00
parent 8161595015
commit 53e1ba3274
3 changed files with 13 additions and 4 deletions

View File

@ -343,10 +343,13 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
Pin the specified <formulae>, preventing them from being upgraded when Pin the specified <formulae>, preventing them from being upgraded when
issuing the `brew upgrade` command. See also `unpin`. issuing the `brew upgrade` command. See also `unpin`.
* `prune`: * `prune` [`--dry-run`]:
Remove dead symlinks from the Homebrew prefix. This is generally not Remove dead symlinks from the Homebrew prefix. This is generally not
needed, but can be useful when doing DIY installations. needed, but can be useful when doing DIY installations.
If `--dry-run` or `-n` is passed, show what would be removed, but do not
actually remove anything.
* `reinstall` <formula>: * `reinstall` <formula>:
Uninstall then install <formula> Uninstall then install <formula>

View File

@ -271,8 +271,11 @@ precedence over <code>--verbose</code>).</p>
valid version is <code>v1</code>.</p></dd> valid version is <code>v1</code>.</p></dd>
<dt><code>pin</code> <var>formulae</var></dt><dd><p>Pin the specified <var>formulae</var>, preventing them from being upgraded when <dt><code>pin</code> <var>formulae</var></dt><dd><p>Pin the specified <var>formulae</var>, preventing them from being upgraded when
issuing the <code>brew upgrade</code> command. See also <code>unpin</code>.</p></dd> issuing the <code>brew upgrade</code> command. See also <code>unpin</code>.</p></dd>
<dt class="flush"><code>prune</code></dt><dd><p>Remove dead symlinks from the Homebrew prefix. This is generally not <dt><code>prune</code> [<code>--dry-run</code>]</dt><dd><p>Remove dead symlinks from the Homebrew prefix. This is generally not
needed, but can be useful when doing DIY installations.</p></dd> needed, but can be useful when doing DIY installations.</p>
<p>If <code>--dry-run</code> or <code>-n</code> is passed, show what would be removed, but do not
actually remove anything.</p></dd>
<dt><code>reinstall</code> <var>formula</var></dt><dd><p>Uninstall then install <var>formula</var></p></dd> <dt><code>reinstall</code> <var>formula</var></dt><dd><p>Uninstall then install <var>formula</var></p></dd>
<dt><code>rm</code>, <code>remove</code>, <code>uninstall</code> [<code>--force</code>] <var>formula</var></dt><dd><p>Uninstall <var>formula</var>.</p> <dt><code>rm</code>, <code>remove</code>, <code>uninstall</code> [<code>--force</code>] <var>formula</var></dt><dd><p>Uninstall <var>formula</var>.</p>

View File

@ -367,9 +367,12 @@ If \fB\-\-json=\fR\fIversion\fR is passed, the output will be in JSON format\. T
Pin the specified \fIformulae\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR command\. See also \fBunpin\fR\. Pin the specified \fIformulae\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR command\. See also \fBunpin\fR\.
. .
.TP .TP
\fBprune\fR \fBprune\fR [\fB\-\-dry\-run\fR]
Remove dead symlinks from the Homebrew prefix\. This is generally not needed, but can be useful when doing DIY installations\. Remove dead symlinks from the Homebrew prefix\. This is generally not needed, but can be useful when doing DIY installations\.
. .
.IP
If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, show what would be removed, but do not actually remove anything\.
.
.TP .TP
\fBreinstall\fR \fIformula\fR \fBreinstall\fR \fIformula\fR
Uninstall then install \fIformula\fR Uninstall then install \fIformula\fR