Update for version release.
[m6w6/libmemcached] / docs / man / memcached_server_list_count.3
index aa2e1c7780f5039f56531a43912de0d091b80c0d..4f82070c93557258f0db067e2769f4b8d46b11df 100644 (file)
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_SERVER_LIST_COUNT" "3" "October 18, 2011" "1.01" "libmemcached"
+.TH "MEMCACHED_SERVER_LIST_COUNT" "3" "May 22, 2012" "1.0.8" "libmemcached"
 .SH NAME
 memcached_server_list_count \- libmemcached Documentation
 .
@@ -39,19 +39,27 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .UNINDENT
 .INDENT 0.0
 .TP
+.B memcached_server_list_st
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_server_st
+.UNINDENT
+.INDENT 0.0
+.TP
 .B const \fI\%memcached_server_instance_st\fP memcached_server_list(memcached_st\fI\ *ptr\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B void memcached_server_list_free(memcached_server_list_st\fI\ list\fP)
+.B void memcached_server_list_free(\fI\%memcached_server_list_st\fP\fI\ list\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B memcached_server_list_st memcached_server_list_append(memcached_server_list_st\fI\ list\fP, const char\fI\ *hostname\fP, unsigned int\fI\ port\fP, memcached_return_t\fI\ *error\fP)
+.B \fI\%memcached_server_list_st\fP memcached_server_list_append(\fI\%memcached_server_list_st\fP\fI\ list\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP, memcached_return_t\fI\ *error\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B uint32_t memcached_server_list_count(memcached_server_list_st\fI\ list\fP)
+.B uint32_t memcached_server_list_count(\fI\%memcached_server_list_st\fP\fI\ list\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -63,30 +71,36 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .UNINDENT
 .sp
 Deprecated since version 0.39.
+.INDENT 0.0
+.TP
+.B void memcached_servers_parse()
+.UNINDENT
+.sp
+Deprecated since version 0.39.
 .sp
 Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
 libmemcached(3) operates on a list of hosts which are stored in
-\fBmemcached_server_st\fP structures. You should not modify these structures
+\fI\%memcached_server_st\fP structures. You should not modify these structures
 directly. Functions are provided to modify these structures (and more can be
 added, just ask!).
 .sp
-\fI\%memcached_server_list()\fP is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free()" up till version 0.39.
+\fI\%memcached_server_list()\fP is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.
 .sp
-\fI\%memcached_server_list_free()\fP deallocates all memory associated with the array of \fBmemcached_server_st\fP that you passed to it.
+\fI\%memcached_server_list_free()\fP deallocates all memory associated with the array of \fI\%memcached_server_st\fP that you passed to it.
 .sp
 \fI\%memcached_server_list_append()\fP adds a server to the end of a
-\fBmemcached_server_st\fP array. On error null will be returned and the
+\fI\%memcached_server_st\fP array. On error null will be returned and the
 \fBmemcached_return_t\fP pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default
 port of a memcached server.
 .sp
-DEPRECATED \fBmemcached_servers_parse()\fP, please see \fBmemcached()\fP
+DEPRECATED \fI\%memcached_servers_parse()\fP, please see \fBmemcached()\fP
 .sp
 \fI\%memcached_server_error()\fP can be used to look at the text of the last error message sent by the server to to the client.
 .sp
 Before version 0.39 theses functions used a memcache_server_st *. In 0.39
-memcached_server_st * was aliased to \fBmemcached_server_list_st\fP. This was done for a style reason to help clean up some concepts in the code.
+memcached_server_st * was aliased to \fI\%memcached_server_list_st\fP. This was done for a style reason to help clean up some concepts in the code.
 .SH RETURN
 .sp
 Varies, see particular functions.