doc/beanstalkd.1.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta http-equiv='content-type' content='text/html;charset=utf8'>
   5   <meta name='generator' content='Ronn-NG/v0.8.2 (http://github.com/apjanke/ronn-ng/tree/0.8.2)'>
   6   <title>beanstalkd(1) - simple, fast work queue</title>
   7   <style type='text/css' media='all'>
   8   /* style: man */
   9   body#manpage {margin:0}
  10   .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
  11   .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
  12   .mp h2 {margin:10px 0 0 0}
  13   .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
  14   .mp h3 {margin:0 0 0 4ex}
  15   .mp dt {margin:0;clear:left}
  16   .mp dt.flush {float:left;width:8ex}
  17   .mp dd {margin:0 0 0 9ex}
  18   .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
  19   .mp pre {margin-bottom:20px}
  20   .mp pre+h2,.mp pre+h3 {margin-top:22px}
  21   .mp h2+pre,.mp h3+pre {margin-top:5px}
  22   .mp img {display:block;margin:auto}
  23   .mp h1.man-title {display:none}
  24   .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
  25   .mp h2 {font-size:16px;line-height:1.25}
  26   .mp h1 {font-size:20px;line-height:2}
  27   .mp {text-align:justify;background:#fff}
  28   .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
  29   .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
  30   .mp u {text-decoration:underline}
  31   .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
  32   .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
  33   .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
  34   .mp b.man-ref {font-weight:normal;color:#434241}
  35   .mp pre {padding:0 4ex}
  36   .mp pre code {font-weight:normal;color:#434241}
  37   .mp h2+pre,h3+pre {padding-left:0}
  38   ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
  39   ol.man-decor {width:100%}
  40   ol.man-decor li.tl {text-align:left}
  41   ol.man-decor li.tc {text-align:center;letter-spacing:4px}
  42   ol.man-decor li.tr {text-align:right;float:right}
  43   </style>
  44 </head>
  45 <!--
  46   The following styles are deprecated and will be removed at some point:
  47   div#man, div#man ol.man, div#man ol.head, div#man ol.man.
  48
  49   The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
  50   .man-navigation should be used instead.
  51 -->
  52 <body id='manpage'>
  53   <div class='mp' id='man'>
  54
  55   <div class='man-navigation' style='display:none'>
  56     <a href="#NAME">NAME</a>
  57     <a href="#SYNOPSIS">SYNOPSIS</a>
  58     <a href="#DESCRIPTION">DESCRIPTION</a>
  59     <a href="#OPTIONS">OPTIONS</a>
  60     <a href="#ENVIRONMENT">ENVIRONMENT</a>
  61     <a href="#SEE-ALSO">SEE ALSO</a>
  62     <a href="#AUTHOR">AUTHOR</a>
  63   </div>
  64
  65   <ol class='man-decor man-head man head'>
  66     <li class='tl'>beanstalkd(1)</li>
  67     <li class='tc'></li>
  68     <li class='tr'>beanstalkd(1)</li>
  69   </ol>
  70
  71
  72
  73 <h2 id="NAME">NAME</h2>
  74 <p class="man-name">
  75   <code>beanstalkd</code> - <span class="man-whatis">simple, fast work queue</span>
  76 </p>
  77 <h2 id="SYNOPSIS">SYNOPSIS</h2>
  78
  79 <p><code>beanstalkd</code> [<var>options</var>]</p>
  80
  81 <h2 id="DESCRIPTION">DESCRIPTION</h2>
  82
  83 <p><code>Beanstalkd</code> is a simple work-queue service. Its interface is
  84 generic, though it was originally designed for reducing the latency of
  85 page views in high-volume web applications by running time-consuming
  86 tasks asynchronously.</p>
  87
  88 <p>When started, <code>beanstalkd</code> opens a socket (or uses a file descriptor
  89 provided by the <span class="man-ref">init<span class="s">(1)</span></span> system, see <a href="#ENVIRONMENT" title="ENVIRONMENT" data-bare-link="true">ENVIRONMENT</a>) and listens for
  90 incoming connections. For each connection, it reads a sequence of
  91 commands to create, reserve, delete, and otherwise manipulate "jobs",
  92 units of work to be done. See file <code>doc/protocol.txt</code> in the
  93 <code>beanstalkd</code> distribution for a thorough description of the meaning
  94 and format of the <code>beanstalkd</code> protocol.</p>
  95
  96 <h2 id="OPTIONS">OPTIONS</h2>
  97
  98 <dl>
  99 <dt>
 100 <code>-b</code> <var>path</var>
 101 </dt>
 102 <dd>Use a binlog to keep jobs on persistent storage in directory <var>path</var>.
 103 Upon startup, <code>beanstalkd</code> will recover any binlog that is present
 104 in <var>path</var>, then, during normal operation, append new jobs and
 105 changes in state to the binlog.</dd>
 106 <dt>
 107 <code>-f</code> <var>ms</var>
 108 </dt>
 109 <dd>Call <span class="man-ref">fsync<span class="s">(2)</span></span> at most once every <var>ms</var> milliseconds. Larger values
 110 for <var>ms</var> reduce disk activity and improve speed at the cost of
 111 safety. A power failure could result in the loss of up to <var>ms</var>
 112 milliseconds of history.
 113
 114 <p>A <var>ms</var> value of 0 will cause <code>beanstalkd</code> to call fsync every time
 115 it writes to the binlog.</p>
 116
 117 <p>The default behavior is to sync every 50 ms.</p>
 118
 119 <p>(This option has no effect without <code>-b</code>.)</p>
 120 </dd>
 121 <dt><code>-F</code></dt>
 122 <dd>Never call <span class="man-ref">fsync<span class="s">(2)</span></span>. Equivalent to <code>-f</code> with an infinite <var>ms</var> value.
 123
 124 <p>(This option has no effect without <code>-b</code>.)</p>
 125 </dd>
 126 <dt><code>-h</code></dt>
 127 <dd>Show a brief help message and exit.</dd>
 128 <dt>
 129 <code>-l</code> <var>addr</var>
 130 </dt>
 131 <dd>Listen on address <var>addr</var> (default is 0.0.0.0).
 132
 133 <p>When <var>addr</var> starts with "unix:", the unprefixed value of it will be
 134 used as the local filesystem path to create a UNIX socket instead of
 135 a TCP socket. In this case the value of <code>-p</code> will be ignored.</p>
 136
 137 <p>(Option <code>-l</code> has no effect if <span class="man-ref">sd-daemon<span class="s">(5)</span></span> socket activation is
 138 being used. See also <a href="#ENVIRONMENT" title="ENVIRONMENT" data-bare-link="true">ENVIRONMENT</a>.)</p>
 139 </dd>
 140 <dt>
 141 <code>-p</code> <var>port</var>
 142 </dt>
 143 <dd>Listen on TCP port <var>port</var> (default is 11300).
 144
 145 <p>(Option <code>-p</code> has no effect if <span class="man-ref">sd-daemon<span class="s">(5)</span></span> socket activation is
 146 being used. See also <a href="#ENVIRONMENT" title="ENVIRONMENT" data-bare-link="true">ENVIRONMENT</a>.)</p>
 147 </dd>
 148 <dt>
 149 <code>-s</code> <var>bytes</var>
 150 </dt>
 151 <dd>The size in bytes of each binlog file.
 152
 153 <p>(This option has no effect without <code>-b</code>.)</p>
 154 </dd>
 155 <dt>
 156 <code>-u</code> <var>user</var>
 157 </dt>
 158 <dd>Become the user <var>user</var> and its primary group.</dd>
 159 <dt><code>-V</code></dt>
 160 <dd>Increase verbosity. May be used more than once to produce more
 161 verbose output. The output format is subject to change.</dd>
 162 <dt><code>-v</code></dt>
 163 <dd>Print the version string and exit.</dd>
 164 <dt>
 165 <code>-z</code> <var>bytes</var>
 166 </dt>
 167 <dd>The maximum size in bytes of a job.</dd>
 168 <dt><code>-c</code></dt>
 169 <dd>This flag has no effect. It is kept for historical compatibility only.</dd>
 170 <dt><code>-n</code></dt>
 171 <dd>This flag has no effect. It is kept for historical compatibility only.</dd>
 172 </dl>
 173
 174
 175 <h2 id="ENVIRONMENT">ENVIRONMENT</h2>
 176
 177 <dl>
 178 <dt>
 179 <code>LISTEN_PID</code>, <code>LISTEN_FDS</code>
 180 </dt>
 181 <dd>These variables can be set by <span class="man-ref">init<span class="s">(1)</span></span>. See <span class="man-ref">sd_listen_fds<span class="s">(3)</span></span> for
 182 details.</dd>
 183 </dl>
 184
 185
 186 <h2 id="SEE-ALSO">SEE ALSO</h2>
 187
 188 <p><span class="man-ref">sd-daemon<span class="s">(3)</span></span>, <span class="man-ref">sd_listen_fds<span class="s">(3)</span></span></p>
 189
 190 <p>Files <code>README.md</code> and <code>doc/protocol.txt</code> in the <code>beanstalkd</code>
 191 distribution.</p>
 192
 193 <p><a href="https://beanstalkd.github.io/" data-bare-link="true">https://beanstalkd.github.io/</a></p>
 194
 195 <h2 id="AUTHOR">AUTHOR</h2>
 196
 197 <p><code>Beanstalkd</code> is written by Keith Rarick and maintained by the community at
 198 <a href="https://github.com/beanstalkd/beanstalkd/issues" data-bare-link="true">https://github.com/beanstalkd/beanstalkd/issues</a></p>
 199
 200   <ol class='man-decor man-foot man foot'>
 201     <li class='tl'></li>
 202     <li class='tc'>June 2020</li>
 203     <li class='tr'>beanstalkd(1)</li>
 204   </ol>
 205
 206   </div>
 207 </body>
 208 </html>