aboutsummaryrefslogtreecommitdiffstatshomepage
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
commitadc300f62b7fbe5b7eb742b3042e1bb923a8093a (patch)
tree67355aff6d7deeea6f1bea2e719b087bfd1b5dae
parentdc84793b8b21e0dfd2d19fbacfe8349e161d9a17 (diff)
downloadmandoc-adc300f62b7fbe5b7eb742b3042e1bb923a8093a.tar.gz
mandoc-adc300f62b7fbe5b7eb742b3042e1bb923a8093a.tar.zst
mandoc-adc300f62b7fbe5b7eb742b3042e1bb923a8093a.zip
clarify the difference between .Cm and .Ic;
triggered by a question from Fabio Scotoni
-rw-r--r--mdoc.722
1 files changed, 12 insertions, 10 deletions
diff --git a/mdoc.7 b/mdoc.7
index 51498e19..40e4ca84 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.7,v 1.277 2019/04/23 18:46:06 schwarze Exp $
+.\" $Id: mdoc.7,v 1.278 2019/04/24 13:15:00 schwarze Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2010, 2011, 2013-2018 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: April 23 2019 $
+.Dd $Mdocdate: April 24 2019 $
.Dt MDOC 7
.Os
.Sh NAME
@@ -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