documented 'ulimits' directory
[util-vserver.git] / util-vserver / doc / configuration.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE cfgdirdoc SYSTEM "cfgdirdoc.dtd" [
3 <!ENTITY init-scriptlet-params
4           "<params>
5             <param id='vserver-dir'>
6               <description>The configuration directory of the current vserver</description>
7             </param>
8             <param id='vserver-name'>
9               <description>The name of the current vserver</description>
10             </param>
11             <param id='action'>
12               <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop', ...).</description>
13             </param>
14           </params>">
15 <!ENTITY init-script-text     "The scriptlet">
16 <!ENTITY init-dir-text        "A directory with scriptlets">
17 <!ENTITY init-dir-script-text "A scriptlet">
18
19 <!ENTITY init-prepre-start "which will be executed before the network-interfaces are enabled
20                             and the directories are mounted.">
21 <!ENTITY init-pre-start  "which will be executed after network-interfaces were enabled and
22                           the directories mounted, but before the vserver itself has been
23                           started.">
24 <!ENTITY init-post-start "which will be executed after the vserver has been started.">
25 <!ENTITY init-pre-stop   "which will be executed before the vserver will be stopped.">
26 <!ENTITY init-post-stop  "which will be executed after the vserver has been stopped, but
27                           before the directories will be umounted and the the interfaces
28                           disabled.">
29 <!ENTITY init-postpost-stop "which will be executed after the vserver has been stopped
30                              completely.">
31 ]>
32
33
34 <cfgdirdoc>
35   <topleveldir path="@CONFDIR@">
36     <description>The base configuration directory.</description>
37
38     <dir name=".defaults" type="fixed" optional="yes">
39       <dir name="init" type="fixed">
40         <file name="mtab">
41           <description>Default mtab-file</description>
42         </file>
43       </dir>
44
45       <symlink name="vdirbase">
46         <description></description>
47         <default>/vservers</default>
48       </symlink>
49
50       <dir name="apps" type="fixed">
51         <dir name="pkgmgmt" type="fixed">
52           <symlink name="base">
53             <description></description>
54             <default>/vservers/.pkg</default>
55           </symlink>
56         </dir>
57       </dir>
58     </dir>
59
60     <dir name=".distributions" type="fixed" optional="yes">
61       <dir name="dist" type="symbolic">
62         <file name="dev">
63           <description></description>
64         </file>
65
66         <script name="initpre">
67           <description>Script which will be executed before packages will be installed.</description>
68           <params>
69             <param id="confdir">
70               <description>The configuration directory of the vserver which is going to be set
71               up.</description>
72             </param>
73
74             <param id="vserver">
75               <description>The pathname of the vserver binary.</description>
76             </param>
77           </params>
78         </script>
79
80         <script name="initpost">
81           <description>Script which will be executed after packages are installed.</description>
82           <params>
83             <param id="confdir">
84               <description>The configuration directory of the vserver which is going to be set
85               up.</description>
86             </param>
87
88             <param id="vserver">
89               <description>The pathname of the vserver binary.</description>
90             </param>
91           </params>
92         </script>
93
94         <dir name="pkgs" type="fixed">
95           <description>Contains files with packages.</description>
96           <file name="list" type="symbolic">
97             <description>File which contains the name of packages. On top of file the special
98             keywords '--reinstall' and '--can-fail' are possible.</description>
99           </file>
100         </dir>
101
102         <dir name="pubkeys" type="fixed">
103           <description>Directory with GPG pubkeys which are used to sign the packages of this
104           distribution.</description>
105         </dir>
106
107         <dir name="apt" type="fixed">
108           <description>Default content of the /etc/apt/ directory.</description>
109         </dir>
110
111         <dir name="rpm" type="fixed">
112           <description>Default content of the /etc/rpm directory.</description>
113         </dir>
114
115         <symlink name="rpmlib">
116           <description>Directory which overrides /usr/lib/rpm.</description>
117         </symlink>
118         
119         <symlink name="execdir">
120           <description>Directory with all executables and libraries which are required for this
121           distribution.</description>
122         </symlink>
123       </dir>
124     </dir> <!-- .distributions -->
125
126     <dir name="vserver-name" type="symbolic">
127       <description>The configuration directory for the vserver vserver-name.</description>
128
129       <file name="hostname">
130         <description>Contains the hostname of the vserver.</description>
131       </file>
132
133       <file name="name">
134         <description>Contains the name of the vserver. When not given, the basename of the directory
135         will be assumed as this name.</description>
136       </file>
137
138       <file name="domainname">
139         <description>The domainname of the vserver.</description>
140       </file>
141
142       <file name="nice">
143         <description>The nice-level on which the vserver will be started.</description>
144       </file>
145
146       <file name="capabilities">
147         <description>Contains per line a capability.</description>
148       </file>
149
150       <file name="shell">
151         <description>Contains the pathname of the shell which will be used by the "vserver ... enter"
152         command.</description>
153       </file>
154
155       <file name="flags">
156         <description>Contains per line a flag.</description>
157       </file>
158
159       <file name="context">
160         <description>Contains the context which shall be used for the vserver.</description>
161       </file>
162
163       <file name="fstab">
164         <description>The fstab file for the vserver.</description>
165       </file>
166       
167       <dir name="apps" type="fixed">
168         <dir name="init" type="fixed">
169           <file name="mtab">
170             <description>The initial-mtab which will be used for the vserver.</description>
171           </file>
172
173           <file name="style">
174             <description>Contains the init-style; possible values are 'sysv', 'plain' and
175             'minit'.</description>
176           </file>
177
178           <file name="runlevel">
179             <description>The start runlevel.</description>
180           </file>
181
182           <file name="runlevel.start">
183             <description>The start runlevel.</description>
184           </file>
185
186           <file name="runlevel.stop">
187             <description>The stop runlevel.</description>
188           </file>
189
190           <file name="killseq">
191             <description>Contains the 'signal [wait signal]*' sequence which is used to stop the
192             vserver.</description>
193           </file>
194
195           <file name="cmd.start">
196             <description>The command which is used to start the vserver. Each option must be on a
197             separate line.</description>
198           </file>
199
200           <file name="cmd.start-sync">
201             <description>The command which is used to wait on the vserver after it has been
202             started. Each option must be on a separate line. This file will be ignored when the
203             'sync' does not exist and the '--sync' option was not used.</description>
204           </file>
205           
206           <file name="cmd.stop">
207             <description>The command which is used to stop the vserver. Each option must be on a
208             separate line.</description>
209           </file>
210
211           <file name="cmd.stop-sync">
212             <description>The command which is used to wait on the vserver after it has been
213             stopped. Each option must be on a separate line. This file will be ignored when the
214             'sync' does not exist and the '--sync' option was not used.</description>
215           </file>
216
217           <file name="cmd.prepare">
218             <description>The command which is used to setup the init-system (e.g. to set the runlevel
219             in the utmp-file). Each option must be on a separate line.</description>
220           </file>
221
222           <file name="sync">
223             <description>Without this file, the 'cmd.*-sync' files will be ignored.</description>
224           </file>
225         </dir>
226       </dir>
227
228       <dir name="scripts" type="fixed">
229         <script name="prepre-start">
230           <description>&init-script-text; &init-prepre-start;</description>
231           &init-scriptlet-params;
232         </script>
233         <dir name="prepre-start.d" type="fixed">
234           <description>&init-dir-text; &init-prepre-start;</description>
235
236           <script name="script">
237             <description>&init-dir-script-text; &init-prepre-start;</description>
238             &init-scriptlet-params;
239           </script>
240         </dir>
241
242         <script name="pre-start">
243           <description>&init-script-text; &init-pre-start;</description>
244           &init-scriptlet-params;
245         </script>
246
247         <dir name="pre-start.d">
248           <description>&init-dir-text; &init-pre-start;</description>
249           
250           <script name="script">
251             <description>&init-dir-script-text; &init-pre-start;</description>
252             &init-scriptlet-params;
253           </script>
254           
255         </dir>
256
257         <script name="post-start">
258           <description>&init-script-text; &init-post-start;</description>
259           &init-scriptlet-params;
260         </script>
261
262         <dir name="post-start.d">
263           <description>&init-dir-text; &init-post-start;</description>
264           
265           <script name="script">
266             <description>&init-dir-script-text; &init-post-start;</description>
267             &init-scriptlet-params;
268           </script>
269         </dir>
270
271         <script name="pre-stop">
272           <description>&init-script-text; &init-pre-stop;</description>
273           &init-scriptlet-params;
274         </script>
275
276         <dir name="pre-stop.d" type="fixed">
277           <description>&init-dir-text; &init-pre-stop;</description>
278           <script name="script">
279             <description>&init-dir-script-text; &init-pre-stop;</description>
280             &init-scriptlet-params;
281           </script>
282         </dir>
283
284         <script name="post-stop">
285           <description>&init-script-text; &init-post-stop;</description>
286           &init-scriptlet-params;
287         </script>
288
289         <dir name="post-stop.d" type="fixed">
290           <description>&init-dir-text; &init-post-stop;</description>
291           <script name="script">
292             <description>&init-dir-script-text; &init-post-stop;</description>
293             &init-scriptlet-params;
294           </script>
295         </dir>
296
297         <script name="postpost-stop">
298           <description>&init-script-text; &init-postpost-stop;</description>
299           &init-scriptlet-params;
300         </script>
301
302         <dir name="postpost-stop.d" type="fixed">
303           <description>&init-dir-text; &init-postpost-stop;</description>
304           <script name="script">
305             <description>&init-dir-script-text; &init-postpost-stop;</description>
306             &init-scriptlet-params;
307           </script>
308         </dir>
309       </dir>
310
311
312       
313       <dir name="interfaces" type="fixed">
314         <file name="bcast">
315           <description>The deafult broadcast address.</description>
316         </file>
317         <file name="dev">
318           <description>The default network-device.</description>
319         </file>
320         <file name="prefix">
321           <description>The default network-prefix.</description>
322         </file>
323         <file name="mask">
324           <description>The default network-mask.</description>
325         </file>
326         <file name="scope">
327           <description>The default scope of the network interfaces.</description>
328         </file>
329
330         <dir name="iface" type="symbolic">
331           <file name="disabled">
332             <description>When this file exists, this interface will be ignored.</description>
333           </file>
334           
335           <file name="ip">
336             <description>The ip which will be assigned to this interface.</description>
337           </file>
338           <file name="bcast">
339             <description>The broadcast address.</description>
340           </file>
341           <file name="dev">
342             <description>The network-device.</description>
343           </file>
344           <file name="prefix">
345             <description>The network-prefix.</description>
346           </file>
347           <file name="mask">
348             <description>The network-mask.</description>
349           </file>
350           <file name="scope">
351             <description>The scope of the network interfaces.</description>
352           </file>
353           <file name="name">
354             <description>When this file exists, the interface will be named.</description>
355           </file>
356         </dir>
357       </dir>
358
359       <dir name="ulimits" type="fixed">
360         <description>A directory with ulimits.</description>
361
362         <file name="resource" type="symbolic">
363           <description>A file which contains the hard- and soft-limit of the given resource in the
364           first line. The special keyword 'inf' is recognized.</description>
365         </file>
366
367         <file name="resource.hard" type="symbolic">
368           <description>A file which contains the hard- of the given resource in the first line. The
369           special keyword 'inf' is recognized.</description>
370         </file>
371
372         <file name="resource.soft" type="symbolic">
373           <description>A file which contains the soft- of the given resource in the first line. The
374           special keyword 'inf' is recognized.</description>
375         </file>
376       </dir>
377     </dir>
378   </topleveldir>
379 </cfgdirdoc>
380
381
382 <!--
383 !! Local Variables:
384 !! fill-column: 100
385 !! End:
386 -->