- BEANSTALKD(1)
- BEANSTALKD(1)
NAME
beanstalkd
- simple, fast work queue
SYNOPSIS
beanstalkd
[options]
DESCRIPTION
Beanstalkd
is a simple work-queue service. Its interface is generic, though it was originally designed for reducing the latency of page views in high-volume web applications by running time-consuming tasks asynchronously.
When started, beanstalkd
opens a socket (or uses a file descriptor provided by theinit(1) system, see ENVIRONMENT) and listens for incoming connections. For each connection, it reads a sequence of commands to create, reserve, delete, and otherwise manipulate "jobs", units of work to be done. See file doc/protocol.txt
in the beanstalkd
distribution for a thorough description of the meaning and format of the beanstalkd
protocol.
OPTIONS
-b
pathUse a binlog to keep jobs on persistent storage in directory path. Upon startup,
beanstalkd
will recover any binlog that is present in path, then, during normal operation, append new jobs and changes in state to the binlog.-c
Perform online, incremental compaction of binlog files. Negates
-n
. This is the default behavior.(Do not use this option, except to negate
-n
. Both-c
and-n
will likely be removed in a futurebeanstalkd
release.)-f
msCall fsync(2) at most once every ms milliseconds. Larger values for msreduce disk activity and improve speed at the cost of safety. A power failure could result in the loss of up to ms milliseconds of history.
A ms value of 0 will cause
beanstalkd
to call fsync every time it writes to the binlog.(This option has no effect without
-b
.)-F
Never call fsync(2). Equivalent to
-f
with an infinite ms value.This is the default behavior.
(This option has no effect without
-b
.)-h
Show a brief help message and exit.
-l
addrListen on address addr (default is 0.0.0.0).
(Option
-l
has no effect if sd-daemon(5) socket activation is being used. See also ENVIRONMENT.)-n
Turn off binlog compaction, negating
-c
.(Do not use this option. Both
-c
and-n
will likely be removed in a futurebeanstalkd
release.)-p
portListen on TCP port port (default is 11300).
(Option
-p
has no effect if sd-daemon(5) socket activation is being used. See also ENVIRONMENT.)-s
bytesThe size in bytes of each binlog file.
(This option has no effect without
-b
.)-u
userBecome the user user and its primary group.
-V
Increase verbosity. May be used more than once to produce more verbose output. The output format is subject to change.
-v
Print the version string and exit.
-z
bytesThe maximum size in bytes of a job.
ENVIRONMENT
LISTEN_PID
,LISTEN_FDS
- These variables can be set by init(1). See sd_listen_fds(3) for details.
SEE ALSO
sd-daemon(5), sd_listen_fds(5)
Files README
and doc/protocol.txt
in the beanstalkd
distribution.
http://kr.github.com/beanstalkd/
AUTHOR
Beanstalkd
is written and maintained by Keith Rarick with the help of many others.
- APRIL 2012
- BEANSTALKD(1)