← Back to branch summary

~fractalcat/gearmand/docfixes

« back to all changes in this revision

Viewing changes to docs/man/gearman_work_epoch.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_work_epoch.3
1
 
.TH "GEARMAN_WORK_EPOCH" "3" "June 17, 2011" "0.22" "Gearmand"
2
 
.SH NAME
3
 
gearman_work_epoch \- 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_work_t
39
 
.UNINDENT
40
 
.INDENT 0.0
41
 
.TP
42
 
.B gearman_work_t gearman_work(gearman_job_priority_t priority);
43
 
.UNINDENT
44
 
.INDENT 0.0
45
 
.TP
46
 
.B gearman_work_t gearman_work_epoch(time_t epoch, gearman_job_priority_t priority);
47
 
.UNINDENT
48
 
.INDENT 0.0
49
 
.TP
50
 
.B gearman_work_t gearman_work_background(gearman_job_priority_t priority);
51
 
.UNINDENT
52
 
.INDENT 0.0
53
 
.TP
54
 
.B gearman_work_t gearman_work_map(const char *name, size_t name_length, gearman_job_priority_t priority);
55
 
.UNINDENT
56
 
.INDENT 0.0
57
 
.TP
58
 
.B gearman_work_t gearman_work_epoch_with_map(time_t epoch, gearman_job_priority_t priority, const char *name, size_t name_length);
59
 
.UNINDENT
60
 
.INDENT 0.0
61
 
.TP
62
 
.B gearman_work_t gearman_work_background_with_map(gearman_job_priority_t priority, const char *name, size_t name_length);
63
 
.UNINDENT
64
 
.INDENT 0.0
65
 
.TP
66
 
.B void gearman_work_set_context(gearman_work_t *, void *);
67
 
.UNINDENT
68
 
.sp
69
 
Compile and link with \-lgearman
70
 
.SH DESCRIPTION
71
 
.sp
72
 
\fI\%gearman_work_t\fP describe work for \fBgearman_execute()\fP.
73
 
.sp
74
 
\fBgearman_work()\fP creates a \fI\%gearman_work_t\fP with a priority.
75
 
.sp
76
 
\fBgearman_work_epoch()\fP creates a \fI\%gearman_work_t\fP which tells \fBgearman_execute()\fP to execute the workload at the time specified by epoch.
77
 
.sp
78
 
\fBgearman_work_background()\fP creates a \fI\%gearman_work_t\fP which tells \fBgearman_execute()\fP to execute the workload as a background job.
79
 
.sp
80
 
\fBgearman_work_map()\fP, \fBgearman_work_map()\fP, and \fBgearman_work_map()\fP, do the same as there non\-map counterparts but specify a map function that will be executed on the result of the function specified for \fBgearman_execute()\fP.
81
 
.SH SEE ALSO
82
 
.sp
83
 
\fIgearmand(8)\fP \fIlibgearman(3)\fP \fIgearman_execute()\fP
84
 
.SH AUTHOR
85
 
Data Differential http://datadifferential.com/
86
 
.SH COPYRIGHT
87
 
2011, Data Differential, http://datadifferential.com/
88
 
.\" Generated by docutils manpage writer.
89
 
.\" 
90
 
.