Merge r4878: converted/cleaned up a few more man pages

git-svn-id: http://www.varnish-cache.org/svn/branches/2.1@5268 d4fa192b-c00b-0410-8231-f00ffab90ce4

doc/sphinx/reference/varnishadm.rst

@@ -78,7 +78,6 @@ 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) 2007-2008 Linpro AS
 * Copyright (c) 2008-2010 Redpill Linpro AS
 * Copyright (c) 2010 Varnish Software AS

doc/sphinx/reference/varnishlog.rst

+==========
+varnishlog
+==========
+
+--------------------
+Display Varnish logs
+--------------------
+
+:Author: Dag-Erling Smørgrav
+:Author: Per Buer
+:Date:   2010-05-31
+:Version: 0.2
+:Manual section: 1
+
+
+SYNOPSIS
+========
+
+varnishlog [-a] [-b] [-C] [-c] [-D] [-d] [-I regex] [-i tag] [-k keep] 
+[-n varnish_name] [-o] [-P file] [-r file] [-s num] [-u] [-V] 
+[-w file] [-X regex] [-x tag] [tag regex]
+
+DESCRIPTION
+===========
+
+
+The varnishlog utility reads and presents varnishd(1) shared memory logs.
+
+The following options are available:
+
+-a          When writing to a file, append to it rather than overwrite it.
+
+-b          Include log entries which result from communication with a backend server.  
+	    If neither -b nor -c is specified, varnishlog 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, varnishlog acts as if they both were.
+
+-D          Daemonize.
+
+-d          Process old log entries on startup.  Normally, varnishlog will only process entries 
+	    which are written to the log after it starts.
+
+-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.
+
+-k num      Only show the first num log records.
+
+-n          Specifies the name of the varnishd instance to get logs from.  If -n is not 
+	    specified, the host name is used.
+
+-o          Group log entries by request ID.  This has no effect when writing to a 
+	    file using the -w option.
+
+-P file     Write the process's PID to the specified file.
+
+-r file     Read log entries from file instead of shared memory.
+
+-s num      Skip the first num log records.
+
+-u          Unbuffered output.
+
+-V          Display the version number and exit.
+
+-w file     Write log entries to file instead of displaying them.  The file 
+   	    will be overwritten unless the -a option was specified. If 
+	    varnishlog receives a SIGHUP while writing to a file, it will 
+	    reopen the file, allowing the old one to be rotated away.
+
+-X regex    Exclude log entries which match the specified regular expression.
+
+-x tag      Exclude log entries with the specified tag.
+
+If the -o option was specified, an additional tag and regex may be
+specified to select only requests which generated a log entry with the
+given tag whose contents match the given regex.
+
+TAGS
+====
+The following log entry tags are currently defined:
+
+* Backend
+* BackendClose
+* BackendOpen
+* BackendReuse
+* BackendXID
+* CLI
+* ClientAddr
+* Debug
+* Error
+* ExpBan
+* ExpKill
+* ExpPick
+* Hit
+* HitPass
+* HttpError
+* HttpGarbage
+* Length
+* ObjHeader
+* ObjLostHeader
+* ObjProtocol
+* ObjRequest
+* ObjResponse
+* ObjStatus
+* ObjURL
+* ReqEnd
+* ReqStart
+* RxHeader
+* RxLostHeader
+* RxProtocol
+* RxRequest
+* RxResponse
+* RxStatus
+* RxURL
+* SessionClose
+* SessionOpen
+* StatAddr
+* StatSess
+* TTL
+* TxHeader
+* TxLostHeader
+* TxProtocol
+* TxRequest
+* TxResponse
+* TxStatus
+* TxURL
+* VCL_acl
+* VCL_call
+* VCL_return
+* VCL_trace
+* WorkThread
+
+EXAMPLES
+========
+
+The following command line simply copies all log entries to a log file:::
+
+    $ varnishlog -w /var/log/varnish.log
+
+The following command line reads that same log file and displays requests for the front page:::
+
+    $ varnishlog -r /var/log/varnish.log -c -o RxURL '^/$'
+
+SEE ALSO
+========
+* varnishd(1)
+* varnishhist(1)
+* varnishncsa(1)
+* varnishstat(1)
+* varnishtop(1)
+
+HISTORY
+=======
+
+The varnishlog utility was developed by Poul-Henning Kamp ⟨phk@phk.freebsd.dk⟩ in cooperation with Verdens Gang
+AS, Linpro AS and Varnish Software.  This manual page was initially written by Dag-Erling Smørgrav.
+
+
+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

doc/sphinx/reference/varnishreplay.rst

+=============
+varnishreplay
+=============
+
+------------------------
+HTTP traffic replay tool
+------------------------
+
+:Author: Cecilie Fritzvold
+:Author: Per Buer
+:Date:   2010-05-31
+:Version: 1.0
+:Manual section: 1
+
+
+SYNOPSIS
+========
+varnishreplay [-D] -a address:port -r file
+
+DESCRIPTION
+===========
+
+The varnishreplay utility parses varnish logs and attempts to
+reproduce the traffic. It is typcally used to *warm* up caches or
+various forms of testing.
+
+The following options are available:
+
+-a backend           Send the traffic over tcp to this server, specified by an 
+   		     address and a port.  This option is 
+   		     mandatory. Only IPV4 is supported at this time.
+
+-D                   Turn on debugging mode.
+
+-r file              Parse logs from this file.  This option is mandatory.
+
+
+SEE ALSO
+========
+
+* varnishd(1)
+* varnishlog(1)
+
+HISTORY
+=======
+
+The varnishreplay utility and this manual page were written by Cecilie
+Fritzvold and later updated by Per Buer.
+
+COPYRIGHT
+=========
+
+This document is licensed under the same licence as Varnish
+itself. See LICENCE for details.
+
+* Copyright (c) 2007 Linpro AS
+* Copyright (c) 2010 Varnish Software AS

doc/sphinx/reference/varnishsizes.rst

+============
+varnishsizes
+============
+
+-------------------------------------
+Varnish object size request histogram
+-------------------------------------
+
+:Author: Dag Erling Smørgrav
+:Author: Kristian Lyngstøl
+:Author: Per Buer
+:Date:   2010-05-31
+:Version: 1.0
+:Manual section: 1
+
+
+SYNOPSIS
+========
+
+varnishsizes [-b] [-C] [-c] [-d] [-I regex] [-i tag] [-n varnish_name]
+             [-r file] [-V] [-w delay] [-X regex] [-x tag]
+
+DESCRIPTION
+===========
+
+The varnishsizes utility reads varnishd(1) shared memory logs and presents a continuously updated histogram
+showing the distribution of the last N requests by their processing.  The value of N and the vertical scale are
+displayed in the top left corner.  The horizontal scale is logarithmic.  Hits are marked with a pipe character
+("|"), and misses are marked with a hash character ("#").
+
+The following options are available:
+
+-b          Include log entries which result from communication with a backend server.  
+	    If neither -b nor -c is specified, varnishsizes 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, varnishsizes acts as if they both were.
+
+-d          Process old log entries on startup.  Normally, varnishsizes will only 
+	    process entries which are written to the log after it starts.
+
+-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.
+
+-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.
+
+-w delay    Wait at least delay seconds between each update.  The default is 1.  
+   	    file instead of displaying them.  The file will be overwritten 
+	    unless the -a option was specified.
+
+-X regex    Exclude log entries which match the specified regular expression.
+
+-x tag      Exclude log entries with the specified tag.
+
+SEE ALSO
+========
+
+* varnishd(1)
+* varnishlog(1)
+* varnishncsa(1)
+* varnishstat(1)
+* varnishtop(1)
+
+HISTORY
+=======
+
+The varnishsizes utility was developed by Kristian Lyngstøl based on
+varnishhist.  This manual page was written by Kristian Lyngstøl,
+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) 2010 Varnish Software AS