source: template/template.xml@ 64fecc4

10.0 10.1 11.0 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 krejzi/svn nosym perl-modules qt5new systemd-11177 systemd-13485 trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 64fecc4 was 64fecc4, checked in by Andrew Benton <andy@…>, 10 years ago

Added some command explanations for possible options to the xine-lib page

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@9515 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 9.0 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!-- Place this in the general.ent file
8 <!ENTITY TEMPLATE-version "">
9 -->
10
11 <!ENTITY TEMPLATE-download-http "http://">
12 <!ENTITY TEMPLATE-download-ftp "ftp://">
13 <!ENTITY TEMPLATE-md5sum "MD5 sum">
14 <!ENTITY TEMPLATE-size "?? MB">
15 <!ENTITY TEMPLATE-buildsize "?? MB">
16 <!ENTITY TEMPLATE-time "?? SBU">
17]>
18
19<!-- Try to keep the indentation used in this file-->
20<sect1 id="TEMPLATE" xreflabel="TEMPLATE-&TEMPLATE-version;">
21 <?dbhtml filename="TEMPLATE.html"?>
22
23 <sect1info>
24 <othername>$LastChangedBy$</othername>
25 <date>$Date$</date>
26 </sect1info>
27
28 <!-- No other tags inside any title-->
29 <!-- Use Title Case in All Titles
30 The "The Chicago Manual of Style":
31 "-Always capitalize the first and the last word.
32 -Capitalize all nouns, pronouns, adjectives, verbs, adverbs, and
33 subordinate conjunctions ("as", "because", "although").
34 -Lowercase all articles, coordinate conjunctions ("and", "or", "nor"),
35 and prepositions regardless of length, when they are other than the
36 first or last word.
37 -Lowercase the "to" in an infinitive."-->
38 <title>TEMPLATE-&TEMPLATE-version;</title>
39
40 <indexterm zone="TEMPLATE">
41 <primary sortas="a-TEMPLATE">TEMPLATE</primary>
42 </indexterm>
43
44 <!--Required section-->
45 <sect2 role="package">
46 <title>Introduction to TEMPLATE</title>
47
48 <para>The <application>TEMPLATE</application> package contains...
49 This is useful for...</para>
50
51 <bridgehead renderas="sect3">Package Information</bridgehead>
52 <itemizedlist spacing="compact">
53 <listitem>
54 <para>Download (HTTP): <ulink url="&TEMPLATE-download-http;"/></para>
55 </listitem>
56 <listitem>
57 <para>Download (FTP): <ulink url="&TEMPLATE-download-ftp;"/></para>
58 </listitem>
59 <listitem>
60 <para>Download MD5 sum: &TEMPLATE-md5sum;</para>
61 </listitem>
62 <listitem>
63 <para>Download size: &TEMPLATE-size;</para>
64 </listitem>
65 <listitem>
66 <para>Estimated disk space required: &TEMPLATE-buildsize;</para>
67 </listitem>
68 <listitem>
69 <para>Estimated build time: &TEMPLATE-time;</para>
70 </listitem>
71 </itemizedlist>
72
73 <!-- As required -->
74 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
75 <itemizedlist spacing="compact">
76 <listitem>
77 <para>Required patch: <ulink
78 url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
79 </listitem>
80 </itemizedlist>
81
82 <bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead>
83
84 <bridgehead renderas="sect4">Required</bridgehead>
85 <para role="required"><xref linkend="BLFS DEPENDENCY"/></para>
86
87 <!-- As required -->
88 <bridgehead renderas="sect4">Recommended</bridgehead>
89 <para role="recommended"><ulink url="http://www.some.url/">EXTERNAL
90 DEPENDENCY</ulink>,
91 <xref linkend="BLFS DEPENDENCY"/></para>
92
93 <!-- As required -->
94 <bridgehead renderas="sect4">Optional</bridgehead>
95 <para role="optional"><ulink url="http://www.some.url/">EXTERNAL
96 DEPENDENCY</ulink></para>
97
98 <para condition="html" role="usernotes">User Notes:
99 <ulink url="&blfs-wiki;/TEMPLATE"/></para>
100 </sect2>
101
102 <!-- Optional section for packages that need a specific kernel
103 configuration-->
104 <sect2 role="kernel" id="TEMPLATE-kernel">
105 <title>Kernel Configuration</title>
106
107 <para>Enable the following options in the kernel configuration
108 and recompile the kernel if necessary:</para>
109
110<!-- Spaces are significant in <screen> sections -->
111<screen><literal>Master section:
112 Subsection:
113 Required Option: M or Y
114 Incompatible option: N</literal></screen>
115
116 <para>Select the appropriate sub-options that appear when the above options
117 are selected.</para>
118
119 <indexterm zone="TEMPLATE TEMPLATE-kernel">
120 <primary sortas="d-TEMPLATE">TEMPLATE</primary>
121 </indexterm>
122 </sect2>
123
124 <!--Required section-->
125 <sect2 role="installation">
126 <title>Installation of TEMPLATE</title>
127
128 <para>Install <application>TEMPLATE</application> by running the following
129 commands:</para>
130
131<!-- Spaces are significant in <screen> sections -->
132<screen><userinput>./configure --prefix=/usr &amp;&amp;
133make</userinput></screen>
134
135 <!-- Optional section. Use one of the two mentions below about a test
136 suite, delete the line that is not applicable. Of course, if the
137 test suite uses syntax other than 'make check', revise the
138 line to reflect the actual syntax to run the test suite -->
139
140 <para>This package does not come with a test suite.</para>
141 <para>To test the results, issue: <command>make check</command>.</para>
142
143 <para>Now, as the <systemitem class="username">root</systemitem>
144 user:</para>
145
146<screen role="root"><userinput>make install</userinput></screen>
147 </sect2>
148
149 <!--Optional section-->
150 <sect2 role="commands">
151 <title>Command Explanations</title>
152
153 <para><command>COMMAND</command>: This command does something.</para>
154
155 <para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
156 something mandatory for BLFS purposes.</para>
157
158 <para><option>--OPTION</option>: This option does something optionally
159 per the user's desires.</para>
160 </sect2>
161
162 <!--Optional section-->
163 <sect2 role="configuration">
164 <title>Configuring TEMPLATE</title>
165
166 <sect3 id="TEMPLATE-config">
167 <title>Config Files</title>
168 <para><filename>~/.Configfilename1</filename> and
169 <filename>/etc/path/Configfilename2</filename></para>
170
171 <indexterm zone="TEMPLATE TEMPLATE-config">
172 <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
173 </indexterm>
174
175 <indexterm zone="TEMPLATE TEMPLATE-config">
176 <primary
177 sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
178 </indexterm>
179 </sect3>
180
181 <sect3><title>Configuration Information</title>
182
183 <para>Blah blah blah about config.</para>
184
185<screen><userinput>USER CONFIG COMMANDS</userinput></screen>
186
187<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
188
189 <!-- File creation. Add the appropriate <indexterm> block if needed.-->
190 <para>Create the file .... for ...</para>
191
192<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
193<literal># Begin FILENAME
194
195TEXT
196
197# End FILENAME</literal>
198EOF</userinput></screen>
199 </sect3>
200
201 <sect3 id="TEMPLATE-init">
202 <title>Boot Script</title>
203
204 <para>To automatically start the <command>TEMPLATE</command> daemon
205 when the system is rebooted, install the
206 <filename>/etc/rc.d/init.d/TEMPLATE</filename>
207 bootscript from the
208 <xref linkend="bootscripts"/> package.</para>
209
210 <indexterm zone="TEMPLATE TEMPLATE-init">
211 <primary sortas="f-TEMPLATE">TEMPLATE</primary>
212 </indexterm>
213
214<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
215 </sect3>
216 </sect2>
217
218 <!--Required section-->
219 <sect2 role="content">
220 <title>Contents</title>
221
222 <segmentedlist>
223 <segtitle>Installed Program(s)</segtitle>
224 <segtitle>Installed Librar(y,ies)</segtitle>
225 <segtitle>Installed Director(y,ies)</segtitle>
226
227 <seglistitem>
228 <seg>PROGRAM1, PROGRAM2, and PROGRAM3</seg>
229 <seg>libLIBRARY1, libLIBRARY2, and libLIBRARY3</seg>
230 <seg>/etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
231 /usr/share/TEMPLATE-&TEMPLATE-version;,
232 /usr/share/doc/TEMPLATE-&TEMPLATE-version;, and
233 /var/lib/TEMPLATE</seg>
234 </seglistitem>
235 </segmentedlist>
236
237 <variablelist>
238 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
239 <?dbfo list-presentation="list"?>
240 <?dbhtml list-presentation="table"?>
241
242 <!-- If the program or library name conflicts (is the same) as the
243 package name, add -prog or -lib to the varlistentry entity id
244 and the 2nd entry of the indexterm zone entity -->
245
246 <varlistentry id="PROGRAM1">
247 <term><command>PROGRAM1</command></term>
248 <listitem>
249 <para>does this .....</para>
250 <indexterm zone="TEMPLATE PROGRAM1">
251 <primary sortas="b-PROGRAM1">PROGRAM1</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="PROGRAM2">
257 <term><command>PROGRAM2</command></term>
258 <listitem>
259 <para>does this .....</para>
260 <indexterm zone="TEMPLATE PROGRAM2">
261 <primary sortas="b-PROGRAM2">PROGRAM2</primary>
262 </indexterm>
263 </listitem>
264 </varlistentry>
265
266 <varlistentry id="libLIBRARY1">
267 <term><filename class="libraryfile">libLIBRARY1.{so,a}</filename></term>
268 <listitem>
269 <para>contains functions that .....</para>
270 <indexterm zone="TEMPLATE libLIBRARY1">
271 <primary sortas="c-libLIBRARY1">libLIBRARY1.{so,a}</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>
275 </variablelist>
276 </sect2>
277</sect1>
Note: See TracBrowser for help on using the repository browser.