From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from scc-mailout-kit-01-web.scc.kit.edu (scc-mailout-kit-01-web.scc.kit.edu [129.13.231.93]); by fantadrom.bsd.lv (OpenSMTPD) with ESMTP id 4a6a5583; for ; Fri, 2 Jan 2015 11:03:38 -0500 (EST) Received: from asta-nat.asta.uni-karlsruhe.de ([172.22.63.82] helo=hekate.usta.de) by scc-mailout-kit-01.scc.kit.edu with esmtps (TLS1.2:DHE_RSA_AES_256_CBC_SHA256:256) (envelope-from ) id 1Y74hL-0007T0-5K; Fri, 02 Jan 2015 17:03:36 +0100 Received: from donnerwolke.usta.de ([172.24.96.3]) by hekate.usta.de with esmtp (Exim 4.77) (envelope-from ) id 1Y74hK-0004B5-Vl; Fri, 02 Jan 2015 17:03:34 +0100 Received: from iris.usta.de ([172.24.96.5] helo=usta.de) by donnerwolke.usta.de with esmtp (Exim 4.72) (envelope-from ) id 1Y74hK-00036W-V5; Fri, 02 Jan 2015 17:03:34 +0100 Received: from schwarze by usta.de with local (Exim 4.77) (envelope-from ) id 1Y74hK-0002b2-II; Fri, 02 Jan 2015 17:03:34 +0100 Date: Fri, 2 Jan 2015 17:03:34 +0100 From: Ingo Schwarze To: Steffen Nurpmeso Cc: tech@mdocml.bsd.lv Subject: Re: mdocml's .Ql doesn't map to original and GNU mdoc(7) Message-ID: <20150102160333.GI32031@iris.usta.de> References: <20141229121746.vAh4wKsy%sdaoden@yandex.com> <20141229193631.GE17408@iris.usta.de> <20141229202024.niCQvsnl%sdaoden@yandex.com> <20141231205156.GQ19654@iris.usta.de> <20150101190136.03oKSkqW%sdaoden@yandex.com> <20150102123636.GF32031@iris.usta.de> <20150102142922.fUbQrsIoLBuOlbo2@yandex.com> X-Mailinglist: mdocml-tech Reply-To: tech@mdocml.bsd.lv MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20150102142922.fUbQrsIoLBuOlbo2@yandex.com> User-Agent: Mutt/1.5.21 (2010-09-15) Hi Steffen, Steffen Nurpmeso wrote on Fri, Jan 02, 2015 at 03:29:22PM +0100: > No, no that is not how i see it. I _think_ of it in terms of > rather than . Because i only know .Dl > (which rather requires a leading .Pp) and ".Bd -literal" to > achieve the same for a block, no macro that i know of except .Ql > can be used to display some code inline. Oh. Now i understand why you consider it semantic markup. You don't consider "literal" as a font specification, but in the sense of "literal display", "text copied verbatim". I have no idea whether Cynthia originally considered it as semantic markup or as physical markup, and how much she even thought about the distinction (one day, i might ask her :). But i'm always happy if we can tweak the documentation to make stuff usable for semantic purposes, as long as that doesn't totally break existing usage - which doesn't seem the case here. So, what do you think about the following patch, documenting it as semantic rather than physical markup? I think i now like the idea, one more semantic macro, one less physical. :-) Yours, Ingo Index: mdoc.7 =================================================================== RCS file: /cvs/src/share/man/man7/mdoc.7,v retrieving revision 1.128 diff -u -r1.128 mdoc.7 --- mdoc.7 31 Dec 2014 20:41:53 -0000 1.128 +++ mdoc.7 2 Jan 2015 15:45:00 -0000 @@ -454,6 +454,7 @@ .Op Fl compact .It Sx \&D1 Ta indented display (one line) .It Sx \&Dl Ta indented literal display (one line) +.It Sx \&Ql Ta in-line literal display: Ql text .It Sx \&Bl , \&El Ta list block: .Fl Ar type .Op Fl width Ar val @@ -528,7 +529,6 @@ .It Sx \&Dq , \&Do , \&Dc Ta enclose in typographic double quotes: Dq text .It Sx \&Qq , \&Qo , \&Qc Ta enclose in typewriter double quotes: Qq text .It Sx \&Sq , \&So , \&Sc Ta enclose in single quotes: Sq text -.It Sx \&Ql Ta single-quoted literal text: Ql text .It Sx \&Pq , \&Po , \&Pc Ta enclose in parentheses: Pq text .It Sx \&Bq , \&Bo , \&Bc Ta enclose in square brackets: Bq text .It Sx \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text @@ -1256,7 +1256,9 @@ .Dl \&.Dl % mandoc mdoc.7 \e(ba less .Pp See also +.Sx \&Ql , .Sx \&Bd +.Fl literal , and .Sx \&D1 . .Ss \&Do @@ -2221,14 +2223,21 @@ Close quoted context opened by .Sx \&Qo . .Ss \&Ql -Request a literal font and enclose in single quotes. -For arguments of three or more characters, formatters other than +In-line literal display. +This can for example be used for complete command invocations and +for multi-word code fragments when more specific markup is not +appropriate and an indented display is not desired. +While .Xr mandoc 1 -usually omit the quotes on non-terminal output devices. +always encloses the arguments in single quotes, other formatters +usually omit the quotes on non-terminal output devices when the +arguments have three or more characters. +.Pp See also -.Sx \&Li +.Sx \&Dl and -.Sx \&Sq . +.Sx \&Bd +.Fl literal . .Ss \&Qo Multi-line version of .Sx \&Qq . -- To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv