← Back to branch summary

~fractalcat/gearmand/docfixes

« back to all changes in this revision

Viewing changes to docs/man/gearman_client_run_tasks.3

  • Committer: Brian Aker
  • Date: 2012-09-30 23:55:03 UTC
  • mto: (621.4.21 workspace)
  • mto: This revision was merged to the branch mainline in revision 656.
  • 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_client_run_tasks.3
1
 
.TH "GEARMAN_CLIENT_RUN_TASKS" "3" "September 14, 2012" "0.38" "Gearmand"
2
 
.SH NAME
3
 
gearman_client_run_tasks \- 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
 
.SH SYNOPSIS
34
 
.sp
35
 
#include <libgearman/gearman.h>
36
 
.INDENT 0.0
37
 
.TP
38
 
.B gearman_return_t gearman_client_run_tasks(gearman_client_st\fI\ *client\fP)
39
 
.UNINDENT
40
 
.sp
41
 
Link with \-lgearman
42
 
.SH DESCRIPTION
43
 
.sp
44
 
\fI\%gearman_client_run_tasks()\fP executes one or more tasks that have
45
 
been added via \fBgearman_client_add_task()\fP,
46
 
\fBgearman_client_add_task_status()\fP or
47
 
\fBgearman_client_add_task_background()\fP.
48
 
.sp
49
 
\fI\%gearman_client_run_tasks()\fP can also be used with
50
 
\fBgearman_execute()\fP if either non\-blocking or background tasks were
51
 
created with it.
52
 
.SH RETURN VALUE
53
 
.sp
54
 
\fBgearman_return_t\fP
55
 
.sp
56
 
If \fBGEARMAN_PAUSE\fP is returned one of the tasks has "paused" in
57
 
order to give the caller an opportunity to take some actions (like read
58
 
data, handle an exception, etc...). See \fBgearman_task_st\fP for more
59
 
information about the state of a task.
60
 
.SH HOME
61
 
.sp
62
 
To find out more information please check:
63
 
\fI\%http://gearman.info/\fP
64
 
.IP "See also"
65
 
.sp
66
 
\fIgearmand(8)\fP \fIlibgearman(3)\fP
67
 
.RE
68
 
.SH AUTHOR
69
 
Data Differential http://www.datadifferential.com/
70
 
.SH COPYRIGHT
71
 
2012, Data Differential, http://www.datadifferential.com/
72
 
.\" Generated by docutils manpage writer.
73
 
.\" 
74
 
.