From: Ingo Schwarze <schwarze@usta.de>
To: Warren Block <wblock@wonkity.com>
Cc: discuss@mdocml.bsd.lv
Subject: Re: Paths with replaceable components
Date: Tue, 16 Dec 2014 02:38:56 +0100 [thread overview]
Message-ID: <20141216013856.GK9092@iris.usta.de> (raw)
In-Reply-To: <alpine.BSF.2.11.1412151712470.25441@wonkity.com>
Hi Warren,
Warren Block wrote on Mon, Dec 15, 2014 at 05:19:44PM -0700:
> We have another man page for the new autofs.
> One of the associated pages refers to this path:
>
> .Pa /net/nfs-server-ip/share-name/
>
> "net" is a literal there, but "nfs-server-ip" and "share-name" are not.
>
> In DocBook, I'd mark them up as <replaceable>, to indicate to the
> reader that they are not literal. Is there a preferred mdoc way to
> do that in a path without splitting up the path components?
I would mark up the path like this:
.Pf /net/ Ar nfs-server-ip Ns / Ns Ar share-name Ns /
Making it clear which parts need replacements is probably more
important than marking up the whole thing as a path, and you can't
do both at the same time since mdoc(7) inline macros don't nest.
Why do you want to avoid splitting up the path components?
Yours,
Ingo
--
To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv
next prev parent reply other threads:[~2014-12-16 1:39 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-12-16 0:19 Warren Block
2014-12-16 1:38 ` Ingo Schwarze [this message]
2014-12-16 16:41 ` Warren Block
2014-12-16 20:05 ` 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=20141216013856.GK9092@iris.usta.de \
--to=schwarze@usta.de \
--cc=discuss@mdocml.bsd.lv \
--cc=wblock@wonkity.com \
/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).