[4.0] 5acc552 Update varnishtop documentation
Martin Blix Grydeland
martin at varnish-software.com
Thu Mar 13 10:24:22 CET 2014
commit 5acc552c0f74f9874a99bdbe8c57d32aa9757de5
Author: Martin Blix Grydeland <martin at varnish-software.com>
Date: Wed Jan 29 15:09:56 2014 +0100
Update varnishtop documentation
diff --git a/doc/sphinx/reference/varnishtop.rst b/doc/sphinx/reference/varnishtop.rst
index 86e6cf6..23298d5 100644
--- a/doc/sphinx/reference/varnishtop.rst
+++ b/doc/sphinx/reference/varnishtop.rst
@@ -1,12 +1,13 @@
-============
+==========
varnishtop
-============
+==========
-------------------------
Varnish log entry ranking
-------------------------
:Author: Dag-Erling Smørgrav
+:Author: Martin Blix Grydeland
:Date: 2010-05-31
:Version: 1.0
:Manual section: 1
@@ -16,9 +17,8 @@ Varnish log entry ranking
SYNOPSIS
========
-varnishtop [-1] [-b] [-C] [-c] [-d] [-f] [-I regex]
-[-i tag] [-n varnish_name] [-r file] [-V] [-X regex]
-[-x tag]
+.. include:: ../../../bin/varnishtop/varnishtop_synopsis.rst
+varnishtop |synopsis|
DESCRIPTION
===========
@@ -32,48 +32,7 @@ recorded in the log.
The following options are available:
--1 Instead of presenting of a continuously updated display,
- print the statistics once and exit. Implies ``-d``.
-
--b Include log entries which result from communication
- with a backend server. If neither ``-b`` nor ``-c`` is
- specified, varnishtop acts as if they both were.
-
--C Ignore case when matching regular expressions.
-
--c Include log entries which result from communication
- with a client. If neither ``-b`` nor ``-c`` is specified,
- varnishtop acts as if they both were.
-
--d Process old log entries on startup. Normally, varnishtop
- will only process entries which are written to the log
- after it starts.
-
--f Sort and group only on the first field of each log entry.
- This is useful when displaying e.g. stataddr entries,
- where the first field is the client IP address.
-
--I regex Include log entries which match the specified regular
- expression. If neither ``-I`` nor ``-i`` is specified, all log
- entries are included.
-
--i tag Include log entries with the specified tag. If neither ``-I``
- nor ``-i`` is specified, all log entries are included.
-
--p period Specifies the number of seconds to measure over, the default
- is 60 seconds. The first number in the list is the average
- number of requests seen over this time period.
-
--n Specifies the name of the varnishd instance to get logs from.
- If ``-n`` is not specified, the host name is used.
-
--r file Read log entries from file instead of shared memory.
-
--V Display the version number and exit.
-
--X regex Exclude log entries which match the specified regular expression.
-
--x tag Exclude log entries with the specified tag.
+.. include:: ../../../bin/varnishtop/varnishtop_options.rst
EXAMPLES
========
@@ -81,12 +40,12 @@ EXAMPLES
The following example displays a continuously updated list of the most
frequently requested URLs::
- varnishtop -i RxURL
+ varnishtop -i ReqURL
The following example displays a continuously updated list of the most
commonly used user agents::
- varnishtop -i RxHeader -C -I ^User-Agent
+ varnishtop -C -I ReqHeader:User-Agent
SEE ALSO
========
@@ -112,4 +71,4 @@ This document is licensed under the same licence as Varnish
itself. See LICENCE for details.
* Copyright (c) 2006 Verdens Gang AS
-* Copyright (c) 2006-2011 Varnish Software AS
+* Copyright (c) 2006-2014 Varnish Software AS
More information about the varnish-commit
mailing list