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

Last change on this file since 1508 was 1508, checked in by bruno, 7 years ago
File size: 42.4 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 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<checkexclude>
26
27 Nature: Optional
28 Key: package (as provided in defpkgdir or extpkgdir)
29 Value: comma separated list of OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch) that are excluded from the checkssh command (no build made for them). The OS name is generaly used here.
30 Conffile: project
31 Example: checkexclude pkg1 = centos,lsb,solaris
32
33=item B<cpandir>
34
35 Nature: Optional
36 Key: project (as defined in the -p option or PBPROJ environment variable)
37 Value: CPAN Pause directory to upload new modules
38 Conffile: pb
39 Example: cpandir default = incoming
40
41=item B<cpanpasswd>
42
43 Nature: Optional
44 Key: project (as defined in the -p option or PBPROJ environment variable)
45 Value: CPAN Pause user's password
46 Conffile: home
47 Example: cpanpasswd default = mycomplicatedpwd
48
49=item B<cpanpause>
50
51 Nature: Optional
52 Key: project (as defined in the -p option or PBPROJ environment variable)
53 Value: CPAN Pause site to upload new modules
54 Conffile: pb
55 Example: cpanpause default = pause.perl.org
56
57=item B<cpansubdir>
58
59 Nature: Optional
60 Key: project (as defined in the -p option or PBPROJ environment variable)
61 Value: CPAN Pause subdirectory in the user's area to upload into
62 Conffile: pb
63 Example: cpansubdir default = mydir
64
65=item B<cpanurl>
66
67 Nature: Optional
68 Key: project (as defined in the -p option or PBPROJ environment variable)
69 Value: CPAN Pause URL to activate the upload mecanism
70 Conffile: pb
71 Example: cpanurl default = http://pause.perl.org/pause/authenquery
72
73=item B<cpanuser>
74
75 Nature: Optional
76 Key: project (as defined in the -p option or PBPROJ environment variable)
77 Value: CPAN Pause user
78 Conffile: home
79 Example: cpanuser default = XXX
80
81=item B<defpkgdir>
82
83 Nature: Mandatory
84 Key: project (as defined in the -p option or PBPROJ environment variable)
85 Value: comma 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.
86 Conffile: project
87 Example: defpkgdir mondorescue = mondo,mindi NB: a default value is not really meaningful.
88
89=item B<delivery>
90
91 Nature: Optional
92 Key: project (as defined in the -p option or PBPROJ environment variable)
93 Value: directory where to deliver packages once built for ftp/web access.
94 Conffile: project
95 Example: delivery mondorescue = prod
96
97=item B<extpkgdir>
98
99 Nature: Optional
100 Key: project (as defined in the -p option or PBPROJ environment variable)
101 Value: comma 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.
102 Conffile: project
103 Example: extpkgdir mondorescue = mondo-doc,mindi-mindibusybox
104
105=item B<filteredfiles>
106
107 Nature: Optional
108 Key: package (as provided in defpkgdir or extpkgdir)
109 Value: comma 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.
110 Conffile: project
111 Example: filteredfiles mindi = rootfs/sbin/init,mindi,install.sh,doc/mindi.8
112
113=item B<ftp_proxy>
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). The family name is generaly used here.
117 Value: string indicating the proxy to use
118 Conffile: pb
119 Example: ftp_proxy default = http://example.com:3128/
120
121=item B<http_proxy>
122
123 Nature: Optional
124 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.
125 Value: string indicating the proxy to use
126 Conffile: pb
127 Example: http_proxy default = http://example.com:3128/
128
129=item B<logcmd>
130
131 Nature: Mandatory
132 Key: project (as defined in the -p option or PBPROJ environment variable)
133 Value: internal (the application then handles the logging of what it finds useful) or the name of an application to launch to log context (e.g. sos, cfg2html, ...).
134 Conffile: pb
135 Example: logcmd pbmkbm = sos
136
137=item B<logcmds>
138
139 Nature: Optional
140 Key: project (as defined in the -p option or PBPROJ environment variable)
141 Value: In case the B<logcmd> command is internal, a comma separated list of the commands whose trace execution is to be captured in order to log context.
142 Conffile: pb
143 Example: logcmds pbmkbm = mount,lsmod,esxcfg-module -l,df -T
144
145=item B<logfiles>
146
147 Nature: Optional
148 Key: project (as defined in the -p option or PBPROJ environment variable)
149 Value: In case the B<logcmd> command is internal, a comma separated list of the files to capture in order to log context.
150 Conffile: pb
151 Example: logfiles pbmkbm = /etc/raidtab,/proc/cmdline,/proc/swaps
152
153=item B<logopt>
154
155 Nature: Optional
156 Key: project (as defined in the -p option or PBPROJ environment variable)
157 Value: In case the B<logcmd> command is not internal, the options of the B<logcmd> application to launch to log context
158 Conffile: pb
159 Example: logcmd pbmkbm = --all
160
161=item B<mkbmbootcmds>
162
163 Nature: Mandatory
164 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.
165 Value: comma separated list of commands to be copied from the original OS to the target boot media tree (works recursively for directory creation on the target). Their actual path is deduced from the PATH variable.
166 Conffile: pb
167 Example: mkbmbootcmds linux = perl,awk,gawk,dd,grep,uname
168
169=item B<mkbmbootdirs>
170
171 Nature: Mandatory
172 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.
173 Value: comma separated list of directories to be copied from the original OS to the target boot media tree (works recursively on the target).
174 Conffile: pb
175 Example: mkbmbootdirs linux = /etc/ssh,/etc/udev,/etc/mdadm
176
177=item B<mkbmbootfiles>
178
179 Nature: Mandatory
180 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.
181 Value: comma separated list of files to be copied from the original OS to the target boot media tree (works recursively for directory creation on the target).
182 Conffile: pb
183 Example: mkbmbootfiles linux = /etc/mdadm.conf,/etc/raidtab,/etc/modprobe.conf
184
185=item B<mkbmkerneldir>
186
187 Nature: Mandatory
188 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.
189 Value: path of the directory containing your kernel.
190 Conffile: pb
191 Example: mkbmkerneldir linux = /boot
192
193=item B<mkbmkernelfile>
194
195 Nature: Optional
196 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.
197 Value: full path of the your kernel.
198 Conffile: pb
199 Example: mkbmkernelfile linux = /boot/vmlinuz-specific
200
201=item B<mkbmkernelnamere>
202
203 Nature: Mandatory
204 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.
205 Value: Perl Regular Expression allowing to find OS kernel names in the B<kerneldir> directory.
206 Conffile: pb
207 Example: mkbmkerneldir linux = ^linu|^vmlinu|^xen
208
209=item B<mkbmpath>
210
211 Nature: Mandatory
212 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.
213 Value: path of the temporary directory into which the boot media is created.
214 Conffile: pb
215 Example: mkbmpath default = /var/cache/pbmkbm
216
217=item B<mkbmtargetdirs>
218
219 Nature: Mandatory
220 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.
221 Value: comma separated list of empty directory paths to be created on the target boot media.
222 Conffile: pb
223 Example: mkbmtargetdirs linux = /tmp,/dev
224
225=item B<namingtype>
226
227 Nature: Optional
228 Key: package (as provided in defpkgdir or extpkgdir)
229 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)
230 Conffile: project
231 Example: namingtype ProjectBuilder = perl
232
233=item B<osambiguous>
234
235 Nature: Optional
236 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.
237 Value: comma 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>
238 Conffile: pb
239 Example: osambiguous debian = debian,ubuntu
240
241=item B<oschkcmd>
242
243 Nature: Optional
244 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
245 Value: package checker tool.
246 Conffile: pb
247 Example: oschkcmd deb = /usr/bin/lintian
248
249=item B<oschkopt>
250
251 Nature: Optional
252 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
253 Value: package checker tool options.
254 Conffile: pb
255 Example: oschkcmd rpm = -i
256
257=item B<oscmd>
258
259 Nature: Mandatory
260 Key: tool (pb or rpmbootstrap)
261 Value: come separated list of commands that are mandatory on the underlying system
262 Conffile: pb
263 Example: oscmd pb = tar,ls
264
265=item B<oscmdopt>
266
267 Nature: Mandatory
268 Key: tool (pb or rpmbootstrap)
269 Value: come separated list of commands that are optional on the underlying system
270 Conffile: pb
271 Example: oscmd pb = svn2cl,svn,cvs
272
273=item B<oscodename>
274
275 Nature: Optional
276 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.
277 Value: code name. Mostly useful for debian and ubuntu, due to debootstrap.
278 Conffile: pb
279 Example: oscodename debian-5.0 = lenny
280
281=item B<osfamily>
282
283 Nature: Mandatory
284 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.
285 Value: OS family name (used to group similar distribution for handling)
286 Conffile: pb
287 Example: osfamily debian = du
288
289=item B<osins>
290
291 Nature: Optional
292 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.
293 Value: OS command to lauch in order to automatically install packages on it.
294 Conffile: pb
295 Example: osins fedora = sudo yum -y install
296
297=item B<osmindep>
298
299 Nature: Optional
300 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.
301 Value: comma separated list of packages needed before setupvm|ve can be run. Install them with your distribution in VM or automatically in VE when possible.
302 Conffile: pb
303 Example: osmindep default = perl,sudo,wget,tar,make,gzip
304
305=item B<osnover>
306
307 Nature: Optional
308 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
309 Value: true|false. True means that this OS has no need to keep the version
310 Conffile: pb
311 Example: osnover gentoo = true
312
313=item B<ospatchcmd>
314
315 Nature: Optional
316 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
317 Value: package patch command. For RPM is implicit.
318 Conffile: pb
319 Example: ospatchcmd deb = /usr/bin/patch
320
321=item B<ospatchopt>
322
323 Nature: Optional
324 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
325 Value: package patch options.
326 Conffile: pb
327 Example: ospatchcmd deb = -s -p1
328
329=item B<ospathcmd-*>
330
331 Nature: Optional
332 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
333 Value: Full path name of the command mentioned after the '-' for the relative OS
334 Conffile: pb
335 Example: ospathcmd-halt solaris = /usr/sbin/halt, ospathcmd-halt default = /sbin/halt
336
337=item B<osperldep>
338
339 Nature: Optional
340 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
341 Value: comma 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.
342 Conffile: pb
343 Example: osperldep rhel-5 = Module-Build,File-MimeInfo,File-BaseDir,Mail-Sendmail
344
345=item B<osperlver>
346
347 Nature: Mandatory (for each module mentioned in B<osperldep>)
348 Key: Perl Module (as defined in B<osperldep>)
349 Value: Version of the perl module that needs to be found on CPAN.
350 Conffile: pb
351 Example: Date-Manip = 5.54
352
353=item B<ospkg>
354
355 Nature: Optional (Mandatory if pbinstalltype is pkg)
356 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
357 Value: comma separated list of packages that have to be installed in order for pb to be operational in the VE|VM
358 Conffile: pb
359 Example: ospkg rhel-5 = project-builder
360
361=item B<ospkgdep>
362
363 Nature: Optional
364 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
365 Value: comma 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.
366 Conffile: pb
367 Example: ospkgdep rhel-5 = wget,make,ntp,patch,perl-DateManip
368
369=item B<osrelambfile>
370
371 Nature: Mandatory (per OS mentioned in B<osambiguous>)
372 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.
373 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.
374 Conffile: pb
375 Example: osrelambfile debian = /etc/debian_version
376
377=item B<osrelexpr>
378
379 Nature: Mandatory (per OS mentioned in B<osrelambfile> and B<osrelfile>)
380 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
381 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)
382 Conffile: pb
383osrelexpr rhel = Red Hat (?:Enterprise Linux|Linux Advanced Server) .*release ([0-9.]+).* \(
384 Example:
385
386=item B<osrelfile>
387
388 Nature: Mandatory
389 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.
390 Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name.
391 Conffile: pb
392 Example: osrelfile fedora = /etc/fedora-release
393
394=item B<osremovedotinver>
395
396 Nature: Optional
397 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
398 Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS.
399 Conffile: pb
400 Example: osremovedotinver redhat = true
401
402=item B<osrepo>
403
404 Nature: Optional (Mandatory if pbinstalltype is pkg)
405 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
406 Value: comma separated list of packages, yum repo or apt sources.list files to be added to the VE|VM to support package installation of pb
407 Conffile: pb
408 Example: osrepo rpm = ftp://ftp.project-builder.org/$ddir/$dver/pb.repo
409
410=item B<ossha>
411
412 Nature: Optional (Mandatory if rpm type of package)
413 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
414 Value: sha algorithm used br createrepo
415 Conffile: pb
416 Example: ossha fedora-10 = sha1
417
418=item B<ossuffix>
419
420 Nature: Optional
421 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
422 Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
423 Conffile: pb
424 Example: ossuffix mandriva = mdv
425
426=item B<ostype>
427
428 Nature: Mandatory
429 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.
430 Value: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type.
431 Conffile: pb
432 Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
433
434=item B<osupd>
435
436 Nature: Optional
437 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.
438 Value: OS command to lauch in order to automatically update th VM|VE
439 Conffile: pb
440 Example: osupd fedora = sudo yum -y update
441
442=item B<pbconfurl>
443
444 Nature: Mandatory
445 Key: project (as defined in the -p option or PBPROJ environment variable)
446 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
447 Conffile: home|project
448 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
449
450=item B<pbdefdir>
451
452 Nature: Optional
453 Key: project (as defined in the -p option or PBPROJ environment variable)
454 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.
455 Conffile: home
456 Example: pbdefdir default = $ENV{'HOME'}/local/pb/projects
457
458=item B<pbinstalltype>
459
460 Nature: Mandatory
461 Key: project (as defined in the -p option or PBPROJ environment variable)
462 Value: file or pkg. Indicates how pb will be installed during the setupve|vm phase in the virtual environment|machine, using CPAN files or upstream packages. Only the dev team needs to use file as packages do not yet exist for it. Or when no repository exists to pull project-builder.org from.
463 Conffile: pb
464
465=item B<pbml>
466
467 Nature: Optional (Mandatory if using announce command)
468 Key: project (as defined in the -p option or PBPROJ environment variable)
469 Value: white space separated list of e-mail adresses used to send announces with the pb announce option.
470 Conffile: project
471 Example: pbml pb = pb-announce@project-builder.org pb-devel@project-builder.org
472
473=item B<pbpackager>
474
475 Nature: Mandatory
476 Key: project (as defined in the -p option or PBPROJ environment variable)
477 Value: Firstname Name and e-mail address of the person packaging the software.
478 Conffile: project
479 Example: pbpackager pb = Bruno Cornec <bruno@project-builder.org>
480
481=item B<pbparallel>
482
483 Nature: Optional
484 Key: tool (pb or rpmbootstrap)
485 Value: number of processes to execute in parallel. By default use the number of cores.
486 Conffile: pb
487 Example: pbparallel pb = 12
488
489=item B<pbpassfile>
490
491 Nature: Optional
492 Key: project (as defined in the -p option or PBPROJ environment variable)
493 Value: File containing the GPG passphrase that is used to sign packages
494 Conffile: home
495 Example: pbpassfile pb = /users/me/secret/passfile
496
497=item B<pbpasspath>
498
499 Nature: Optional
500 Key: project (as defined in the -p option or PBPROJ environment variable)
501 Value: The directory under which will be found your secret key file.
502 Conffile: home
503 Example: pbpasspath pb = /home/me/.gnupg
504
505=item B<pbpassphrase>
506
507 Nature: Optional
508 Key: project (as defined in the -p option or PBPROJ environment variable)
509 Value: The GPG passphrase that is used to sign packages. Putting it in your conf file has security implications.
510 Conffile: home
511 Example: pbpassphrase pb = TheSecretPassPhrase
512
513=item B<pbprojdir>
514
515 Nature: Optional
516 Key: project (as defined in the -p option or PBPROJ environment variable)
517 Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname
518 Conffile: home
519 Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue
520
521=item B<pbrepo>
522
523 Nature: Mandatory
524 Key: project (as defined in the -p option or PBPROJ environment variable)
525 Value: URL of the server hosting the upstream tar file.
526 Conffile: project
527 Example: pbrepo mondorescue = ftp://ftp.mondorescue.org
528
529=item B<pbsmtp>
530
531 Nature: Optional (Mandatory if using the announce command)
532 Key: project (as defined in the -p option or PBPROJ environment variable)
533 Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here.
534 Conffile: home
535 Example: pbsmtp mondorescue = localhost
536
537=item B<pbsockscmd>
538
539 Nature: Optional
540 Key: project (as defined in the -p option or PBPROJ environment variable)
541 Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here.
542 Conffile: home
543 Example: pbsockscmd default = tsocks
544
545=item B<pburl>
546
547 Nature: Optional
548 Key: project (as defined in the -p option or PBPROJ environment variable)
549 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
550 Conffile: home|project
551 Example: pburl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pburl pb = svk:////local/pb
552
553=item B<pbwf>
554
555 Nature: Optional
556 Key: project (as defined in the -p option or PBPROJ environment variable)
557 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.
558 Conffile: project
559 Example: pbwf afio = 1
560
561=item B<pkgtag>
562
563 Nature: Optional
564 Key: package (as provided in defpkgdir or extpkgdir)
565 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).
566 Conffile: project
567 Example: pkgtag mindi-busybox = 2
568
569=item B<pkgver>
570
571 Nature: Optional
572 Key: package (as provided in defpkgdir or extpkgdir)
573 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>.
574 Conffile: project
575 Example: pkgver mindi-busybox = 1.7.3
576
577=item B<projtag>
578
579 Nature: Mandatory
580 Key: project (as defined in the -p option or PBPROJ environment variable)
581 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>.
582 Conffile: project
583 Example: projtag mondorescue = 1
584
585=item B<projver>
586
587 Nature: Mandatory
588 Key: project (as defined in the -p option or PBPROJ environment variable)
589 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>.
590 Conffile: project
591 Example: projver mondorescue = 2.2.9
592
593=item B<rbsconf>
594
595 Nature: Optional
596 Key: project (as defined in the -p option or PBPROJ environment variable)
597 Value: for mock it's the configuration directory. For rinse it's its configuration file. For rpmbootstrap it's not used yet.
598 Conffile: ve
599 Example: rbsconf default = /etc/mock, rbsconf default = /etc/pb/pb-rinse.conf
600
601=item B<rbsb4pi>
602
603 Nature: Optional
604 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.
605 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.
606 Conffile: ve
607 Example: rbsb4pi centos = /home/rinse/bin/before-post-install.sh
608
609=item B<rbsmirrorsrv>
610
611 Nature: Optional
612 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.
613 Value: URL for the mirror server for setting up a virtual environment
614 Conffile: ve
615 Example: rbsmirrorsrv debian = http://mirrors1.kernel.org/
616
617=item B<rbsopt>
618
619 Nature: Optional
620 Key: tool used for rpm based VE. Could be one of rpmbootstrap, rinse, mock, ...
621 Value: Additional option to pass to the command
622 Conffile: ve
623 Example: rbsopt rpmbootstrap = -k
624
625=item B<rbspi>
626
627 Nature: Optional
628 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.
629 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.
630 Conffile: ve
631 Example: rbspi centos = /home/rinse/bin/post-install.sh
632
633=item B<rmhost>
634
635 Nature: Mandatory
636 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.
637 Value: IP address or name of the Remote Machine running the OS mentioned in the key, accessed through ssh.
638 Conffile: rm
639 Example: rmhost default = localhost - rmhost hpux-11.3-ia64 = 10.10.10.10 - rmhost mandriva-2010.2-x86_64 = machine1.domain.name
640
641=item B<rmlist>
642
643 Nature: Mandatory
644 Key: project (as defined in the -p option or PBPROJ environment variable)
645 Value: list of comma separated OS (under the form of os-ver-arch). The corresponding machines running these distributions are given in the rmpool parameter.
646 Conffile: rm
647 Example: rmlist default = mandriva-2010.2-i386,fedora-14-i386,rhel-6-i386,rhel-5-i386,pensuse-11.3-i386,sles-11-i386,gentoo-nover-i386,debian-5.0-i386,ubuntu-10.10-i386,solaris-10-i386,mandriva-2010.2-x86_64,fedora-14-x86_64,rhel-6-x86_64,rhel-5-x86_64,opensuse-11.3-x86_64,sles-11-x86_64,gentoo-nover-x86_64,debian-5.0-x86_64,ubuntu-10.10-x86_64,solaris-10-x86_64,hp-ux-11.3-ia64,rhel-5-ia64
648
649=item B<rmlogin>
650
651 Nature: Mandatory
652 Key: project (as defined in the -p option or PBPROJ environment variable)
653 Value: account name to use on the Remote Machine to build packages. Communication is done with ssh.
654 Conffile: rm
655 Example: rmlogin default = pb
656
657=item B<rmmonport>
658
659 Nature: Optional
660 Key: project (as defined in the -p option or PBPROJ environment variable)
661 Value: TCP port that is used to dialog with the monitor of the Remote Machine, to pass orders.
662 Conffile: rm
663 Example: rmmonport default = 4444
664
665=item B<rmntp>
666
667 Nature: Optional
668 Key: project (as defined in the -p option or PBPROJ environment variable)
669 Value: NTP server to contact for time accuracy with B<rmntpcmd> before building.
670 Conffile: rm
671 Example: rmntp default = 1.pool.ntp.org
672
673=item B<rmntpcmd>
674
675 Nature: Mandatory
676 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
677 Value: NTP command to use to perform time synchronization with the B<rmntp> server. Use full path name, as this command will be used in the sudoers file to allow its launch by root.
678 Conffile: rm
679 Example: rmntpcmd default = /usr/sbin/ntpdate,rmntpcmd opensuse-10.1-i386 = /usr/sbin/sntp -P no -r
680
681=item B<rmpath>
682
683 Nature: Mandatory
684 Key: project (as defined in the -p option or PBPROJ environment variable)
685 Value: path where to find configuration file for Remote Machines management.
686 Conffile: rm
687 Example: rmpath default = /home/remote
688
689=item B<rmport>
690
691 Nature: Mandatory
692 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
693 Value: port number to use to communicate with the RM using the SSH protocol. This localport is redirected to the port 22 of the RM.
694 Conffile: rm
695 Example: rmport pb = 2222,rmport mondorescue = 2223
696
697=item B<rmtmout>
698
699 Nature: Optional
700 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.
701 Value: Time in seconds to wait before interacting with the RM. This may correspond to the time the RM takes to boot.
702 Conffile: rm
703 Example: rmtmout default = 10
704
705=item B<rmtype>
706
707 Nature: Mandatory
708 Key: project (as defined in the -p option or PBPROJ environment variable)
709 Value: ssh. For the moment, only ssh is supported as a communication means with RM.
710 Conffile: rm
711 Example: rmrtype default = ssh
712
713=item B<sshdir>
714
715 Nature: Mandatory
716 Key: project (as defined in the -p option or PBPROJ environment variable)
717 Value: dirname into which packages are uploaded on the B<sshhost> machine.
718 Conffile: project
719 Example: sshdir mondorescue = /pub/mondorescue
720
721=item B<sshhost>
722
723 Nature: Mandatory
724 Key: project (as defined in the -p option or PBPROJ environment variable)
725 Value: hostname to connect to in order to deliver packages to the repository server.
726 Conffile: project
727 Example: sshhost mondorescue = ftp.mondorescue.org
728
729=item B<sshlogin>
730
731 Nature: Optional
732 Key: project (as defined in the -p option or PBPROJ environment variable)
733 Value: login to use when connecting to the repository server B<sshhost> for package delivery. whoami result by default
734 Conffile: project
735 Example: sshlogin mondorescue = mylogin
736
737=item B<sshport>
738
739 Nature: Optional
740 Key: project (as defined in the -p option or PBPROJ environment variable)
741 Value: port to use when connecting to the repository server B<sshhost> for package delivery. 22 by default.
742 Conffile: project
743 Example: sshport mondorescue = 22
744
745=item B<supfiles>
746
747Not used yet.
748
749=item B<testver>
750
751 Nature: Optional
752 Key: project (as defined in the -p option or PBPROJ environment variable)
753 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.
754 Conffile: project
755 Example: testver mondorescue = true
756
757=item B<vedebtype>
758
759 Nature: Mandatory
760 Key: project (as defined in the -p option or PBPROJ environment variable)
761 Value: debootstrap (no other tool to create deb distro based chroot)
762 Conffile: ve
763 Example: vedebtype default = debootstrap
764
765=item B<velist>
766
767 Nature: Mandatory
768 Key: project (as defined in the -p option or PBPROJ environment variable)
769 Value: list of comma separated OS (under the form of os-ver-arch).
770 Conffile: ve
771 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
772
773=item B<velogin>
774
775 Nature: Mandatory
776 Key: project (as defined in the -p option or PBPROJ environment variable)
777 Value: account name to use in the VE to build packages.
778 Conffile: ve
779 Example: velogin default = pb
780
781=item B<ventp>
782
783 Nature: Optional
784 Key: project (as defined in the -p option or PBPROJ environment variable)
785 Value: NTP server to contact for time accuracy with B<ventpcmd> before building.
786 Conffile: ve
787 Example: ventp default = 1.pool.ntp.org
788
789=item B<ventpcmd>
790
791 Nature: Mandatory
792 Key: project (as defined in the -p option or PBPROJ environment variable)
793 Value: NTP command to use to perform time synchronization with the B<ventp> server. Use full path name, as this command will be used in the sudoers file to allow its launch by root.
794 Conffile: ve
795 Example: ventpcmd default = /usr/sbin/ntpdate
796
797=item B<vepath>
798
799 Nature: Mandatory
800 Key: project (as defined in the -p option or PBPROJ environment variable)
801 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.
802 Conffile: ve
803 Example: vepath default = /home/rpmbootstrap
804
805=item B<verebuild>
806
807 Nature: Optional
808 Key: project (as defined in the -p option or PBPROJ environment variable)
809 Value: true|false. True means that the VE should be rebuild before usage.
810 Conffile: ve
811 Example: verebuild default = true
812
813=item B<verpmtype>
814
815 Nature: Mandatory
816 Key: project (as defined in the -p option or PBPROJ environment variable)
817 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).
818 Conffile: ve
819 Example: verpmtype default = rpmbootstrap
820
821=item B<vesnap>
822
823 Nature: Optional
824 Key: project (as defined in the -p option or PBPROJ environment variable)
825 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.
826 Conffile: ve
827 Example: vesnap default = true
828
829=item B<vetype>
830
831 Nature: Mandatory
832 Key: project (as defined in the -p option or PBPROJ environment variable)
833 Value: chroot|schroot. There are two different ways of launching a chroot activity in pb. For the moment only chroot has been tested.
834 Conffile: ve
835 Example: vertype default = chroot
836
837=item B<vmbuildtm>
838
839 Nature: Optional
840 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). Default value is set to vmtmout
841 Value: Time in seconds to wait before killing the VM if SSH port already used. This should corresponds to the time to send files, build the project and get packages in the VM.
842 Conffile: project
843 Example: vmbuildtm default = 600,vmbuildtm mandriva-2009.0-x86_64 = 1200
844
845=item B<vmcmd>
846
847 Nature: Mandatory
848 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.
849 Value: Command to call to launch the VM emulator.  It can contain some options. Another way to pass options to the VM manager command launcher is by using the PBVMOPT environment variable, which comes in addition to the option vmopt.
850 Conffile: vm
851 Example: vmcmd default = /usr/bin/kvm
852
853=item B<vmhost>
854
855 Nature: Mandatory
856 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
857 Value: hostname to connect to in order to reach the VM through ssh. Generally redirected from a port on localhost.
858 Conffile: vm
859 Example: vmhost default = localhost
860
861=item B<vmlist>
862
863 Nature: Mandatory
864 Key: project (as defined in the -p option or PBPROJ environment variable)
865 Value: list of comma separated OS (under the form of os-ver-arch).
866 Conffile: vm
867 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
868
869=item B<vmlogin>
870
871 Nature: Mandatory
872 Key: project (as defined in the -p option or PBPROJ environment variable)
873 Value: account name to use in the VM to build packages. Communication is done with ssh.
874 Conffile: vm
875 Example: vmlogin default = pb
876
877=item B<vmmem>
878
879 Nature: Optional
880 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
881 Value: Memory size in MB to allocate to the VM.
882 Conffile: vm
883 Example: vmmem default = 512
884
885=item B<vmmonport>
886
887 Nature: Optional
888 Key: project (as defined in the -p option or PBPROJ environment variable)
889 Value: TCP port that is used to dialog with the monitor of the VM, to pass orders such as snapshot. Not really operational yet.
890 Conffile: vm
891 Example: vmmonport default = 4444
892
893=item B<vmntp>
894
895 Nature: Optional
896 Key: project (as defined in the -p option or PBPROJ environment variable)
897 Value: NTP server to contact for time accuracy with B<vmntpcmd> before building.
898 Conffile: vm
899 Example: vmntp default = 1.pool.ntp.org
900
901=item B<vmntpcmd>
902
903 Nature: Mandatory
904 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
905 Value: NTP command to use to perform time synchronization with the B<vmntp> server. Use full path name, as this command will be used in the sudoers file to allow its launch by root.
906 Conffile: vm
907 Example: vmntpcmd default = /usr/sbin/ntpdate,vmntpcmd opensuse-11.0-i386 = /usr/sbin/sntp -P no -r
908
909=item B<vmopt>
910
911 Nature: Optional
912 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.
913 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.
914 Conffile: vm
915 Example: vmopt default = -m 384 -daemonize,vmopt mandriva-2009.0-i386 = -m 256 -daemonize -no-kvm
916
917=item B<vmpath>
918
919 Nature: Mandatory
920 Key: project (as defined in the -p option or PBPROJ environment variable)
921 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.
922 Conffile: vm
923 Example: vmpath default = /home/qemu
924
925=item B<vmport>
926
927 Nature: Mandatory
928 Key: project (as defined in the -p option or PBPROJ environment variable)
929 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.
930 Conffile: vm
931 Example: vmport pb = 2222,vmport mondorescue = 2223
932
933=item B<vmsize>
934
935 Nature: Mandatory
936 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
937 Value: Size of the VM to create when using the newvm command of pb.
938 Conffile: vm
939 Example: vmsize default = 7G
940
941=item B<vmsnap>
942
943 Nature: Optional
944 Key: project (as defined in the -p option or PBPROJ environment variable)
945 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.
946 Conffile: vm
947 Example: vmsnap default = true
948
949=item B<vmtmout>
950
951 Nature: Optional
952 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.
953 Value: Time in seconds to wait before interacting with the VM. This should correspond to the time the VM takes to boot.
954 Conffile: vm
955 Example: vmtmout default = 180,vmtmout mandriva-2009.0-x86_64 = 500
956
957=item B<vmtype>
958
959 Nature: Mandatory
960 Key: project (as defined in the -p option or PBPROJ environment variable)
961 Value: qemu|kvm. For the moment, only QEMU or KVM are supported as virtualization technologies.
962 Conffile: vm
963 Example: vmrtype default = kvm
964
965=item B<webdir>
966
967 Nature: Optional
968 Key: project (as defined in the -p option or PBPROJ environment variable)
969 Value: Target directory containing the web content in the project that should be delivered when using the sbx|cms2webssh|pkg command of pb.
970 Conffile: project
971 Example: webdir mondorescue = website
972
973=item B<websshdir>
974
975 Nature: Optional (when not using *2webssh commands)
976 Key: project (as defined in the -p option or PBPROJ environment variable)
977 Value: dirname into which content is uploaded on the B<websshhost> machine.
978 Conffile: project
979 Example: websshdir mondorescue = /var/www/html
980
981=item B<websshhost>
982
983 Nature: Optional (when not using *2webssh commands)
984 Key: project (as defined in the -p option or PBPROJ environment variable)
985 Value: hostname to connect to in order to deliver content to the Web server.
986 Conffile: project
987 Example: websshhost mondorescue = www.mondorescue.org
988
989=item B<websshlogin>
990
991 Nature: Optional (when not using *2webssh commands)
992 Key: project (as defined in the -p option or PBPROJ environment variable)
993 Value: login to use when connecting to the Web server B<websshhost> for content delivery.
994 Conffile: project
995 Example: websshlogin mondorescue = mylogin
996
997=item B<websshport>
998
999 Nature: Optional (when not using *2webssh commands)
1000 Key: project (as defined in the -p option or PBPROJ environment variable)
1001 Value: port to use when connecting to the Web server B<websshhost> for content delivery.
1002 Conffile: project
1003 Example: websshport mondorescue = 22
1004
1005=back
1006
1007=head1 OTHER PARAMETERS
1008=item B<pb_URL>
1009=item B<pb_directory_desc>
1010=item B<pb_environment_variables>
Note: See TracBrowser for help on using the repository browser.