source: devel/pb-doc/pb.conf.pod @ 988

Last change on this file since 988 was 988, checked in by Bruno Cornec, 10 years ago

r3704@localhost: bruno | 2010-02-22 00:35:17 +0100

  • Updated pb.conf configuration (mostly done)
  • vetmout removed
File size: 23.7 KB
Line 
1=pod
2
3=head1 NAME
4
5Documentation for pb configuration files
6
7=head1 DESCRIPTION
8
9pb helps you build various packages directly from your project sources.
10In order to work correctly, it relies on a certain number of configuration files. Most of these configuration parameters can be setup in all the configuration files, however, they generally make more sense in a specific one, which is indicated. There are mainly 4 configuration files, the one in the home directory of the user (used first), the one from the project (use in second), the one in the VM/VE hosting directory, and the one provided by the tool in /etc/pb or /usr/local/etc/pb (lastly).
11
12=head1 SYNOPSIS
13
14Those files have the same format, which is near from a a perl hash structure:
15keyword key = value1[,value2,...]
16
17The key could be also default, in which case it will be used as a default value if no more precise content is given for the key.
18
19Each value is detailed below giving the nature of its use (Mandatory or Optional - only used for certain feature), the value of the key (could be the project, an OS name, default, ...), the value of the parameter field and its format, the default configuration file in which it should be defined (home $HOME/.pbrc, conf /etc/pb/pb.conf or /usr/local/etc/pb/pb.conf, VE vepath/.pbrc, VM vmpath/.pbrc,  or project project.pb) and an example of use.
20
21=head1 OPTIONS
22
23=over 4
24
25=item B<defpkgdir>>
26
27Nature: Mandatory
28Key: project (as defined in the -p option or PBPROJ environment variable)
29Value: coma separated list of packages built by default in this project. When not using any package name as a parameter to pb commands, this list will be used.
30Conffile: project
31Example: defpkgdir mondorescue = mondo,mindi
32NB: a default value is not really meaningful.
33
34=item B<extpkgdir>
35
36Nature: Optional
37Key: project (as defined in the -p option or PBPROJ environment variable)
38Value: coma separated list of packages built in addition in this project. When using the all package name as a parameter to pb commands, this list will be used, in addition to the defpkgdir list.
39Conffile: project
40Example: extpkgdir mondorescue = mondo-doc,mindi-mindibusybox
41
42=item B<filteredfiles>
43
44Nature: Optional
45Key: package (as provided in defpkgdir or extpkgdir)
46Value: coma separated list of files that will be filtered using the macro system from pb, during the creation of the compressed source tar files for this package. Their path is relative to the directory containing the package.
47Conffile: project
48Example: filteredfiles mindi = rootfs/sbin/init,mindi,install.sh,doc/mindi.8
49
50=item B<namingtype>
51
52Nature: Optional
53Key: package (as provided in defpkgdir or extpkgdir)
54Value: perl, if packages are CPAN perl modules that need to be named respecting the distribution perl convention (perl-Name for rpm, libname-perl for deb)
55Conffile: project
56Example: namingtype ProjectBuilder = perl
57
58=item B<osambiguous>
59
60Nature: Optional
61Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). In that case, should be an OS name.
62Value: coma separated list of distributions which use the same file name in /etc for different distributions (ex: /etc/redhat-release for redhat, rhel, mandriva,...). Cf: B<osrelambfile>
63Conffile: pb
64Example: osambiguous debian = debian,ubuntu
65
66=item B<oscodename>
67
68Nature: Optional
69Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). In that case, should be an os-ver.
70Value: code name. Mostly useful for debian and ubuntu, due to debootstrap.
71Conffile: pb
72Example: oscodename debian-5.0 = lenny
73
74=item B<osfamily>
75
76Nature: Mandatory
77Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). In that case, should be an os.
78Value: OS family name (used to group similar distribution for handling)
79Conffile: pb
80Example: osfamily debian = du
81
82=item B<osmindep>
83
84Nature: Optional
85Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). NB: a default value is highly interesting here.
86Value: coma separated list of packages needed before setupvm|ve can be run. Install them with your distribution in VM or automatically in VE when possible.
87Conffile: pb
88Example: osmindep default = perl,sudo,wget,tar,make,gzip
89
90=item B<osnover>
91
92Nature: Optional
93Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
94Value: true|false. True means that this OS has no need to keep the version
95Conffile: pb
96Example: osnover gentoo = true
97
98=item B<osperldep>
99
100Nature: Optional
101Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
102Value: coma separated list of perl modules needed by pb and not provided in a package format for the relative OS, and that will be installed from CPAN in your VM/VE.
103Conffile: pb
104Example: osperldep rhel-5 = Module-Build,File-MimeInfo,File-BaseDir,Mail-Sendmail
105
106=item B<osperlver>
107
108Nature: Mandatory (for each module mentioned in B<osperldep>)
109Key: Perl Module (as defined in B<osperldep>)
110Value: Version of the perl module that needs to be found on CPAN.
111Conffile: pb
112Example: Date-Manip = 5.54
113
114=item B<ospkgdep>
115
116Nature: Optional
117Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
118Value: coma separated list of packages that are needed by pb and should be installed automatically in the VM/VE during the setupvm|ve phasis by pb.
119Conffile: pb
120Example: ospkgdep rhel-5 = wget,make,ntp,patch,perl-DateManip
121
122=item B<osrelambfile>
123
124Nature: Mandatory (per OS mentioned in B<osambiguous>)
125Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). Should be the OS name here.
126Value: full path name of the ambiguous file describing that distribution, as well as some others. All the distributions mentioned here should also be mentioned with their ambiguous other distribution in the B<osambiguous> parameter.
127Conffile: pb
128Example: osrelambfile debian = /etc/debian_version
129
130=item B<osrelexpr>
131
132Nature: Mandatory (per OS mentioned in B<osrelambfile> and B<osrelfile>)
133Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
134Value: the perl regular expression used to parse the B<osrelambfile> in order to extract from it the version of the distribution (in parenthesis to allow its usage as $1 by perl)
135Conffile: pb
136osrelexpr rhel = Red Hat (?:Enterprise Linux|Linux Advanced Server) .*release ([0-9.]+).* \(
137Example:
138
139=item B<osrelfile>
140
141Nature: Mandatory
142Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). Should be the OS name here.
143Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name.
144Conffile: pb
145Example: osrelfile fedora = /etc/fedora-release
146
147=item B<osremovedotinver>
148
149Nature: Optional
150Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
151Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS.
152Conffile: pb
153Example: osremovedotinver redhat = true
154
155=item B<ossuffix>
156
157Nature: Optional
158Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
159Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
160Conffile: pb
161Example: ossuffix mandriva = mdv
162
163=item B<ostype>
164
165Nature: Mandatory
166Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). The family name is generaly used here.
167Value: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type.
168Conffile: pb
169Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
170
171=item B<osupd>
172
173Nature: Optional
174Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). The family name is generaly used here.
175Value: OS command to lauch in order to automatically install packages on it.
176Conffile: pb
177Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
178
179=item B<pbconfurl>
180
181Nature: Mandatory
182Key: project (as defined in the -p option or PBPROJ environment variable)
183Value: B<pb URL> giving access to where the pb configuration dir is stored. Under that directory you have the same tree infrastructure as the upstream project, and under the pb packaging infra, including the project configuration file. Cf: man
184Conffile: home|project
185Example: pbconfurl fossology = svn+ssh://user@svn.project-builder.org/mondo/svn/pb/projects/fossology/pbconf, cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe/pbconf
186
187=item B<pbdefdir>
188
189Nature: Optional
190Key: project (as defined in the -p option or PBPROJ environment variable)
191Value: local directory under which every pb related operation will take place. if not defined then /var/cache. A default value is highly interesting here. If you want to use VMs/VEs, then use $ENV{'HOME'} to make it portable to it.
192Conffile: home
193Example: pbdefdir default = $ENV{'HOME'}/local/pb/projects
194
195=item B<pbml>
196
197Nature: Optional (Mandatory if using announce command)
198Key: project (as defined in the -p option or PBPROJ environment variable)
199Value: white space separated list of e-mail adresses used to send announces with the pb announce option.
200Conffile: project
201Example: pbml pb = pb-announce@project-builder.org pb-devel@project-builder.org
202
203=item B<pbpackager>
204
205Nature: Mandatory
206Key: project (as defined in the -p option or PBPROJ environment variable)
207Value: Firstname Name and e-mail address of the person packaging the software.
208Conffile: project
209Example: pbpackager pb = Bruno Cornec <bruno@project-builder.org>
210
211=item B<pbprojdir>
212
213Nature: Optional
214Key: project (as defined in the -p option or PBPROJ environment variable)
215Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname
216Conffile: home
217Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue
218
219=item B<pbrepo>
220
221Nature: Mandatory
222Key: project (as defined in the -p option or PBPROJ environment variable)
223Value: URL of the server hosting the upstream tar file.
224Conffile: project
225Example: pbrepo mondorescue = ftp://ftp.mondorescue.org
226
227=item B<pbsmtp>
228
229Nature: Optional (Mandatory if using the announce command)
230Key: project (as defined in the -p option or PBPROJ environment variable)
231Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here.
232Conffile: home
233Example: pbsmtp mondorescue = localhost
234
235=item B<pbsockscmd>
236
237Nature: Optional
238Key: project (as defined in the -p option or PBPROJ environment variable)
239Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here.
240Conffile: home
241Example: pbsockscmd default = tsocks
242
243=item B<pburl>
244
245Nature: Optional
246Key: project (as defined in the -p option or PBPROJ environment variable)
247Value: B<pb URL> giving access to where the project is stored. Normaly provided by the project, but could be overloaded for specific authentication information in the home configuration file or when using a DVCS
248Conffile: home|project
249Example: pburl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pburl pb = svk:////local/pb
250
251=item B<pbwf>
252
253Nature: Optional
254Key: project (as defined in the -p option or PBPROJ environment variable)
255Value: whatever. As soon as this is defined, then that project is known as not well formed (have a subdirectory in its tar file under which all sources are put named project-version). This should be reported upstream to the project. tar files generated by project-builder to not suffer from that. This is valid when packaging for tar files and not CMS.
256Conffile: project
257Example: pbwf afio = 1
258
259=item B<pkgtag>
260
261Nature: Optional
262Key: package (as provided in defpkgdir or extpkgdir)
263Value: Tag that needs to be used in package name (on rpm: name-ver-tag.arch.rpm).  Useful when different from the project version B<projtag> and when republishing a package due to package build modification (not code).
264Conffile: project
265Example: pkgtag mindi-busybox = 2
266
267=item B<pkgver>
268
269Nature: Optional
270Key: package (as provided in defpkgdir or extpkgdir)
271Value: Version that needs to be used in package name (on rpm: name-ver-tag.arch.rpm). Useful when different from the project version B<projver>.
272Conffile: project
273Example: pkgver mindi-busybox = 1.7.3
274
275=item B<projtag>
276
277Nature: Mandatory
278Key: project (as defined in the -p option or PBPROJ environment variable)
279Value: tag that will be used for all packages names (on rpm: name-ver-tag.arch.rpm) in the project. Each package can overwrite it using B<pkgtag>.
280Conffile: project
281Example: projtag mondorescue = 1
282
283=item B<projver>
284
285Nature: Mandatory
286Key: project (as defined in the -p option or PBPROJ environment variable)
287Value: version that will be used for all packages names (on rpm: name-ver-tag.arch.rpm) in the project. Each package can overwrite it using B<pkgver>.
288Conffile: project
289Example: projver mondorescue = 2.2.9
290
291=item B<rbsconf>
292
293Nature: Optional
294Key: project (as defined in the -p option or PBPROJ environment variable)
295Value: for mock it's the configuration directory. For rinse it's its configuration file. For rpmbootstrap it's not used yet.
296Conffile: ve
297Example: rbsconf default = /etc/mock, rbsconf default = /etc/pb/pb-rinse.conf
298
299=item B<rbsb4pi>
300
301Nature: Optional
302Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). The family name is generaly used here.
303Value: for mock it's not used. For rinse it's the script to call before doing installation (in order change the mirror location). For rpmbootstrap it's not used yet.
304Conffile: ve
305Example: rbsb4pi centos = /home/rinse/bin/before-post-install.sh
306
307=item B<rbspi>
308
309Nature: Optional
310Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). The family name is generaly used here.
311Value: for mock it's not used. For rinse it's the script to call after doing installation for customization. For rpmbootstrap it's the script to call after doing installation for customization.
312Conffile: ve
313Example: pbrpi centos = /home/rinse/bin/post-install.sh
314
315=item B<supfiles>
316
317Not used yet.
318
319=item B<testver>
320
321Nature: Optional
322Key: project (as defined in the -p option or PBPROJ environment variable)
323Value: true (meaning this is a test version, whose tag will be generated automatically, based on 0+date in order to allow regular updates, and still be inferior to tag 1 of the official version, and delivered under the test subdirectory of the ftp server). By default false.
324Conffile: project
325Example: testver mondorescue = true
326
327=item B<vedebtype>
328
329Nature: Mandatory
330Key: project (as defined in the -p option or PBPROJ environment variable)
331Value: debootstrap (no other tool to create deb distro based chroot)
332Conffile: ve
333Example: vedebtype default = debootstrap
334
335=item B<velist>
336
337Nature: Mandatory
338Key: project (as defined in the -p option or PBPROJ environment variable)
339Value: list of coma separated OS (under the form of os-ver-arch).
340Conffile: ve
341Example: velist default = centos-4-i386,centos-5-i386,centos-4-x86_64,centos-5-x86_64,debian-5.0-i386,debian-5.0-x86_64,lsb-4.0.1-i386,lsb-4.0.1-x86_64
342
343=item B<velogin>
344
345Nature: Mandatory
346Key: project (as defined in the -p option or PBPROJ environment variable)
347Value: account name to use in the VE to build packages.
348Conffile: ve
349Example: velogin default = pb
350
351=item B<vemindep>
352
353Nature: Optional
354Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). NB: a default value per OS family is interesting here.
355Value: coma separated list of packages needed before pb can be run in the VE. Installed automatically in setupve phase.
356Conffile: ve
357Example: vemindep rpm = rpm-build,diffutils,ntpdate, vemindep deb = diff
358
359=item B<ventp>
360
361Nature: Optional
362Key: project (as defined in the -p option or PBPROJ environment variable)
363Value: NTP server to contact for time accuracy with B<ventpcmd> before building.
364Conffile: ve
365Example: ventp default = 1.pool.ntp.org
366
367=item B<ventpcmd>
368
369Nature: Optional
370Key: project (as defined in the -p option or PBPROJ environment variable)
371Value: NTP command to use to perform time synchronization with the B<ventp> server.
372Conffile: ve
373Example: ventpcmd default = /usr/sbin/ntpdate
374
375=item B<vepath>
376
377Nature: Mandatory
378Key: project (as defined in the -p option or PBPROJ environment variable)
379Value: path where to find VEs. Ve will be created and used under that path. For each VE os-ver-arch, it will create a subdirectory tree os/ver/arch below that point.
380Conffile: ve
381Example: vepath default = /home/rpmbootstrap
382
383=item B<verebuild>
384
385Nature: Optional
386Key: project (as defined in the -p option or PBPROJ environment variable)
387Value: true|false. True means that the VE should be rebuild before usage.
388Conffile: ve
389Example: ventpcmd default = /usr/sbin/ntpdate
390
391=item B<verpmtype>
392
393Nature: Mandatory
394Key: project (as defined in the -p option or PBPROJ environment variable)
395Value: rpmbootstrap|rinse|mock (different tools to create a chroot environment for RPM based distributions. rpmbootstrap comes with pb. the 2 others are separate projects).
396Conffile: ve
397Example: verpmtype default = rpmbootstrap
398
399=item B<vesnap>
400
401Nature: Optional
402Key: project (as defined in the -p option or PBPROJ environment variable)
403Value: true|false. True means that the snapshot of the VE should be used before call to the VE. This snapshot consists of a compressed tar pf the VE. Which means that you will always start from a known state, resulting of a former snapshot operation on the VE. Also speeds up a lot the VM launch operation.
404Conffile: ve
405Example: vesnap default = true
406
407=item B<vetype>
408
409Nature: Mandatory
410Key: project (as defined in the -p option or PBPROJ environment variable)
411Value: chroot|schroot. There are two different ways of launching a chroot activity in pb. For the moment only chroot has been tested.
412Conffile: ve
413Example: vertype default = chroot
414
415=item B<vmhost>
416
417Nature: Mandatory
418Key: project (as defined in the -p option or PBPROJ environment variable)
419Value: hostname to connect to in order to reach the VM through ssh. Generally redirected from a port on localhost.
420Conffile: vm
421Example: vmhost default = localhost
422
423=item B<vmlist>
424
425Nature: Mandatory
426Key: project (as defined in the -p option or PBPROJ environment variable)
427Value: list of coma separated OS (under the form of os-ver-arch).
428Conffile: vm
429Example: vmlist default = asianux-2-i386,asianux-3-i386,mandrake-10.1-i386,mandrake-10.2-i386,mandriva-2006.0-i386,mandriva-2007.0-i386,mandriva-2007.1-i386,mandriva-2008.0-i386,mandriva-2008.1-i386,mandriva-2009.0-i386,mandriva-2009.1-i386,mandriva-2010.0-i386,redhat-7.3-i386,redhat-9-i386,fedora-4-i386,fedora-5-i386,fedora-6-i386,fedora-7-i386,fedora-8-i386,fedora-9-i386,fedora-10-i386,fedora-11-i386,fedora-12-i386,rhel-2.1-i386,rhel-3-i386,rhel-4-i386,rhel-5-i386,suse-10.0-i386,suse-10.1-i386,suse-10.2-i386,opensuse-10.3-i386,opensuse-11.0-i386,opensuse-11.1-i386,opensuse-11.2-i386,sles-9-i386,sles-10-i386,sles-11-i386,gentoo-nover-i386,debian-3.1-i386,debian-4.0-i386,debian-5.0-i386,ubuntu-6.06-i386,ubuntu-7.04-i386,ubuntu-7.10-i386,ubuntu-8.04-i386,ubuntu-8.10-i386,ubuntu-9.04-i386,ubuntu-9.10-i386,solaris-10-i386,asianux-2-x86_64,asianux-3-x86_64,mandriva-2007.0-x86_64,mandriva-2007.1-x86_64,mandriva-2008.0-x86_64,mandriva-2008.1-x86_64,mandriva-2009.0-x86_64,mandriva-2009.1-x86_64,mandriva-2010.0-x86_64,fedora-6-x86_64,fedora-7-x86_64,fedora-8-x86_64,fedora-9-x86_64,fedora-10-x86_64,fedora-11-x86_64,fedora-12-x86_64,rhel-3-x86_64,rhel-4-x86_64,rhel-5-x86_64,suse-10.2-x86_64,opensuse-10.3-x86_64,opensuse-11.0-x86_64,opensuse-11.1-x86_64,opensuse-11.2-x86_64,sles-10-x86_64,sles-11-x86_64,gentoo-nover-x86_64,debian-4.0-x86_64,debian-5.0-x86_64,ubuntu-7.04-x86_64,ubuntu-7.10-x86_64,ubuntu-8.04-x86_64,ubuntu-8.10-x86_64,ubuntu-9.04-x86_64,ubuntu-9.10-x86_64,solaris-10-x86_64
430
431=item B<vmlogin>
432
433Nature: Mandatory
434Key: project (as defined in the -p option or PBPROJ environment variable)
435Value: account name to use in the VM to build packages. Communication is done with ssh.
436Conffile: vm
437Example: vmlogin default = pb
438
439=item B<vmmonport>
440
441Nature: Optional
442Key: project (as defined in the -p option or PBPROJ environment variable)
443Value: TCP port that is used to dialog with the monitor of the VM, to pass orders such as snapshot. Not really operational yet.
444Conffile: vm
445Example: vmmonport default = 4444
446
447=item B<vmntp>
448
449Nature: Optional
450Key: project (as defined in the -p option or PBPROJ environment variable)
451Value: NTP server to contact for time accuracy with B<vmntpcmd> before building.
452Conffile: vm
453Example: vmntp default = 1.pool.ntp.org
454
455=item B<vmntpcmd>
456
457Nature: Optional
458Key: project (as defined in the -p option or PBPROJ environment variable)
459Value: NTP command to use to perform time synchronization with the B<vmntp> server.
460Conffile: vm
461Example: vmntpcmd default = /usr/sbin/ntpdate,vmntpcmd opensuse-11.0-i386 = sntp -P no -r
462
463=item B<vmopt>
464
465Nature: Optional
466Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). NB: a default value is highly interesting here.
467Value: list of options to pass to the VM manager command launcher for that distribution. Another way to pass options to the VM manager command launcher is by using the PBVMOPT environment variable, which comes in addition to his option.
468Conffile: vm
469Example: vmopt default = -m 384 -daemonize,vmopt mandriva-2009.0-i386 = -m 256 -daemonize -no-kvm
470
471=item B<vmpath>
472
473Nature: Mandatory
474Key: project (as defined in the -p option or PBPROJ environment variable)
475Value: path where to find VMs. They will be created and used under that path. For each VM os-ver-arch, it will create a os-ver-arch.qemu file below that point.
476Conffile: vm
477Example: vmpath default = /home/qemu
478
479=item B<vmport>
480
481Nature: Mandatory
482Key: project (as defined in the -p option or PBPROJ environment variable)
483Value: port number to use to communicate with the VM using the SSH protocol. This localport is redirected to the port 22 of the VM.
484Conffile: vm
485Example: vmport pb = 2222,vmport mondorescue = 2223
486
487=item B<vmsize>
488
489Nature: Mandatory
490Key: project (as defined in the -p option or PBPROJ environment variable)
491Value: Size of the VM to create when using the newvm command of pb.
492Conffile: vm
493Example: vmsize default = 7G
494
495=item B<vmsnap>
496
497Nature: Optional
498Key: project (as defined in the -p option or PBPROJ environment variable)
499Value: true|false. True means that the snapshot of the VM called pb should be used. Which means that you will always start from a known state, resulting of a former snapshot operation on the VM. Also speeds up a lot the VM launch operation.
500Conffile: vm
501Example: vmsnap default = true
502
503=item B<vmtmout>
504
505Nature: Optional
506Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). NB: a default value is highly interesting here.
507Value: Time in seconds to way beofre interacting with the VM. This should corresponds to the time the VM takes to boot.
508Conffile: vm
509Example: vmtmout default = 180,vmtmout mandriva-2009.0-x86_64 = 500
510
511=item B<vmtype>
512
513Nature: Mandatory
514Key: project (as defined in the -p option or PBPROJ environment variable)
515Value: qemu|kvm. For the moment, only QEMU or KVM are supported as virtualization technologies.
516Conffile: vm
517Example: vmrtype default = kvm
518
519=item B<webdir>
520
521Nature: Optional
522Key: project (as defined in the -p option or PBPROJ environment variable)
523Value: Target directory containing the web content in the project that should be delivered when using the web2ssh command of pb.
524Conffile: project
525Example: webdir mondorescue = website
526
527=item B<pb URL>
528=item B<pb directory desc>
529=item B<pb environment variables>
Note: See TracBrowser for help on using the repository browser.