Update docs.

[m6w6/libmemcached] / docs / man / memcached_behavior.3

diff --git a/docs/man/memcached_behavior.3 b/docs/man/memcached_behavior.3
index 89f6c8293b77651e9ba8b9cda83f185f4c973abd..1658a14d51f006ca541b1d0d3c17f993ed608f07 100644 (file)
--- a/docs/man/memcached_behavior.3
+++ b/docs/man/memcached_behavior.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_BEHAVIOR" "3" "April 08, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_BEHAVIOR" "3" "April 09, 2011" "0.47" "libmemcached"

 .SH NAME
 memcached_behavior \- libmemcached Documentation
 .
 .SH NAME
 memcached_behavior \- libmemcached Documentation
 .


@@ -35,7 +35,7 @@ Manipulate behavior
 .SH LIBRARY
 .sp
 C Client Library for memcached (libmemcached, \-lmemcached)
 .SH LIBRARY
 .sp
 C Client Library for memcached (libmemcached, \-lmemcached)

-.SH SYNOPSIS
+.SS SYNOPSIS

 .sp
 .nf
 .ft C
 .sp
 .nf
 .ft C


@@ -51,7 +51,7 @@ memcached_return_t
                           uint64_t data);
 .ft P
 .fi
                           uint64_t data);
 .ft P
 .fi

-.SH DESCRIPTION
+.SS DESCRIPTION

 .sp
 libmemcached(3) behavior can be modified by use memcached_behavior_set().
 Default behavior is the library strives to be quick and accurate. Some
 .sp
 libmemcached(3) behavior can be modified by use memcached_behavior_set().
 Default behavior is the library strives to be quick and accurate. Some


@@ -72,14 +72,14 @@ MEMCACHED_BEHAVIOR_USE_UDP
 .INDENT 3.5
 .sp
 Causes libmemcached(3) to use the UDP transport when communicating
 .INDENT 3.5
 .sp
 Causes libmemcached(3) to use the UDP transport when communicating

-with a memcached server. Not all I/O operations are supported
+with a memcached server. Not all I/O operations are testsed

 when this behavior is enababled. The following operations will return
 \fBMEMCACHED_NOT_SUPPORTED\fP when executed with the MEMCACHED_BEHAVIOR_USE_UDP
 enabled: memcached_version(), memcached_stat(), memcached_get(),
 memcached_get_by_key(), memcached_mget(), memcached_mget_by_key(),
 memcached_fetch(), memcached_fetch_result(), memcached_value_fetch().
 .sp
 when this behavior is enababled. The following operations will return
 \fBMEMCACHED_NOT_SUPPORTED\fP when executed with the MEMCACHED_BEHAVIOR_USE_UDP
 enabled: memcached_version(), memcached_stat(), memcached_get(),
 memcached_get_by_key(), memcached_mget(), memcached_mget_by_key(),
 memcached_fetch(), memcached_fetch_result(), memcached_value_fetch().
 .sp

-All other operations are supported but are executed in a \(aqfire\-and\-forget\(aq
+All other operations are testsed but are executed in a \(aqfire\-and\-forget\(aq

 mode, in which once the client has executed the operation, no attempt
 will be made to ensure the operation has been received and acted on by the
 server.
 mode, in which once the client has executed the operation, no attempt
 will be made to ensure the operation has been received and acted on by the
 server.


@@ -136,7 +136,7 @@ MEMCACHED_BEHAVIOR_HASH
 Makes the default hashing algorithm for keys use MD5. The value can be set
 to either MEMCACHED_HASH_DEFAULT, MEMCACHED_HASH_MD5, MEMCACHED_HASH_CRC, MEMCACHED_HASH_FNV1_64, MEMCACHED_HASH_FNV1A_64, MEMCACHED_HASH_FNV1_32, MEMCACHED_HASH_FNV1A_32, MEMCACHED_HASH_JENKINS, MEMCACHED_HASH_HSIEH, and MEMCACHED_HASH_MURMUR.
 Each hash has it\(aqs advantages and it\(aqs weaknesses. If you don\(aqt know or don\(aqt care, just go with the default.
 Makes the default hashing algorithm for keys use MD5. The value can be set
 to either MEMCACHED_HASH_DEFAULT, MEMCACHED_HASH_MD5, MEMCACHED_HASH_CRC, MEMCACHED_HASH_FNV1_64, MEMCACHED_HASH_FNV1A_64, MEMCACHED_HASH_FNV1_32, MEMCACHED_HASH_FNV1A_32, MEMCACHED_HASH_JENKINS, MEMCACHED_HASH_HSIEH, and MEMCACHED_HASH_MURMUR.
 Each hash has it\(aqs advantages and it\(aqs weaknesses. If you don\(aqt know or don\(aqt care, just go with the default.

-Support for MEMCACHED_HASH_HSIEH is a compile time option that is disabled by default. To enable support for this hashing algorithm, configure and build libmemcached with the \-\-enable\-hash_hsieh.
+Support for MEMCACHED_HASH_HSIEH is a compile time option that is disabled by default. To enable tests for this hashing algorithm, configure and build libmemcached with the \-\-enable\-hash_hsieh.

 .UNINDENT
 .UNINDENT
 .sp
 .UNINDENT
 .UNINDENT
 .sp


@@ -183,7 +183,7 @@ MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .INDENT 0.0
 .INDENT 3.5
 .sp

-Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA with the weighted support.
+Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA with the weighted tests.

 and the hash to MEMCACHED_HASH_MD5.
 .UNINDENT
 .UNINDENT
 and the hash to MEMCACHED_HASH_MD5.
 .UNINDENT
 .UNINDENT


@@ -363,7 +363,7 @@ MEMCACHED_BEHAVIOR_CORK
 Enable TCP_CORK behavior. This is only available as an option Linux.
 MEMCACHED_NO_SERVERS is returned if no servers are available to test with.
 MEMCACHED_NOT_SUPPORTED is returned if we were not able to determine
 Enable TCP_CORK behavior. This is only available as an option Linux.
 MEMCACHED_NO_SERVERS is returned if no servers are available to test with.
 MEMCACHED_NOT_SUPPORTED is returned if we were not able to determine

-if support was available. All other responses then MEMCACHED_SUCCESS
+if tests was available. All other responses then MEMCACHED_SUCCESS

 report an error of some sort. This behavior also enables
 MEMCACHED_BEHAVIOR_TCP_NODELAY when set.
 .UNINDENT
 report an error of some sort. This behavior also enables
 MEMCACHED_BEHAVIOR_TCP_NODELAY when set.
 .UNINDENT


@@ -456,13 +456,13 @@ To find out more information please check:
 .SH AUTHOR
 .sp
 Brian Aker, <\fI\%brian@tangent.org\fP>
 .SH AUTHOR
 .sp
 Brian Aker, <\fI\%brian@tangent.org\fP>

-.SH SEE ALSO
+.SS SEE ALSO

 .sp
 .sp

-memcached(1) libmemcached(3) memcached_strerror(3)
+\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP

 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT

-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/

 .\" Generated by docutils manpage writer.
 .\" 
 .
 .\" Generated by docutils manpage writer.
 .\" 
 .