Merge commit 'copiousfreetime/update-script-options'
[beanstalkd.git] / doc / beanstalkd.1
blob21ac2525dec17fdc94b4aa7b2c31b890384175a1
1 .TH BEANSTALKD 1 "November 21, 2008"
2 .SH NAME
3 beastalkd \- A fast, distributed, in-memory work-queue service
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 .PP
13 .B beanstalkd
14 is a fast, distributed, in-memory work-queue service. Its
15 interface is generic, but was originally designed for reducing the
16 latency of page views in high-volume web applications by running most
17 time-consuming tasks asynchronously.
18 .br
19 .SH OPTIONS
20 These programs follow the usual GNU command line syntax. A summary of options 
21 is included below.
22 .TP
23 .B \-d
24 Detach and run beanstalkd as a daemon.
25 .TP
26 .B \-l <addr>
27 Listen on address ADDR (default is 0.0.0.0)
28 .TP
29 .B \-u <user>
30 Become the user USER and its primary group.
31 .TP
32 .B \-p <port>
33 Listen on TCP port PORT (default is 11300).
34 .TP
35 .B \-z <size>
36 The maximum size in bytes of a job.
37 .TP
38 .B \-h
39 Show the command line help and summary of options.
40 .SH LICENSE
41 The beanstalkd daemon is copyright Keith Rarick and Philotic Inc. and is
42 distributed under the GNU General Public License version 3 or later.
43 .br
44 .SH SEE ALSO
45 The README file that comes with beanstalkd
46 .br
47 .B http://xph.us/software/beanstalkd/
48 .SH AUTHOR
49 The beanstalkd daemon was written by Keith Rarick and Philotic Inc.
50 .br