← Back to branch summary

~ubuntu-branches/ubuntu/precise/live-manual/precise

« back to all changes in this revision

Viewing changes to xml/chapters/customization/contents.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Baumann
  • Date: 2010-06-06 15:30:21 UTC
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20100606153021-wjm839uxrii9x2ks
Tags: upstream-2.0~a1
Import upstream version 2.0~a1

Show diffs side-by-side

added added

removed removed

Lines of Context:
xml/chapters/customization/contents.xml
1
 
<?xml version="1.0" encoding="utf-8"?>
2
 
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3
 
    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4
 
  <!ENTITY % commondata SYSTEM "../../entities/common.ent" > %commondata;
5
 
]>
6
 
<sect1 id="contents">
7
 
<title>Customising contents</title>
8
 
 
9
 
<para>This chapter discusses further customisation of the live system.</para>
10
 
 
11
 
<sect2>
12
 
 <title>Includes</title>
13
 
 
14
 
 <para>Using includes, it is possible to add (or replace) arbitrary files in your Debian Live image. &live-helper; provides three mechanisms for using them:</para>
15
 
 
16
 
 <variablelist>
17
 
  <varlistentry>
18
 
   <term>
19
 
    Chroot local includes
20
 
   </term>
21
 
   <listitem>
22
 
    <para>
23
 
     These allow you to add or replace files to the chroot/Live filesystem. Please see <xref linkend="chroot-local-includes"/> for more information.
24
 
    </para>
25
 
   </listitem>
26
 
  </varlistentry>
27
 
  <varlistentry>
28
 
   <term>
29
 
    Binary local includes
30
 
   </term>
31
 
   <listitem>
32
 
    <para>
33
 
     These allow you to add or replace files in the binary image. Please see <xref linkend="binary-local-includes"/> for more information.
34
 
    </para>
35
 
   </listitem>
36
 
  </varlistentry>
37
 
  <varlistentry>
38
 
   <term>
39
 
    Binary includes
40
 
   </term>
41
 
   <listitem>
42
 
    <para>
43
 
     These allow you to add or replace Debian specific files in the binary image, such as the templates and tools directories. Please see <xref linkend="binary-includes"/> for more information.
44
 
    </para>
45
 
   </listitem>
46
 
  </varlistentry>
47
 
 </variablelist>
48
 
 
49
 
 <para>
50
 
  Please see <xref linkend="terms"/> for more information about the distinction between the "Live" and "binary" images.
51
 
 </para>
52
 
 
53
 
<sect3 id="chroot-local-includes">
54
 
 <title>Live/chroot local includes</title>
55
 
 <para>
56
 
  Chroot local includes can be used to add or replace files in the chroot/Live filesystem so that they are visible when the Live system is booted. Typical uses for them are to populate the skeleton user directory (<filename class="directory">/etc/skel</filename>) used by the live system to create the live user's home directory, or adding configuration files where additional processing is not required.
57
 
 </para>
58
 
 
59
 
 <para>
60
 
  To include files, simply add them to your <filename class="directory">config/chroot_local-includes</filename> directory. This directory corresponds to the root directory (<filename class="directory">/</filename>) of the live system. For example, to add a file <filename>/var/www/index.html</filename> in the live system, use:
61
 
 </para>
62
 
 
63
 
 <screen>
64
 
  $ mkdir -p config/chroot_local-includes/var/www
65
 
  $ cp /path/to/my/index.html config/chroot_local-includes/var/www
66
 
 </screen>
67
 
 
68
 
 <para>
69
 
  Your configuration will then have the following layout:
70
 
 </para>
71
 
 
72
 
 <screen>
73
 
   [...]
74
 
    |-- chroot_local-includes
75
 
    |   `-- var
76
 
    |       `-- www
77
 
    |           `-- index.html
78
 
   [...]
79
 
    `-- templates
80
 
 </screen>
81
 
 
82
 
 <para>
83
 
  Chroot local includes are installed after package installation so that files installed by packages are overwritten.
84
 
 </para>
85
 
</sect3>
86
 
 
87
 
<sect3 id="binary-local-includes">
88
 
<title>Binary local includes</title>
89
 
 <para>
90
 
  FIXME.
91
 
 </para>
92
 
</sect3>
93
 
 
94
 
<sect3 id="binary-includes">
95
 
<title>Binary includes</title>
96
 
 <para>
97
 
  FIXME.
98
 
 </para>
99
 
</sect3>
100
 
 
101
 
</sect2>
102
 
 
103
 
<sect2 id="hooks">
104
 
<title>Hooks</title>
105
 
 
106
 
<para>FIXME.</para>
107
 
<para>Enabling hooks</para>
108
 
 
109
 
<sect3 id="chroot-local-hooks">
110
 
<title>Live/chroot local hooks</title>
111
 
<para>FIXME.</para>
112
 
</sect3>
113
 
 
114
 
<sect3 id="binary-local-hooks">
115
 
<title>Binary local hooks</title>
116
 
<para>FIXME.</para>
117
 
</sect3>
118
 
 
119
 
</sect2>
120
 
 
121
 
<sect2 id="debconf-preseed">
122
 
 <title>Preseeding Debconf questions</title>
123
 
 
124
 
 <para>Files in the <filename class="directory">config/chroot_local-preseed</filename> directory are considered to be debconf preseed files and are installed by &live-helper; using <filename>debconf-set-selections</filename>.</para>
125
 
 
126
 
 <para>For more information about debconf, please see debconf(7) in the <command>debconf</command> package.</para>
127
 
</sect2>
128
 
 
129
 
<sect2 id="symlinks">
130
 
<title>Symlink conversion</title>
131
 
<para>FIXME. (This is probably in the wrong section)</para>
132
 
</sect2>
133
 
 
134
 
</sect1>