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

Clarify an example.

Browse source 
PR:		docs/30975
Submitted by:	Giorgos Keramidas <charon@labs.gr>, bmah
This commit is contained in:
Murray Stokely 2001-10-02 06:00:27 +00:00
parent d4c848f394
commit b6c1d3fcbf
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=10861
1 changed files with 34 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

42
en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml
View file

@ -27,7 +27,7 @@
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
$FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml,v 1.8 2001/09/26 21:49:28 murray Exp $
$FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml,v 1.9 2001/10/02 05:28:55 murray Exp $
-->
<chapter id="overview">
@ -243,15 +243,41 @@
</step>
<step>
<para>Test the markup using the <maketarget>lint</maketarget> target,
and convert the document to other formats for review.</para>
<para>Test the markup using the <maketarget>lint</maketarget>
target. This will quickly find any errors in the document
without actually performing the time-consuming
transformation.</para>
<screen>&prompt.user; <userinput>make lint</userinput>
&prompt.user; <userinput>make FORMATS=<replaceable>format</replaceable></userinput></screen>
<screen>&prompt.user; <userinput>make lint</userinput></screen>
<para>Where <replaceable>format</replaceable> is one of
<literal>html</literal>, <literal>html-split</literal>,
<literal>txt</literal>, or <literal>rtf</literal></para>
<para>When you are ready to actually build the document, you
may specify a single format or a list of formats in the
<varname>FORMATS</varname> variable. Currently,
<literal>html</literal>, <literal>html-split</literal>,
<literal>txt</literal>, <literal>ps</literal>,
<literal>pdf</literal>, and <literal>rtf</literal> are
supported. The most up to date list of supported formats is
listed at the top of the
<filename>doc/share/mk/doc.docbook.mk</filename> file. Make
sure to use quotes around the list of formats when you build
more than one format with a single command.</para>
<para>For example, to convert the document to
<literal>html</literal> only, you would use:</para>
<screen>&prompt.user; <userinput>make FORMATS=html</userinput></screen>
<para>But when you want to convert the document to both
<literal>html</literal> and <literal>txt</literal> format,
you could use either two separate &man.make.1; runs,
with:</para>
<screen>&prompt.user; <userinput>make FORMATS=html</userinput>
&prompt.user; <userinput>make FORMATS=txt</userinput></screen>
<para>or, you can do it in one command:</para>
<screen>&prompt.user; <userinput>make FORMATS="html txt"</userinput></screen>
</step>
<step>