linux-from-scratch/glfs
1
0
Fork 0
mirror of https://github.com/Zeckmathederg/glfs.git synced 2025-01-23 22:42:14 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Removed spaces from blank lines in the template file

Browse Source 
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@4293 af4574ff-66df-0310-9fd7-8a98e5e911e0
This commit is contained in:
Randy McMurchy 2005-05-16 11:51:14 +00:00
parent 89f473df44
commit 46daaa1cea
1 changed files with 71 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

141
template/template.xml
View File

@ -19,12 +19,12 @@
<!-- Try to keep the indentation used in this file-->
<sect1 id="TEMPLATE" xreflabel="TEMPLATE-&TEMPLATE-version;">
<?dbhtml filename="TEMPLATE.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<!-- No other tags inside any title-->
<!-- Use Title Case in All Titles
The "The Chicago Manual of Style":
@ -36,18 +36,18 @@
first or last word.
-Lowercase the "to" in an infinitive."-->
<title>TEMPLATE-&TEMPLATE-version;</title>
<indexterm zone="TEMPLATE">
<primary sortas="a-TEMPLATE">TEMPLATE</primary>
</indexterm>
<!--Required section-->
<sect2 role="package">
<title>Introduction to TEMPLATE</title>
<para>The <application>TEMPLATE</application> package contains...
This is useful for...</para>
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
@ -69,7 +69,7 @@
<para>Estimated build time: &TEMPLATE-time;</para>
</listitem>
</itemizedlist>
<!-- As required -->
<bridgehead renderas="sect3">Additional Downloads</bridgehead>
<itemizedlist spacing="compact">
@ -78,143 +78,145 @@
url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para><xref linkend="BLFS DEPENDENCY"/></para>
<!-- As required -->
<bridgehead renderas="sect4">Recommended</bridgehead>
<para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>,
<xref linkend="BLFS DEPENDENCY"/></para>
<!-- As required -->
<bridgehead renderas="sect4">Optional</bridgehead>
<para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
</sect2>
<!-- Optional section for packages that need a specific kernel configuration-->
<sect2 role="kernel" id='TEMPLATE-kernel'>
<title>Kernel Configuration</title>
<para>Enable the following options in the kernel configuration
and recompile the kernel if neccessary:</para>
<!-- Spaces are significant in <screen> sections -->
<!-- Spaces are significant in <screen> sections -->
<screen><literal>Master section:
Subsection:
Required Option: M or Y
Incompatible option: N</literal></screen>
<para>Select the appropriate sub-options that appear when the above options
are selected.</para>
<indexterm zone="TEMPLATE TEMPLATE-kernel">
<primary sortas="d-TEMPLATE">TEMPLATE</primary>
</indexterm>
</sect2>
<!--Required section-->
<sect2 role="installation">
<title>Installation of TEMPLATE</title>
<para>Install <application>TEMPLATE</application> by running the following
commands:</para>
<!-- Spaces are significant in <screen> sections -->
<!-- Spaces are significant in <screen> sections -->
<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>
<para>To test the results, issue: <command>make check</command>.</para>
<para>Now, as the <systemitem class="username">root</systemitem> user:</para>
<screen role="root"><userinput>make install</userinput></screen>
</sect2>
<!--Optional section-->
<sect2 role="commands">
<title>Command Explanations</title>
<para><command>COMMAND</command>: This command does something.</para>
<para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
something mandatory for BLFS purposes.</para>
<para><option>--OPTION</option>: This option does something optionally
per the user's desires.</para>
</sect2>
<!--Optional section-->
<sect2 role="configuration">
<title>Configuring TEMPLATE</title>
<sect3 id="TEMPLATE-config">
<title>Config Files</title>
<para><filename>~/.Configfilename1</filename> and
<filename>/etc/path/Configfilename2</filename></para>
<indexterm zone="TEMPLATE TEMPLATE-config">
<primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
</indexterm>
<indexterm zone="TEMPLATE TEMPLATE-config">
<primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
</indexterm>
</sect3>
<sect3><title>Configuration Information</title>
<para>Blah blah blah about config.</para>
<screen><userinput>USER CONFIG COMMANDS</userinput></screen>
<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
<!-- File creation. Add the appropiate <indexterm> block if needed.-->
<para>Create the file .... for ...</para>
<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
<literal># Begin FILENAME
TEXT
# End FILENAME</literal>
EOF</userinput></screen>
</sect3>
<sect3 id="TEMPLATE-init">
<title>Boot Script</title>
<para>To automatically start the <command>TEMPLATE</command> daemon
when the system is rebooted, install the <filename>/etc/rc.d/init.d/TEMPLATE</filename>
bootscript from the <xref linkend="intro-important-bootscripts"/> package.</para>
<indexterm zone="TEMPLATE TEMPLATE-init">
when the system is rebooted, install the
<filename>/etc/rc.d/init.d/TEMPLATE</filename>
bootscript from the
<xref linkend="intro-important-bootscripts"/> package.</para>
<indexterm zone="TEMPLATE TEMPLATE-init">
<primary sortas="f-TEMPLATE">TEMPLATE</primary>
</indexterm>
</indexterm>
<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
</sect3>
</sect2>
<!--Required section-->
<!--Required section-->
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Program(s)</segtitle>
<segtitle>Installed Librar(y,ies)</segtitle>
<segtitle>Installed Director(y,ies)</segtitle>
<seglistitem>
<seg>PROGRAM1, PROGRAM2, and PROGRAM3</seg>
<seg>libLIBRARY1, libLIBRARY2, and libLIBRARY3</seg>
@ -224,16 +226,16 @@ EOF</userinput></screen>
/var/lib/TEMPLATE</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<!-- If the program or library name conflicts (is the same) as the
package name, add -prog or -lib to the varlistentry entity id
and the 2nd entry of the indexterm zone entity -->
<varlistentry id="PROGRAM1">
<term><command>PROGRAM1</command></term>
<listitem>
@ -243,7 +245,7 @@ EOF</userinput></screen>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="PROGRAM2">
<term><command>PROGRAM2</command></term>
<listitem>
@ -253,7 +255,7 @@ EOF</userinput></screen>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libLIBRARY1">
<term><filename class='libraryfile'>libLIBRARY1.[so,a]</filename></term>
<listitem>
@ -263,10 +265,9 @@ EOF</userinput></screen>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
</variablelist>
</sect2>
</sect1>