From owner-freebsd-doc@FreeBSD.ORG Mon May 19 13:24:21 2003 Return-Path: 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 5EC9737B40A; Mon, 19 May 2003 13:24:21 -0700 (PDT) Received: from pittgoth.com (14.zlnp1.xdsl.nauticom.net [209.195.149.111]) by mx1.FreeBSD.org (Postfix) with ESMTP id 3612C43FA3; Mon, 19 May 2003 13:24:18 -0700 (PDT) (envelope-from trhodes@FreeBSD.org) Received: from mobile.pittgoth.com (acs-24-154-229-196.zoominternet.net [24.154.229.196]) by pittgoth.com (8.12.9/8.12.9) with SMTP id h4JKOGka012268; Mon, 19 May 2003 16:24:16 -0400 (EDT) (envelope-from trhodes@FreeBSD.org) Date: Mon, 19 May 2003 16:17:00 -0400 From: Tom Rhodes To: "Simon L. Nielsen" Message-Id: <20030519161700.27143841.trhodes@FreeBSD.org> In-Reply-To: <20030519200900.GA1120@nitro.dk> References: <20030519192255.GB74434@submonkey.net> <20030519153048.51f20a06.trhodes@FreeBSD.org> <20030519200900.GA1120@nitro.dk> X-Mailer: Sylpheed version 0.8.10claws (GTK+ 1.2.10; i386-portbld-freebsd5.1) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit cc: ceri@FreeBSD.org cc: doc@FreeBSD.org Subject: Re: Application and command names in elements X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project <freebsd-doc.freebsd.org> List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>, <mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe> List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc> List-Post: <mailto:freebsd-doc@freebsd.org> List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help> List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>, <mailto:freebsd-doc-request@freebsd.org?subject=subscribe> X-List-Received-Date: Mon, 19 May 2003 20:24:21 -0000 On Mon, 19 May 2003 22:09:06 +0200 "Simon L. Nielsen" <simon@nitro.dk> wrote: > On 2003.05.19 15:30:48 -0400, Tom Rhodes wrote: > > > I'd like to chime in here if you do not mind. While I was thinking > > about this just last night, a question arose as to which is more appropriate: > > <command> or manual page entities. > > In a patch I used man entities multiple times shortly after each other > and Murrays changed it in the committed version to only use it the first > time and use <command> for the other cases. > > <comment by Murray from docs/50790 audit trail> > One thing to note is > that it doesn't look good to use the man page entities twice in close > proximity. So I used &man.dumpon.8; the first time, then just used > <command>dumpon</command> elsewhere in the paragraph. > </comment> > > I think this is seems like a good way since the man reference is still > nice to have. Ok, I see the logic here. Thanks guys. > > > Perhaps we should standardize this some way. We have the screen for examples. > > Perhaps for commands where we do not need the screen tag, we can use the > > markup: > > > > Use <command>cvsup -g -L 2 src</command> to remove the graphic dependency on > > X11. > > > > Then we can use screen for, say, a series of commands which generate output. > > I think screen is mainly uses this way at the moment? It seems <screen> > is used when there is output or if it is a command the user should run > which is then preceded by a prompt char. This is at least the impression > I get from a grep trough the handbook. > Yes, this is the way screen is usually used. The programlisting tag is also pretty nifty. :) -- Tom Rhodes