Clarify meaning of `--defer' in the manual.

This commit is contained in:
Adam Spiers 2011-11-17 15:32:51 +00:00
parent cb86578b87
commit da7255528e

View file

@ -275,9 +275,17 @@ Note that the regular expression is anchored to the end of the filename,
because this is what you will want to do most of the time.
@item --defer='<regex>'
This (repeatable) option lets you defer stowing a file matching the given
regular expression, if that file is already stowed by another package. For
example, the following options
This (repeatable) option avoids stowing a file matching the given
regular expression, if that file is already stowed by another package.
This is effectively the opposite of @code{--override}.
(N.B. the name @code{--defer} was chosen in the sense that the package
currently being stowed is treated with lower precedence than any already
installed package, not in the sense that the operation is being
postponed to be run at a later point in time; do not confuse this
nomenclature with the wording used in @xref{Deferred Operation}.)
For example, the following options
@example
--defer='man' --defer='info'