os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add a description of when to use a manual page reference and when to

Browse source 
use <command> to markup commands in SGML docbook.

PR:		docs/52467
Submitted by:	Simon L.Nielsen <simon@nitro.dk>
Discussed on:	-doc
This commit is contained in:
Ceri Davies 2003-05-20 21:18:38 +00:00
parent d0f50c8b42
commit 1ce60fc6d2
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=17002
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
View file

@ -1741,6 +1741,14 @@ This is the file called 'foo2'</screen>
<para>Use <sgmltag>option</sgmltag> to mark up a command's
options.</para>
<para>When referring to the same command multiple times in
close proximity it preferred to use the
<literal>&amp;man.<replaceable>command</replaceable>.<replaceable>section</replaceable>;</literal>
notation to markup the first reference and use
<sgmltag>command</sgmltag> to markup subsequent references.
This makes the generated output, especially HTML, appear
visually better.</para>
<para>This can be confusing, and sometimes the choice is not always
clear. Hopefully this example makes it clearer.</para>