1
2BUILDBOT-WORKER(1)               User Commands              BUILDBOT-WORKER(1)
3
4
5

NAME

7       buildbot-worker - a tool for managing buildbot worker instances
8

SYNOPSIS

10       buildbot-worker [ global options ] command [ command options ]
11
12       buildbot-worker   create-worker   [  -q|--quiet  ]  [  -f|--force  ]  [
13       -r|--relocatable ] [ -n|--no-logrotate ]  [  -k|--keepalive  TIME  ]  [
14       --usepty  {0|1}  ] [ --umask UMASK ] [ -s|--log-size SIZE ] [ -l|--log-
15       count COUNT ] [ --verbose ] PATH MASTER USERNAME PASSWORD
16
17       buildbot-worker [ --verbose ] { start|stop|restart } [ PATH ]
18
19       buildbot-worker [ --verbose ] { --help|--version }
20
21       buildbot-worker command -h|--help
22

DESCRIPTION

24       The `buildbot-worker' command-line tool can be used to start or stop  a
25       Buildbot worker or create a new worker instance.
26

OPTIONS

28   Commands
29       create-worker
30              Create and populate a directory for a new worker
31
32       start  Start a worker
33
34       stop   Stop a worker
35
36       restart
37              Restart a worker
38
39   Global options
40       -h|--help
41              Print  the  list  of available commands and global options.  All
42              subsequent commands are ignored.
43
44       --version
45              Print twistd and buildbot-worker version.  All  subsequent  com‐
46              mands are ignored.
47
48       --verbose
49              Verbose output.
50
51   create-worker command options
52       -f|--force
53              Re-use an existing directory.
54
55       -h|--help
56              Show help for current command and exit.  All subsequent commands
57              are ignored.
58
59       -k|--keepalive
60              Send keepalive  requests  to  buildmaster  every  TIME  seconds.
61              Default value is 600 seconds.
62
63       -l|--log-count
64              Limit  the  number  of kept old twisted log files to COUNT.  All
65              files are kept by default.
66
67       -q|--quiet
68              Do not emit the commands being run.
69
70       -r|--relocatable
71              Create a relocatable buildbot.tac.
72
73       -n|--no-logrotate
74              Do not permit worker rotate logs by itself.
75
76       -s|--log-size
77              Set size at which twisted lof file is  rotated  to  SIZE  bytes.
78              Default value is 1000000 bytes.
79
80       --umask
81              Set  umask  for  files  created by worker.  Default value is 077
82              which means only owner can access the files.  See  umask(2)  for
83              more details.
84
85       --usepty
86              Set  whether  child processes should be run in a pty (0 means do
87              not run in a pty).  Default value is 0.
88
89       PATH   Path to worker base directory.
90
91       MASTER Set the host and port of buildbot master to attach  to  in  form
92              HOST:PORT.   This  should be provided by buildmaster administra‐
93              tor.
94
95       USERNAME
96              Worker name to connect with.  This should be provided by  build‐
97              master administrator.
98
99       PASSWORD
100              Worker  password  to  connect  with.  This should be provided by
101              buildmaster administrator.
102

SEE ALSO

104       buildbot(1), umask(2),
105
106
107
108Buildbot                          August 2010               BUILDBOT-WORKER(1)
Impressum