Many fixes to the POD documentation
[awesomized/libmemcached] / docs / memcached_behavior.pod
index 3b33d7bf76543d22416bd3e2522235e08377507c..d9e157f4ea1e4116dbceb6ecc0e86eb8d67927bd 100755 (executable)
@@ -8,19 +8,24 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
 =head1 SYNOPSIS
 
-#include <memcached.h>
+  #include <memcached.h>
 
-unsigned long long memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
-memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, void *data);
+  unsigned long long
+    memcached_behavior_get (memcached_st *ptr,
+                            memcached_behavior flag);
 
-=head1 DESCRIPTION
+  memcached_return
+    memcached_behavior_set (memcached_st *ptr,
+                            memcached_behavior flag,
+                            void *data);
 
+=head1 DESCRIPTION
 
 libmemcached(3) behavior can be modified by use memcached_behavior_set().
 Default behavior is the library strives to be quick and accurate. Some
-behavior, like , while being faster can also result in not entirely accurate
-behavior (for instance memcached_set will always respond with
-MEMCACHED_SUCCES).
+behavior, while being faster, can also result in not entirely accurate
+behavior (for instance, memcached_set() will always respond with
+C<MEMCACHED_SUCCESS>).
 
 memcached_behavior_get() takes a behavior flag and returns whether or not
 that behavior is currently enabled in the client.
@@ -29,19 +34,23 @@ memcached_behavior_set() changes the value of a particular option of the
 client. It takes both a flag (listed below) and a value. For simple on or
 off options you just need to pass in a value of 1.
 
-=item  MEMCACHED_BEHAVIOR_NO_BLOCK,
+=over 4
 
-Causes libmemcached(3) to use asycronous IO. This is the fastest transport
+=item MEMCACHED_BEHAVIOR_NO_BLOCK
+
+Causes libmemcached(3) to use asychronous IO. This is the fastest transport
 available.
 
-=item MEMCACHED_BEHAVIOR_TCP_NODELAY,
+=item MEMCACHED_BEHAVIOR_TCP_NODELAY
 
 Turns on the no-delay feature for connecting sockets (may be faster in some
-setups).
+environments).
+
+=item MEMCACHED_BEHAVIOR_MD5_HASHING
 
-=item MEMCACHED_BEHAVIOR_MD5_HASHING,
+Makes the default hashing algorithm for keys use MD5.
 
-Makes the default hashing algorithm for keys use RSA's MD5.
+=back
 
 =head1 RETURN
 
@@ -51,11 +60,12 @@ returns whether or not the behavior was enabled.
 
 =head1 HOME
 
-To find out more information please check: http://tangent.org/552/libmemcached.html
+To find out more information please check:
+L<http://tangent.org/552/libmemcached.html>
 
 =head1 AUTHOR
 
-Brian Aker, brian@tangent.org
+Brian Aker, E<lt>brian@tangent.orgE<gt>
 
 =head1 SEE ALSO