From owner-freebsd-doc  Wed Mar 12 10:33:11 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 29BF937B401
	for <doc@FreeBSD.ORG>; Wed, 12 Mar 2003 10:33:10 -0800 (PST)
Received: from pakastelohi.cypherpunks.to (pakastelohi.cypherpunks.to [213.130.163.34])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 79ECE43FCB
	for <doc@FreeBSD.ORG>; Wed, 12 Mar 2003 10:33:09 -0800 (PST)
	(envelope-from shamrock@cypherpunks.to)
Received: from VAIO650 (adsl-208-201-229-160.sonic.net [208.201.229.160])
	(using TLSv1 with cipher RC4-MD5 (128/128 bits))
	(No client certificate requested)
	by pakastelohi.cypherpunks.to (Postfix) with ESMTP
	id 0AA6A36519; Wed, 12 Mar 2003 19:33:06 +0100 (CET)
From: "Lucky Green" <shamrock@cypherpunks.to>
To: "'Hiroki Sato'" <hrs@eos.ocn.ne.jp>
Cc: <doc@FreeBSD.ORG>
Subject: RE: <citerefentry> vs. &man.command.section
Date: Wed, 12 Mar 2003 10:32:59 -0800
Message-ID: <00aa01c2e8c5$d079cdc0$6601a8c0@VAIO650>
MIME-Version: 1.0
Content-Type: text/plain;
	charset="us-ascii"
Content-Transfer-Encoding: 7bit
X-Priority: 3 (Normal)
X-MSMail-Priority: Normal
X-Mailer: Microsoft Outlook, Build 10.0.2627
In-Reply-To: <20030313.025224.98423896.hrs@eos.ocn.ne.jp>
Importance: Normal
X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2800.1106
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-doc.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-doc>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-doc>
X-Loop: FreeBSD.org

Hiroki Sato wrote:
>  No.  They have the same meaning.  The latter (short) form is 
> defined in  doc/share/sgml/man-refs.ent.  It is something 
> like #define macro in C.
>  If you can find man.xxx.n in man-refs.ent, you should use 
> it.  If not, I think it is better to add an entry by yourself 
> or ask someone  who is a doc committer, instead of using the former.


Ah. Thank you for the explanation! This wasn't clear to me from reading
the docs.

> shamrock> 2) Is it required that every time a FreeBSD command is 
> shamrock> mentioned the command _must_ be surrounded by the <command> 
> shamrock> tags? I have explanatory text paragraphs in which gbde is 
> shamrock> mentioned multiple times and having all these bold 
> instances 
> shamrock> of gbde in the same paragraph looks strange to me 
> (in the html 
> shamrock> output).
> 
>  Hmmm, could you please show an example?

First of all, sorry for the mental typo. I meant to say <application>,
not <command>.

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:

<sect2>
<title>Compatibility issues</title>
<para>&man.sysinstall.8; is incompatible with
<application>gbde</application>-encrypted devices. All
<application>gbde</application> devices must be detached from the kernel
before launching <application>sysinstall</application> or
<application>sysinstall</application> will crash during its initial
probing for devices. To detach the <application>gbde</application>
device used in our example, use the following command:
</para>
<screen>&prompt.root; <userinput>gbde detach /dev/ad4s1c.bde</userinput>
</screen>
</sect2>

Thanks,
--Lucky


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message