Application and command names in <title> elements
Tom Rhodes
trhodes at FreeBSD.org
Mon May 19 20:24:21 UTC 2003
On Mon, 19 May 2003 22:09:06 +0200
"Simon L. Nielsen" <simon at 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
More information about the freebsd-doc
mailing list