doc/beanstalkd.1

   1 .TH BEANSTALKD 1 "October 14, 2009"
   2 .SH NAME
   3 beastalkd \- A simple, fast work queue.
   4 .SH SYNOPSIS
   5 .B beanstalkd
   6 .RI [ options ]
   7 .br
   8 .SH DESCRIPTION
   9 This manual page documents briefly the
  10 .B beanstalkd
  11 work-queue service.
  12 The beanstalk interface is generic, but was originally
  13 designed for reducing the latency of page views in high-volume web applications
  14 by running time-consuming tasks asynchronously.
  15 .br
  16 .SH OPTIONS
  17 A summary of options is included below.
  18 .TP
  19 .B \-b <dir>
  20 Use a binlog to keep jobs on persistent storage in <dir>. Upon startup,
  21 beanstalkd will recover any binlog that is present in <dir>, then, during
  22 normal operation, append new jobs and changes in state to the binlog.
  23 .TP
  24 .B \-d
  25 Detach and run beanstalkd as a daemon.
  26 .TP
  27 .B \-f <ms>
  28 Call
  29 .BR fsync (2)
  30 at most once every <ms> milliseconds. This will recuce disk activity
  31 and improve speed at the cost of safety. A power failure could result in the
  32 loss of up to <ms> milliseconds of history.
  33
  34 A <ms> value of 0 will cause beanstalkd to call fsync every time it writes to
  35 the binlog.
  36
  37 This option has no effect without the
  38 .B \-b
  39 option.
  40 .TP
  41 .B \-F
  42 Never call
  43 .BR fsync (2)
  44 function. This is like
  45 .B \-f
  46 with a <ms> value of infinity.
  47
  48 This option has no effect without the
  49 .B \-b
  50 option.
  51 .TP
  52 .B \-h
  53 Show the command line help and summary of options.
  54 .TP
  55 .B \-l <addr>
  56 Listen on address <addr> (default is 0.0.0.0)
  57 .TP
  58 .B \-p <port>
  59 Listen on TCP port <port> (default is 11300).
  60 .TP
  61 .B \-s <bytes>
  62 The maximum size in bytes of each binlog file.
  63
  64 This option has no effect without the
  65 .B \-b
  66 option.
  67 .TP
  68 .B \-u <user>
  69 Become the user <user> and its primary group.
  70 .TP
  71 .B \-z <bytes>
  72 The maximum size in bytes of a job.
  73 .SH LICENSE
  74 The beanstalkd daemon is copyright Keith Rarick and Philotic Inc. and is
  75 distributed under the GNU General Public License version 3 or later.
  76 .br
  77 .SH SEE ALSO
  78 The README file that comes with beanstalkd
  79 .br
  80 .B http://xph.us/software/beanstalkd/
  81 .SH AUTHOR
  82 The beanstalkd daemon was written by Keith Rarick and Philotic Inc.
  83 .br