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

Clarification updates to the template file

Browse Source 
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@10975 af4574ff-66df-0310-9fd7-8a98e5e911e0
This commit is contained in:
Randy McMurchy 2013-01-25 13:52:33 +00:00
parent 8f1699f259
commit 8bf1180904
1 changed files with 28 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
template/template.xml
View File

@ -96,20 +96,24 @@
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="BLFS DEPENDENCY"/>
<xref linkend="BLFS DEPENDENCY"/> <!-- notice no period as this is not a sentence
If there are more than two, they must be separated by commas with the last
member having "and" in front of it. The use of a serial comma is preferred
(a comma after the next to last member before the "and"). -->
</para>
<!-- As required -->
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink> and
<xref linkend="BLFS DEPENDENCY"/>.
<xref linkend="BLFS DEPENDENCY"/> <!-- notice no period as this is not a sentence-->
</para>
<!-- As required -->
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>.
<ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>
<!-- notice no period as this is not a sentence-->
</para>
<para condition="html" role="usernotes">
@ -191,13 +195,15 @@ make</userinput></screen>
</para>
<para>
<parameter>--SWITCH=PARAMETER</parameter>: This parameter does something
mandatory for BLFS purposes.
<parameter>--PARAMETER</parameter>: This parameter does something
mandatory for BLFS purposes. It will be in the instructions above. It is
not optional and is why it is listed as a parameter and not an option.
</para>
<para>
<option>--OPTION</option>: This option does something optionally per the
user's desires.
user's desires. It is not listed in the instructions above, but instead,
is listed here because many (some) readers may want to include it.
</para>
</sect2>
@ -205,7 +211,8 @@ make</userinput></screen>
<title>Using TEMPLATE</title>
<para>
Stuff about how to use TEMPLATE to do something.
Stuff about how to use TEMPLATE to do something. This section is rarely
used.
</para>
</sect2>
@ -217,7 +224,7 @@ make</userinput></screen>
<title>Config Files</title>
<para>
<filename>~/.Configfilename1</filename> and
<filename>/etc/path/Configfilename2</filename>.
<filename>/etc/path/Configfilename2</filename> <!-- notice no period as this is not a sentence-->
</para>
<indexterm zone="TEMPLATE TEMPLATE-config">
@ -261,7 +268,8 @@ EOF</userinput></screen>
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="bootscripts"/> package.
<xref linkend="bootscripts"/> package as the
<systemitem class="username">root</systemitem> user:
</para>
<indexterm zone="TEMPLATE TEMPLATE-init">
@ -281,6 +289,14 @@ EOF</userinput></screen>
<segtitle>Installed Librar(y,ies)</segtitle>
<segtitle>Installed Director(y,ies)</segtitle>
<!-- If there were no programs, libraries, or directories created, then
we would list the section as "None". However, a decision must have
been made to change the "None" to just removing the whole section
because I've noticed that many packages have had the "None"
removed and the section completely removed as well. The reasoning
was that by putting "None", it appears as we know there are none.
Without anything it appears as we are not sure. -->
<seglistitem>
<seg>
PROGRAM1, PROGRAM2 and PROGRAM3.
@ -310,7 +326,7 @@ EOF</userinput></screen>
<term><command>PROGRAM1</command></term>
<listitem>
<para>
does this .....
does this ..... (end the sentence with a period).
</para>
<indexterm zone="TEMPLATE PROGRAM1">
<primary sortas="b-PROGRAM1">PROGRAM1</primary>
@ -322,7 +338,7 @@ EOF</userinput></screen>
<term><command>PROGRAM2</command></term>
<listitem>
<para>
does this .....
does this ..... (end the sentence with a period).
</para>
<indexterm zone="TEMPLATE PROGRAM2">
<primary sortas="b-PROGRAM2">PROGRAM2</primary>
@ -334,7 +350,7 @@ EOF</userinput></screen>
<term><filename class="libraryfile">libLIBRARY1.so</filename></term>
<listitem>
<para>
contains functions that .....
contains functions that ..... (end the sentence with a period).
</para>
<indexterm zone="TEMPLATE libLIBRARY1">
<primary sortas="c-libLIBRARY1">libLIBRARY1.so</primary>