doc/beanstalkd.1

   1 .\" generated with Ronn/v0.7.3
   2 .\" http://github.com/rtomayko/ronn/tree/0.7.3
   3 .
   4 .TH "BEANSTALKD" "1" "April 2012" "" ""
   5 .
   6 .SH "NAME"
   7 \fBbeanstalkd\fR \- simple, fast work queue
   8 .
   9 .SH "SYNOPSIS"
  10 \fBbeanstalkd\fR [\fIoptions\fR]
  11 .
  12 .SH "DESCRIPTION"
  13 \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\.
  14 .
  15 .P
  16 When started, \fBbeanstalkd\fR opens a socket (or uses a file descriptor provided by the init(1) system, see \fIENVIRONMENT\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\.
  17 .
  18 .SH "OPTIONS"
  19 .
  20 .TP
  21 \fB\-b\fR \fIpath\fR
  22 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\.
  23 .
  24 .TP
  25 \fB\-c\fR
  26 Perform online, incremental compaction of binlog files\. Negates \fB\-n\fR\. This is the default behavior\.
  27 .
  28 .IP
  29 (Do not use this option, except to negate \fB\-n\fR\. Both \fB\-c\fR and \fB\-n\fR will likely be removed in a future \fBbeanstalkd\fR release\.)
  30 .
  31 .TP
  32 \fB\-f\fR \fIms\fR
  33 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\.
  34 .
  35 .IP
  36 A \fIms\fR value of 0 will cause \fBbeanstalkd\fR to call fsync every time it writes to the binlog\.
  37 .
  38 .IP
  39 (This option has no effect without \fB\-b\fR\.)
  40 .
  41 .TP
  42 \fB\-F\fR
  43 Never call fsync(2)\. Equivalent to \fB\-f\fR with an infinite \fIms\fR value\.
  44 .
  45 .IP
  46 This is the default behavior\.
  47 .
  48 .IP
  49 (This option has no effect without \fB\-b\fR\.)
  50 .
  51 .TP
  52 \fB\-h\fR
  53 Show a brief help message and exit\.
  54 .
  55 .TP
  56 \fB\-l\fR \fIaddr\fR
  57 Listen on address \fIaddr\fR (default is 0\.0\.0\.0)\.
  58 .
  59 .IP
  60 (Option \fB\-l\fR has no effect if sd\-daemon(5) socket activation is being used\. See also \fIENVIRONMENT\fR\.)
  61 .
  62 .TP
  63 \fB\-n\fR
  64 Turn off binlog compaction, negating \fB\-c\fR\.
  65 .
  66 .IP
  67 (Do not use this option\. Both \fB\-c\fR and \fB\-n\fR will likely be removed in a future \fBbeanstalkd\fR release\.)
  68 .
  69 .TP
  70 \fB\-p\fR \fIport\fR
  71 Listen on TCP port \fIport\fR (default is 11300)\.
  72 .
  73 .IP
  74 (Option \fB\-p\fR has no effect if sd\-daemon(5) socket activation is being used\. See also \fIENVIRONMENT\fR\.)
  75 .
  76 .TP
  77 \fB\-s\fR \fIbytes\fR
  78 The size in bytes of each binlog file\.
  79 .
  80 .IP
  81 (This option has no effect without \fB\-b\fR\.)
  82 .
  83 .TP
  84 \fB\-u\fR \fIuser\fR
  85 Become the user \fIuser\fR and its primary group\.
  86 .
  87 .TP
  88 \fB\-V\fR
  89 Increase verbosity\. May be used more than once to produce more verbose output\. The output format is subject to change\.
  90 .
  91 .TP
  92 \fB\-v\fR
  93 Print the version string and exit\.
  94 .
  95 .TP
  96 \fB\-z\fR \fIbytes\fR
  97 The maximum size in bytes of a job\.
  98 .
  99 .SH "ENVIRONMENT"
 100 .
 101 .TP
 102 \fBLISTEN_PID\fR, \fBLISTEN_FDS\fR
 103 These variables can be set by init(1)\. See sd_listen_fds(3) for details\.
 104 .
 105 .SH "SEE ALSO"
 106 sd\-daemon(5), sd_listen_fds(5)
 107 .
 108 .P
 109 Files \fBREADME\fR and \fBdoc/protocol\.txt\fR in the \fBbeanstalkd\fR distribution\.
 110 .
 111 .P
 112 \fIhttp://kr\.github\.com/beanstalkd/\fR
 113 .
 114 .SH "AUTHOR"
 115 \fBBeanstalkd\fR is written and maintained by Keith Rarick with the help of many others\.