← Back to branch summary

~1-infe-w/gearmand/1.0

« back to all changes in this revision

Viewing changes to docs/man/gearman.1

  • Committer: Brian Aker
  • Date: 2012-09-30 23:55:03 UTC
  • mto: This revision was merged to the branch mainline in revision 660.
  • Revision ID: brian@tangent.org-20120930235503-u6r0uq1hl0mdj5an
Fix it so that we don't need to store the manpages in the tree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/gearman.1
1
 
.TH "GEARMAN" "1" "September 14, 2012" "0.38" "Gearmand"
2
 
.SH NAME
3
 
gearman \- Gearmand Documentation, http://gearman.info/
4
 
.
5
 
.nr rst2man-indent-level 0
6
 
.
7
 
.de1 rstReportMargin
8
 
\\$1 \\n[an-margin]
9
 
level \\n[rst2man-indent-level]
10
 
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11
 
-
12
 
\\n[rst2man-indent0]
13
 
\\n[rst2man-indent1]
14
 
\\n[rst2man-indent2]
15
 
..
16
 
.de1 INDENT
17
 
.\" .rstReportMargin pre:
18
 
. RS \\$1
19
 
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20
 
. nr rst2man-indent-level +1
21
 
.\" .rstReportMargin post:
22
 
..
23
 
.de UNINDENT
24
 
. RE
25
 
.\" indent \\n[an-margin]
26
 
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27
 
.nr rst2man-indent-level -1
28
 
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29
 
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30
 
..
31
 
.\" Man page generated from reStructeredText.
32
 
.
33
 
.sp
34
 
Command line client for Gearmand
35
 
.SH SYNOPSIS
36
 
.sp
37
 
\fBCommon options\fP
38
 
.INDENT 0.0
39
 
.TP
40
 
.B \-f <function>
41
 
Function name to use for jobs (can give many)
42
 
.UNINDENT
43
 
.INDENT 0.0
44
 
.TP
45
 
.B \-h <host>
46
 
Job server host
47
 
.UNINDENT
48
 
.INDENT 0.0
49
 
.TP
50
 
.B \-H
51
 
Print this help menu
52
 
.UNINDENT
53
 
.INDENT 0.0
54
 
.TP
55
 
.B \-p <port>
56
 
Gearman server port
57
 
.UNINDENT
58
 
.INDENT 0.0
59
 
.TP
60
 
.B \-t <timeout>
61
 
Timeout in milliseconds
62
 
.UNINDENT
63
 
.INDENT 0.0
64
 
.TP
65
 
.B \-i <pidfile>
66
 
Create a pidfile for the process
67
 
.UNINDENT
68
 
.INDENT 0.0
69
 
.TP
70
 
.B \-n
71
 
In client mode run one job per line, in worker mode send data packet for each line
72
 
.UNINDENT
73
 
.INDENT 0.0
74
 
.TP
75
 
.B \-N
76
 
Same as \-n, but strip off the newline
77
 
.UNINDENT
78
 
.sp
79
 
\fBClient options\fP
80
 
.INDENT 0.0
81
 
.TP
82
 
.B \-b
83
 
Run jobs in the background
84
 
.UNINDENT
85
 
.INDENT 0.0
86
 
.TP
87
 
.B \-I
88
 
Run jobs as high priority
89
 
.UNINDENT
90
 
.INDENT 0.0
91
 
.TP
92
 
.B \-L
93
 
Run jobs as low priority
94
 
.UNINDENT
95
 
.INDENT 0.0
96
 
.TP
97
 
.B \-P
98
 
Prefix all output lines with functions names
99
 
.UNINDENT
100
 
.INDENT 0.0
101
 
.TP
102
 
.B \-s
103
 
Send job without reading from standard input
104
 
.UNINDENT
105
 
.INDENT 0.0
106
 
.TP
107
 
.B \-u <unique>
108
 
Unique key to use for job
109
 
.UNINDENT
110
 
.sp
111
 
\fIWorker options*\fP
112
 
.INDENT 0.0
113
 
.TP
114
 
.B \-c <count>
115
 
Number of jobs for worker to run before exiting
116
 
.UNINDENT
117
 
.INDENT 0.0
118
 
.TP
119
 
.B \-w
120
 
Run in worker mode
121
 
.UNINDENT
122
 
.SH DESCRIPTION
123
 
.sp
124
 
With gearman you can run client and worker functions from the command line.
125
 
.sp
126
 
The environmental variable GEARMAN_SERVER can be used to specify multiple gearmand servers. Please see the c:func:\(aqgearman_client_add_servers\(aq for an explanation of the required syntax.
127
 
.SH HOME
128
 
.sp
129
 
To find out more information please check:
130
 
\fI\%http://gearman.info/\fP
131
 
.SH SEE ALSO
132
 
.sp
133
 
\fIgearmand(8)\fP \fIlibgearman(3)\fP
134
 
.SH AUTHOR
135
 
Data Differential http://www.datadifferential.com/
136
 
.SH COPYRIGHT
137
 
2012, Data Differential, http://www.datadifferential.com/
138
 
.\" Generated by docutils manpage writer.
139
 
.\" 
140
 
.