diff options
| author |   Ingo Schwarze <schwarze@openbsd.org> | 2021-07-29 16:25:20 +0000 |
|---|---|---|
| committer | Ingo Schwarze <schwarze@openbsd.org> | 2021-07-29 16:25:20 +0000 |
| commit | 614c2bef60cc322303c8d8c5cf0f3dc48f217dbf (patch) | |
| tree | 8d4cd67f7d397bdca7ed2c305bdcccd651ad942f | |
| parent | 9da075194331263ad449da9c0e105b47903e17f5 (diff) | |
| download | mandoc-614c2bef60cc322303c8d8c5cf0f3dc48f217dbf.tar.gz mandoc-614c2bef60cc322303c8d8c5cf0f3dc48f217dbf.tar.zst mandoc-614c2bef60cc322303c8d8c5cf0f3dc48f217dbf.zip | |
Improve the description of .Fl in multiple respects and in paricular
improve the .Fl examples in multiple respects, including better
demonstrating long options.
Prompted by a question from espie@.
Feedback and OK jmc@.
| -rw-r--r-- | mdoc.7 | 32 |
1 files changed, 19 insertions, 13 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mdoc.7,v 1.285 2021/07/04 16:33:04 schwarze Exp $ +.\" $Id: mdoc.7,v 1.286 2021/07/29 16:25:20 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> .\" Copyright (c) 2010, 2011, 2013-2020 Ingo Schwarze <schwarze@openbsd.org> @@ -15,7 +15,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: July 4 2021 $ +.Dd $Mdocdate: July 29 2021 $ .Dt MDOC 7 .Os .Sh NAME @@ -1568,19 +1568,25 @@ and .It Ic \&Fl Op Ar word ... Command-line flag or option. Used when listing arguments to command-line utilities. -Prints a fixed-width hyphen -.Sq \- -directly followed by each argument. -If no arguments are provided, a hyphen is printed followed by a space. -If the argument is a macro, a hyphen is prefixed to the subsequent macro -output. +For each argument, prints an ASCII hyphen-minus character +.Sq \- , +immediately followed by the argument. +If no arguments are provided, a hyphen-minus is printed followed by a space. +If the argument is a macro, a hyphen-minus is prefixed +to the subsequent macro output. .Pp Examples: -.Dl ".Fl R Op Fl H | L | P" -.Dl ".Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux" -.Dl ".Fl type Cm d Fl name Pa CVS" -.Dl ".Fl Ar signal_number" -.Dl ".Fl o Fl" +.Dl ".Nm du Op Fl H | L | P" +.Dl ".Nm ls Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux" +.Dl ".Nm route Cm add Fl inet Ar destination gateway" +.Dl ".Nm locate.updatedb Op Fl \e-fcodes Ns = Ns Ar dbfile" +.Dl ".Nm aucat Fl o Fl" +.Dl ".Nm kill Fl Ar signal_number" +.Pp +For GNU-sytle long options, escaping the additional hyphen-minus is not +strictly required, but may be safer with future versions of GNU troff; see +.Xr mandoc_char 7 +for details. .Pp See also .Ic \&Cm . |