boourns-memcached 1.4.6

data/ext/libmemcached-0.32/docs/libmemcached.3

@@ -0,0 +1,229 @@
+.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.ie \nF \{\
+.    de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.el \{\
+.    de IX
+..
+.\}
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "..::docs::libmemcached 3"
+.TH ..::docs::libmemcached 3 "2012-10-24" "" "libmemcached"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+libmemcached \- Client library for memcached
+.SH "LIBRARY"
+.IX Header "LIBRARY"
+C Client Library for memcached (libmemcached, \-lmemcached)
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\&  #include <memcached.h>
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+\&\*(L"Memcached is a high-performance, distributed memory object caching
+system, generic in nature, but intended for use in speeding up dynamic web
+applications by alleviating database load.\*(R" <http://danga.com/memcached/>
+.PP
+\&\fBlibmemcached\fR is a small, thread-safe client library for the
+memcached protocol. The code has all been written with an eye to allow
+for both web and embedded usage. It handles the work behind routing
+particular keys to specific servers that you specify (and values are
+matched based on server order as supplied by you). It implements both
+a modula and consistent method of object distribution.
+.PP
+There are multiple implemented routing and hashing methods. See the
+\&\fImemcached_behavior_set()\fR manpage.
+.PP
+All operations are performed against a \f(CW\*(C`memcached_st\*(C'\fR structure.
+These structures can either be dynamically allocated or statically
+allocated and then initialized by \fImemcached_create()\fR. Functions have been
+written in order to encapsulate the \f(CW\*(C`memcached_st\*(C'\fR. It is not
+recommended that you operate directly against the structure.
+.PP
+Nearly all functions return a \f(CW\*(C`memcached_return\*(C'\fR value.
+This value can be translated to a printable string with \fImemcached_strerror\fR\|(3).
+.PP
+Partitioning based on keys is supported in the library. Using the key partioning
+functions it is possible to group sets of object onto servers.
+.PP
+\&\f(CW\*(C`memcached_st\*(C'\fR structures are thread-safe, but each thread must
+contain its own structure (that is, if you want to share these among
+threads you must provide your own locking). No global variables are
+used in this library.
+.PP
+If you are working with \s-1GNU\s0 autotools you will want to add the following to
+your configure.ac to properly include libmemcached in your application.
+.PP
+\&\s-1PKG_CHECK_MODULES\s0(\s-1DEPS\s0, libmemcached >= 0.8.0)
+\&\s-1AC_SUBST\s0(\s-1DEPS_CFLAGS\s0)
+\&\s-1AC_SUBST\s0(\s-1DEPS_LIBS\s0)
+.PP
+Some features of the library must be enabled through \fImemcached_behavior_set()\fR.
+.PP
+Hope you enjoy it!
+.SH "CONSTANTS"
+.IX Header "CONSTANTS"
+A number of constants have been provided for in the library.
+.IP "\s-1MEMCACHED_DEFAULT_PORT\s0" 4
+.IX Item "MEMCACHED_DEFAULT_PORT"
+The default port used by \fImemcached\fR\|(3).
+.IP "\s-1MEMCACHED_MAX_KEY\s0" 4
+.IX Item "MEMCACHED_MAX_KEY"
+Default maximum size of a key (which includes the null pointer). Master keys
+have no limit, this only applies to keys used for storage.
+.IP "\s-1MEMCACHED_MAX_KEY\s0" 4
+.IX Item "MEMCACHED_MAX_KEY"
+Default size of key (which includes the null pointer).
+.IP "\s-1MEMCACHED_MAX_HOST_LENGTH\s0" 4
+.IX Item "MEMCACHED_MAX_HOST_LENGTH"
+Maximum allowed size of the hostname.
+.IP "\s-1MEMCACHED_VERSION_STRING\s0" 4
+.IX Item "MEMCACHED_VERSION_STRING"
+String value of libmemcached version such as \*(L"1.23.4\*(R"
+.IP "\s-1MEMCACHED_MAJOR_VERSION\s0" 4
+.IX Item "MEMCACHED_MAJOR_VERSION"
+Major version value. Such as 1.23.4, would be 1
+.IP "\s-1MEMCACHED_MINOR_VERSION\s0" 4
+.IX Item "MEMCACHED_MINOR_VERSION"
+Major version value. Such as 1.23.4, would be 23
+.IP "\s-1MEMCACHED_MICRO_VERSION\s0" 4
+.IX Item "MEMCACHED_MICRO_VERSION"
+Major version value. Such as 1.23.4, would be 4
+.SH "THREADS AND PROCESSES"
+.IX Header "THREADS AND PROCESSES"
+When using threads or forked processes it is important to keep an instance
+of \f(CW\*(C`memcached_st\*(C'\fR per process or thread. Without creating your own locking
+structures you can not share a single \f(CW\*(C`memcached_st\*(C'\fR. You can though call
+\&\fImemcached_quit\fR\|(3) on a \f(CW\*(C`memcached_st\*(C'\fR and then use the resulting cloned
+structure.
+.SH "HOME"
+.IX Header "HOME"
+To find out more information please check:
+<http://tangent.org/552/libmemcached.html>
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Brian Aker, <brian@tangent.org>
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fImemcached\fR\|(1) \fIlibmemcached_examples\fR\|(3) \fIlibmemcached\fR\|(1) \fImemcat\fR\|(1) \fImemcp\fR\|(1) \fImemflush\fR\|(1) \fImemrm\fR\|(1) \fImemslap\fR\|(1) \fImemstat\fR\|(1) \fImemcached_fetch\fR\|(3) \fImemcached_replace\fR\|(3) \fImemcached_server_list_free\fR\|(3) \fIlibmemcached_examples\fR\|(3) \fImemcached_clone\fR\|(3) \fImemcached_free\fR\|(3) \fImemcached_server_add\fR\|(3) \fImemcached_server_push\fR\|(3) \fImemcached_add\fR\|(3) \fImemcached_get\fR\|(3) \fImemcached_server_count\fR\|(3) \fImemcached_servers_parse\fR\|(3) \fImemcached_create\fR\|(3) \fImemcached_increment\fR\|(3) \fImemcached_server_list\fR\|(3) \fImemcached_set\fR\|(3) \fImemcached_decrement\fR\|(3) \fImemcached_mget\fR\|(3) \fImemcached_server_list_append\fR\|(3) \fImemcached_strerror\fR\|(3) \fImemcached_delete\fR\|(3) \fImemcached_quit\fR\|(3) \fImemcached_server_list_count\fR\|(3) \fImemcached_verbosity\fR\|(3) \fImemcached_server_add_unix_socket\fR\|(3) \fImemcached_result_create\fR\|(3)  \fImemcached_result_free\fR\|(3)  \fImemcached_result_key_value\fR\|(3)  \fImemcached_result_key_length\fR\|(3)  \fImemcached_result_value\fR\|(3)  \fImemcached_result_length\fR\|(3)  \fImemcached_result_flags\fR\|(3)  \fImemcached_result_cas\fR\|(3) \fImemcached_result_st\fR\|(3) \fImemcached_append\fR\|(3) \fImemcached_prepend\fR\|(3) \fImemcached_fetch_result\fR\|(3) \fImemerror\fR\|(1) \fImemcached_get_by_key\fR\|(3) \fImemcached_mget_by_key\fR\|(3) \fImemcached_delete_by_key\fR\|(3) \fImemcached_fetch_execute\fR\|(3) \fImemcached_callback_get\fR\|(3) \fImemcached_callback_set\fR\|(3) \fImemcached_version\fR\|(3) \fImemcached_lib_version\fR\|(3) \fImemcached_result_set_value\fR\|(3) \fImemcached_dump\fR\|(3) \fImemdump\fR\|(1) \fImemcached_set_memory_allocators\fR\|(3) \fImemcached_get_memory_allocators\fR\|(3) \fImemcached_get_user_data\fR\|(3) \fImemcached_set_user_data\fR\|(3)

data/ext/libmemcached-0.32/docs/libmemcached.pod

@@ -0,0 +1,123 @@
+=head1 NAME
+
+libmemcached - Client library for memcached
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+=head1 DESCRIPTION
+
+"Memcached is a high-performance, distributed memory object caching
+system, generic in nature, but intended for use in speeding up dynamic web
+applications by alleviating database load." L<http://danga.com/memcached/>
+
+B<libmemcached> is a small, thread-safe client library for the
+memcached protocol. The code has all been written with an eye to allow
+for both web and embedded usage. It handles the work behind routing
+particular keys to specific servers that you specify (and values are
+matched based on server order as supplied by you). It implements both
+a modula and consistent method of object distribution.
+
+There are multiple implemented routing and hashing methods. See the
+memcached_behavior_set() manpage.
+
+All operations are performed against a C<memcached_st> structure.
+These structures can either be dynamically allocated or statically
+allocated and then initialized by memcached_create(). Functions have been
+written in order to encapsulate the C<memcached_st>. It is not
+recommended that you operate directly against the structure.
+
+Nearly all functions return a C<memcached_return> value.
+This value can be translated to a printable string with memcached_strerror(3).
+
+Partitioning based on keys is supported in the library. Using the key partioning
+functions it is possible to group sets of object onto servers.
+
+C<memcached_st> structures are thread-safe, but each thread must
+contain its own structure (that is, if you want to share these among
+threads you must provide your own locking). No global variables are
+used in this library.
+
+If you are working with GNU autotools you will want to add the following to
+your configure.ac to properly include libmemcached in your application.
+
+PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
+AC_SUBST(DEPS_CFLAGS)
+AC_SUBST(DEPS_LIBS)
+
+Some features of the library must be enabled through memcached_behavior_set().
+
+Hope you enjoy it!
+
+=head1 CONSTANTS
+
+A number of constants have been provided for in the library.
+
+=over 4
+
+=item MEMCACHED_DEFAULT_PORT
+
+The default port used by memcached(3).
+
+=item MEMCACHED_MAX_KEY
+
+Default maximum size of a key (which includes the null pointer). Master keys
+have no limit, this only applies to keys used for storage.
+
+=item MEMCACHED_MAX_KEY
+
+Default size of key (which includes the null pointer).
+
+=item MEMCACHED_MAX_HOST_LENGTH
+
+Maximum allowed size of the hostname.
+
+=item MEMCACHED_VERSION_STRING
+
+String value of libmemcached version such as "1.23.4"
+
+=item MEMCACHED_MAJOR_VERSION
+
+Major version value. Such as 1.23.4, would be 1
+
+=item MEMCACHED_MINOR_VERSION
+
+Major version value. Such as 1.23.4, would be 23
+
+=item MEMCACHED_MICRO_VERSION
+
+Major version value. Such as 1.23.4, would be 4
+
+
+=back
+
+
+
+=head1 THREADS AND PROCESSES
+
+When using threads or forked processes it is important to keep an instance
+of C<memcached_st> per process or thread. Without creating your own locking
+structures you can not share a single C<memcached_st>. You can though call
+memcached_quit(3) on a C<memcached_st> and then use the resulting cloned
+structure.
+
+=head1 HOME
+
+To find out more information please check:
+L<http://tangent.org/552/libmemcached.html>
+
+=head1 AUTHOR
+
+Brian Aker, E<lt>brian@tangent.orgE<gt>
+
+=head1 SEE ALSO
+
+memcached(1) libmemcached_examples(3) libmemcached(1) memcat(1) memcp(1) memflush(1) memrm(1) memslap(1) memstat(1) memcached_fetch(3) memcached_replace(3) memcached_server_list_free(3) libmemcached_examples(3) memcached_clone(3) memcached_free(3) memcached_server_add(3) memcached_server_push(3) memcached_add(3) memcached_get(3) memcached_server_count(3) memcached_servers_parse(3) memcached_create(3) memcached_increment(3) memcached_server_list(3) memcached_set(3) memcached_decrement(3) memcached_mget(3) memcached_server_list_append(3) memcached_strerror(3) memcached_delete(3) memcached_quit(3) memcached_server_list_count(3) memcached_verbosity(3) memcached_server_add_unix_socket(3) memcached_result_create(3)  memcached_result_free(3)  memcached_result_key_value(3)  memcached_result_key_length(3)  memcached_result_value(3)  memcached_result_length(3)  memcached_result_flags(3)  memcached_result_cas(3) memcached_result_st(3) memcached_append(3) memcached_prepend(3) memcached_fetch_result(3) memerror(1) memcached_get_by_key(3) memcached_mget_by_key(3) memcached_delete_by_key(3) memcached_fetch_execute(3) memcached_callback_get(3) memcached_callback_set(3) memcached_version(3) memcached_lib_version(3) memcached_result_set_value(3) memcached_dump(3) memdump(1) memcached_set_memory_allocators(3) memcached_get_memory_allocators(3) memcached_get_user_data(3) memcached_set_user_data(3)
+
+=cut
+

data/ext/libmemcached-0.32/docs/libmemcached_examples.3

@@ -0,0 +1,242 @@
+.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.ie \nF \{\
+.    de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.el \{\
+.    de IX
+..
+.\}
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "..::docs::libmemcached_examples 3"
+.TH ..::docs::libmemcached_examples 3 "2012-10-24" "" "libmemcached"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+libmemcached_examples \- Examples for libmemcached
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+For full examples, test cases are found in tests/*.c in the main
+distribution. These are always up to date, and are used for each test run of
+the library.
+.SS "Creating and Freeing structure"
+.IX Subsection "Creating and Freeing structure"
+.Vb 2
+\&  memcached_st *memc;
+\&  memcached_return rc;
+\&
+\&  memc= memcached_create(NULL);
+\&  ...do stuff...
+\&  memcached_free(memc);
+.Ve
+.PP
+The above code would create a connection and then free the connection when
+finished.
+.SS "Connecting to servers"
+.IX Subsection "Connecting to servers"
+.Vb 3
+\&  memcached_server_st *servers;
+\&  memcached_st *memc= memcached_create(NULL);
+\&  char servername[]= "0.example.com";
+\&
+\&  servers= memcached_server_list_append(NULL, servername, 400, &rc);
+\&
+\&  for (x= 0; x < 20; x++)
+\&  {
+\&    char buffer[SMALL_STRING_LEN];
+\&
+\&    snprintf(buffer, SMALL_STRING_LEN, "%u.example.com", 400+x);
+\&    servers= memcached_server_list_append(servers, buffer, 401, &rc);
+\&  }
+\&  rc= memcached_server_push(memc, servers);
+\&  memcached_server_free(servers);
+\&  memcached_free(memc);
+.Ve
+.PP
+In the above code you create a \f(CW\*(C`memcached_st\*(C'\fR object that you then feed in a
+single host into. In the for loop you build a \f(CW\*(C`memcached_server_st\*(C'\fR
+pointer that you then later feed via \fImemcached_server_push()\fR into the
+\&\f(CW\*(C`memcached_st\*(C'\fR structure.
+.PP
+You can reuse the \f(CW\*(C`memcached_server_st\*(C'\fR object with multile \f(CW\*(C`memcached_st\*(C'\fR
+structures.
+.SS "Adding a value to the server"
+.IX Subsection "Adding a value to the server"
+.Vb 4
+\&  char *key= "foo";
+\&  char *value;
+\&  size_t value_length= 8191;
+\&  unsigned int x;
+\&
+\&  value = (char*)malloc(value_length);
+\&  assert(value);
+\&
+\&  for (x= 0; x < value_length; x++)
+\&  value[x] = (char) (x % 127);
+\&
+\&  for (x= 0; x < 1; x++)
+\&  {
+\&    rc= memcached_set(memc, key, strlen(key), 
+\&    value, value_length,
+\&    (time_t)0, (uint32_t)0);
+\&    assert(rc == MEMCACHED_SUCCESS);
+\&  }
+\&
+\&  free(value);
+.Ve
+.PP
+It is best practice to always look at the return value of any operation.
+.SS "Fetching multiple values"
+.IX Subsection "Fetching multiple values"
+.Vb 5
+\&  memcached_return rc;
+\&  char *keys[]= {"fudge", "son", "food"};
+\&  size_t key_length[]= {5, 3, 4};
+\&  unsigned int x;
+\&  uint32_t flags;
+\&
+\&  char return_key[MEMCACHED_MAX_KEY];
+\&  size_t return_key_length;
+\&  char *return_value;
+\&  size_t return_value_length;
+\&
+\&  rc= memcached_mget(memc, keys, key_length, 3);
+\&
+\&  x= 0;
+\&  while ((return_value= memcached_fetch(memc, return_key, &return_key_length, 
+\&                                        &return_value_length, &flags, &rc)))
+\&  {
+\&    free(return_value);
+\&    x++;
+\&  }
+.Ve
+.PP
+Notice that you freed values returned from \fImemcached_fetch()\fR. The define
+\&\f(CW\*(C`MEMCACHED_MAX_KEY\*(C'\fR is provided for usage.
+.SH "HOME"
+.IX Header "HOME"
+To find out more information please check:
+<http://tangent.org/552/libmemcached.html>
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Brian Aker, <brian@tangent.org>
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fImemcached\fR\|(1)