-.. highlight:: perl
+======================================
+Creating and destroying a memcached_st
+======================================
+.. index:: object: memcached_st
-memcached_create, memcached_free, memcached_clone, memcached_servers_reset
-**************************************************************************
-
-
-Create a memcached_st structure
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
+--------
SYNOPSIS
-********
-
+--------
-
-.. code-block:: perl
-
- #include <memcached.h>
+#include <libmemcached/memcached.h>
- memcached_st *memcached_create (memcached_st *ptr);
+.. c:function:: memcached_st *memcached_create (memcached_st *ptr);
- void memcached_free (memcached_st *ptr);
+.. c:function:: void memcached_free (memcached_st *ptr);
- memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
+.. c:function:: memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
- void memcached_servers_reset(memcached_st);
+.. c:function:: void memcached_servers_reset(memcached_st);
+Compile and link with -lmemcached
-***********
+-----------
DESCRIPTION
-***********
-
+-----------
memcached_create() is used to create a \ ``memcached_st``\ structure that will then
be used by other libmemcached(3) functions to communicate with the server. You
should either pass a statically declared \ ``memcached_st``\ to memcached_create() or
a NULL. If a NULL passed in then a structure is allocated for you.
+Please note, when you write new application use memcached_create_with_options() over memcached_create().
+
memcached_clone() is similar to memcached_create(3) but it copies the
defaults and list of servers from the source \ ``memcached_st``\ . If you pass a null as
the argument for the source to clone, it is the same as a call to memcached_create().
heap allocated structures.
-******
+------
RETURN
-******
+------
memcached_create() returns a pointer to the memcached_st that was created
(or initialized). On an allocation failure, it returns NULL.
-****
+----
HOME
-****
+----
To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
+`http://libmemcached.org/ <http://libmemcached.org/>`_
-******
-AUTHOR
-******
-
-Brian Aker, <brian@tangent.org>
-
-
-********
+--------
SEE ALSO
-********
-
+--------
-memcached(1) libmemcached(3) memcached_strerror(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`