Rocksolid Light

News from da outaworlds

mail  files  register  groups  login

Message-ID:  

You will meet an important person who will help you advance professionally.

comp / comp.unix.bsd.freebsd.misc / Re: man page command or convention for subheaders?

SubjectAuthor
* man page command or convention for subheaders?Winston
`* Re: man page command or convention for subheaders?Christian Weisgerber
 `* Re: man page command or convention for subheaders?Winston
  `- Re: man page command or convention for subheaders?Felix Palmen

1
Subject: man page command or convention for subheaders?
From: Winston
Newsgroups: comp.unix.bsd.freebsd.misc
Organization: A noiseless patient Spider
Date: Thu, 7 Mar 2024 07:19 UTC
Path: eternal-september.org!news.eternal-september.org!.POSTED!not-for-mail
From: wbe@UBEBLOCK.psr.com.invalid (Winston)
Newsgroups: comp.unix.bsd.freebsd.misc
Subject: man page command or convention for subheaders?
Date: Thu, 07 Mar 2024 02:19:46 -0500
Organization: A noiseless patient Spider
Lines: 6
Message-ID: <ydv85yh5kd.fsf@UBEblock.psr.com>
MIME-Version: 1.0
Content-Type: text/plain
Injection-Info: dont-email.me; posting-host="c79723978a91a98e0ac8d0e5e4f7c64a";
logging-data="989829"; mail-complaints-to="abuse@eternal-september.org"; posting-account="U2FsdGVkX1+G63bXEVXOYRAW3eDisqOF"
User-Agent: Gnus/5.13 (Gnus v5.13)
Cancel-Lock: sha1:MfUQ01wXkoEOm0ji8Et5YNS2l8w=
sha1:ysdPKOGsQiDHfIrOwwNrTh9ek6I=
Mail-Copies-To: never
View all headers

A FreeBSD man page I'm trying to edit uses ".Sh" for the
main headers. Is there a macro or formatting convention
for subheaders kind of like HTML's <h1> <h2> <h3>, or
like text documents have Chapter 1, 1.1, 1.2, 2, ...?
TIA,
-WBE

Subject: Re: man page command or convention for subheaders?
From: Christian Weisgerber
Newsgroups: comp.unix.bsd.freebsd.misc
Date: Thu, 7 Mar 2024 11:07 UTC
References: 1
Path: eternal-september.org!news.eternal-september.org!feeder3.eternal-september.org!news.szaf.org!inka.de!mips.inka.de!.POSTED.localhost!not-for-mail
From: naddy@mips.inka.de (Christian Weisgerber)
Newsgroups: comp.unix.bsd.freebsd.misc
Subject: Re: man page command or convention for subheaders?
Date: Thu, 7 Mar 2024 11:07:53 -0000 (UTC)
Message-ID: <slrnuuj809.l0r.naddy@lorvorc.mips.inka.de>
References: <ydv85yh5kd.fsf@UBEblock.psr.com>
Injection-Date: Thu, 7 Mar 2024 11:07:53 -0000 (UTC)
Injection-Info: lorvorc.mips.inka.de; posting-host="localhost:::1";
logging-data="21532"; mail-complaints-to="usenet@mips.inka.de"
User-Agent: slrn/1.0.3 (FreeBSD)
View all headers

On 2024-03-07, Winston <wbe@UBEBLOCK.psr.com.invalid> wrote:

> A FreeBSD man page I'm trying to edit uses ".Sh" for the
> main headers. Is there a macro or formatting convention
> for subheaders kind of like HTML's <h1> <h2> <h3>, or
> like text documents have Chapter 1, 1.1, 1.2, 2, ...?

Check what's documented in mdoc(7).

--
Christian "naddy" Weisgerber naddy@mips.inka.de

Subject: Re: man page command or convention for subheaders?
From: Winston
Newsgroups: comp.unix.bsd.freebsd.misc
Organization: A noiseless patient Spider
Date: Thu, 7 Mar 2024 15:46 UTC
References: 1 2
Path: eternal-september.org!news.eternal-september.org!.POSTED!not-for-mail
From: wbe@UBEBLOCK.psr.com.invalid (Winston)
Newsgroups: comp.unix.bsd.freebsd.misc
Subject: Re: man page command or convention for subheaders?
Date: Thu, 07 Mar 2024 10:46:11 -0500
Organization: A noiseless patient Spider
Lines: 18
Message-ID: <ydr0gmgi4c.fsf@UBEblock.psr.com>
References: <ydv85yh5kd.fsf@UBEblock.psr.com>
<slrnuuj809.l0r.naddy@lorvorc.mips.inka.de>
MIME-Version: 1.0
Content-Type: text/plain
Injection-Info: dont-email.me; posting-host="c79723978a91a98e0ac8d0e5e4f7c64a";
logging-data="1190192"; mail-complaints-to="abuse@eternal-september.org"; posting-account="U2FsdGVkX1+fUQQpTh9HKe4SvwgaIkKH"
User-Agent: Gnus/5.13 (Gnus v5.13)
Cancel-Lock: sha1:Tchk6yP8oZ3f9cVVYI1/PmA5VAk=
sha1:/Kx+xqEUA0hz0cG3yK/bEMsA6rc=
Mail-Copies-To: never
View all headers

I originally asked:
>> A FreeBSD man page I'm trying to edit uses ".Sh" for the
>> main headers. Is there a macro or formatting convention
>> for subheaders kind of like HTML's <h1> <h2> <h3>, or
>> like text documents have Chapter 1, 1.1, 1.2, 2, ...?

Christian Weisgerber <naddy@mips.inka.de> kindly replied:
> Check what's documented in mdoc(7).

Got it. Thanks!

Under "Physical enclosures" are macros for surrounding text in
double quotes, single quotes, parentheses, etc.
I can understand using .Dq to get typographical quotes, but is
there an advantage to doing, say, .Qq foo rather than just
having "foo" outright as text, or using .Aq text rather than
just writing <text>?
-WBE

Subject: Re: man page command or convention for subheaders?
From: Felix Palmen
Newsgroups: comp.unix.bsd.freebsd.misc
Organization: palmen-it.de
Date: Thu, 14 Mar 2024 10:42 UTC
References: 1 2 3
Path: eternal-september.org!news.eternal-september.org!.POSTED!not-for-mail
From: felix@palmen-it.de (Felix Palmen)
Newsgroups: comp.unix.bsd.freebsd.misc
Subject: Re: man page command or convention for subheaders?
Date: Thu, 14 Mar 2024 11:42:08 +0100
Organization: palmen-it.de
Lines: 14
Message-ID: <0t0bck-gm72.ln1@mail.home.palmen-it.de>
References: <ydv85yh5kd.fsf@UBEblock.psr.com> <slrnuuj809.l0r.naddy@lorvorc.mips.inka.de> <ydr0gmgi4c.fsf@UBEblock.psr.com>
Injection-Date: Thu, 14 Mar 2024 11:42:08 +0100
Injection-Info: dont-email.me; posting-host="b9a2f45ea5d42a8ae6ac3d12d3140364";
logging-data="1650731"; mail-complaints-to="abuse@eternal-september.org"; posting-account="U2FsdGVkX1/udXICyEQui/Mtjmc+2r7m"
User-Agent: tin/2.6.3-20231224 ("Banff") (FreeBSD/13.2-RELEASE-p9 (amd64)) tinews.pl/1.1.64
Cancel-Lock: sha256:Gpt+eURNr/cXFbKos8QjbXhPY6hGDzETBgWx5M6jR2A=
sha1:Lim2yJB2xSu7Zym5nMzThhKY1n8=
X-PGP-Hash: SHA256
X-PGP-Key: 693613D55BBF4837B2123ACC54ADE0069879F231
X-PGP-Sig: GnuPG-v2 From,Newsgroups,Subject,Date,Injection-Date,Message-ID
iNUEARYIAH0WIQRpNhPVW79IN7ISOsxUreAGmHnyMQUCZfLUhF8UgAAAAAAuAChp
c3N1ZXItZnByQG5vdGF0aW9ucy5vcGVucGdwLmZpZnRoaG9yc2VtYW4ubmV0Njkz
NjEzRDU1QkJGNDgzN0IyMTIzQUNDNTRBREUwMDY5ODc5RjIzMQAKCRBUreAGmHny
MQ+lAQCO6+yEU7pS7N3I4Bb1Bplc5uBWWWIisDPdQ+r5no+PKQEAsWetyozPW0Mq
m6etOYVx85QhSBagx6qn6DWefp8jmg0=
=p33O
View all headers

* Winston <wbe@ubeblock.psr.com.invalid>:
> I can understand using .Dq to get typographical quotes, but is
> there an advantage to doing, say, .Qq foo rather than just
> having "foo" outright as text, or using .Aq text rather than
> just writing <text>?

Semantics. In these specific cases, the renderer can e.g. use
typographic quotes and brackets, even depending on current locale.

--
Dipl.-Inform. Felix Palmen <felix@palmen-it.de> ,.//..........
{web} http://palmen-it.de {jabber} [see email] ,//palmen-it.de
{pgp public key} http://palmen-it.de/pub.txt // """""""""""
{pgp fingerprint} 6936 13D5 5BBF 4837 B212 3ACC 54AD E006 9879 F231

1

rocksolid light 0.9.8
clearnet tor