From: "Ulrich Spörlein" <uqs@spoerlein.net>
To: discuss@mdocml.bsd.lv
Subject: Wrong treatment of ".Nm ."
Date: Thu, 2 Jun 2011 11:03:51 +0200 [thread overview]
Message-ID: <20110602090351.GN1002@acme.spoerlein.net> (raw)
Hi,
dump.8 on FreeBSD starts roughly like this:
.Dd February 24, 2006
.Dt DUMP 8
.Os
.Sh NAME
.Nm dump ,
.Nm rdump
.Nd file system backup
.Sh SYNOPSIS
.Nm
.Op Fl T Ar date
.Ar filesystem
.Nm
.Fl W | Fl w
.Pp
.Nm rdump
is an alternate name for
.Nm .
.Pp
.in \" XXX
(The
.Bx 4.3
option syntax is implemented for backward compatibility, but
is not documented here.)
.Sh DESCRIPTION
The
.Nm
utility examines files
And mandoc will misrender the .Nm . like this:
rdump is an alternate name for
.
when it should do this:
rdump is an alternate name for dump.
Also, groff will indent the sentence in parenthesis unless the ".in"
suppresses that. mandoc doesn't know ".in" but behaves like it is set.
Not sure if you want to follow what groff is doing here ...
Uli
--
To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv
next reply other threads:[~2011-06-02 9:03 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-06-02 9:03 Ulrich Spörlein [this message]
2011-06-02 9:33 ` Ulrich Spörlein
2011-06-11 15:46 ` Ingo Schwarze
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20110602090351.GN1002@acme.spoerlein.net \
--to=uqs@spoerlein.net \
--cc=discuss@mdocml.bsd.lv \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).