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

Last change on this file was 2241, checked in by bruno, 3 weeks ago

revert last commit as this is not ready yet for integration in that tree !

File size: 46.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 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<addrepo>
26
27 Nature: Optional
28 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.
29 Value: comma separated list of URLs that point to repository files, or packages to install. The values may not include substitutions.
30 Conffile: project
31 Example: addrepo centos-5-x86_64 = file:///prj/extras.repo,http://mirror.centos.org/centos/5.8/extras/x86_64/RPMS/chrpath-0.13-3.el5.centos.x86_64.rpm
32
33=item B<cachedir>
34
35 Nature: Optional
36 Key: pb project: rpmbootstrap|pbmkbm|pb
37 Value: Directory to cache temporary content for the relevant pb project.
38 Conffile: pb
39 Example: cachedir rpbootstrap = /var/cache/rpmbootstrap
40
41=item B<checkexclude>
42
43 Nature: Optional
44 Key: package (as provided in defpkgdir or extpkgdir)
45 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.
46 Conffile: project
47 Example: checkexclude pkg1 = centos,lsb,solaris
48
49=item B<cpandir>
50
51 Nature: Optional
52 Key: project (as defined in the -p option or PBPROJ environment variable)
53 Value: CPAN Pause directory to upload new modules
54 Conffile: pb
55 Example: cpandir default = incoming
56
57=item B<cpanpasswd>
58
59 Nature: Optional
60 Key: project (as defined in the -p option or PBPROJ environment variable)
61 Value: CPAN Pause user's password
62 Conffile: home
63 Example: cpanpasswd default = mycomplicatedpwd
64
65=item B<cpanpause>
66
67 Nature: Optional
68 Key: project (as defined in the -p option or PBPROJ environment variable)
69 Value: CPAN Pause site to upload new modules
70 Conffile: pb
71 Example: cpanpause default = pause.perl.org
72
73=item B<cpansubdir>
74
75 Nature: Optional
76 Key: project (as defined in the -p option or PBPROJ environment variable)
77 Value: CPAN Pause subdirectory in the user's area to upload into
78 Conffile: pb
79 Example: cpansubdir default = mydir
80
81=item B<cpanurl>
82
83 Nature: Optional
84 Key: project (as defined in the -p option or PBPROJ environment variable)
85 Value: CPAN Pause URL to activate the upload mecanism
86 Conffile: pb
87 Example: cpanurl default = http://pause.perl.org/pause/authenquery
88
89=item B<cpanuser>
90
91 Nature: Optional
92 Key: project (as defined in the -p option or PBPROJ environment variable)
93 Value: CPAN Pause user
94 Conffile: home
95 Example: cpanuser default = XXX
96
97=item B<defpkgdir>
98
99 Nature: Mandatory
100 Key: project (as defined in the -p option or PBPROJ environment variable)
101 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.
102 Conffile: project
103 Example: defpkgdir mondorescue = mondo,mindi NB: a default value is not really meaningful.
104
105=item B<delivery>
106
107 Nature: Optional
108 Key: project (as defined in the -p option or PBPROJ environment variable)
109 Value: directory where to deliver packages once built for ftp/web access.
110 Conffile: project
111 Example: delivery mondorescue = prod
112
113=item B<dockeropt>
114
115 Nature: Optional
116 Key: project (as defined in the -p option or PBPROJ environment variable)
117 Value: List of the options to call docker with
118 Conffile: project
119 Example: dockeropt default = --bip=172.16.42.1/16
120
121=item B<dockerregistry>
122
123 Nature: Optional
124 Key: project (as defined in the -p option or PBPROJ environment variable)
125 Value: name of the docker registry to interact with if any
126 Conffile: project
127 Example: dockerregistry mondorescue = localhost:5900/mondorescue
128
129=item B<dockerrepository>
130
131 Nature: Optional
132 Key: project (as defined in the -p option or PBPROJ environment variable)
133 Value: name of the docker repository to interact with if any. It is mandatory if no dockerregistry is defined.
134 Conffile: project
135 Example: dockerrepository mondorescue = localhost:5000/mondorescue
136
137=item B<extpkgdir>
138
139 Nature: Optional
140 Key: project (as defined in the -p option or PBPROJ environment variable)
141 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.
142 Conffile: project
143 Example: extpkgdir mondorescue = mondo-doc,mindi-mindibusybox
144
145=item B<filteredfiles>
146
147 Nature: Optional
148 Key: package (as provided in defpkgdir or extpkgdir)
149 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.
150 Conffile: project
151 Example: filteredfiles mindi = rootfs/sbin/init,mindi,install.sh,doc/mindi.8
152
153=item B<ftp_proxy>
154
155 Nature: Optional
156 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.
157 Value: string indicating the proxy to use
158 Conffile: pb
159 Example: ftp_proxy default = http://example.com:3128/
160
161=item B<http_proxy>
162
163 Nature: Optional
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: string indicating the proxy to use
166 Conffile: pb
167 Example: http_proxy default = http://example.com:3128/
168
169=item B<https_proxy>
170
171 Nature: Optional
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: string indicating the proxy to use
174 Conffile: pb
175 Example: https_proxy default = http://example.com:3128/
176
177=item B<logcmd>
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: 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, ...).
182 Conffile: pb
183 Example: logcmd mageia = sos
184
185=item B<logcmds>
186
187 Nature: Optional
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: 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.
190 Conffile: pb
191 Example: logcmds mageia = mount,lsmod,esxcfg-module -l,df -T
192
193=item B<logfiles>
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: In case the B<logcmd> command is internal, a comma separated list of the files to capture in order to log context.
198 Conffile: pb
199 Example: logfiles mageia = /etc/raidtab,/proc/cmdline,/proc/swaps
200
201=item B<logopt>
202
203 Nature: Optional
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: In case the B<logcmd> command is not internal, the options of the B<logcmd> application to launch to log context
206 Conffile: pb
207 Example: logopt mageia = --all
208
209=item B<mkbmbootcmds>
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: 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.
214 Conffile: pb
215 Example: mkbmbootcmds linux = perl,awk,gawk,dd,grep,uname
216
217=item B<mkbmbootdirs>
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 directories to be copied from the original OS to the target boot media tree (works recursively on the target).
222 Conffile: pb
223 Example: mkbmbootdirs linux = /etc/ssh,/etc/udev,/etc/mdadm
224
225=item B<mkbmbootfiles>
226
227 Nature: Mandatory
228 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.
229 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).
230 Conffile: pb
231 Example: mkbmbootfiles linux = /etc/mdadm.conf,/etc/raidtab,/etc/modprobe.conf
232
233=item B<mkbmkerneldir>
234
235 Nature: Mandatory
236 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.
237 Value: path of the directory containing your kernel.
238 Conffile: pb
239 Example: mkbmkerneldir linux = /boot
240
241=item B<mkbmkernelfile>
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). The family name is generaly used here.
245 Value: full path of the your kernel.
246 Conffile: pb
247 Example: mkbmkernelfile linux = /boot/vmlinuz-specific
248
249=item B<mkbmkernelnamere>
250
251 Nature: Mandatory
252 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.
253 Value: Perl Regular Expression allowing to find OS kernel names in the B<kerneldir> directory.
254 Conffile: pb
255 Example: mkbmkerneldir linux = ^linu|^vmlinu|^xen
256
257=item B<mkbmtargetdirs>
258
259 Nature: Mandatory
260 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.
261 Value: comma separated list of empty directory paths to be created on the target boot media.
262 Conffile: pb
263 Example: mkbmtargetdirs linux = /tmp,/dev
264
265=item B<namingtype>
266
267 Nature: Optional
268 Key: package (as provided in defpkgdir or extpkgdir)
269 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)
270 Conffile: project
271 Example: namingtype ProjectBuilder = perl
272
273=item B<osambiguous>
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 name.
277 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>
278 Conffile: pb
279 Example: osambiguous debian = debian,ubuntu
280
281=item B<oschkcmd>
282
283 Nature: Optional
284 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
285 Value: package checker tool.
286 Conffile: pb
287 Example: oschkcmd deb = /usr/bin/lintian
288
289=item B<oschkopt>
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).
293 Value: package checker tool options.
294 Conffile: pb
295 Example: oschkcmd rpm = -i
296
297=item B<oscmd>
298
299 Nature: Mandatory
300 Key: tool (pb or rpmbootstrap)
301 Value: come separated list of commands that are mandatory on the underlying system
302 Conffile: pb
303 Example: oscmd pb = tar,ls
304
305=item B<oscmdopt>
306
307 Nature: Mandatory
308 Key: tool (pb or rpmbootstrap)
309 Value: come separated list of commands that are optional on the underlying system
310 Conffile: pb
311 Example: oscmd pb = svn2cl,svn,cvs
312
313=item B<oscodename>
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). In that case, should be an os-ver.
317 Value: code name. Mostly useful for debian and ubuntu, due to debootstrap.
318 Conffile: pb
319 Example: oscodename debian-5.0 = lenny
320
321=item B<osfamily>
322
323 Nature: Mandatory
324 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.
325 Value: OS family name (used to group similar distribution for handling)
326 Conffile: pb
327 Example: osfamily debian = du
328
329=item B<osins>
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). The family name is generaly used here.
333 Value: OS command to lauch in order to automatically install packages on it.
334 Conffile: pb
335 Example: osins fedora = sudo yum -y install
336
337=item B<osmindep>
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). NB: a default value is highly interesting here.
341 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.
342 Conffile: pb
343 Example: osmindep default = perl,sudo,wget,tar,make,gzip
344
345=item B<osnover>
346
347 Nature: Optional
348 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
349 Value: true|false. True means that this OS has no need to keep the version
350 Conffile: pb
351 Example: osnover gentoo = true
352
353=item B<ospatchcmd>
354
355 Nature: Optional
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: package patch command. For RPM is implicit.
358 Conffile: pb
359 Example: ospatchcmd deb = /usr/bin/patch
360
361=item B<ospatchopt>
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: package patch options.
366 Conffile: pb
367 Example: ospatchcmd deb = -s -p1
368
369=item B<ospathcmd-*>
370
371 Nature: Optional
372 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
373 Value: Full path name of the command mentioned after the '-' for the relative OS
374 Conffile: pb
375 Example: ospathcmd-halt solaris = /usr/sbin/halt, ospathcmd-halt default = /sbin/halt
376
377=item B<osperldep>
378
379 Nature: Optional
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: 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.
382 Conffile: pb
383 Example: osperldep rhel-5 = Module-Build,File-MimeInfo,File-BaseDir,Mail-Sendmail
384
385=item B<osperlver>
386
387 Nature: Mandatory (for each module mentioned in B<osperldep>)
388 Key: Perl Module (as defined in B<osperldep>)
389 Value: Version of the perl module that needs to be found on CPAN.
390 Conffile: pb
391 Example: Date-Manip = 5.54
392
393=item B<ospkg>
394
395 Nature: Optional (Mandatory if pbinstalltype is pkg)
396 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
397 Value: comma separated list of packages that have to be installed in order for pb to be operational in the VE|VM
398 Conffile: pb
399 Example: ospkg rhel-5 = project-builder
400
401=item B<ospkgdep>
402
403 Nature: Optional
404 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
405 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.
406 Conffile: pb
407 Example: ospkgdep rhel-5 = wget,make,ntp,patch,perl-DateManip
408
409=item B<osrelambfile>
410
411 Nature: Mandatory (per OS mentioned in B<osambiguous>)
412 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.
413 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.
414 Conffile: pb
415 Example: osrelambfile debian = /etc/debian_version
416
417=item B<osrelexpr>
418
419 Nature: Mandatory (per OS mentioned in B<osrelambfile> and B<osrelfile>)
420 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
421 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)
422 Conffile: pb
423osrelexpr rhel = Red Hat (?:Enterprise Linux|Linux Advanced Server) .*release ([0-9.]+).* \(
424 Example:
425
426=item B<osrelfile>
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). Should be the OS name here.
430 Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name.
431 Conffile: pb
432 Example: osrelfile fedora = /etc/fedora-release
433
434=item B<osremovedotinver>
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).
438 Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS.
439 Conffile: pb
440 Example: osremovedotinver redhat = true
441
442=item B<osrepo>
443
444 Nature: Optional (Mandatory if pbinstalltype is pkg)
445 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
446 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
447 Conffile: pb
448 Example: osrepo rpm = ftp://ftp.project-builder.org/$ddir/$dver/pb.repo
449
450=item B<ossha>
451
452 Nature: Optional (Mandatory if rpm type of package)
453 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
454 Value: sha algorithm used br createrepo
455 Conffile: pb
456 Example: ossha fedora-10 = sha1
457
458=item B<ossudoersmode>
459
460 Nature: Mandatory
461 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
462 Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
463 Conffile: pb
464 Example: ossudoersmode novell = 640
465
466=item B<ossuffix>
467
468 Nature: Optional
469 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
470 Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
471 Conffile: pb
472 Example: ossuffix mandriva = mdv
473
474=item B<ostype>
475
476 Nature: Mandatory
477 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.
478 Value: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type.
479 Conffile: pb
480 Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
481
482=item B<osupd>
483
484 Nature: Optional
485 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.
486 Value: OS command to lauch in order to automatically update th VM|VE
487 Conffile: pb
488 Example: osupd fedora = sudo yum -y update
489
490=item B<ossueminorrel>
491
492 Nature: Mandatory
493 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.
494 Value: Should that OS distinguish between its minor version, considering them as different versions or not. Typically for CentOS where .x versions make incompatible changes.
495 Conffile: pb
496 Example: ossueminorrel centos = true
497
498
499=item B<pbconfurl>
500
501 Nature: Mandatory
502 Key: project (as defined in the -p option or PBPROJ environment variable)
503 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
504 Conffile: home|project
505 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
506
507=item B<pbdefdir>
508
509 Nature: Optional
510 Key: project (as defined in the -p option or PBPROJ environment variable)
511 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.
512 Conffile: home
513 Example: pbdefdir default = $ENV{'HOME'}/local/pb/projects
514
515=item B<pbgpgcheck>
516
517 Nature: Optional
518 Key: project (as defined in the -p option or PBPROJ environment variable)
519 Value: Whether the repository file should be generated specifying that gpg checking of the packages is on. Note that failures to sign packages is tolerated by default, which means that signatures can fail making the repository file generated not work. The default is to require gpg checks (value is 1)
520 Conffile: project
521 Example: pbgpgcheck Lintel = 0
522
523=item B<pbinstalltype>
524
525 Nature: Mandatory
526 Key: project (as defined in the -p option or PBPROJ environment variable)
527 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.
528 Conffile: pb
529
530=item B<pbml>
531
532 Nature: Optional (Mandatory if using announce command)
533 Key: project (as defined in the -p option or PBPROJ environment variable)
534 Value: white space separated list of e-mail adresses used to send announces with the pb announce option.
535 Conffile: project
536 Example: pbml pb = pb-announce@project-builder.org pb-devel@project-builder.org
537
538=item B<pbpackager>
539
540 Nature: Mandatory
541 Key: project (as defined in the -p option or PBPROJ environment variable)
542 Value: Firstname Name and e-mail address of the person packaging the software.
543 Conffile: project
544 Example: pbpackager pb = Bruno Cornec <bruno@project-builder.org>
545
546=item B<pbparallel>
547
548 Nature: Optional
549 Key: tool (pb or rpmbootstrap)
550 Value: number of processes to execute in parallel. By default use the number of cores.
551 Conffile: pb
552 Example: pbparallel pb = 12
553
554=item B<pbpassfile>
555
556 Nature: Optional
557 Key: project (as defined in the -p option or PBPROJ environment variable)
558 Value: File containing the GPG passphrase that is used to sign packages
559 Conffile: home
560 Example: pbpassfile pb = /users/me/secret/passfile
561
562=item B<pbpasspath>
563
564 Nature: Optional
565 Key: project (as defined in the -p option or PBPROJ environment variable)
566 Value: The directory under which will be found your secret GPG key file.
567 Conffile: home
568 Example: pbpasspath pb = /home/me/.gnupg
569
570=item B<pbpassphrase>
571
572 Nature: Optional
573 Key: project (as defined in the -p option or PBPROJ environment variable)
574 Value: The GPG passphrase that is used to sign packages. Putting it in your conf file has security implications.
575 Conffile: home
576 Example: pbpassphrase pb = TheSecretPassPhrase
577
578=item B<pbpbr>
579
580 Nature: Optional
581 Key: project (as defined in the -p option or PBPROJ environment variable)
582 Value: whatever. As soon as this is defined, then that project is known as using pbr for source epansion.
583 Conffile: project
584 Example: pbpbr python-redfish = 1
585
586=item B<pbprojdir>
587
588 Nature: Optional
589 Key: project (as defined in the -p option or PBPROJ environment variable)
590 Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname
591 Conffile: home
592 Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue
593
594=item B<pbrepo>
595
596 Nature: Mandatory
597 Key: project (as defined in the -p option or PBPROJ environment variable)
598 Value: URL of the server hosting the upstream tar file.
599 Conffile: project
600 Example: pbrepo mondorescue = ftp://ftp.mondorescue.org
601
602=item B<pbshowsudo>
603
604 Nature: Optional
605 Key: project (as defined in the -p option or PBPROJ environment variable)
606 Value: false (by default), meaning that sudo commands executed with pb_system won't be shown in details, but that the associated comment will be used. For security cncerns, you may want to turn it to true in order to see what pb does with sudo to be safe. Turned on by debug flag.
607 Conffile: home
608 Example: pbshowsudo mondorescue = true
609
610=item B<pbsmtp>
611
612 Nature: Optional (Mandatory if using the announce command)
613 Key: project (as defined in the -p option or PBPROJ environment variable)
614 Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here.
615 Conffile: home
616 Example: pbsmtp mondorescue = localhost
617
618=item B<pbsockscmd>
619
620 Nature: Optional
621 Key: project (as defined in the -p option or PBPROJ environment variable)
622 Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here.
623 Conffile: home
624 Example: pbsockscmd default = tsocks
625
626=item B<pbstoponerr>
627
628 Nature: Optional
629 Key: project (as defined in the -p option or PBPROJ environment variable)
630 Value: false (by default), meaning that commands giving errors will not stop execution of the pb job. For quicker error solving, you may want to turn it to true in order to stop at the first error. Be aware that project-builder.org is not robust enough to work fully correctly with this on. Especially some commands may in a justified way error out, and you still want the process to go on.
631 Conffile: home
632 Example: pbstoponerr mondorescue = true
633
634
635=item B<pburl>
636
637 Nature: Optional
638 Key: project (as defined in the -p option or PBPROJ environment variable)
639 Value: B<pburl> 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
640 Conffile: home|project
641 Example: pburl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pburl pb = svk:////local/pb
642
643=item B<pbusesshagent>
644
645 Nature: Mandatory
646 Key: project (as defined in the -p option or PBPROJ environment variable)
647 Value: false means that you want pb to create a dedicated SSH key pair to dialog with VM|RM and false that you prefer to use an existing SSH Agent instead and existing keys
648 Conffile: pb
649 Example: pbusesshagent default = false
650
651=item B<pbwf>
652
653 Nature: Optional
654 Key: project (as defined in the -p option or PBPROJ environment variable)
655 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.
656 Conffile: project
657 Example: pbwf afio = 1
658
659=item B<pkgtag>
660
661 Nature: Optional
662 Key: package (as provided in defpkgdir or extpkgdir)
663 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).
664 Conffile: project
665 Example: pkgtag mindi-busybox = 2
666
667=item B<pkgver>
668
669 Nature: Optional
670 Key: package (as provided in defpkgdir or extpkgdir)
671 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>.
672 Conffile: project
673 Example: pkgver mindi-busybox = 1.7.3
674
675=item B<projcomponent>
676
677 Nature: Optional
678 Key: project (as defined in the -p option or PBPROJ environment variable)
679 Value: The component in the distribution repository, e.g. main for debian/ubuntu free software, (or non-free, contrib) or contrib for mandriva non core component e.g.
680 Conffile: project
681 Example: projcomponent Lintel = main
682
683=item B<projtag>
684
685 Nature: Mandatory
686 Key: project (as defined in the -p option or PBPROJ environment variable)
687 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>.
688 Conffile: project
689 Example: projtag mondorescue = 1
690
691=item B<projver>
692
693 Nature: Mandatory
694 Key: project (as defined in the -p option or PBPROJ environment variable)
695 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>.
696 Conffile: project
697 Example: projver mondorescue = 2.2.9
698
699=item B<rbsconf>
700
701 Nature: Optional
702 Key: project (as defined in the -p option or PBPROJ environment variable)
703 Value: for mock it's the configuration directory. For rinse it's its configuration file. For rpmbootstrap it's not used yet.
704 Conffile: ve
705 Example: rbsconf default = /etc/mock, rbsconf default = /etc/pb/pb-rinse.conf
706
707=item B<rbsb4pi>
708
709 Nature: Optional
710 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.
711 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.
712 Conffile: ve
713 Example: rbsb4pi centos = /home/rinse/bin/before-post-install.sh
714
715=item B<rbsmirrorsrv>
716
717 Nature: Optional
718 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.
719 Value: URL for the mirror server for setting up a virtual environment
720 Conffile: ve
721 Example: rbsmirrorsrv debian = http://mirrors1.kernel.org/
722
723=item B<rbsmirrorupd>
724
725 Nature: Optional
726 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.
727 Value: Relative path wrt B<rbsmirrorsrv> where updates are located
728 Conffile: ve
729 Example: rbsmirrorupd mageia = ../updates
730
731=item B<rbsopt>
732
733 Nature: Optional
734 Key: tool used for rpm based VE. Could be one of rpmbootstrap, rinse, mock, ...
735 Value: Additional option to pass to the command
736 Conffile: ve
737 Example: rbsopt rpmbootstrap = -k
738
739=item B<rbspi>
740
741 Nature: Optional
742 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.
743 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.
744 Conffile: ve
745 Example: rbspi centos = /home/rinse/bin/post-install.sh
746
747=item B<rmhost>
748
749 Nature: Mandatory
750 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.
751 Value: IP address or name of the Remote Machine running the OS mentioned in the key, accessed through ssh.
752 Conffile: rm
753 Example: rmhost default = localhost - rmhost hpux-11.3-ia64 = 10.10.10.10 - rmhost mandriva-2010.2-x86_64 = machine1.domain.name
754
755=item B<rmlist>
756
757 Nature: Mandatory
758 Key: project (as defined in the -p option or PBPROJ environment variable)
759 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.
760 Conffile: rm
761 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
762
763=item B<rmlogin>
764
765 Nature: Mandatory
766 Key: project (as defined in the -p option or PBPROJ environment variable)
767 Value: account name to use on the Remote Machine to build packages. Communication is done with ssh.
768 Conffile: rm
769 Example: rmlogin default = pb
770
771=item B<rmmonport>
772
773 Nature: Optional
774 Key: project (as defined in the -p option or PBPROJ environment variable)
775 Value: TCP port that is used to dialog with the monitor of the Remote Machine, to pass orders.
776 Conffile: rm
777 Example: rmmonport default = 4444
778
779=item B<rmntp>
780
781 Nature: Optional
782 Key: project (as defined in the -p option or PBPROJ environment variable)
783 Value: NTP server to contact for time accuracy with B<ospathcmd-ntpdate> before building.
784 Conffile: rm
785 Example: rmntp default = 1.pool.ntp.org
786
787=item B<rmpath>
788
789 Nature: Mandatory
790 Key: project (as defined in the -p option or PBPROJ environment variable)
791 Value: path where to find configuration file for Remote Machines management.
792 Conffile: rm
793 Example: rmpath default = /home/remote
794
795=item B<rmport>
796
797 Nature: Mandatory
798 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
799 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.
800 Conffile: rm
801 Example: rmport pb = 2222,rmport mondorescue = 2223
802
803=item B<rmtmout>
804
805 Nature: Optional
806 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.
807 Value: Time in seconds to wait before interacting with the RM. This may correspond to the time the RM takes to boot.
808 Conffile: rm
809 Example: rmtmout default = 10
810
811=item B<rmtype>
812
813 Nature: Mandatory
814 Key: project (as defined in the -p option or PBPROJ environment variable)
815 Value: ssh. For the moment, only ssh is supported as a communication means with RM.
816 Conffile: rm
817 Example: rmrtype default = ssh
818
819=item B<sshdir>
820
821 Nature: Mandatory
822 Key: project (as defined in the -p option or PBPROJ environment variable)
823 Value: dirname into which packages are uploaded on the B<sshhost> machine.
824 Conffile: project
825 Example: sshdir mondorescue = /pub/mondorescue
826
827=item B<sshhost>
828
829 Nature: Mandatory
830 Key: project (as defined in the -p option or PBPROJ environment variable)
831 Value: hostname to connect to in order to deliver packages to the repository server.
832 Conffile: project
833 Example: sshhost mondorescue = ftp.mondorescue.org
834
835=item B<sshlogin>
836
837 Nature: Optional
838 Key: project (as defined in the -p option or PBPROJ environment variable)
839 Value: login to use when connecting to the repository server B<sshhost> for package delivery. whoami result by default
840 Conffile: project
841 Example: sshlogin mondorescue = mylogin
842
843=item B<sshport>
844
845 Nature: Optional
846 Key: project (as defined in the -p option or PBPROJ environment variable)
847 Value: port to use when connecting to the repository server B<sshhost> for package delivery. 22 by default.
848 Conffile: project
849 Example: sshport mondorescue = 22
850
851=item B<supfiles>
852
853Not used yet.
854
855=item B<testver>
856
857 Nature: Optional
858 Key: project (as defined in the -p option or PBPROJ environment variable)
859 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.
860 Conffile: project
861 Example: testver mondorescue = true
862
863=item B<vedebtype>
864
865 Nature: Mandatory
866 Key: project (as defined in the -p option or PBPROJ environment variable)
867 Value: debootstrap (no other tool to create deb distro based chroot)
868 Conffile: ve
869 Example: vedebtype default = debootstrap
870
871=item B<velist>
872
873 Nature: Mandatory
874 Key: project (as defined in the -p option or PBPROJ environment variable)
875 Value: list of comma separated OS (under the form of os-ver-arch).
876 Conffile: ve
877 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
878
879=item B<velogin>
880
881 Nature: Mandatory
882 Key: project (as defined in the -p option or PBPROJ environment variable)
883 Value: account name to use in the VE to build packages.
884 Conffile: ve
885 Example: velogin default = pb
886
887=item B<ventp>
888
889 Nature: Optional
890 Key: project (as defined in the -p option or PBPROJ environment variable)
891 Value: NTP server to contact for time accuracy with B<ospathcmd-ntpdate> before building.
892 Conffile: ve
893 Example: ventp default = 1.pool.ntp.org
894
895=item B<vepath>
896
897 Nature: Mandatory
898 Key: project (as defined in the -p option or PBPROJ environment variable)
899 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.
900 Conffile: ve
901 Example: vepath default = /home/rpmbootstrap
902
903=item B<verebuild>
904
905 Nature: Optional
906 Key: project (as defined in the -p option or PBPROJ environment variable)
907 Value: true|false. True means that the VE should be rebuild before usage.
908 Conffile: ve
909 Example: verebuild default = true
910
911=item B<verpmtype>
912
913 Nature: Mandatory
914 Key: project (as defined in the -p option or PBPROJ environment variable)
915 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).
916 Conffile: ve
917 Example: verpmtype default = rpmbootstrap
918
919=item B<vesnap>
920
921 Nature: Optional
922 Key: project (as defined in the -p option or PBPROJ environment variable)
923 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.
924 Conffile: ve
925 Example: vesnap default = true
926
927=item B<vetype>
928
929 Nature: Mandatory
930 Key: project (as defined in the -p option or PBPROJ environment variable)
931 Value: chroot|schroot|docker. There are two different ways of launching a Virtual Environment activity in pb. For the moment only chroot and docker have been tested.
932 Conffile: ve
933 Example: vetype default = chroot
934
935=item B<vmbuildtm>
936
937 Nature: Optional
938 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
939 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.
940 Conffile: project
941 Example: vmbuildtm default = 600,vmbuildtm mandriva-2009.0-x86_64 = 1200
942
943=item B<vmcmd>
944
945 Nature: Mandatory
946 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.
947 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.
948 Conffile: vm
949 Example: vmcmd default = /usr/bin/kvm
950
951=item B<vmhost>
952
953 Nature: Mandatory
954 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
955 Value: hostname to connect to in order to reach the VM through ssh. Generally redirected from a port on localhost.
956 Conffile: vm
957 Example: vmhost default = localhost
958
959=item B<vmlist>
960
961 Nature: Mandatory
962 Key: project (as defined in the -p option or PBPROJ environment variable)
963 Value: list of comma separated OS (under the form of os-ver-arch).
964 Conffile: vm
965 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
966
967=item B<vmlogin>
968
969 Nature: Mandatory
970 Key: project (as defined in the -p option or PBPROJ environment variable)
971 Value: account name to use in the VM to build packages. Communication is done with ssh.
972 Conffile: vm
973 Example: vmlogin default = pb
974
975=item B<vmmem>
976
977 Nature: Optional
978 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
979 Value: Memory size in MB to allocate to the VM.
980 Conffile: vm
981 Example: vmmem default = 512
982
983=item B<vmmonport>
984
985 Nature: Optional
986 Key: project (as defined in the -p option or PBPROJ environment variable)
987 Value: TCP port that is used to dialog with the monitor of the VM, to pass orders such as snapshot. Not really operational yet.
988 Conffile: vm
989 Example: vmmonport default = 4444
990
991=item B<vmntp>
992
993 Nature: Optional
994 Key: project (as defined in the -p option or PBPROJ environment variable)
995 Value: NTP server to contact for time accuracy with B<ospathcmd-ntpdate> before building.
996 Conffile: vm
997 Example: vmntp default = 1.pool.ntp.org
998
999=item B<vmopt>
1000
1001 Nature: Optional
1002 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.
1003 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.
1004 Conffile: vm
1005 Example: vmopt default = -m 384 -daemonize,vmopt mandriva-2009.0-i386 = -m 256 -daemonize -no-kvm
1006
1007=item B<vmpath>
1008
1009 Nature: Mandatory
1010 Key: project (as defined in the -p option or PBPROJ environment variable)
1011 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.
1012 Conffile: vm
1013 Example: vmpath default = /home/qemu
1014
1015=item B<vmport>
1016
1017 Nature: Mandatory
1018 Key: project (as defined in the -p option or PBPROJ environment variable)
1019 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.
1020 Conffile: vm
1021 Example: vmport pb = 2222,vmport mondorescue = 2223
1022
1023=item B<vmsize>
1024
1025 Nature: Mandatory
1026 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
1027 Value: Size of the VM to create when using the newvm command of pb.
1028 Conffile: vm
1029 Example: vmsize default = 7G
1030
1031=item B<vmsnap>
1032
1033 Nature: Optional
1034 Key: project (as defined in the -p option or PBPROJ environment variable)
1035 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.
1036 Conffile: vm
1037 Example: vmsnap default = true
1038
1039=item B<vmtmout>
1040
1041 Nature: Optional
1042 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.
1043 Value: Time in seconds to wait before interacting with the VM. This should correspond to the time the VM takes to boot.
1044 Conffile: vm
1045 Example: vmtmout default = 180,vmtmout mandriva-2009.0-x86_64 = 500
1046
1047=item B<vmtype>
1048
1049 Nature: Mandatory
1050 Key: project (as defined in the -p option or PBPROJ environment variable)
1051 Value: qemu|kvm. For the moment, only QEMU or KVM are supported as virtualization technologies.
1052 Conffile: vm
1053 Example: vmtype default = kvm
1054
1055=item B<webdir>
1056
1057 Nature: Optional
1058 Key: project (as defined in the -p option or PBPROJ environment variable)
1059 Value: Target directory containing the web content in the project that should be delivered when using the sbx|cms2webssh|pkg command of pb.
1060 Conffile: project
1061 Example: webdir mondorescue = website
1062
1063=item B<websshdir>
1064
1065 Nature: Optional (when not using *2webssh commands)
1066 Key: project (as defined in the -p option or PBPROJ environment variable)
1067 Value: dirname into which content is uploaded on the B<websshhost> machine.
1068 Conffile: project
1069 Example: websshdir mondorescue = /var/www/html
1070
1071=item B<websshhost>
1072
1073 Nature: Optional (when not using *2webssh commands)
1074 Key: project (as defined in the -p option or PBPROJ environment variable)
1075 Value: hostname to connect to in order to deliver content to the Web server.
1076 Conffile: project
1077 Example: websshhost mondorescue = www.mondorescue.org
1078
1079=item B<websshlogin>
1080
1081 Nature: Optional (when not using *2webssh commands)
1082 Key: project (as defined in the -p option or PBPROJ environment variable)
1083 Value: login to use when connecting to the Web server B<websshhost> for content delivery.
1084 Conffile: project
1085 Example: websshlogin mondorescue = mylogin
1086
1087=item B<websshport>
1088
1089 Nature: Optional (when not using *2webssh commands)
1090 Key: project (as defined in the -p option or PBPROJ environment variable)
1091 Value: port to use when connecting to the Web server B<websshhost> for content delivery.
1092 Conffile: project
1093 Example: websshport mondorescue = 22
1094
1095=back
1096
1097=head1 OTHER PARAMETERS
1098
1099=over 4
1100
1101=item B<pb_URL>
1102
1103=item B<pb_directory_desc>
1104
1105=item B<pb_environment_variables>
1106
1107=back
1108
1109=head1 COPYRIGHT
1110
1111 (c) B. Cornec 2007-2016
1112 Eric Anderson's changes are (c) Copyright 2012 Hewlett Packard
1113 Provided under the Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) Creative Common License
1114
1115=cut
Note: See TracBrowser for help on using the repository browser.