From 343273b1d918a9fca0e62feafe6e1bcc0ceb3eb0 Mon Sep 17 00:00:00 2001 From: des Date: Wed, 20 Sep 2006 16:26:54 +0000 Subject: [PATCH] Add an unfinished vcl(7) man page. git-svn-id: svn+ssh://projects.linpro.no/svn/varnish/trunk@1113 d4fa192b-c00b-0410-8231-f00ffab90ce4 --- varnish-cache/Makefile.am | 2 +- varnish-cache/configure.ac | 1 + varnish-cache/man/Makefile.am | 3 ++ varnish-cache/man/vcl.7 | 64 +++++++++++++++++++++++++++++++++++ 4 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 varnish-cache/man/Makefile.am create mode 100644 varnish-cache/man/vcl.7 diff --git a/varnish-cache/Makefile.am b/varnish-cache/Makefile.am index bb053b89..29970ae9 100644 --- a/varnish-cache/Makefile.am +++ b/varnish-cache/Makefile.am @@ -1,5 +1,5 @@ # $Id$ -SUBDIRS = include lib bin +SUBDIRS = include lib bin man EXTRA_DIST = LICENSE autogen.sh diff --git a/varnish-cache/configure.ac b/varnish-cache/configure.ac index dbd80f14..13203bee 100644 --- a/varnish-cache/configure.ac +++ b/varnish-cache/configure.ac @@ -99,5 +99,6 @@ AC_CONFIG_FILES([ lib/libvarnish/Makefile lib/libvarnishapi/Makefile lib/libvcl/Makefile + man/Makefile ]) AC_OUTPUT diff --git a/varnish-cache/man/Makefile.am b/varnish-cache/man/Makefile.am new file mode 100644 index 00000000..ca8d5377 --- /dev/null +++ b/varnish-cache/man/Makefile.am @@ -0,0 +1,3 @@ +# $Id$ + +dist_man_MANS = vcl.7 diff --git a/varnish-cache/man/vcl.7 b/varnish-cache/man/vcl.7 new file mode 100644 index 00000000..8a6d15d8 --- /dev/null +++ b/varnish-cache/man/vcl.7 @@ -0,0 +1,64 @@ +.\"- +.\" Copyright (c) 2006 Verdens Gang AS +.\" Copyright (c) 2006 Linpro AS +.\" All rights reserved. +.\" +.\" Author: Dag-Erling Smørgrav +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $Id$ +.\" +.Dd September 20, 2006 +.Dt VCL 7 +.Os +.Sh NAME +.Nm VCL +.Nd Varnish Configuration Language +.Sh SYNOPSIS +.\" ... +.Sh DESCRIPTION +The +.Nm +language is a small domain-specific language designed to be used to +define request handling and document caching policies for the Varnish +HTTP accelerator. +.Pp +When a new configuration is loaded, the +.Nm varnishd +management process translates the VCL code to C and compiles it to a +shared object which is then dynamically linked into the server +process. +.Ss Syntax +.Ss The State Machine +.Ss Backend Definitions +.Ss Access Control Lists +.Sh SEE ALSO +.Xr varnishd 1 +.Sh HISTORY +The +.Nm +language was developed by +.An Poul-Henning Kamp Aq phk@phk.freebsd.dk +in cooperation with Verdens Gang AS and Linpro AS. +This manual page was written by +.An Dag-Erling Sm\(/orgrav Aq des@linpro.no . -- 2.39.5