Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 23 Dec 1999 06:38:30 +0000
From:      Mark Ovens <mark@ukug.uk.freebsd.org>
To:        Jim Mock <jim@luna.cdrom.com>
Cc:        doc@FreeBSD.ORG
Subject:   Re: Correct tag to quote commands in the docs
Message-ID:  <19991223063830.B323@marder-1>
In-Reply-To: <19991222182934.A2091@luna.cdrom.com>
References:  <19991223011842.B2347@marder-1> <19991222182934.A2091@luna.cdrom.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On Wed, Dec 22, 1999 at 06:29:34PM -0800, Jim Mock wrote:
> On Thu, 23 Dec 1999 at 01:18:42 +0000, Mark Ovens wrote:
> > What is the correct tag to use for commands embedded in the text of
> > a doc (article)? I mean in the context:
> > 
> >      "A good way of stress-testing your hardware is to run make world
> >      several times in succession"
> > 
> > What tag would you use for ``make world''?
> > 
> > Reading the FDP Primer (Example 4-35. Applications, commands, and
> > options.) I think it is:
> > 
> > 	 <application>make world</application>
> > 
> > Is this correct?
> 
> I'd say no.  Using <command>make world</command> would be better since
> it's not really an application whereas something like..
> 
> 	"I use mutt as a mailer."
> 
> Would be <application>mutt</application> since it's the actual
> application being discussed.
> 

Thanks.

> - jim
> 
> -- 
> - jim mock - walnut creek cdrom/freebsd test labs - jim@luna.cdrom.com -
> - phone: 1.925.691.2800 x.3814 - fax: 1.925.674.0821 - jim@FreeBSD.org -

-- 
	"there's a long-standing bug relating to the x86 architecture
	that allows you to install Windows too"
				   -Matthew D. Fuller
________________________________________________________________
      FreeBSD - The Power To Serve http://www.freebsd.org
      My Webpage http://ukug.uk.freebsd.org/~mark/
mailto:mark@ukug.uk.freebsd.org              http://www.radan.com



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




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19991223063830.B323>