[memcached] update memcached man page and add memcached-tool man page
Miroslav Lichvar
mlichvar at fedoraproject.org
Wed Aug 7 10:48:02 UTC 2013
commit 98f11e21e4f19f708193a0bab1fa7ad189c94840
Author: Miroslav Lichvar <mlichvar at redhat.com>
Date: Wed Aug 7 12:32:06 2013 +0200
update memcached man page and add memcached-tool man page
memcached-manpages.patch | 141 ++++++++++++++++++++++++++++++++++++++++++++++
memcached.spec | 5 ++
2 files changed, 146 insertions(+), 0 deletions(-)
---
diff --git a/memcached-manpages.patch b/memcached-manpages.patch
new file mode 100644
index 0000000..e54c2d4
--- /dev/null
+++ b/memcached-manpages.patch
@@ -0,0 +1,141 @@
+From 8cf9b071c77f1f305f4bae795166da8e7daab179 Mon Sep 17 00:00:00 2001
+From: Miroslav Lichvar <mlichvar at redhat.com>
+Date: Tue, 2 Jul 2013 13:54:04 +0200
+Subject: [PATCH 1/2] describe -b and -S options in man page
+
+---
+ doc/memcached.1 | 7 +++++++
+ memcached.c | 2 +-
+ 2 files changed, 8 insertions(+), 1 deletion(-)
+
+diff --git a/doc/memcached.1 b/doc/memcached.1
+index b6f633d..7e72e2e 100644
+--- a/doc/memcached.1
++++ b/doc/memcached.1
+@@ -119,6 +119,9 @@ could reduce the number of TLB misses and improve the performance. In order to
+ get large pages from the OS, memcached will allocate the total item-cache in
+ one large chunk. Only available if supported on your OS.
+ .TP
++.B \-b <num>
++Set the backlog queue limit to <num> connections. The default is 1024.
++.TP
+ .B \-B <proto>
+ Specify the binding protocol to use. By default, the server will
+ autonegotiate client connections. By using this option, you can
+@@ -131,6 +134,10 @@ minimum is 1k, max is 128m. Adjusting this value changes the item size limit.
+ Beware that this also increases the number of slabs (use -v to view), and the
+ overal memory usage of memcached.
+ .TP
++.B \-S
++Turn on SASL authentication. This option is only meaningful if memcached was
++compiled with SASL support enabled.
++.TP
+ .B \-o <options>
+ Comma separated list of extended or experimental options. See -h or wiki for
+ up to date list.
+diff --git a/memcached.c b/memcached.c
+index 35f6f4d..dc8b770 100644
+--- a/memcached.c
++++ b/memcached.c
+@@ -4498,7 +4498,7 @@ static void usage(void) {
+ " requests process for a given connection to prevent \n"
+ " starvation (default: 20)\n");
+ printf("-C Disable use of CAS\n");
+- printf("-b Set the backlog queue limit (default: 1024)\n");
++ printf("-b <num> Set the backlog queue limit (default: 1024)\n");
+ printf("-B Binding protocol - one of ascii, binary, or auto (default)\n");
+ printf("-I Override the size of each slab page. Adjusts max item size\n"
+ " (default: 1mb, min: 1k, max: 128m)\n");
+--
+1.8.1.4
+
+From 6f9f9fe20d4b591c5b392660460fdd0e9cf2ca58 Mon Sep 17 00:00:00 2001
+From: Miroslav Lichvar <mlichvar at redhat.com>
+Date: Tue, 2 Jul 2013 17:15:03 +0200
+Subject: [PATCH 2/2] add man page for memcached-tool
+
+---
+ scripts/memcached-tool.1 | 71 ++++++++++++++++++++++++++++++++++++++++++++++++
+ 1 file changed, 71 insertions(+)
+ create mode 100644 scripts/memcached-tool.1
+
+diff --git a/scripts/memcached-tool.1 b/scripts/memcached-tool.1
+new file mode 100644
+index 0000000..6bb021b
+--- /dev/null
++++ b/scripts/memcached-tool.1
+@@ -0,0 +1,71 @@
++.TH MEMCACHED-TOOL 1 "Jul 2, 2013"
++.SH NAME
++memcached-tool \- stats and management tool for memcached
++
++.SH SYNOPSIS
++.B memcached-tool
++.RI < host [: port "] | " /path/to/socket "> [" mode ]
++
++.SH DESCRIPTION
++.B memcached-tool
++is a Perl script used to print statistics from a running memcached instance.
++The first parameter specifies the address of the daemon either by a hostname,
++optionally followed by the port number (the default is 11211), or a path to
++UNIX domain socket. The second parameter specifies the mode in which the tool
++should run.
++
++.SH MODES
++.TP
++.B display
++Print slab class statistics. This is the default mode if no mode is specified.
++The printed columns are:
++.RS
++.TP
++.B #
++Number of the slab class.
++.TP
++.B Item_Size
++The amount of space each chunk uses. One item uses one chunk of the
++appropriate size.
++.TP
++.B Max_age
++Age of the oldest item in the LRU.
++.TP
++.B Pages
++Total number of pages allocated to the slab class.
++.TP
++.B Count
++Number of items presently stored in this class. Expired items are not
++automatically excluded.
++.TP
++.B Full?
++Yes if there are no free chunks at the end of the last allocated page.
++.TP
++.B Evicted
++Number of times an item had to be evicted from the LRU before it expired.
++.TP
++.B Evict_Time
++Seconds since the last access for the most recent item evicted from this
++class.
++.TP
++.B OOM
++Number of times the underlying slab class was unable to store a new item.
++.RE
++
++.TP
++.B stats
++Print general-purpose statistics of the daemon. Each line contains the name of
++the statistic and its value.
++.TP
++.B dump
++Make a partial dump of the cache written in the add statements of the
++memcached protocol.
++
++.SH SEE ALSO
++.BR memcached (1),
++.br
++.B http://www.memcached.org
++
++.SH AUTHOR
++The memcached-tool script was written by Brad Fitzpatrick
++.B <brad at danga.com>
+--
+1.8.1.4
+
diff --git a/memcached.spec b/memcached.spec
index 7974c39..05be28d 100644
--- a/memcached.spec
+++ b/memcached.spec
@@ -16,6 +16,7 @@ Source0: http://memcached.googlecode.com/files/%{name}-%{version}.tar.gz
Source1: memcached.service
# Patches
+Patch001: memcached-manpages.patch
# Fixes
@@ -51,6 +52,7 @@ access to the memcached binary include files.
%prep
%setup -q
+%patch001 -p1 -b .manpages
%build
# compile with full RELRO
@@ -81,6 +83,8 @@ rm -f %{buildroot}/%{_bindir}/memcached-debug
# Perl script for monitoring memcached
install -Dp -m0755 scripts/memcached-tool %{buildroot}%{_bindir}/memcached-tool
+install -Dp -m0644 scripts/memcached-tool.1 \
+ %{buildroot}%{_mandir}/man1/memcached-tool.1
# Unit file
install -Dp -m0644 %{SOURCE1} %{buildroot}%{_unitdir}/memcached.service
@@ -138,6 +142,7 @@ exit 0
%config(noreplace) %{_sysconfdir}/sysconfig/%{name}
%{_bindir}/memcached-tool
%{_bindir}/memcached
+%{_mandir}/man1/memcached-tool.1*
%{_mandir}/man1/memcached.1*
%{_unitdir}/memcached.service
More information about the scm-commits
mailing list