source: devel/pb-modules/etc/pb.conf.pod @ 989

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

r3705@localhost: bruno | 2010-02-22 01:48:44 +0100

  • Improved pod format for pb.conf.pod
  • man page generated from pod now included in Makefile.PL and packages
  • Move the pod file into the etc conf dir
File size: 24.0 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
27 Nature: Mandatory
28 Key: project (as defined in the -p option or PBPROJ environment variable)
29 Value: 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.
30 Conffile: project
31 Example: defpkgdir mondorescue = mondo,mindi NB: a default value is not really meaningful.
32
33=item B<extpkgdir>
34
35 Nature: Optional
36 Key: project (as defined in the -p option or PBPROJ environment variable)
37 Value: 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.
38 Conffile: project
39 Example: extpkgdir mondorescue = mondo-doc,mindi-mindibusybox
40
41=item B<filteredfiles>
42
43 Nature: Optional
44 Key: package (as provided in defpkgdir or extpkgdir)
45 Value: 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.
46 Conffile: project
47 Example: filteredfiles mindi = rootfs/sbin/init,mindi,install.sh,doc/mindi.8
48
49=item B<namingtype>
50
51 Nature: Optional
52 Key: package (as provided in defpkgdir or extpkgdir)
53 Value: 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)
54 Conffile: project
55 Example: namingtype ProjectBuilder = perl
56
57=item B<osambiguous>
58
59 Nature: Optional
60 Key: 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.
61 Value: 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>
62 Conffile: pb
63 Example: osambiguous debian = debian,ubuntu
64
65=item B<oscodename>
66
67 Nature: Optional
68 Key: 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.
69 Value: code name. Mostly useful for debian and ubuntu, due to debootstrap.
70 Conffile: pb
71 Example: oscodename debian-5.0 = lenny
72
73=item B<osfamily>
74
75 Nature: Mandatory
76 Key: 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.
77 Value: OS family name (used to group similar distribution for handling)
78 Conffile: pb
79 Example: osfamily debian = du
80
81=item B<osmindep>
82
83 Nature: Optional
84 Key: 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.
85 Value: 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.
86 Conffile: pb
87 Example: osmindep default = perl,sudo,wget,tar,make,gzip
88
89=item B<osnover>
90
91 Nature: Optional
92 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
93 Value: true|false. True means that this OS has no need to keep the version
94 Conffile: pb
95 Example: osnover gentoo = true
96
97=item B<osperldep>
98
99 Nature: Optional
100 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
101 Value: 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.
102 Conffile: pb
103 Example: osperldep rhel-5 = Module-Build,File-MimeInfo,File-BaseDir,Mail-Sendmail
104
105=item B<osperlver>
106
107 Nature: Mandatory (for each module mentioned in B<osperldep>)
108 Key: Perl Module (as defined in B<osperldep>)
109 Value: Version of the perl module that needs to be found on CPAN.
110 Conffile: pb
111 Example: Date-Manip = 5.54
112
113=item B<ospkgdep>
114
115 Nature: Optional
116 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
117 Value: 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.
118 Conffile: pb
119 Example: ospkgdep rhel-5 = wget,make,ntp,patch,perl-DateManip
120
121=item B<osrelambfile>
122
123 Nature: Mandatory (per OS mentioned in B<osambiguous>)
124 Key: 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.
125 Value: 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.
126 Conffile: pb
127 Example: osrelambfile debian = /etc/debian_version
128
129=item B<osrelexpr>
130
131 Nature: Mandatory (per OS mentioned in B<osrelambfile> and B<osrelfile>)
132 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
133 Value: 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)
134 Conffile: pb
135osrelexpr rhel = Red Hat (?:Enterprise Linux|Linux Advanced Server) .*release ([0-9.]+).* \(
136 Example:
137
138=item B<osrelfile>
139
140 Nature: Mandatory
141 Key: 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.
142 Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name.
143 Conffile: pb
144 Example: osrelfile fedora = /etc/fedora-release
145
146=item B<osremovedotinver>
147
148 Nature: Optional
149 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
150 Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS.
151 Conffile: pb
152 Example: osremovedotinver redhat = true
153
154=item B<ossuffix>
155
156 Nature: Optional
157 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
158 Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
159 Conffile: pb
160 Example: ossuffix mandriva = mdv
161
162=item B<ostype>
163
164 Nature: Mandatory
165 Key: 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.
166 Value: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type.
167 Conffile: pb
168 Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
169
170=item B<osupd>
171
172 Nature: Optional
173 Key: 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.
174 Value: OS command to lauch in order to automatically install packages on it.
175 Conffile: pb
176 Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
177
178=item B<pbconfurl>
179
180 Nature: Mandatory
181 Key: project (as defined in the -p option or PBPROJ environment variable)
182 Value: 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
183 Conffile: home|project
184 Example: 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
185
186=item B<pbdefdir>
187
188 Nature: Optional
189 Key: project (as defined in the -p option or PBPROJ environment variable)
190 Value: 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.
191 Conffile: home
192 Example: pbdefdir default = $ENV{'HOME'}/local/pb/projects
193
194=item B<pbml>
195
196 Nature: Optional (Mandatory if using announce command)
197 Key: project (as defined in the -p option or PBPROJ environment variable)
198 Value: white space separated list of e-mail adresses used to send announces with the pb announce option.
199 Conffile: project
200 Example: pbml pb = pb-announce@project-builder.org pb-devel@project-builder.org
201
202=item B<pbpackager>
203
204 Nature: Mandatory
205 Key: project (as defined in the -p option or PBPROJ environment variable)
206 Value: Firstname Name and e-mail address of the person packaging the software.
207 Conffile: project
208 Example: pbpackager pb = Bruno Cornec <bruno@project-builder.org>
209
210=item B<pbprojdir>
211
212 Nature: Optional
213 Key: project (as defined in the -p option or PBPROJ environment variable)
214 Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname
215 Conffile: home
216 Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue
217
218=item B<pbrepo>
219
220 Nature: Mandatory
221 Key: project (as defined in the -p option or PBPROJ environment variable)
222 Value: URL of the server hosting the upstream tar file.
223 Conffile: project
224 Example: pbrepo mondorescue = ftp://ftp.mondorescue.org
225
226=item B<pbsmtp>
227
228 Nature: Optional (Mandatory if using the announce command)
229 Key: project (as defined in the -p option or PBPROJ environment variable)
230 Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here.
231 Conffile: home
232 Example: pbsmtp mondorescue = localhost
233
234=item B<pbsockscmd>
235
236 Nature: Optional
237 Key: project (as defined in the -p option or PBPROJ environment variable)
238 Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here.
239 Conffile: home
240 Example: pbsockscmd default = tsocks
241
242=item B<pburl>
243
244 Nature: Optional
245 Key: project (as defined in the -p option or PBPROJ environment variable)
246 Value: 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
247 Conffile: home|project
248 Example: pburl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pburl pb = svk:////local/pb
249
250=item B<pbwf>
251
252 Nature: Optional
253 Key: project (as defined in the -p option or PBPROJ environment variable)
254 Value: 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.
255 Conffile: project
256 Example: pbwf afio = 1
257
258=item B<pkgtag>
259
260 Nature: Optional
261 Key: package (as provided in defpkgdir or extpkgdir)
262 Value: 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).
263 Conffile: project
264 Example: pkgtag mindi-busybox = 2
265
266=item B<pkgver>
267
268 Nature: Optional
269 Key: package (as provided in defpkgdir or extpkgdir)
270 Value: 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>.
271 Conffile: project
272 Example: pkgver mindi-busybox = 1.7.3
273
274=item B<projtag>
275
276 Nature: Mandatory
277 Key: project (as defined in the -p option or PBPROJ environment variable)
278 Value: 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>.
279 Conffile: project
280 Example: projtag mondorescue = 1
281
282=item B<projver>
283
284 Nature: Mandatory
285 Key: project (as defined in the -p option or PBPROJ environment variable)
286 Value: 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>.
287 Conffile: project
288 Example: projver mondorescue = 2.2.9
289
290=item B<rbsconf>
291
292 Nature: Optional
293 Key: project (as defined in the -p option or PBPROJ environment variable)
294 Value: for mock it's the configuration directory. For rinse it's its configuration file. For rpmbootstrap it's not used yet.
295 Conffile: ve
296 Example: rbsconf default = /etc/mock, rbsconf default = /etc/pb/pb-rinse.conf
297
298=item B<rbsb4pi>
299
300 Nature: Optional
301 Key: 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.
302 Value: 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.
303 Conffile: ve
304 Example: rbsb4pi centos = /home/rinse/bin/before-post-install.sh
305
306=item B<rbspi>
307
308 Nature: Optional
309 Key: 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.
310 Value: 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.
311 Conffile: ve
312 Example: pbrpi centos = /home/rinse/bin/post-install.sh
313
314=item B<supfiles>
315
316Not used yet.
317
318=item B<testver>
319
320 Nature: Optional
321 Key: project (as defined in the -p option or PBPROJ environment variable)
322 Value: 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.
323 Conffile: project
324 Example: testver mondorescue = true
325
326=item B<vedebtype>
327
328 Nature: Mandatory
329 Key: project (as defined in the -p option or PBPROJ environment variable)
330 Value: debootstrap (no other tool to create deb distro based chroot)
331 Conffile: ve
332 Example: vedebtype default = debootstrap
333
334=item B<velist>
335
336 Nature: Mandatory
337 Key: project (as defined in the -p option or PBPROJ environment variable)
338 Value: list of coma separated OS (under the form of os-ver-arch).
339 Conffile: ve
340 Example: 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
341
342=item B<velogin>
343
344 Nature: Mandatory
345 Key: project (as defined in the -p option or PBPROJ environment variable)
346 Value: account name to use in the VE to build packages.
347 Conffile: ve
348 Example: velogin default = pb
349
350=item B<vemindep>
351
352 Nature: Optional
353 Key: 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.
354 Value: coma separated list of packages needed before pb can be run in the VE. Installed automatically in setupve phase.
355 Conffile: ve
356 Example: vemindep rpm = rpm-build,diffutils,ntpdate, vemindep deb = diff
357
358=item B<ventp>
359
360 Nature: Optional
361 Key: project (as defined in the -p option or PBPROJ environment variable)
362 Value: NTP server to contact for time accuracy with B<ventpcmd> before building.
363 Conffile: ve
364 Example: ventp default = 1.pool.ntp.org
365
366=item B<ventpcmd>
367
368 Nature: Optional
369 Key: project (as defined in the -p option or PBPROJ environment variable)
370 Value: NTP command to use to perform time synchronization with the B<ventp> server.
371 Conffile: ve
372 Example: ventpcmd default = /usr/sbin/ntpdate
373
374=item B<vepath>
375
376 Nature: Mandatory
377 Key: project (as defined in the -p option or PBPROJ environment variable)
378 Value: 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.
379 Conffile: ve
380 Example: vepath default = /home/rpmbootstrap
381
382=item B<verebuild>
383
384 Nature: Optional
385 Key: project (as defined in the -p option or PBPROJ environment variable)
386 Value: true|false. True means that the VE should be rebuild before usage.
387 Conffile: ve
388 Example: ventpcmd default = /usr/sbin/ntpdate
389
390=item B<verpmtype>
391
392 Nature: Mandatory
393 Key: project (as defined in the -p option or PBPROJ environment variable)
394 Value: rpmbootstrap|rinse|mock (different tools to create a chroot environment for RPM based distributions. rpmbootstrap comes with pb. the 2 others are separate projects).
395 Conffile: ve
396 Example: verpmtype default = rpmbootstrap
397
398=item B<vesnap>
399
400 Nature: Optional
401 Key: project (as defined in the -p option or PBPROJ environment variable)
402 Value: 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.
403 Conffile: ve
404 Example: vesnap default = true
405
406=item B<vetype>
407
408 Nature: Mandatory
409 Key: project (as defined in the -p option or PBPROJ environment variable)
410 Value: chroot|schroot. There are two different ways of launching a chroot activity in pb. For the moment only chroot has been tested.
411 Conffile: ve
412 Example: vertype default = chroot
413
414=item B<vmhost>
415
416 Nature: Mandatory
417 Key: project (as defined in the -p option or PBPROJ environment variable)
418 Value: hostname to connect to in order to reach the VM through ssh. Generally redirected from a port on localhost.
419 Conffile: vm
420 Example: vmhost default = localhost
421
422=item B<vmlist>
423
424 Nature: Mandatory
425 Key: project (as defined in the -p option or PBPROJ environment variable)
426 Value: list of coma separated OS (under the form of os-ver-arch).
427 Conffile: vm
428 Example: 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
429
430=item B<vmlogin>
431
432 Nature: Mandatory
433 Key: project (as defined in the -p option or PBPROJ environment variable)
434 Value: account name to use in the VM to build packages. Communication is done with ssh.
435 Conffile: vm
436 Example: vmlogin default = pb
437
438=item B<vmmonport>
439
440 Nature: Optional
441 Key: project (as defined in the -p option or PBPROJ environment variable)
442 Value: TCP port that is used to dialog with the monitor of the VM, to pass orders such as snapshot. Not really operational yet.
443 Conffile: vm
444 Example: vmmonport default = 4444
445
446=item B<vmntp>
447
448 Nature: Optional
449 Key: project (as defined in the -p option or PBPROJ environment variable)
450 Value: NTP server to contact for time accuracy with B<vmntpcmd> before building.
451 Conffile: vm
452 Example: vmntp default = 1.pool.ntp.org
453
454=item B<vmntpcmd>
455
456 Nature: Optional
457 Key: project (as defined in the -p option or PBPROJ environment variable)
458 Value: NTP command to use to perform time synchronization with the B<vmntp> server.
459 Conffile: vm
460 Example: vmntpcmd default = /usr/sbin/ntpdate,vmntpcmd opensuse-11.0-i386 = sntp -P no -r
461
462=item B<vmopt>
463
464 Nature: Optional
465 Key: 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.
466 Value: 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.
467 Conffile: vm
468 Example: vmopt default = -m 384 -daemonize,vmopt mandriva-2009.0-i386 = -m 256 -daemonize -no-kvm
469
470=item B<vmpath>
471
472 Nature: Mandatory
473 Key: project (as defined in the -p option or PBPROJ environment variable)
474 Value: 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.
475 Conffile: vm
476 Example: vmpath default = /home/qemu
477
478=item B<vmport>
479
480 Nature: Mandatory
481 Key: project (as defined in the -p option or PBPROJ environment variable)
482 Value: port number to use to communicate with the VM using the SSH protocol. This localport is redirected to the port 22 of the VM.
483 Conffile: vm
484 Example: vmport pb = 2222,vmport mondorescue = 2223
485
486=item B<vmsize>
487
488 Nature: Mandatory
489 Key: project (as defined in the -p option or PBPROJ environment variable)
490 Value: Size of the VM to create when using the newvm command of pb.
491 Conffile: vm
492 Example: vmsize default = 7G
493
494=item B<vmsnap>
495
496 Nature: Optional
497 Key: project (as defined in the -p option or PBPROJ environment variable)
498 Value: 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.
499 Conffile: vm
500 Example: vmsnap default = true
501
502=item B<vmtmout>
503
504 Nature: Optional
505 Key: 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.
506 Value: Time in seconds to way beofre interacting with the VM. This should corresponds to the time the VM takes to boot.
507 Conffile: vm
508 Example: vmtmout default = 180,vmtmout mandriva-2009.0-x86_64 = 500
509
510=item B<vmtype>
511
512 Nature: Mandatory
513 Key: project (as defined in the -p option or PBPROJ environment variable)
514 Value: qemu|kvm. For the moment, only QEMU or KVM are supported as virtualization technologies.
515 Conffile: vm
516 Example: vmrtype default = kvm
517
518=item B<webdir>
519
520 Nature: Optional
521 Key: project (as defined in the -p option or PBPROJ environment variable)
522 Value: Target directory containing the web content in the project that should be delivered when using the web2ssh command of pb.
523 Conffile: project
524 Example: webdir mondorescue = website
525
526=item B<pb URL>
527=item B<pb directory desc>
528=item B<pb environment variables>
529
530=back
Note: See TracBrowser for help on using the repository browser.