summaryrefslogtreecommitdiffabout
authorSergey Poznyakoff <gray@gnu.org.ua>2013-10-18 14:17:51 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2013-10-18 14:23:30 (GMT)
commitf8804331ac83e7db86ec1212d1849de02a091cf2 (patch) (side-by-side diff)
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,
Diffstat (more/less context) (ignore whitespace changes)
-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
SUBDIRS = libltdl src tests doc
+AM_DISTCHECK_CONFIGURE_FLAGS=--without-vmoddir
+
EXTRA_DIST=git2chg.awk
.PHONY: ChangeLog
diff --git a/README b/README
index e69de29..afa07f0 100644
--- a/README
+++ b/README
@@ -0,0 +1,97 @@
+Vmod-binlog README
+Copyright (C) 2013 Sergey Poznyakoff
+See the end of file for copying conditions.
+
+* Introduction
+
+This file contains brief information about configuring, testing
+and using vmod-binlog. It is *not* intended as a replacement
+for the documentation, and is provided as a brief reference only.
+For accessing complete vmod-binlog documentation, see the section
+'Documentation' below.
+
+* Overview
+
+Vmod-binlog is a module for Varnish Cache. It provides support for
+writing binary log files from VCL scripts.
+
+A binary log file consists of an arbitrary number of equally sized
+records. Each record contains a UNIX timestamp in binary form and
+arbitrary user-defined data. Such files are convenient for storing
+big amounts of information arriving at high rates.
+
+The package provides the module itself and the utilities for listing
+and searching in binary log files.
+
+* Installation
+
+In order to compile the package you need to have Varnish source tree.
+At least Varnish 3.0.1 is required. Supposing that the varnish source tree
+is available under /usr/src/varnish-3.0.1, run:
+
+ ./configure --with-varnish-source=/usr/src/varnish-3.0.1
+
+The `--with-varnish-source' option is mandatory: it tells configure
+where Varnish sources reside.
+
+Once configured, do
+
+ make
+
+This will build the module. After this step you can optionally run
+'make test' to test the package.
+
+Finally, run the following command as root:
+
+ make install
+
+This package contains the 'magic' file for the file(1) utility. It is
+not installed by default, as its installation location differs
+considerably between various distributions. See the documentation in
+your distribution for detailed instructions.
+
+After properly installing this file, you will be able to use file(1)
+to briefly examine binary logs. For example:
+
+ $ file 10.log
+ 10.log: NXC binary log file, version 1.0, format L3, 81004 records
+
+* Documentation
+
+The following manual pages will be available after successful install:
+
+ vmod-binlog(3)
+ binlogcat(1)
+ binlogsel(1)
+
+You can also read them without actually installing the module, .e.g.:
+`man doc/vmod-binlog.3'.
+
+An online copy of the documentation is available from
+http://www.gnu.org.ua/software/vmod-binlog.
+
+* Bug reporting
+
+Send bug reports and suggestions to <gray@gnu.org>
+
+
+* Copyright information:
+
+Copyright (C) 2013 Sergey Poznyakoff
+
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and this permission notice are preserved,
+ thus giving the recipient permission to redistribute in turn.
+
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them.
+
+
+Local Variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+version-control: never
+End:
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],
)
# vmod installation dir
-AC_ARG_VAR([VMODDIR],
- [vmod installation directory @<:@LIBDIR/varnish/vmods@:>@])
-AC_ARG_WITH([vmod-dir],
- AC_HELP_STRING([--with-vmod-dir@<:@=DIR@:>@],
- [install modules to DIR; if used without arguments, install them to the varnish module directory]),
+AC_ARG_VAR([VMODDIR], [vmod installation directory])
+AC_ARG_WITH([vmoddir],
+ AC_HELP_STRING([--with-vmoddir=DIR],
+ [install modules to DIR]),
[case "$withval" in
- yes)
- VMODDIR=`pkg-config --variable=vmoddir varnishapi`
- if test -z "$VMODDIR"; then
- AC_MSG_FAILURE([cannot determine vmod installation directory])
- fi;;
- /*) VMODDIR=$withval;;
- *) AC_MSG_ERROR([argument to --with-vmod-dir must be absolute pathname])
- esac])
+ /*) VMODDIR=$withval;;
+ no) unset VMODDIR;;
+ *) AC_MSG_ERROR([argument to --with-vmoddir must be absolute pathname])
+ esac],[VMODDIR=`pkg-config --variable=vmoddir varnishapi`
+ if test -z "$VMODDIR"; then
+ AC_MSG_FAILURE([cannot determine vmod installation directory])
+ fi])
+
if test -z "$VMODDIR"; then
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 @@
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with vmod-binlog. If not, see <http://www.gnu.org/licenses/>.
-.TH VMOD-BINLOG 1 "October 17, 2013" "VMOD-BINLOG" "User Reference"
+.TH VMOD-BINLOG 1 "October 18, 2013" "VMOD-BINLOG" "User Reference"
.SH NAME
vmod\-binlog \- binary log file support for Varnish Cache.
.SH SYNOPSIS
@@ -27,7 +27,7 @@ vmod\-binlog \- binary log file support for Varnish Cache.
.B VOID binlog.commit();
.SH DESCRIPTION
-This module provides adds binary log files support to
+This module adds binary log files support to
.BR "Varnish Cache" .
.PP
Binary log file consists of an arbitrary number of equally sized

Return to:

Send suggestions and report system problems to the System administrator.