debian/buildslave.1

   1 .\" Based on template /usr/share/man-db/examples/manpage.example provided by
   2 .\" Tom Christiansen <tchrist@jhereg.perl.com>.
   3 .TH BUILDSLAVE "1" "August 2010" "Buildbot version: 0.8.1" "User Commands"
   4 .SH NAME
   5 buildslave \- a tool for managing buildbot slave instances
   6 .SH SYNOPSIS
   7 .PP
   8 .B buildslave
   9 [
  10 .BR "global options"
  11 ]
  12 .I command
  13 [
  14 .BR "command options"
  15 ]
  16 .PP
  17 .B buildslave
  18 create-slave
  19 [
  20 .BR \-q | \-\-quiet
  21 ]
  22 [
  23 .BR \-f | \-\-force
  24 ]
  25 [
  26 .BR \-r | \-\-relocatable
  27 ]
  28 [
  29 .BR \-k | \-\-keepalive
  30 .I TIME
  31 ]
  32 [
  33 .BR --usepty
  34 {0|1}
  35 ]
  36 [
  37 .BR \-\-umask
  38 .I UMASK
  39 ]
  40 [
  41 .BR \-s | \-\-log-size
  42 .I SIZE
  43 ]
  44 [
  45 .BR \-l | \-\-log-count
  46 .I COUNT
  47 ]
  48 [
  49 .BR \-\-verbose
  50 ]
  51 .I PATH
  52 .I MASTER
  53 .I USERNAME
  54 .I PASSWORD
  55 .PP
  56 .B buildslave
  57 [
  58 .BR \-\-verbose
  59 ]
  60 {
  61 .BR start | stop | restart
  62 }
  63 [
  64 .I PATH
  65 ]
  66 .PP
  67 .B buildslave
  68 [
  69 .BR \-\-verbose
  70 ]
  71 {
  72 .BR \-\-help | \-\-version
  73 }
  74 .PP
  75 .B buildslave
  76 .I command
  77 .BR \-h | \-\-help
  78 .SH DESCRIPTION
  79 .\" Putting a newline after each sentence can generate better output.
  80 The `buildslave' command-line tool can be used to start or stop a
  81 buildslave or create a new buildslave instance.
  82 .SH OPTIONS
  83 .SS Commands
  84 .TP
  85 .BR create-slave
  86 Create and populate a directory for a new buildslave
  87 .TP
  88 .BR start
  89 Start a buildslave
  90 .TP
  91 .BR stop
  92 Stop a buildslave
  93 .TP
  94 .BR restart
  95 Restart a buildslave
  96 .SS Global options
  97 .TP
  98 .BR \-h | \-\-help
  99 Print the list of available commands and global options.
 100 All subsequent commands are ignored.
 101 .TP
 102 .BR --version
 103 Print twistd and buildslave version.
 104 All subsequent commands are ignored.
 105 .TP
 106 .BR --verbose
 107 Verbose output.
 108 .SS create-slave command options
 109 .TP
 110 .BR \-f | \-\-force
 111 Re-use an existing directory.
 112 .TP
 113 .BR \-h | \-\-help
 114 Show help for current command and exit.
 115 All subsequent commands are ignored.
 116 .TP
 117 .BR \-k | \-\-keepalive
 118 Send keepalive requests to buildmaster every
 119 .I TIME
 120 seconds.
 121 Default value is 600 seconds.
 122 .TP
 123 .BR \-l | \-\-log-count
 124 Limit the number of kept old twisted log files to
 125 .IR COUNT .
 126 All files are kept by default.
 127 .TP
 128 .BR \-q | \-\-quiet
 129 Do not emit the commands being run.
 130 .TP
 131 .BR \-r | \-\-relocatable
 132 Create a relocatable buildbot.tac
 133 .TP
 134 .BR \-s | \-\-log-size
 135 Set size at which twisted lof file is rotated to
 136 .I SIZE
 137 bytes.
 138 Default value is 1000000 bytes.
 139 .TP
 140 .BR \-\-umask
 141 Set umask for files created by buildslave.
 142 Default value is 077 which means only owner can access the files.
 143 See
 144 .BR umask (2)
 145 for more details.
 146 .TP
 147 .BR \-\-usepty
 148 Set wether child processes should be run in a pty (0 means do not run in a
 149 pty).
 150 Default value is 0.
 151 .TP
 152 .I PATH
 153 Path to buildslave base directory.
 154 .TP
 155 .I MASTER
 156 Set the host and port of buildbot master to attach to in form
 157 .IR HOST:PORT .
 158 This should be provided by buildmaster administrator.
 159 .TP
 160 .I USERNAME
 161 Buildslave name to connect with.
 162 This should be provided by buildmaster administrator.
 163 .TP
 164 .I PASSWORD
 165 Buildslave password to connect with.
 166 This should be provided by buildmaster administrator.
 167 .SH AUTHOR
 168 \fBAndriy Senkovych\fR <\&andriysenkovych@gmail.com\&>
 169 .SH "SEE ALSO"
 170 .BR buildbot (1),
 171 .BR umask (2),
 172 .PP
 173 The complete documentation is available in texinfo format. To use it, run
 174 .BR "info buildbot" .
 175