debian/buildbot.1

   1 .TH BUILDBOT "1" "August 2010" "Buildbot version: 0.8.1" "User Commands"
   2 .SH NAME
   3 buildbot \- a tool for managing buildbot master instances
   4 .SH SYNOPSIS
   5 .SS General Invocation
   6 .PP
   7 .B buildbot
   8 [
   9 .BR "global options"
  10 ]
  11 .I command
  12 [
  13 .BR "command options"
  14 ]
  15 .PP
  16 .B buildbot
  17 .I command
  18 .BR \-h | \-\-help
  19 .SS Command Options
  20 .PP
  21 .B buildbot
  22 create-master
  23 [
  24 .BR \-q | \-\-quiet
  25 ]
  26 [
  27 .BR \-f | \-\-force
  28 ]
  29 [
  30 .BR \-r | \-\-relocatable
  31 ]
  32 [
  33 .BR \-s | \-\-log-size
  34 .I SIZE
  35 ]
  36 [
  37 .BR \-l | \-\-log-count
  38 .I COUNT
  39 ]
  40 [
  41 .BR \-c | \-\-config
  42 .I CONFIG
  43 ]
  44 [
  45 .BR \-\-db
  46 .I DATABASE
  47 ]
  48 [
  49 .I PATH
  50 ]
  51 .PP
  52 .B buildbot
  53 upgrade-master
  54 [
  55 .BR \-q | \-\-quiet
  56 ]
  57 [
  58 .BR \-r | \-\-replace
  59 ]
  60 [
  61 .BR \-\-db
  62 .I DATABASE
  63 ]
  64 [
  65 .I PATH
  66 ]
  67 .PP
  68 .B buildbot
  69 [
  70 .BR \-\-verbose
  71 ]
  72 {
  73 .BR start | stop | restart | sighup | reconfig
  74 }
  75 [
  76 .I PATH
  77 ]
  78 .PP
  79 .B buildbot
  80 sendchange
  81 [
  82 .B \-\-master
  83 .I MASTER
  84 ]
  85 [
  86 .BR \-u | \-\-username
  87 .I USERNAME
  88 ]
  89 [
  90 .BR \-R | \-\-repository
  91 .I REPOSITORY
  92 ]
  93 [
  94 .BR \-P | \-\-project
  95 .I PROJECT
  96 ]
  97 [
  98 .BR \-b | \-\-branch
  99 .I BRANCH
 100 ]
 101 [
 102 .BR \-c | \-\-category
 103 .I CATEGORY
 104 ]
 105 [
 106 .BR \-r | \-\-revision
 107 .I REVISION
 108 ]
 109 [
 110 .BR \-\-revision-file
 111 .I REVISIONFILE
 112 ]
 113 [
 114 .BR \-p | \-\-property
 115 .I PROPERTY
 116 ]
 117 [
 118 .BR \-m | \-\-comments
 119 .I MESSAGE
 120 ]
 121 [
 122 .BR \-F | \-\-logfile
 123 .I LOGFILE
 124 ]
 125 [
 126 .BR \-w | \-\-when
 127 .I TIMESTAMP
 128 ]
 129 .IR FILES ...
 130 .PP
 131 .B buildbot
 132 debugclient
 133 [
 134 .BR \-m | \-\-master
 135 .I MASTER
 136 ]
 137 [
 138 .BR \-p | \-\-passwd
 139 .I PASSWORD
 140 ]
 141 .PP
 142 .B buildbot
 143 statuslog
 144 [
 145 .BR \-m | \-\-master
 146 .I MASTER
 147 ]
 148 [
 149 .BR \-u | \-\-username
 150 .I USERNAME
 151 ]
 152 [
 153 .BR \-p | \-\-passwd
 154 .I PASSWORD
 155 ]
 156 .PP
 157 .B buildbot
 158 statusgui
 159 [
 160 .BR \-m | \-\-master
 161 .I MASTER
 162 ]
 163 [
 164 .BR \-u | \-\-username
 165 .I USERNAME
 166 ]
 167 [
 168 .BR \-p | \-\-passwd
 169 .I PASSWORD
 170 ]
 171 .PP
 172 .B buildbot
 173 try
 174 [
 175 .BR \-\-wait
 176 ]
 177 [
 178 .BR \-n | \-\-dry-run
 179 ]
 180 [
 181 .BR \-\-get-builder-names
 182 ]
 183 [
 184 .BR \-c | \-\-connect
 185 {ssh|pb}
 186 ]
 187 [
 188 .BR \-\-tryhost
 189 .I HOSTNAME
 190 ]
 191 [
 192 .BR \-\-trydir
 193 .I PATH
 194 ]
 195 [
 196 .BR \-m | \-\-master
 197 .I MASTER
 198 ]
 199 [
 200 .BR \-u | \-\-username
 201 .I USERNAME
 202 ]
 203 [
 204 .BR \-\-passwd
 205 .I PASSWORD
 206 ]
 207 [
 208 .BR \-\-diff
 209 .I DIFF
 210 ]
 211 [
 212 .BR \-\-patchlevel
 213 .I PATCHLEVEL
 214 ]
 215 [
 216 .BR \-\-baserev
 217 .I BASEREV
 218 ]
 219 [
 220 .BR \-\-vc
 221 {cvs|svn|tla|baz|darcs|p4}
 222 ]
 223 [
 224 .BR \-\-branch
 225 .I BRANCH
 226 ]
 227 [
 228 .BR \-b | \-\-builder
 229 .I BUILDER
 230 ]
 231 [
 232 .BR \-\-properties
 233 .I PROPERTIES
 234 ]
 235 [
 236 .BR \-\-try-topfile
 237 .I FILE
 238 ]
 239 [
 240 .BR \-\-try-topdir
 241 .I PATH
 242 ]
 243 .PP
 244 .B buildbot
 245 tryserver
 246 [
 247 .BR \-\-jobdir
 248 .I PATH
 249 ]
 250 .PP
 251 .B buildbot
 252 checkconfig
 253 [
 254 .I CONFIGFILE
 255 ]
 256 .PP
 257 .B buildbot
 258 [
 259 .BR \-\-verbose
 260 ]
 261 {
 262 .BR start | stop | restart | sighup | reconfig
 263 }
 264 [
 265 .I PATH
 266 ]
 267 .PP
 268 .B buildbot
 269 [
 270 .BR \-\-verbose
 271 ]
 272 {
 273 .BR \-\-help | \-\-version
 274 }
 275
 276 .SH DESCRIPTION
 277 The `buildbot' command-line tool can be used to start or stop a
 278 buildmaster and to interact with a running buildmaster instance.
 279 Some of its subcommands are intended for buildmaster admins, while
 280 some are for developers who are editing the code that the buildbot is
 281 monitoring.
 282
 283 .SH OPTIONS
 284 .SS Commands
 285 .TP
 286 .BR create-master
 287 Create and populate a directory for a new buildmaster
 288 .TP
 289 .BR upgrade-master
 290 Upgrade an existing buildmaster directory for the current version
 291 .TP
 292 .BR start
 293 Start a buildmaster
 294 .TP
 295 .BR stop
 296 Stop a buildmaster
 297 .TP
 298 .BR restart
 299 Restart a buildmaster
 300 .TP
 301 .BR sighup | reconfig
 302 Send SIGHUP signal to buildmaster to make it re-read the config file
 303 .TP
 304 .BR sendchange
 305 Send a change to the buildmaster
 306 .TP
 307 .BR debugclient
 308 Launch a small debug panel gui
 309 .TP
 310 .BR statuslog
 311 Emit current builder status to stdout
 312 .TP
 313 .BR statusgui
 314 Display a small window showing current builder status
 315 .TP
 316 .BR try
 317 Run a build with your local changes. This command requires in-advance
 318 configuration of the buildmaster to accept such build requests. Please
 319 see the documentation for details about this command.
 320 .TP
 321 .BR tryserver
 322 buildmaster-side \'try\' support function, not for users
 323 .TP
 324 .BR checkconfig
 325 Validate buildbot master config file.
 326
 327 .SS Global options
 328 .TP
 329 .BR \-h | \-\-help
 330 Print the list of available commands and global options.
 331 All subsequent commands are ignored.
 332 .TP
 333 .BR --version
 334 Print twistd and buildslave version.
 335 All subsequent commands are ignored.
 336 .TP
 337 .BR --verbose
 338 Verbose output.
 339
 340 .SS create-master command options
 341 .TP
 342 .BR \-q | \-\-quiet
 343 Do not emit the commands being run
 344 .TP
 345 .BR \-f | \-\-force
 346 Re-use an existing directory (will not overwrite master.cfg file)
 347 .TP
 348 .BR \-r | \-\-relocatable
 349 Create a relocatable buildbot.tac
 350 .TP
 351 .BR \-c | \-\-config
 352 Set name of the buildbot master config file to
 353 .IR CONFIG .
 354 Default file name is master.cfg.
 355 .TP
 356 .BR \-s | \-\-log-size
 357 Set size at which twisted lof file is rotated to
 358 .I SIZE
 359 bytes.
 360 Default value is 1000000 bytes.
 361 .TP
 362 .BR \-l | \-\-log-count
 363 Limit the number of kept old twisted log files to
 364 .IR COUNT .
 365 All files are kept by default.
 366 .TP
 367 .BR \-\-db
 368 Set the database connection for storing scheduler/status state to
 369 .IR DATABASE .
 370 Default value is
 371 .BR "sqlite:///state.sqlite" .
 372 .TP
 373 .I PATH
 374 Directory where buildbot master files will be stored.
 375
 376 .SS upgrade-master command options
 377 .TP
 378 .BR \-q | \-\-quiet
 379 Do not emit the commands being run.
 380 .TP
 381 .BR \-r | \-\-replace
 382 Replace any modified files without confirmation.
 383 .TP
 384 .BR \-\-db
 385 Set the database connection for storing scheduler/status state to
 386 .IR DATABASE .
 387 Default value is
 388 .BR "sqlite:///state.sqlite" .
 389 .TP
 390 .I PATH
 391 Directory where buildbot master files are stored.
 392
 393 .SS sendchange command options
 394 .TP
 395 .B \-\-master
 396 Set the location of buildmaster's PBListener to attach to in form
 397 .IR HOST : PORT .
 398 .TP
 399 .BR \-u | \-\-username
 400 Set commiter's username to
 401 .IR USERNAME .
 402 .TP
 403 .BR \-R | \-\-repository
 404 Set repository URL to
 405 .IR REPOSITORY .
 406 .TP
 407 .BR \-P | \-\-project
 408 Set project specifier to
 409 .IR PROJECT .
 410 .TP
 411 .BR \-b | \-\-branch
 412 Set branch name to
 413 .IR BRANCH .
 414 .TP
 415 .BR \-c | \-\-category
 416 Set category of repository to
 417 .IR CATEGORY .
 418 .TP
 419 .BR \-r | \-\-revision
 420 Set revision being built to
 421 .IR REVISION .
 422 .TP
 423 .BR \-\-revision-file
 424 Use
 425 .I REVISIONFILE
 426 file to read revision spec data from.
 427 .TP
 428 .BR \-p | \-\-property
 429 Set property for the change to
 430 .IR PROPERTY .
 431 It should be in format
 432 .IR NAME : VALUE .
 433 .TP
 434 .BR \-m | \-\-comments
 435 Set log message to
 436 .IR MESSAGE .
 437 .TP
 438 .BR \-F | \-\-logfile
 439 Set logfile to
 440 .IR LOGFILE .
 441 .TP
 442 .BR \-w | \-\-when
 443 Set timestamp used as the change time to
 444 .IR TIMESTAMP .
 445 .TP
 446 .I FILES
 447 Lis of files have been changed.
 448
 449 .SS debugclient command options
 450 .TP
 451 .BR \-m | \-\-master
 452 Set the location of buildmaster's PBListener to attach to in form
 453 .IR HOST : PORT .
 454 .TP
 455 .BR \-p | \-\-passwd
 456 Debug password to use.
 457
 458 .SS statuslog command options
 459 .TP
 460 .BR \-m | \-\-master
 461 Set the location of buildmaster's PBListener to attach to in form
 462 .IR HOST : PORT .
 463 .TP
 464 .BR \-u | \-\-username
 465 Set username for PB authentication to
 466 .IR USERNAME .
 467 Default is
 468 .BR statusClient .
 469 .TP
 470 .BR \-p | \-\-passwd
 471 Set password for PB authentication to
 472 .IR PASSWORD .
 473 Default is
 474 .BR clientpw .
 475
 476 .SS statusgui command options
 477 .TP
 478 .BR \-m | \-\-master
 479 Set the location of buildmaster's PBListener to attach to in form
 480 .IR HOST : PORT .
 481 .TP
 482 .BR \-u | \-\-username
 483 Set username for PB authentication to
 484 .IR USERNAME .
 485 Default is
 486 .BR statusClient .
 487 .TP
 488 .BR \-p | \-\-passwd
 489 Set password for PB authentication to
 490 .IR PASSWORD .
 491 Default is
 492 .BR clientpw .
 493
 494 .SS try command options
 495 .TP
 496 .BR \-\-wait
 497 Wait until the builds have finished.
 498 .TP
 499 .BR \-n | \-\-dry-run
 500 Gather info, but don't actually submit.
 501 .TP
 502 .BR \-\-get-builder-names
 503 Get the names of available builders.
 504 Doesn't submit anything.
 505 Only supported for 'pb' connections.
 506 .TP
 507 .BR \-c | \-\-connect
 508 Connection type.
 509 Can be either \'ssh\' or \'pb\'.
 510 .TP
 511 .BR \-\-tryhost
 512 Set the hostname (used by ssh) for the buildmaster to
 513 .IR HOSTNAME .
 514 .TP
 515 .BR \-\-trydir
 516 Specify trydir (on the tryhost) where tryjobs are deposited.
 517 .TP
 518 .BR \-m | \-\-master
 519 Set the location of the buildmaster's PBListener in form
 520 .IR HOST : PORT
 521 .TP
 522 .BR \-u | \-\-username
 523 Set the username performing the trial build to
 524 .IR USERNAME .
 525 .TP
 526 .BR \-\-passwd
 527 Set password for PB authentication to
 528 .IR PASSWORD .
 529 .TP
 530 .BR \-\-diff
 531 Use
 532 .I DIFF
 533 file to use as a patch instead of scanning a local tree.
 534 Use \'-\' for stdin.
 535 .TP
 536 .BR \-\-patchlevel
 537 Specify the patchlevel to apply with.
 538 Defaults to 0.
 539 See
 540 .BR patch
 541 for details.
 542 .TP
 543 .BR \-\-baserev
 544 Use
 545 .I BASEREV
 546 revision instead of scanning a local tree.
 547 .TP
 548 .BR \-\-vc
 549 Specify version control system in use.
 550 Possible values: cvs, svn, tla, baz, darcs, p4.
 551 .TP
 552 .BR \-\-branch
 553 Specify the branch in use, for VC systems that can't figure it out themselves.
 554 .TP
 555 .BR \-b | \-\-builder
 556 Run the trial build on the specified Builder. Can be used multiple times.
 557 .TP
 558 .BR \-\-properties
 559 Specify the set of properties made available in the build environment in format
 560 .IR prop1 = value1 , prop2 = value2 ...
 561 .TP
 562 .BR \-\-try-topfile
 563 Specify name of a file at the top of the tree.
 564 This option is used to find the top.
 565 Only needed for SVN and CVS.
 566 .TP
 567 .BR \-\-try-topdir
 568 Specify the path to the top of the working copy.
 569 Only needed for SVN and CVS.
 570
 571 .SS tryserver command options
 572 .TP
 573 .BR \-\-jobdir
 574 The jobdir (maildir) for submitting jobs
 575 .SH FILES
 576 .TP
 577 master.cfg
 578 Buildbot master configuration file
 579 .SH AUTHOR
 580 \fBAndriy Senkovych\fR <\&andriysenkovych@gmail.com\&>
 581 .SH "SEE ALSO"
 582 .BR buildslave (1),
 583 .BR patch (1)
 584 .PP
 585 The complete documentation is available in texinfo format. To use it, run
 586 .BR "info buildbot" .