summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2019-04-24 13:15:00 +0000
committerIngo Schwarze <schwarze@openbsd.org>2019-04-24 13:15:00 +0000
commit120e720433c04ebfe7b465c35c0d9b0f95b3d0f8 (patch)
tree52d7f14a53ddbc78e4d050efa95c3a05b1978f68
parent2e3ccbef889c7e0f9623f5ea3afa86bb61d7ab4a (diff)
downloadmandoc-120e720433c04ebfe7b465c35c0d9b0f95b3d0f8.tar.gz
clarify the difference between .Cm and .Ic;
triggered by a question from Fabio Scotoni
-rw-r--r--mdoc.718
1 files changed, 10 insertions, 8 deletions
diff --git a/mdoc.7 b/mdoc.7
index f1422b11..611c603c 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1163,17 +1163,19 @@ declarations.
This practise is discouraged.
.It Ic \&Cm Ar keyword ...
Command modifiers.
-Typically used for fixed strings passed as arguments, unless
+Typically used for fixed strings passed as arguments to interactive
+commands, to commands in interpreted scripts, or to configuration
+file directives, unless
.Ic \&Fl
is more appropriate.
-Also useful when specifying configuration options or keys.
.Pp
Examples:
.Dl ".Nm mt Fl f Ar device Cm rewind"
.Dl ".Nm ps Fl o Cm pid , Ns Cm command"
.Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2"
-.Dl ".Cm IdentityFile Pa ~/.ssh/id_rsa"
-.Dl ".Cm LogLevel Dv DEBUG"
+.Dl ".Ic set Fl o Cm vi"
+.Dl ".Ic lookup Cm file bind"
+.Dl ".Ic permit Ar identity Op Cm as Ar target"
.It Ic \&D1 Ar line
One-line indented display.
This is formatted by the default rules and is useful for simple indented
@@ -1684,10 +1686,10 @@ This macro is not implemented in
.Xr mandoc 1 .
It was used to include the contents of a (header) file literally.
.It Ic \&Ic Ar keyword ...
-Designate an internal or interactive command.
-This is similar to
-.Ic \&Cm
-but used for instructions rather than values.
+Internal or interactive command, or configuration instruction
+in a configuration file.
+See also
+.Ic \&Cm .
.Pp
Examples:
.Dl \&.Ic :wq