1BEANSTALKD(1)                                                    BEANSTALKD(1)
2
3
4

NAME

6       beanstalkd - simple, fast work queue
7

SYNOPSIS

9       beanstalkd [options]
10

DESCRIPTION

12       Beanstalkd  is  a  simple work-queue service. Its interface is generic,
13       though it was originally designed for  reducing  the  latency  of  page
14       views  in  high-volume web applications by running time-consuming tasks
15       asynchronously.
16
17       When started, beanstalkd opens a socket (or uses a file descriptor pro‐
18       vided  by the init(1) system, see ENVIRONMENT) and listens for incoming
19       connections. For each connection, it reads a sequence  of  commands  to
20       create, reserve, delete, and otherwise manipulate "jobs", units of work
21       to be done. See file doc/protocol.txt in  the  beanstalkd  distribution
22       for  a thorough description of the meaning and format of the beanstalkd
23       protocol.
24

OPTIONS

26       -b path
27              Use a binlog to keep jobs on  persistent  storage  in  directory
28              path.  Upon  startup, beanstalkd will recover any binlog that is
29              present in path, then, during normal operation, append new  jobs
30              and changes in state to the binlog.
31
32       -c     Perform  online, incremental compaction of binlog files. Negates
33              -n. This is the default behavior.
34
35              (Do not use this option, except to negate -n.  Both  -c  and  -n
36              will likely be removed in a future beanstalkd release.)
37
38       -f ms  Call  fsync(2) at most once every ms milliseconds. Larger values
39              for ms reduce disk activity and improve speed  at  the  cost  of
40              safety.  A  power  failure  could result in the loss of up to ms
41              milliseconds of history.
42
43              A ms value of 0 will cause beanstalkd to call fsync  every  time
44              it writes to the binlog.
45
46              (This option has no effect without -b.)
47
48       -F     Never call fsync(2). Equivalent to -f with an infinite ms value.
49
50              This is the default behavior.
51
52              (This option has no effect without -b.)
53
54       -h     Show a brief help message and exit.
55
56       -l addr
57              Listen on address addr (default is 0.0.0.0).
58
59              (Option  -l  has  no effect if sd-daemon(5) socket activation is
60              being used. See also ENVIRONMENT.)
61
62       -n     Turn off binlog compaction, negating -c.
63
64              (Do not use this option. Both -c and -n will likely  be  removed
65              in a future beanstalkd release.)
66
67       -p port
68              Listen on TCP port port (default is 11300).
69
70              (Option  -p  has  no effect if sd-daemon(5) socket activation is
71              being used. See also ENVIRONMENT.)
72
73       -s bytes
74              The size in bytes of each binlog file.
75
76              (This option has no effect without -b.)
77
78       -u user
79              Become the user user and its primary group.
80
81       -V     Increase verbosity. May be used more than once to  produce  more
82              verbose output. The output format is subject to change.
83
84       -v     Print the version string and exit.
85
86       -z bytes
87              The maximum size in bytes of a job.
88

ENVIRONMENT

90       LISTEN_PID, LISTEN_FDS
91              These  variables can be set by init(1). See sd_listen_fds(3) for
92              details.
93

SEE ALSO

95       sd-daemon(5), sd_listen_fds(5)
96
97       Files README and doc/protocol.txt in the beanstalkd distribution.
98
99       http://kr.github.com/beanstalkd/
100

AUTHOR

102       Beanstalkd is written and maintained by Keith Rarick with the  help  of
103       many others.
104
105
106
107                                  April 2012                     BEANSTALKD(1)