← Back to branch summary

~brianaker/libmemcached/libmemcached-gearman-remove

« back to all changes in this revision

Viewing changes to docs/man/memcached_touch.3

  • Committer: Brian Aker
  • Date: 2012-09-30 23:57:30 UTC
  • mto: This revision was merged to the branch mainline in revision 1073.
  • Revision ID: brian@tangent.org-20120930235730-jl3k607syliahnl0
Fix how we do manpages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/memcached_touch.3
1
 
.TH "MEMCACHED_TOUCH" "3" "September 16, 2012" "1.0.10" "libmemcached"
2
 
.SH NAME
3
 
memcached_touch \- libmemcached Documentation
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 <libmemcached/memcached.h>
36
 
.INDENT 0.0
37
 
.TP
38
 
.B memcached_return_t memcached_touch(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, time_t\fI\ expiration\fP)
39
 
.UNINDENT
40
 
.INDENT 0.0
41
 
.TP
42
 
.B memcached_return_t memcached_touch_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, time_t\fI\ expiration\fP)
43
 
.UNINDENT
44
 
.sp
45
 
Compile and link with \-lmemcached
46
 
.SH DESCRIPTION
47
 
.sp
48
 
\fI\%memcached_touch()\fP is used to update the expiration time on an existing key.
49
 
\fI\%memcached_touch_by_key()\fP works the same, but it takes a master key
50
 
to find the given value.
51
 
.SH RETURN
52
 
.sp
53
 
A value of type \fBmemcached_return_t\fP is returned
54
 
On success that value will be \fBMEMCACHED_SUCCESS\fP.
55
 
Use \fBmemcached_strerror()\fP to translate this value to a printable
56
 
string.
57
 
.SH HOME
58
 
.sp
59
 
To find out more information please check:
60
 
\fI\%http://libmemcached.org/\fP
61
 
.SH AUTHOR
62
 
.sp
63
 
Brian Aker, <\fI\%brian@tangent.org\fP>
64
 
.SH SEE ALSO
65
 
.sp
66
 
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
67
 
.SH AUTHOR
68
 
Brian Aker
69
 
.SH COPYRIGHT
70
 
2011-2012, Brian Aker DataDifferential, http://datadifferential.com/
71
 
.\" Generated by docutils manpage writer.
72
 
.\" 
73
 
.