Updates for RPM

[awesomized/libmemcached] / docs / libmemcached.pod

diff --git a/docs/libmemcached.pod b/docs/libmemcached.pod
index 8840f5d3b9f4acf66518aac3761330bf38155dfa..5f2b1e30c072b6011c37a2bab6585f01456820cc 100755 (executable)
--- a/docs/libmemcached.pod
+++ b/docs/libmemcached.pod
@@ -8,46 +8,49 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
 =head1 SYNOPSIS
 
-#include <memcached.h>
+  #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." (http://danga.com/memcached/)
+applications by alleviating database load." L<http://danga.com/memcached/>
 
-libmemcached has the aim of being a small, thread safe client library for
-memcached. The code has all been written with an eye to allow for both web
-and embedded usage. It handles the work behind route particular keys to
-specifc servers that you specify (and values are matched based on server
-order as supplied by you). See more about this via X.
+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).
 
 The aim is to support multiple routing and hashing methods. Currently only
-two hashing methods are supported, a built quick routine, and MD5. For
-routing a simple modulous method is used currently.
+two hashing methods are supported, a quick built-in routine, and MD5. For
+routing, a simple modulus method is currently used.
 
-All operations are performance against memcached_st structure. These
-can either be dynamically allocated or statically allocated and initializd
-by memcached_create(3). Functions have been written in order to encapsulate
-the memcached_st (it is not recommended that you operate directly against
-the structure). 
+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 memcached_return value. This is documented in
-memcached_strerr(3).
+Nearly all functions return a C<memcached_return> value.
+This value can be translated to a printable string with memcached_strerr(3).
 
-memcached_st structures are thread safe, but each thread must contain its own structure (aka if you want to share these among threads you must provide your own locking). No global variables are used in this library.
+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.
 
-Some features of the library must be enabled through memcached_behavior_set(3). 
+Some features of the library must be enabled through memcached_behavior_set(). 
 Hope you enjoy it!
 
-
 =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