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

Last change on this file since 2092 was 2092, checked in by Bruno Cornec, 5 years ago

Adds function pv_ve_docker_repo

Reuse code from VE.pm in pb to check whether we use a Registry or just a
repository
Adds a new conf param dockerrepository and document it (mandatory if no
registry used)

File size: 46.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<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<logcmd>
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: 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, ...).
174 Conffile: pb
175 Example: logcmd mageia = sos
176
177=item B<logcmds>
178
179 Nature: Optional
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: 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.
182 Conffile: pb
183 Example: logcmds mageia = mount,lsmod,esxcfg-module -l,df -T
184
185=item B<logfiles>
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 files to capture in order to log context.
190 Conffile: pb
191 Example: logfiles mageia = /etc/raidtab,/proc/cmdline,/proc/swaps
192
193=item B<logopt>
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 not internal, the options of the B<logcmd> application to launch to log context
198 Conffile: pb
199 Example: logopt mageia = --all
200
201=item B<mkbmbootcmds>
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: 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.
206 Conffile: pb
207 Example: mkbmbootcmds linux = perl,awk,gawk,dd,grep,uname
208
209=item B<mkbmbootdirs>
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 directories to be copied from the original OS to the target boot media tree (works recursively on the target).
214 Conffile: pb
215 Example: mkbmbootdirs linux = /etc/ssh,/etc/udev,/etc/mdadm
216
217=item B<mkbmbootfiles>
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 files to be copied from the original OS to the target boot media tree (works recursively for directory creation on the target).
222 Conffile: pb
223 Example: mkbmbootfiles linux = /etc/mdadm.conf,/etc/raidtab,/etc/modprobe.conf
224
225=item B<mkbmkerneldir>
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: path of the directory containing your kernel.
230 Conffile: pb
231 Example: mkbmkerneldir linux = /boot
232
233=item B<mkbmkernelfile>
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). The family name is generaly used here.
237 Value: full path of the your kernel.
238 Conffile: pb
239 Example: mkbmkernelfile linux = /boot/vmlinuz-specific
240
241=item B<mkbmkernelnamere>
242
243 Nature: Mandatory
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: Perl Regular Expression allowing to find OS kernel names in the B<kerneldir> directory.
246 Conffile: pb
247 Example: mkbmkerneldir linux = ^linu|^vmlinu|^xen
248
249=item B<mkbmtargetdirs>
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: comma separated list of empty directory paths to be created on the target boot media.
254 Conffile: pb
255 Example: mkbmtargetdirs linux = /tmp,/dev
256
257=item B<namingtype>
258
259 Nature: Optional
260 Key: package (as provided in defpkgdir or extpkgdir)
261 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)
262 Conffile: project
263 Example: namingtype ProjectBuilder = perl
264
265=item B<osambiguous>
266
267 Nature: Optional
268 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.
269 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>
270 Conffile: pb
271 Example: osambiguous debian = debian,ubuntu
272
273=item B<oschkcmd>
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).
277 Value: package checker tool.
278 Conffile: pb
279 Example: oschkcmd deb = /usr/bin/lintian
280
281=item B<oschkopt>
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 options.
286 Conffile: pb
287 Example: oschkcmd rpm = -i
288
289=item B<oscmd>
290
291 Nature: Mandatory
292 Key: tool (pb or rpmbootstrap)
293 Value: come separated list of commands that are mandatory on the underlying system
294 Conffile: pb
295 Example: oscmd pb = tar,ls
296
297=item B<oscmdopt>
298
299 Nature: Mandatory
300 Key: tool (pb or rpmbootstrap)
301 Value: come separated list of commands that are optional on the underlying system
302 Conffile: pb
303 Example: oscmd pb = svn2cl,svn,cvs
304
305=item B<oscodename>
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). In that case, should be an os-ver.
309 Value: code name. Mostly useful for debian and ubuntu, due to debootstrap.
310 Conffile: pb
311 Example: oscodename debian-5.0 = lenny
312
313=item B<osfamily>
314
315 Nature: Mandatory
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.
317 Value: OS family name (used to group similar distribution for handling)
318 Conffile: pb
319 Example: osfamily debian = du
320
321=item B<osins>
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). The family name is generaly used here.
325 Value: OS command to lauch in order to automatically install packages on it.
326 Conffile: pb
327 Example: osins fedora = sudo yum -y install
328
329=item B<osmindep>
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). NB: a default value is highly interesting here.
333 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.
334 Conffile: pb
335 Example: osmindep default = perl,sudo,wget,tar,make,gzip
336
337=item B<osnover>
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: true|false. True means that this OS has no need to keep the version
342 Conffile: pb
343 Example: osnover gentoo = true
344
345=item B<ospatchcmd>
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: package patch command. For RPM is implicit.
350 Conffile: pb
351 Example: ospatchcmd deb = /usr/bin/patch
352
353=item B<ospatchopt>
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 options.
358 Conffile: pb
359 Example: ospatchcmd deb = -s -p1
360
361=item B<ospathcmd-*>
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: Full path name of the command mentioned after the '-' for the relative OS
366 Conffile: pb
367 Example: ospathcmd-halt solaris = /usr/sbin/halt, ospathcmd-halt default = /sbin/halt
368
369=item B<osperldep>
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: 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.
374 Conffile: pb
375 Example: osperldep rhel-5 = Module-Build,File-MimeInfo,File-BaseDir,Mail-Sendmail
376
377=item B<osperlver>
378
379 Nature: Mandatory (for each module mentioned in B<osperldep>)
380 Key: Perl Module (as defined in B<osperldep>)
381 Value: Version of the perl module that needs to be found on CPAN.
382 Conffile: pb
383 Example: Date-Manip = 5.54
384
385=item B<ospkg>
386
387 Nature: Optional (Mandatory if pbinstalltype is pkg)
388 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
389 Value: comma separated list of packages that have to be installed in order for pb to be operational in the VE|VM
390 Conffile: pb
391 Example: ospkg rhel-5 = project-builder
392
393=item B<ospkgdep>
394
395 Nature: Optional
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 are needed by pb and should be installed automatically in the VM/VE during the setupvm|ve phasis by pb.
398 Conffile: pb
399 Example: ospkgdep rhel-5 = wget,make,ntp,patch,perl-DateManip
400
401=item B<osrelambfile>
402
403 Nature: Mandatory (per OS mentioned in B<osambiguous>)
404 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.
405 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.
406 Conffile: pb
407 Example: osrelambfile debian = /etc/debian_version
408
409=item B<osrelexpr>
410
411 Nature: Mandatory (per OS mentioned in B<osrelambfile> and B<osrelfile>)
412 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
413 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)
414 Conffile: pb
415osrelexpr rhel = Red Hat (?:Enterprise Linux|Linux Advanced Server) .*release ([0-9.]+).* \(
416 Example:
417
418=item B<osrelfile>
419
420 Nature: Mandatory
421 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.
422 Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name.
423 Conffile: pb
424 Example: osrelfile fedora = /etc/fedora-release
425
426=item B<osremovedotinver>
427
428 Nature: Optional
429 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
430 Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS.
431 Conffile: pb
432 Example: osremovedotinver redhat = true
433
434=item B<osrepo>
435
436 Nature: Optional (Mandatory if pbinstalltype is pkg)
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: 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
439 Conffile: pb
440 Example: osrepo rpm = ftp://ftp.project-builder.org/$ddir/$dver/pb.repo
441
442=item B<ossha>
443
444 Nature: Optional (Mandatory if rpm type of package)
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: sha algorithm used br createrepo
447 Conffile: pb
448 Example: ossha fedora-10 = sha1
449
450=item B<ossudoersmode>
451
452 Nature: Mandatory
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: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
455 Conffile: pb
456 Example: ossudoersmode novell = 640
457
458=item B<ossuffix>
459
460 Nature: Optional
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: ossuffix mandriva = mdv
465
466=item B<ostype>
467
468 Nature: Mandatory
469 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.
470 Value: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type.
471 Conffile: pb
472 Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
473
474=item B<osupd>
475
476 Nature: Optional
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: OS command to lauch in order to automatically update th VM|VE
479 Conffile: pb
480 Example: osupd fedora = sudo yum -y update
481
482=item B<ossueminorrel>
483
484 Nature: Mandatory
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: Should that OS distinguish between its minor version, considering them as different versions or not. Typically for CentOS where .x versions make incompatible changes.
487 Conffile: pb
488 Example: ossueminorrel centos = true
489
490
491=item B<pbconfurl>
492
493 Nature: Mandatory
494 Key: project (as defined in the -p option or PBPROJ environment variable)
495 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
496 Conffile: home|project
497 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
498
499=item B<pbdefdir>
500
501 Nature: Optional
502 Key: project (as defined in the -p option or PBPROJ environment variable)
503 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.
504 Conffile: home
505 Example: pbdefdir default = $ENV{'HOME'}/local/pb/projects
506
507=item B<pbgpgcheck>
508
509 Nature: Optional
510 Key: project (as defined in the -p option or PBPROJ environment variable)
511 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)
512 Conffile: project
513 Example: pbgpgcheck Lintel = 0
514
515=item B<pbinstalltype>
516
517 Nature: Mandatory
518 Key: project (as defined in the -p option or PBPROJ environment variable)
519 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.
520 Conffile: pb
521
522=item B<pbml>
523
524 Nature: Optional (Mandatory if using announce command)
525 Key: project (as defined in the -p option or PBPROJ environment variable)
526 Value: white space separated list of e-mail adresses used to send announces with the pb announce option.
527 Conffile: project
528 Example: pbml pb = pb-announce@project-builder.org pb-devel@project-builder.org
529
530=item B<pbpackager>
531
532 Nature: Mandatory
533 Key: project (as defined in the -p option or PBPROJ environment variable)
534 Value: Firstname Name and e-mail address of the person packaging the software.
535 Conffile: project
536 Example: pbpackager pb = Bruno Cornec <bruno@project-builder.org>
537
538=item B<pbparallel>
539
540 Nature: Optional
541 Key: tool (pb or rpmbootstrap)
542 Value: number of processes to execute in parallel. By default use the number of cores.
543 Conffile: pb
544 Example: pbparallel pb = 12
545
546=item B<pbpassfile>
547
548 Nature: Optional
549 Key: project (as defined in the -p option or PBPROJ environment variable)
550 Value: File containing the GPG passphrase that is used to sign packages
551 Conffile: home
552 Example: pbpassfile pb = /users/me/secret/passfile
553
554=item B<pbpasspath>
555
556 Nature: Optional
557 Key: project (as defined in the -p option or PBPROJ environment variable)
558 Value: The directory under which will be found your secret GPG key file.
559 Conffile: home
560 Example: pbpasspath pb = /home/me/.gnupg
561
562=item B<pbpassphrase>
563
564 Nature: Optional
565 Key: project (as defined in the -p option or PBPROJ environment variable)
566 Value: The GPG passphrase that is used to sign packages. Putting it in your conf file has security implications.
567 Conffile: home
568 Example: pbpassphrase pb = TheSecretPassPhrase
569
570=item B<pbpbr>
571
572 Nature: Optional
573 Key: project (as defined in the -p option or PBPROJ environment variable)
574 Value: whatever. As soon as this is defined, then that project is known as using pbr for source epansion.
575 Conffile: project
576 Example: pbpbr python-redfish = 1
577
578=item B<pbprojdir>
579
580 Nature: Optional
581 Key: project (as defined in the -p option or PBPROJ environment variable)
582 Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname
583 Conffile: home
584 Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue
585
586=item B<pbrepo>
587
588 Nature: Mandatory
589 Key: project (as defined in the -p option or PBPROJ environment variable)
590 Value: URL of the server hosting the upstream tar file.
591 Conffile: project
592 Example: pbrepo mondorescue = ftp://ftp.mondorescue.org
593
594=item B<pbshowsudo>
595
596 Nature: Optional
597 Key: project (as defined in the -p option or PBPROJ environment variable)
598 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.
599 Conffile: home
600 Example: pbshowsudo mondorescue = true
601
602=item B<pbsmtp>
603
604 Nature: Optional (Mandatory if using the announce command)
605 Key: project (as defined in the -p option or PBPROJ environment variable)
606 Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here.
607 Conffile: home
608 Example: pbsmtp mondorescue = localhost
609
610=item B<pbsockscmd>
611
612 Nature: Optional
613 Key: project (as defined in the -p option or PBPROJ environment variable)
614 Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here.
615 Conffile: home
616 Example: pbsockscmd default = tsocks
617
618=item B<pbstoponerr>
619
620 Nature: Optional
621 Key: project (as defined in the -p option or PBPROJ environment variable)
622 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.
623 Conffile: home
624 Example: pbstoponerr mondorescue = true
625
626
627=item B<pburl>
628
629 Nature: Optional
630 Key: project (as defined in the -p option or PBPROJ environment variable)
631 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
632 Conffile: home|project
633 Example: pburl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pburl pb = svk:////local/pb
634
635=item B<pbusesshagent>
636
637 Nature: Mandatory
638 Key: project (as defined in the -p option or PBPROJ environment variable)
639 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
640 Conffile: pb
641 Example: pbusesshagent default = false
642
643=item B<pbwf>
644
645 Nature: Optional
646 Key: project (as defined in the -p option or PBPROJ environment variable)
647 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.
648 Conffile: project
649 Example: pbwf afio = 1
650
651=item B<pkgtag>
652
653 Nature: Optional
654 Key: package (as provided in defpkgdir or extpkgdir)
655 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).
656 Conffile: project
657 Example: pkgtag mindi-busybox = 2
658
659=item B<pkgver>
660
661 Nature: Optional
662 Key: package (as provided in defpkgdir or extpkgdir)
663 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>.
664 Conffile: project
665 Example: pkgver mindi-busybox = 1.7.3
666
667=item B<projcomponent>
668
669 Nature: Optional
670 Key: project (as defined in the -p option or PBPROJ environment variable)
671 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.
672 Conffile: project
673 Example: projcomponent Lintel = main
674
675=item B<projtag>
676
677 Nature: Mandatory
678 Key: project (as defined in the -p option or PBPROJ environment variable)
679 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>.
680 Conffile: project
681 Example: projtag mondorescue = 1
682
683=item B<projver>
684
685 Nature: Mandatory
686 Key: project (as defined in the -p option or PBPROJ environment variable)
687 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>.
688 Conffile: project
689 Example: projver mondorescue = 2.2.9
690
691=item B<rbsconf>
692
693 Nature: Optional
694 Key: project (as defined in the -p option or PBPROJ environment variable)
695 Value: for mock it's the configuration directory. For rinse it's its configuration file. For rpmbootstrap it's not used yet.
696 Conffile: ve
697 Example: rbsconf default = /etc/mock, rbsconf default = /etc/pb/pb-rinse.conf
698
699=item B<rbsb4pi>
700
701 Nature: Optional
702 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.
703 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.
704 Conffile: ve
705 Example: rbsb4pi centos = /home/rinse/bin/before-post-install.sh
706
707=item B<rbsmirrorsrv>
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: URL for the mirror server for setting up a virtual environment
712 Conffile: ve
713 Example: rbsmirrorsrv debian = http://mirrors1.kernel.org/
714
715=item B<rbsmirrorupd>
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: Relative path wrt B<rbsmirrorsrv> where updates are located
720 Conffile: ve
721 Example: rbsmirrorupd mageia = ../updates
722
723=item B<rbsopt>
724
725 Nature: Optional
726 Key: tool used for rpm based VE. Could be one of rpmbootstrap, rinse, mock, ...
727 Value: Additional option to pass to the command
728 Conffile: ve
729 Example: rbsopt rpmbootstrap = -k
730
731=item B<rbspi>
732
733 Nature: Optional
734 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.
735 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.
736 Conffile: ve
737 Example: rbspi centos = /home/rinse/bin/post-install.sh
738
739=item B<rmhost>
740
741 Nature: Mandatory
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: IP address or name of the Remote Machine running the OS mentioned in the key, accessed through ssh.
744 Conffile: rm
745 Example: rmhost default = localhost - rmhost hpux-11.3-ia64 = 10.10.10.10 - rmhost mandriva-2010.2-x86_64 = machine1.domain.name
746
747=item B<rmlist>
748
749 Nature: Mandatory
750 Key: project (as defined in the -p option or PBPROJ environment variable)
751 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.
752 Conffile: rm
753 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
754
755=item B<rmlogin>
756
757 Nature: Mandatory
758 Key: project (as defined in the -p option or PBPROJ environment variable)
759 Value: account name to use on the Remote Machine to build packages. Communication is done with ssh.
760 Conffile: rm
761 Example: rmlogin default = pb
762
763=item B<rmmonport>
764
765 Nature: Optional
766 Key: project (as defined in the -p option or PBPROJ environment variable)
767 Value: TCP port that is used to dialog with the monitor of the Remote Machine, to pass orders.
768 Conffile: rm
769 Example: rmmonport default = 4444
770
771=item B<rmntp>
772
773 Nature: Optional
774 Key: project (as defined in the -p option or PBPROJ environment variable)
775 Value: NTP server to contact for time accuracy with B<ospathcmd-ntpdate> before building.
776 Conffile: rm
777 Example: rmntp default = 1.pool.ntp.org
778
779=item B<rmpath>
780
781 Nature: Mandatory
782 Key: project (as defined in the -p option or PBPROJ environment variable)
783 Value: path where to find configuration file for Remote Machines management.
784 Conffile: rm
785 Example: rmpath default = /home/remote
786
787=item B<rmport>
788
789 Nature: Mandatory
790 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
791 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.
792 Conffile: rm
793 Example: rmport pb = 2222,rmport mondorescue = 2223
794
795=item B<rmtmout>
796
797 Nature: Optional
798 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.
799 Value: Time in seconds to wait before interacting with the RM. This may correspond to the time the RM takes to boot.
800 Conffile: rm
801 Example: rmtmout default = 10
802
803=item B<rmtype>
804
805 Nature: Mandatory
806 Key: project (as defined in the -p option or PBPROJ environment variable)
807 Value: ssh. For the moment, only ssh is supported as a communication means with RM.
808 Conffile: rm
809 Example: rmrtype default = ssh
810
811=item B<sshdir>
812
813 Nature: Mandatory
814 Key: project (as defined in the -p option or PBPROJ environment variable)
815 Value: dirname into which packages are uploaded on the B<sshhost> machine.
816 Conffile: project
817 Example: sshdir mondorescue = /pub/mondorescue
818
819=item B<sshhost>
820
821 Nature: Mandatory
822 Key: project (as defined in the -p option or PBPROJ environment variable)
823 Value: hostname to connect to in order to deliver packages to the repository server.
824 Conffile: project
825 Example: sshhost mondorescue = ftp.mondorescue.org
826
827=item B<sshlogin>
828
829 Nature: Optional
830 Key: project (as defined in the -p option or PBPROJ environment variable)
831 Value: login to use when connecting to the repository server B<sshhost> for package delivery. whoami result by default
832 Conffile: project
833 Example: sshlogin mondorescue = mylogin
834
835=item B<sshport>
836
837 Nature: Optional
838 Key: project (as defined in the -p option or PBPROJ environment variable)
839 Value: port to use when connecting to the repository server B<sshhost> for package delivery. 22 by default.
840 Conffile: project
841 Example: sshport mondorescue = 22
842
843=item B<supfiles>
844
845Not used yet.
846
847=item B<testver>
848
849 Nature: Optional
850 Key: project (as defined in the -p option or PBPROJ environment variable)
851 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.
852 Conffile: project
853 Example: testver mondorescue = true
854
855=item B<vedebtype>
856
857 Nature: Mandatory
858 Key: project (as defined in the -p option or PBPROJ environment variable)
859 Value: debootstrap (no other tool to create deb distro based chroot)
860 Conffile: ve
861 Example: vedebtype default = debootstrap
862
863=item B<velist>
864
865 Nature: Mandatory
866 Key: project (as defined in the -p option or PBPROJ environment variable)
867 Value: list of comma separated OS (under the form of os-ver-arch).
868 Conffile: ve
869 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
870
871=item B<velogin>
872
873 Nature: Mandatory
874 Key: project (as defined in the -p option or PBPROJ environment variable)
875 Value: account name to use in the VE to build packages.
876 Conffile: ve
877 Example: velogin default = pb
878
879=item B<ventp>
880
881 Nature: Optional
882 Key: project (as defined in the -p option or PBPROJ environment variable)
883 Value: NTP server to contact for time accuracy with B<ospathcmd-ntpdate> before building.
884 Conffile: ve
885 Example: ventp default = 1.pool.ntp.org
886
887=item B<vepath>
888
889 Nature: Mandatory
890 Key: project (as defined in the -p option or PBPROJ environment variable)
891 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.
892 Conffile: ve
893 Example: vepath default = /home/rpmbootstrap
894
895=item B<verebuild>
896
897 Nature: Optional
898 Key: project (as defined in the -p option or PBPROJ environment variable)
899 Value: true|false. True means that the VE should be rebuild before usage.
900 Conffile: ve
901 Example: verebuild default = true
902
903=item B<verpmtype>
904
905 Nature: Mandatory
906 Key: project (as defined in the -p option or PBPROJ environment variable)
907 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).
908 Conffile: ve
909 Example: verpmtype default = rpmbootstrap
910
911=item B<vesnap>
912
913 Nature: Optional
914 Key: project (as defined in the -p option or PBPROJ environment variable)
915 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.
916 Conffile: ve
917 Example: vesnap default = true
918
919=item B<vetype>
920
921 Nature: Mandatory
922 Key: project (as defined in the -p option or PBPROJ environment variable)
923 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.
924 Conffile: ve
925 Example: vertype default = chroot
926
927=item B<vmbuildtm>
928
929 Nature: Optional
930 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
931 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.
932 Conffile: project
933 Example: vmbuildtm default = 600,vmbuildtm mandriva-2009.0-x86_64 = 1200
934
935=item B<vmcmd>
936
937 Nature: Mandatory
938 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.
939 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.
940 Conffile: vm
941 Example: vmcmd default = /usr/bin/kvm
942
943=item B<vmhost>
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).
947 Value: hostname to connect to in order to reach the VM through ssh. Generally redirected from a port on localhost.
948 Conffile: vm
949 Example: vmhost default = localhost
950
951=item B<vmlist>
952
953 Nature: Mandatory
954 Key: project (as defined in the -p option or PBPROJ environment variable)
955 Value: list of comma separated OS (under the form of os-ver-arch).
956 Conffile: vm
957 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
958
959=item B<vmlogin>
960
961 Nature: Mandatory
962 Key: project (as defined in the -p option or PBPROJ environment variable)
963 Value: account name to use in the VM to build packages. Communication is done with ssh.
964 Conffile: vm
965 Example: vmlogin default = pb
966
967=item B<vmmem>
968
969 Nature: Optional
970 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
971 Value: Memory size in MB to allocate to the VM.
972 Conffile: vm
973 Example: vmmem default = 512
974
975=item B<vmmonport>
976
977 Nature: Optional
978 Key: project (as defined in the -p option or PBPROJ environment variable)
979 Value: TCP port that is used to dialog with the monitor of the VM, to pass orders such as snapshot. Not really operational yet.
980 Conffile: vm
981 Example: vmmonport default = 4444
982
983=item B<vmntp>
984
985 Nature: Optional
986 Key: project (as defined in the -p option or PBPROJ environment variable)
987 Value: NTP server to contact for time accuracy with B<ospathcmd-ntpdate> before building.
988 Conffile: vm
989 Example: vmntp default = 1.pool.ntp.org
990
991=item B<vmopt>
992
993 Nature: Optional
994 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.
995 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.
996 Conffile: vm
997 Example: vmopt default = -m 384 -daemonize,vmopt mandriva-2009.0-i386 = -m 256 -daemonize -no-kvm
998
999=item B<vmpath>
1000
1001 Nature: Mandatory
1002 Key: project (as defined in the -p option or PBPROJ environment variable)
1003 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.
1004 Conffile: vm
1005 Example: vmpath default = /home/qemu
1006
1007=item B<vmport>
1008
1009 Nature: Mandatory
1010 Key: project (as defined in the -p option or PBPROJ environment variable)
1011 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.
1012 Conffile: vm
1013 Example: vmport pb = 2222,vmport mondorescue = 2223
1014
1015=item B<vmsize>
1016
1017 Nature: Mandatory
1018 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
1019 Value: Size of the VM to create when using the newvm command of pb.
1020 Conffile: vm
1021 Example: vmsize default = 7G
1022
1023=item B<vmsnap>
1024
1025 Nature: Optional
1026 Key: project (as defined in the -p option or PBPROJ environment variable)
1027 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.
1028 Conffile: vm
1029 Example: vmsnap default = true
1030
1031=item B<vmtmout>
1032
1033 Nature: Optional
1034 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.
1035 Value: Time in seconds to wait before interacting with the VM. This should correspond to the time the VM takes to boot.
1036 Conffile: vm
1037 Example: vmtmout default = 180,vmtmout mandriva-2009.0-x86_64 = 500
1038
1039=item B<vmtype>
1040
1041 Nature: Mandatory
1042 Key: project (as defined in the -p option or PBPROJ environment variable)
1043 Value: qemu|kvm. For the moment, only QEMU or KVM are supported as virtualization technologies.
1044 Conffile: vm
1045 Example: vmtype default = kvm
1046
1047=item B<webdir>
1048
1049 Nature: Optional
1050 Key: project (as defined in the -p option or PBPROJ environment variable)
1051 Value: Target directory containing the web content in the project that should be delivered when using the sbx|cms2webssh|pkg command of pb.
1052 Conffile: project
1053 Example: webdir mondorescue = website
1054
1055=item B<websshdir>
1056
1057 Nature: Optional (when not using *2webssh commands)
1058 Key: project (as defined in the -p option or PBPROJ environment variable)
1059 Value: dirname into which content is uploaded on the B<websshhost> machine.
1060 Conffile: project
1061 Example: websshdir mondorescue = /var/www/html
1062
1063=item B<websshhost>
1064
1065 Nature: Optional (when not using *2webssh commands)
1066 Key: project (as defined in the -p option or PBPROJ environment variable)
1067 Value: hostname to connect to in order to deliver content to the Web server.
1068 Conffile: project
1069 Example: websshhost mondorescue = www.mondorescue.org
1070
1071=item B<websshlogin>
1072
1073 Nature: Optional (when not using *2webssh commands)
1074 Key: project (as defined in the -p option or PBPROJ environment variable)
1075 Value: login to use when connecting to the Web server B<websshhost> for content delivery.
1076 Conffile: project
1077 Example: websshlogin mondorescue = mylogin
1078
1079=item B<websshport>
1080
1081 Nature: Optional (when not using *2webssh commands)
1082 Key: project (as defined in the -p option or PBPROJ environment variable)
1083 Value: port to use when connecting to the Web server B<websshhost> for content delivery.
1084 Conffile: project
1085 Example: websshport mondorescue = 22
1086
1087=back
1088
1089=head1 OTHER PARAMETERS
1090
1091=over 4
1092
1093=item B<pb_URL>
1094
1095=item B<pb_directory_desc>
1096
1097=item B<pb_environment_variables>
1098
1099=back
1100
1101=head1 COPYRIGHT
1102
1103 (c) B. Cornec 2007-2016
1104 Eric Anderson's changes are (c) Copyright 2012 Hewlett Packard
1105 Provided under the Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) Creative Common License
1106
1107=cut
Note: See TracBrowser for help on using the repository browser.