.Fl marks up options not arguments
authorkn <kn@openbsd.org>
Sun, 4 Jul 2021 15:58:51 +0000 (15:58 +0000)
committerkn <kn@openbsd.org>
Sun, 4 Jul 2021 15:58:51 +0000 (15:58 +0000)
POSIX says `-v' is an option, not an argument;  options may take arguments,
as documented in getopt(3).

Programs may take arguments as well, e.g. "prog -v -- arg ...", but these
are usually marked up with `.Cm'.

Change "The arguments are as follows:" to "The options are as follows:" in
`.Fl's DESCRIPTION example to match what most of our base manuals say.

OK schwarze jmc

share/man/man7/mdoc.7

index 8e123be..fcf8271 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: mdoc.7,v 1.176 2021/05/12 10:59:43 jmc Exp $
+.\"    $OpenBSD: mdoc.7,v 1.177 2021/07/04 15:58:51 kn 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: May 12 2021 $
+.Dd $Mdocdate: July 4 2021 $
 .Dt MDOC 7
 .Os
 .Sh NAME
@@ -297,7 +297,7 @@ utility does this, that, and the other.
 It usually follows with a breakdown of the options (if documenting a
 command), such as:
 .Bd -literal -offset indent
-The arguments are as follows:
+The options are as follows:
 \&.Bl \-tag \-width Ds
 \&.It Fl v
 Print verbose information.