Subversion Repositories svn LFS-FR

Compare Revisions

Ignore whitespace Rev 4537 → Rev 4538

/trunk/blfs/template/template-intro.xml
0,0 → 1,14
<sect3>
<title>Introduction à template</title>
 
<screen>Téléchargement location: &template-download;
Version used: &template-version;
Package size: &template-size;
Estimated Disk space required: &template-buildsize;</screen>
 
<para>The template package contains... This is useful for...</para>
 
<screen>template depends on:
DEPENDENCY LIST (if any)</screen>
 
</sect3>
/trunk/blfs/template/template-exp.xml
0,0 → 1,7
<sect3>
<title>Command explanations</title>
 
<para><userinput>COMMAND:</userinput> This command does something.</para>
 
</sect3>
 
/trunk/blfs/template/template-inst.xml
0,0 → 1,9
<sect3>
<title>Installation de template</title>
 
<para>Install template by running the following </para>
 
<para><screen><userinput>./configure </userinput></screen></para>
 
</sect3>
 
/trunk/blfs/template/template-desc.xml
0,0 → 1,17
<sect3>
<title>Contenu</title>
 
<para>The template package contains <userinput>LISTOFFILES</userinput></para>
 
</sect3>
 
<sect3><title>Description</title>
 
<sect4><title>item1</title>
<para>item1 does this</para></sect4>
 
<sect4><title>item2</title>
<para>item2 does that</para></sect4>
 
</sect3>
 
/trunk/blfs/template/newitem
0,0 → 1,37
#!/bin/sh
 
# Copies the template files et replaces template with the supplied package
# name, greatly simplifying the process of adding a new package.
 
if [ -z "$1" ]
then
echo "Creates template files for a package et fills in the package name."
echo "Usage: $0 <written-package-name> <package-filename>"
echo
echo "Note that if you want to create the package Glib, you should"
echo "call the script as: '$0 Glib glib' so that the filenames are in"
echo "lower case. If you only specify the first option, it is used"
echo "for both the written et filenames."
echo "Note also that *all* filenames in BLFS should be lower-case only"
exit 1
fi
 
WRITTENNAME=$1
 
if [ -z "$2" ]
then
FILENAME=$WRITTENNAME
else
FILENAME=$2
fi
 
pushd `dirname $0`
TEMPLDIR=`pwd`
popd
for i in $TEMPLDIR/template*
do
NEWFILE=`echo $i | sed s@$TEMPLDIR/template@$FILENAME@`
echo $NEWFILE
sed s/template/$WRITTENNAME/g $i > $NEWFILE
done
/trunk/blfs/template/template.xml
1,221 → 1,11
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY TEMPLATE-download-http "http://">
<!ENTITY TEMPLATE-download-ftp "ftp://">
<!ENTITY TEMPLATE-md5sum "MD5 sum">
<!ENTITY TEMPLATE-size "?? Mo">
<!ENTITY TEMPLATE-buildsize "?? Mo">
<!ENTITY TEMPLATE-time "?? SBU">
]>
<sect1 id="TEMPLATE" xreflabel="TEMPLATE-&TEMPLATE-version;">
<?dbhtml filename="TEMPLATE.html"?>
<sect1info>
<othername>$LastChangedBy&nbsp;: randy $</othername>
<date>$Date&nbsp;: 2013-02-11 19:51:17 +0100 (Mon, 11 Feb 2013) $</date>
</sect1info>
<title>TEMPLATE-&TEMPLATE-version;</title>
<indexterm zone="TEMPLATE">
<primary sortas="a-TEMPLATE">TEMPLATE</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to TEMPLATE</title>
<para>The <application>TEMPLATE</application> package contains...
This is useful for...</para>
&lfs70_built;
&lfs71_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>Download (HTTP): <ulink url="&TEMPLATE-download-http;"/></para>
</listitem>
<listitem>
<para>Download (FTP): <ulink url="&TEMPLATE-download-ftp;"/></para>
</listitem>
<listitem>
<para>Download MD5 sum: &TEMPLATE-md5sum;</para>
</listitem>
<listitem>
<para>Download size: &TEMPLATE-size;</para>
</listitem>
<listitem>
<para>Estimated disk space required: &TEMPLATE-buildsize;</para>
</listitem>
<listitem>
<para>Estimated build time: &TEMPLATE-time;</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">Additional Downloads</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>Required patch: <ulink
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 role="required"><xref linkend="BLFS DEPENDENCY"/></para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended"><ulink url="http://www.some.url/">EXTERNAL
DEPENDENCY</ulink>,
<xref linkend="BLFS DEPENDENCY"/></para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><ulink url="http://www.some.url/">EXTERNAL
DEPENDENCY</ulink></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/TEMPLATE"/></para>
</sect2>
<sect2 role="kernel" id="TEMPLATE-kernel">
<title>Kernel Configuration</title>
<para>Enable the following options in the kernel configuration
and recompile the kernel if necessary:</para>
<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>
<sect2 role="installation">
<title>Installation of TEMPLATE</title>
<para>Install <application>TEMPLATE</application> by running the following
commands:</para>
<screen>
<userinput>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput>
</screen>
<para>This package does not come with a test suite.</para>
<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>
<sect2 role="commands">
<title>Command Explanations</title>
<para><command>COMMAND</command>&nbsp;: This command does something.</para>
<para><parameter>--SWITCH=PARAMETER</parameter>&nbsp;: This parameter does
something mandatory for BLFS purposes.</para>
<para><option>--OPTION</option>&nbsp;: This option does something optionally
per the user's desires.</para>
</sect2>
<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>
<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="bootscripts"/> package.</para>
<indexterm zone="TEMPLATE TEMPLATE-init">
<primary sortas="f-TEMPLATE">TEMPLATE</primary>
</indexterm>
<screen role="root">
<userinput>make install-TEMPLATE</userinput>
</screen>
</sect3>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Programme installé(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>
<seg>/etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
/usr/share/TEMPLATE-&TEMPLATE-version;,
/usr/share/doc/TEMPLATE-&TEMPLATE-version;, and
/var/lib/TEMPLATE</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="PROGRAM1">
<term><command>PROGRAM1</command></term>
<listitem>
<para>does this .....</para>
<indexterm zone="TEMPLATE PROGRAM1">
<primary sortas="b-PROGRAM1">PROGRAM1</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="PROGRAM2">
<term><command>PROGRAM2</command></term>
<listitem>
<para>does this .....</para>
<indexterm zone="TEMPLATE PROGRAM2">
<primary sortas="b-PROGRAM2">PROGRAM2</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libLIBRARY1">
<term><filename class="libraryfile">libLIBRARY1.{so,a}</filename></term>
<listitem>
<para>contains functions that .....</para>
<indexterm zone="TEMPLATE libLIBRARY1">
<primary sortas="c-libLIBRARY1">libLIBRARY1.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<sect2 id="template" xreflabel="template-&template-version;">
<title>template-&template-version;</title>
 
&template-intro;
&template-inst;
&template-exp;
&template-config;
&template-desc;
 
</sect2>
 
/trunk/blfs/template/README
1,10 → 1,6
$LastChangedBy: andy $
$Date: 2012-02-17 14:32:38 +0100 (ven 17 fév 2012) $
These files are generic templates.
The newitem script makes a copy of the files et changes all occurances
of template in them to the package name to save a lot of tedious work.
 
This is a generic template.
 
Makes a copy of the file and edit as needed.
 
don't forget to:
 
svn propset svn:keywords "LastChangedBy Date" path/to/new/page.xml
Not all will always be needed
/trunk/blfs/template/template-config.xml
0,0 → 1,15
<sect3>
<title>Configuring template</title>
 
<sect4><title>Config files</title>
<para><userinput>List of config files</userinput></para>
</sect4>
 
<sect4><title>Configuration Information</title>
 
<para><userinput>USERINPUT GOES HERE</userinput> Blah blah blah about config.
</para>
</sect4>
 
</sect3>