diff options
author | 2019-04-24 13:13:03 +0000 | |
---|---|---|
committer | 2019-04-24 13:13:03 +0000 | |
commit | 710a2f69974cf4ef976541ab4217806de59d4b62 (patch) | |
tree | 2e7695b4e8cdfe24b88f0ca8a5ef1e5170676aab | |
parent | Fix the capitalization of OCTEON. (diff) | |
download | wireguard-openbsd-710a2f69974cf4ef976541ab4217806de59d4b62.tar.xz wireguard-openbsd-710a2f69974cf4ef976541ab4217806de59d4b62.zip |
clarify the difference between .Cm and .Ic;
triggered by a question from Fabio Scotoni
-rw-r--r-- | share/man/man7/mdoc.7 | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/share/man/man7/mdoc.7 b/share/man/man7/mdoc.7 index 1afe032ed57..2aa8a4bde2d 100644 --- a/share/man/man7/mdoc.7 +++ b/share/man/man7/mdoc.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.7,v 1.165 2019/04/23 18:45:41 schwarze Exp $ +.\" $OpenBSD: mdoc.7,v 1.166 2019/04/24 13:13:03 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 @@ -1697,10 +1699,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 |