doc/beanstalkd.1

   1 .\" generated with Ronn-NG/v0.8.2
   2 .\" http://github.com/apjanke/ronn-ng/tree/0.8.2
   3 .TH "BEANSTALKD" "1" "June 2020" "" ""
   4 .SH "NAME"
   5 \fBbeanstalkd\fR \- simple, fast work queue
   6 .SH "SYNOPSIS"
   7 \fBbeanstalkd\fR [\fIoptions\fR]
   8 .SH "DESCRIPTION"
   9 \fBBeanstalkd\fR 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\.
  10 .P
  11 When started, \fBbeanstalkd\fR opens a socket (or uses a file descriptor provided by the init(1) system, see \fI\%#ENVIRONMENT\fR) 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 \fBdoc/protocol\.txt\fR in the \fBbeanstalkd\fR distribution for a thorough description of the meaning and format of the \fBbeanstalkd\fR protocol\.
  12 .SH "OPTIONS"
  13 .TP
  14 \fB\-b\fR \fIpath\fR
  15 Use a binlog to keep jobs on persistent storage in directory \fIpath\fR\. Upon startup, \fBbeanstalkd\fR will recover any binlog that is present in \fIpath\fR, then, during normal operation, append new jobs and changes in state to the binlog\.
  16 .TP
  17 \fB\-f\fR \fIms\fR
  18 Call fsync(2) at most once every \fIms\fR milliseconds\. Larger values for \fIms\fR reduce disk activity and improve speed at the cost of safety\. A power failure could result in the loss of up to \fIms\fR milliseconds of history\.
  19 .IP
  20 A \fIms\fR value of 0 will cause \fBbeanstalkd\fR to call fsync every time it writes to the binlog\.
  21 .IP
  22 The default behavior is to sync every 50 ms\.
  23 .IP
  24 (This option has no effect without \fB\-b\fR\.)
  25 .TP
  26 \fB\-F\fR
  27 Never call fsync(2)\. Equivalent to \fB\-f\fR with an infinite \fIms\fR value\.
  28 .IP
  29 (This option has no effect without \fB\-b\fR\.)
  30 .TP
  31 \fB\-h\fR
  32 Show a brief help message and exit\.
  33 .TP
  34 \fB\-l\fR \fIaddr\fR
  35 Listen on address \fIaddr\fR (default is 0\.0\.0\.0)\.
  36 .IP
  37 When \fIaddr\fR starts with "unix:", the unprefixed value of it will be used as the local filesystem path to create a UNIX socket instead of a TCP socket\. In this case the value of \fB\-p\fR will be ignored\.
  38 .IP
  39 (Option \fB\-l\fR has no effect if sd\-daemon(5) socket activation is being used\. See also \fI\%#ENVIRONMENT\fR\.)
  40 .TP
  41 \fB\-p\fR \fIport\fR
  42 Listen on TCP port \fIport\fR (default is 11300)\.
  43 .IP
  44 (Option \fB\-p\fR has no effect if sd\-daemon(5) socket activation is being used\. See also \fI\%#ENVIRONMENT\fR\.)
  45 .TP
  46 \fB\-s\fR \fIbytes\fR
  47 The size in bytes of each binlog file\.
  48 .IP
  49 (This option has no effect without \fB\-b\fR\.)
  50 .TP
  51 \fB\-u\fR \fIuser\fR
  52 Become the user \fIuser\fR and its primary group\.
  53 .TP
  54 \fB\-V\fR
  55 Increase verbosity\. May be used more than once to produce more verbose output\. The output format is subject to change\.
  56 .TP
  57 \fB\-v\fR
  58 Print the version string and exit\.
  59 .TP
  60 \fB\-z\fR \fIbytes\fR
  61 The maximum size in bytes of a job\.
  62 .TP
  63 \fB\-c\fR
  64 This flag has no effect\. It is kept for historical compatibility only\.
  65 .TP
  66 \fB\-n\fR
  67 This flag has no effect\. It is kept for historical compatibility only\.
  68 .SH "ENVIRONMENT"
  69 .TP
  70 \fBLISTEN_PID\fR, \fBLISTEN_FDS\fR
  71 These variables can be set by init(1)\. See sd_listen_fds(3) for details\.
  72 .SH "SEE ALSO"
  73 sd\-daemon(3), sd_listen_fds(3)
  74 .P
  75 Files \fBREADME\.md\fR and \fBdoc/protocol\.txt\fR in the \fBbeanstalkd\fR distribution\.
  76 .P
  77 \fI\%https://beanstalkd\.github\.io/\fR
  78 .SH "AUTHOR"
  79 \fBBeanstalkd\fR is written by Keith Rarick and maintained by the community at \fI\%https://github\.com/beanstalkd/beanstalkd/issues\fR