aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2013-10-18 17:17:51 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2013-10-18 17:23:30 +0300
commitf8804331ac83e7db86ec1212d1849de02a091cf2 (patch)
treee375c435d6a9b8197cecedb4a2cd96cd6d3b539d
parent803128db75e3efea8cd7be29732a7b4315205d13 (diff)
downloadvmod-binlog-f8804331ac83e7db86ec1212d1849de02a091cf2.tar.gz
vmod-binlog-f8804331ac83e7db86ec1212d1849de02a091cf2.tar.bz2
Get rid of the --with-vmod-dir option.
* Makefile.am: Add default options for distcheck. * configure.ac: Remove --with-vmod-dir, default to the standard Varnish module location, Provide the --without-vmoddir option for use in distcheck. * README: Write it. * doc/vmod-binlog.3: Minor change,
-rw-r--r--Makefile.am2
-rw-r--r--README97
-rw-r--r--configure.ac25
-rw-r--r--doc/vmod-binlog.34
4 files changed, 113 insertions, 15 deletions
diff --git a/Makefile.am b/Makefile.am
index 917f2e5..2928055 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -17,6 +17,8 @@ ACLOCAL_AMFLAGS = -I m4
17 17
18SUBDIRS = libltdl src tests doc 18SUBDIRS = libltdl src tests doc
19 19
20AM_DISTCHECK_CONFIGURE_FLAGS=--without-vmoddir
21
20EXTRA_DIST=git2chg.awk 22EXTRA_DIST=git2chg.awk
21 23
22.PHONY: ChangeLog 24.PHONY: ChangeLog
diff --git a/README b/README
index e69de29..afa07f0 100644
--- a/README
+++ b/README
@@ -0,0 +1,97 @@
1Vmod-binlog README
2Copyright (C) 2013 Sergey Poznyakoff
3See the end of file for copying conditions.
4
5* Introduction
6
7This file contains brief information about configuring, testing
8and using vmod-binlog. It is *not* intended as a replacement
9for the documentation, and is provided as a brief reference only.
10For accessing complete vmod-binlog documentation, see the section
11'Documentation' below.
12
13* Overview
14
15Vmod-binlog is a module for Varnish Cache. It provides support for
16writing binary log files from VCL scripts.
17
18A binary log file consists of an arbitrary number of equally sized
19records. Each record contains a UNIX timestamp in binary form and
20arbitrary user-defined data. Such files are convenient for storing
21big amounts of information arriving at high rates.
22
23The package provides the module itself and the utilities for listing
24and searching in binary log files.
25
26* Installation
27
28In order to compile the package you need to have Varnish source tree.
29At least Varnish 3.0.1 is required. Supposing that the varnish source tree
30is available under /usr/src/varnish-3.0.1, run:
31
32 ./configure --with-varnish-source=/usr/src/varnish-3.0.1
33
34The `--with-varnish-source' option is mandatory: it tells configure
35where Varnish sources reside.
36
37Once configured, do
38
39 make
40
41This will build the module. After this step you can optionally run
42'make test' to test the package.
43
44Finally, run the following command as root:
45
46 make install
47
48This package contains the 'magic' file for the file(1) utility. It is
49not installed by default, as its installation location differs
50considerably between various distributions. See the documentation in
51your distribution for detailed instructions.
52
53After properly installing this file, you will be able to use file(1)
54to briefly examine binary logs. For example:
55
56 $ file 10.log
57 10.log: NXC binary log file, version 1.0, format L3, 81004 records
58
59* Documentation
60
61The following manual pages will be available after successful install:
62
63 vmod-binlog(3)
64 binlogcat(1)
65 binlogsel(1)
66
67You can also read them without actually installing the module, .e.g.:
68`man doc/vmod-binlog.3'.
69
70An online copy of the documentation is available from
71http://www.gnu.org.ua/software/vmod-binlog.
72
73* Bug reporting
74
75Send bug reports and suggestions to <gray@gnu.org>
76
77
78* Copyright information:
79
80Copyright (C) 2013 Sergey Poznyakoff
81
82 Permission is granted to anyone to make or distribute verbatim copies
83 of this document as received, in any medium, provided that the
84 copyright notice and this permission notice are preserved,
85 thus giving the recipient permission to redistribute in turn.
86
87 Permission is granted to distribute modified versions
88 of this document, or of portions of it,
89 under the above conditions, provided also that they
90 carry prominent notices stating who last changed them.
91
92
93Local Variables:
94mode: outline
95paragraph-separate: "[ ]*$"
96version-control: never
97End:
diff --git a/configure.ac b/configure.ac
index c4c9872..1bfc079 100644
--- a/configure.ac
+++ b/configure.ac
@@ -84,20 +84,19 @@ AC_CHECK_FILE([$VARNISHSRC/bin/varnishtest/varnishtest],
84) 84)
85 85
86# vmod installation dir 86# vmod installation dir
87AC_ARG_VAR([VMODDIR], 87AC_ARG_VAR([VMODDIR], [vmod installation directory])
88 [vmod installation directory @<:@LIBDIR/varnish/vmods@:>@]) 88AC_ARG_WITH([vmoddir],
89AC_ARG_WITH([vmod-dir], 89 AC_HELP_STRING([--with-vmoddir=DIR],
90 AC_HELP_STRING([--with-vmod-dir@<:@=DIR@:>@], 90 [install modules to DIR]),
91 [install modules to DIR; if used without arguments, install them to the varnish module directory]),
92 [case "$withval" in 91 [case "$withval" in
93 yes) 92 /*) VMODDIR=$withval;;
94 VMODDIR=`pkg-config --variable=vmoddir varnishapi` 93 no) unset VMODDIR;;
95 if test -z "$VMODDIR"; then 94 *) AC_MSG_ERROR([argument to --with-vmoddir must be absolute pathname])
96 AC_MSG_FAILURE([cannot determine vmod installation directory]) 95 esac],[VMODDIR=`pkg-config --variable=vmoddir varnishapi`
97 fi;; 96 if test -z "$VMODDIR"; then
98 /*) VMODDIR=$withval;; 97 AC_MSG_FAILURE([cannot determine vmod installation directory])
99 *) AC_MSG_ERROR([argument to --with-vmod-dir must be absolute pathname]) 98 fi])
100 esac]) 99
101 100
102if test -z "$VMODDIR"; then 101if test -z "$VMODDIR"; then
103 VMODDIR='$(libdir)/varnish/mods' 102 VMODDIR='$(libdir)/varnish/mods'
diff --git a/doc/vmod-binlog.3 b/doc/vmod-binlog.3
index 2d6dfdb..7578615 100644
--- a/doc/vmod-binlog.3
+++ b/doc/vmod-binlog.3
@@ -13,7 +13,7 @@
13.\" 13.\"
14.\" You should have received a copy of the GNU General Public License 14.\" You should have received a copy of the GNU General Public License
15.\" along with vmod-binlog. If not, see <http://www.gnu.org/licenses/>. 15.\" along with vmod-binlog. If not, see <http://www.gnu.org/licenses/>.
16.TH VMOD-BINLOG 1 "October 17, 2013" "VMOD-BINLOG" "User Reference" 16.TH VMOD-BINLOG 1 "October 18, 2013" "VMOD-BINLOG" "User Reference"
17.SH NAME 17.SH NAME
18vmod\-binlog \- binary log file support for Varnish Cache. 18vmod\-binlog \- binary log file support for Varnish Cache.
19.SH SYNOPSIS 19.SH SYNOPSIS
@@ -27,7 +27,7 @@ vmod\-binlog \- binary log file support for Varnish Cache.
27 27
28.B VOID binlog.commit(); 28.B VOID binlog.commit();
29.SH DESCRIPTION 29.SH DESCRIPTION
30This module provides adds binary log files support to 30This module adds binary log files support to
31.BR "Varnish Cache" . 31.BR "Varnish Cache" .
32.PP 32.PP
33Binary log file consists of an arbitrary number of equally sized 33Binary log file consists of an arbitrary number of equally sized

Return to:

Send suggestions and report system problems to the System administrator.