From owner-freebsd-doc Fri Mar 14 8:11:24 2003 Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 1495637B401 for ; Fri, 14 Mar 2003 08:11:22 -0800 (PST) Received: from sccrmhc01.attbi.com (sccrmhc01.attbi.com [204.127.202.61]) by mx1.FreeBSD.org (Postfix) with ESMTP id 1D95543FAF for ; Fri, 14 Mar 2003 08:11:21 -0800 (PST) (envelope-from bmah@employees.org) Received: from bmah.dyndns.org (12-240-204-110.client.attbi.com[12.240.204.110]) by sccrmhc01.attbi.com (sccrmhc01) with ESMTP id <2003031416112000100gv06ne>; Fri, 14 Mar 2003 16:11:20 +0000 Received: from intruder.bmah.org (localhost [127.0.0.1]) by bmah.dyndns.org (8.12.8/8.12.8) with ESMTP id h2EGBJWp030139; Fri, 14 Mar 2003 08:11:19 -0800 (PST) (envelope-from bmah@intruder.bmah.org) Received: (from bmah@localhost) by intruder.bmah.org (8.12.8/8.12.8/Submit) id h2EGBISV030138; Fri, 14 Mar 2003 08:11:18 -0800 (PST) Date: Fri, 14 Mar 2003 08:11:17 -0800 From: "Bruce A. Mah" To: Lucky Green Cc: "'Hiroki Sato'" , doc@FreeBSD.ORG Subject: Re: vs. &man.command.section Message-ID: <20030314161117.GB29924@intruder.bmah.org> References: <20030313.025224.98423896.hrs@eos.ocn.ne.jp> <00aa01c2e8c5$d079cdc0$6601a8c0@VAIO650> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="/WwmFnJnmDyWGHa4" Content-Disposition: inline In-Reply-To: <00aa01c2e8c5$d079cdc0$6601a8c0@VAIO650> User-Agent: Mutt/1.4i X-Image-Url: http://www.employees.org/~bmah/Images/bmah-cisco-small.gif X-url: http://www.employees.org/~bmah/ Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org --/WwmFnJnmDyWGHa4 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable If memory serves me right, Lucky Green wrote: > Hiroki Sato wrote: > > shamrock> 2) Is it required that every time a FreeBSD command is=20 > > shamrock> mentioned the command _must_ be surrounded by the = =20 > > shamrock> tags? I have explanatory text paragraphs in which gbde is=20 > > shamrock> mentioned multiple times and having all these bold=20 > > instances=20 > > shamrock> of gbde in the same paragraph looks strange to me=20 > > (in the html=20 > > shamrock> output). > >=20 > > Hmmm, could you please show an example? >=20 > First of all, sorry for the mental typo. I meant to say , > not . >=20 > Here is an example of some text that I wrote that I believe may be too > cluttered with bold face terms when rendered as HTML: (or PDF or...) > > Compatibility issues > &man.sysinstall.8; is incompatible with > gbde-encrypted devices. All > gbde devices must be detached from the kernel > before launching sysinstall or > sysinstall will crash during its initial > probing for devices. To detach the gbde > device used in our example, use the following command: > > &prompt.root; gbde detach /dev/ad4s1c.bde > > Hmmm. I'm not real happy with the above markup either. If it was me, I would have done the markup like this: Compatibility issues &man.sysinstall.8; is incompatible with &man.gbde.4;-encrypted devices. All &man.gbde.4; devices must be detached from the kernel before launching &man.sysinstall.8; or &man.sysinstall.8; will crash during its initial probing for devices. To detach the &man.gbde.4; device used in our example, use the following command: &prompt.root; gbde detach /dev/ad4s1c.bde That's still a little repetitive, but better than before. (Note that the original author might have written this before the gbde(4) manpage was added to the tree.) I generally use the elements when referring to a software package as a whole and manpage entities when referring to specific executables. The FDP Primer (look for "In-line Elements") has a pretty good example of this: http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup-doc= book.html Bruce. --/WwmFnJnmDyWGHa4 Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.1 (FreeBSD) iD8DBQE+cf8l2MoxcVugUsMRAgU3AJwKDpgwPHWKwfXQ08pO4n4RKfdybwCcDZfU qxbnIBz6cQQYjPOF4mBEVq0= =sbZl -----END PGP SIGNATURE----- --/WwmFnJnmDyWGHa4-- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message