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 36efcbab; for ; Tue, 16 Dec 2014 15:05:44 -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 1Y0yNL-0002cC-2H for discuss@mdocml.bsd.lv; Tue, 16 Dec 2014 21:05:43 +0100 Received: from donnerwolke.usta.de ([172.24.96.3]) by hekate.usta.de with esmtp (Exim 4.77) (envelope-from ) id 1Y0yNK-0004dt-Su for discuss@mdocml.bsd.lv; Tue, 16 Dec 2014 21:05:42 +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 1Y0yNK-0006KT-RQ for discuss@mdocml.bsd.lv; Tue, 16 Dec 2014 21:05:42 +0100 Received: from schwarze by usta.de with local (Exim 4.77) (envelope-from ) id 1Y0yNK-00060E-HM for discuss@mdocml.bsd.lv; Tue, 16 Dec 2014 21:05:42 +0100 Date: Tue, 16 Dec 2014 21:05:42 +0100 From: Ingo Schwarze To: discuss@mdocml.bsd.lv Subject: Re: Paths with replaceable components Message-ID: <20141216200542.GC16561@iris.usta.de> References: <20141216013856.GK9092@iris.usta.de> X-Mailinglist: mdocml-discuss Reply-To: discuss@mdocml.bsd.lv MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.5.21 (2010-09-15) Hi Warren, Warren Block wrote on Tue, Dec 16, 2014 at 09:41:02AM -0700: > On Tue, 16 Dec 2014, Ingo Schwarze wrote: >> 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 , 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 / > Nice! Heh, i feared you would consider that "splitting up the path". All the better you don't. >> Why do you want to avoid splitting up the path components? > I tried it, and it just seemed to make it longer. More > interpretation was required by the reader, and it was just unwieldy. > One version: > > Access to files on a remote NFS server is provided through the > .Pa /net > directory. > Inside that directory are subdirectories for each NFS server IP > address and the exported directories. > For example, files in the > .Pa artwork > directory on the NFS server at 192.168.1.202 will appear in the > .Pa /net/192.168.1.202/artwork > directory without any additional configuration. Yikes! Indeed, splitting it up in that sense adds nothing but verbosity. > Certainly that can be improved, but I prefer the clarity of having > one full path shown with replaceable arguments. Indeed. > Thanks! You are welcome. Yours, Ingo -- To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv