r4874 - trunk/varnish-cache/doc/sphinx/reference

[perbu at varnish-cache.org]

Author: perbu
Date: 2010-06-01 13:09:28 +0200 (Tue, 01 Jun 2010)
New Revision: 4874

Added:
   trunk/varnish-cache/doc/sphinx/reference/varnishstat.rst
Modified:
   trunk/varnish-cache/doc/sphinx/reference/varnishadm.rst
Log:
added varnishstat + minor fixup~

Modified: trunk/varnish-cache/doc/sphinx/reference/varnishadm.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/reference/varnishadm.rst	2010-06-01 09:11:59 UTC (rev 4873)
+++ trunk/varnish-cache/doc/sphinx/reference/varnishadm.rst	2010-06-01 11:09:28 UTC (rev 4874)
@@ -1,6 +1,6 @@
-===========
- varnishadm
-===========
+==========
+varnishadm
+==========
 
 ----------------------------------
 Control a running varnish instance

Added: trunk/varnish-cache/doc/sphinx/reference/varnishstat.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/reference/varnishstat.rst	                        (rev 0)
+++ trunk/varnish-cache/doc/sphinx/reference/varnishstat.rst	2010-06-01 11:09:28 UTC (rev 4874)
@@ -0,0 +1,90 @@
+===========
+varnishstat
+===========
+
+---------------------------
+HTTP accelerator statistics
+---------------------------
+
+:Author: Dag-Erling Smørgrav
+:Author: Per Buer
+:Date:   2010-06-1
+:Version: 1.0
+:Manual section: 1
+
+
+SYNOPSIS
+========
+
+varnishstat [-1] [-f field_list] [-l] [-n varnish_name] [-V] [-w delay]
+
+DESCRIPTION
+===========
+
+The varnishstat utility displays statistics from a running varnishd(1) instance.
+
+The following options are available:
+
+-1          Instead of presenting of a continuously updated display, print the statistics once and exit.
+
+-f          A comma separated list of the fields to display.  If it starts with '^' it is used as an exclusion
+	    list.
+
+-l          Lists the available fields to use with the -f option.
+
+-n          Specifies the name of the varnishd instance to get logs from.  If -n is not specified, the host name
+	    is used.
+
+-V          Display the version number and exit.
+
+-w delay    Wait delay seconds between updates.  The default is 1.
+
+The columns in the main display are, from left to right:
+
+1.   Value
+
+2.   Per-second average in the period since last update, or a period if the value can not be averaged
+
+3.   Per-second average over process lifetime, or a period if the value can not be averaged
+
+4.   Descriptive text
+
+
+When using the -1 option, the columns in the output are, from left to right:
+
+1.   Symbolic entry name
+
+2.   Value
+
+3.   Per-second average over process lifetime, or a period if the value can not be averaged
+
+4.   Descriptive text
+
+SEE ALSO
+========
+
+* varnishd(1)
+* varnishhist(1)
+* varnishlog(1)
+* varnishncsa(1)
+* varnishtop(1)
+* curses(3)
+
+HISTORY
+=======
+
+The varnishstat utility was originally developed by Poul-Henning Kamp
+⟨phk at phk.freebsd.dk⟩ in cooperation with Verdens Gang AS, Linpro AS
+and Varnish Software. Manual page written by Dag-Erling Smørgrav,
+and Per Buer. 
+
+COPYRIGHT
+=========
+
+This document is licensed under the same licence as Varnish
+itself. See LICENCE for details.
+
+* Copyright (c) 2006 Verdens Gang AS
+* Copyright (c) 2006-2008 Linpro AS
+* Copyright (c) 2008-2010 Redpill Linpro AS
+* Copyright (c) 2010 Varnish Software AS