From 34d7ed41c4b2b71f167fc30311b01a50c40319a6 Mon Sep 17 00:00:00 2001
From: des <des@d4fa192b-c00b-0410-8231-f00ffab90ce4>
Date: Mon, 18 Sep 2006 15:24:11 +0000
Subject: [PATCH] Add man page.

git-svn-id: svn+ssh://projects.linpro.no/svn/varnish/trunk@1076 d4fa192b-c00b-0410-8231-f00ffab90ce4
---
 varnish-cache/bin/varnishtop/Makefile.am  |   2 +-
 varnish-cache/bin/varnishtop/varnishtop.1 | 123 ++++++++++++++++++++++
 2 files changed, 124 insertions(+), 1 deletion(-)
 create mode 100644 varnish-cache/bin/varnishtop/varnishtop.1

diff --git a/varnish-cache/bin/varnishtop/Makefile.am b/varnish-cache/bin/varnishtop/Makefile.am
index 3750f2eb..377486d4 100644
--- a/varnish-cache/bin/varnishtop/Makefile.am
+++ b/varnish-cache/bin/varnishtop/Makefile.am
@@ -4,7 +4,7 @@ INCLUDES = -I$(top_srcdir)/include
 
 bin_PROGRAMS = varnishtop
 
-# dist_man_MANS = varnishtop.1
+dist_man_MANS = varnishtop.1
 
 varnishtop_SOURCES = varnishtop.c
 
diff --git a/varnish-cache/bin/varnishtop/varnishtop.1 b/varnish-cache/bin/varnishtop/varnishtop.1
new file mode 100644
index 00000000..49433ed3
--- /dev/null
+++ b/varnish-cache/bin/varnishtop/varnishtop.1
@@ -0,0 +1,123 @@
+.\"
+.\" $Id$
+.\"
+.Dd September 16, 2006
+.Dt VARNISHHIST 1
+.Os
+.Sh NAME
+.Nm varnishhist
+.Nd Varnish request histogram
+.Sh SYNOPSIS
+.Nm
+.Op Fl 1
+.Op Fl b
+.Op Fl C
+.Op Fl c
+.Op Fl d
+.Op Fl f
+.Op Fl I Ar regex
+.Op Fl i Ar tag
+.Op Fl r Ar file
+.Op Fl V
+.Op Fl X Ar regex
+.Op Fl x Ar tag
+.Sh DESCRIPTION
+The
+.Nm
+utility reads
+.Xr varnishd 1
+shared memory logs and presents a continuously updated list of the
+most commonly occurring log entries.
+With suitable filtering using the
+.Fl I ,
+.Fl i ,
+.Fl X
+and
+.Fl x
+options, it can be used to display a ranking of requested documents,
+clients, user agents, or any other information which is recorded in
+the log.
+.Pp
+The following options are available:
+.Bl -tag -width Fl
+.It Fl 1
+Instead of presenting of a continuously updated display, print the
+statistics once and exit.
+.It Fl b
+Include log entries which result from communication with a backend
+server.
+If neither
+.Fl b
+nor
+.Fl c
+is specified,
+.Nm
+acts as if they both were.
+.It Fl C
+Ignore case when matching regular expressions.
+.It Fl c
+Include log entries which result from communication with a client.
+If neither
+.Fl b
+nor
+.Fl c
+is specified,
+.Nm
+acts as if they both were.
+.It Fl d
+Process old log entries on startup.
+Normally,
+.Nm
+will only process entries which are written to the log after it
+starts.
+.Op Fl f
+Sort and group only on the first field of each log entry.
+This is useful when displaying e.g.
+.Dv stataddr
+entries, where the first field is the client IP address.
+.It Fl I Ar regex
+Include log entries which match the specified regular expression.
+If neither
+.Fl I
+nor
+.Fl i
+is specified, all log entries are included.
+.It Fl i Ar tag
+Include log entries with the specified tag.
+If neither
+.Fl I
+nor
+.Fl i
+is specified, all log entries are included.
+.It Fl r Ar file
+Read log entries from
+.Ar file
+instead of shared memory.
+.It Fl V
+Display the version number and exit.
+.Ar file
+instead of displaying them.
+The file will be overwritten unless the
+.Fl a
+option was specified.
+.It Fl X Ar regex
+Exclude log entries which match the specified regular expression.
+.It Fl x Ar tag
+Exclude log entries with the specified tag.
+.El
+.Sh SEE ALSO
+.Xr varnishd 1 ,
+.Xr varnishhist 1 ,
+.Xr varnishlog 1 ,
+.Xr varnishncsa 1 ,
+.Xr varnishstat 1
+.Sh HISTORY
+The
+.Nm
+utility was developed by
+.An Poul-Henning Kamp Aq phk@freebsd.dk
+in cooperation with Verdens Gang AS and Linpro AS.
+.Sh BUGS
+The
+.Fl 1
+option currently does not work very well.
-- 
2.39.5