[master] 0f66e81 Reformatting tab/space and width.
Lasse Karstensen
lkarsten at varnish-software.com
Tue Feb 25 14:09:41 CET 2014
commit 0f66e81e5e858e5b43aa8f1e1008661cf571df40
Author: Lasse Karstensen <lkarsten at varnish-software.com>
Date: Tue Feb 25 14:08:39 2014 +0100
Reformatting tab/space and width.
Also removed one last meta-header forgotten on the last commit.
diff --git a/doc/sphinx/reference/varnishadm.rst b/doc/sphinx/reference/varnishadm.rst
index 54e42ec..5bb9f6e 100644
--- a/doc/sphinx/reference/varnishadm.rst
+++ b/doc/sphinx/reference/varnishadm.rst
@@ -29,22 +29,23 @@ OPTIONS
=======
-t timeout
- Wait no longer than this many seconds for an operation to finish.
+ Wait no longer than this many seconds for an operation to finish.
-S secret_file
- Specify the authentication secret file. This should be the same -S
- argument as was given to varnishd. Only processes which can read
- the contents of this file, will be able to authenticate the CLI connection.
-
--T address:port
- Connect to the management interface at the specified address and port.
+ Specify the authentication secret file. This should be the same -S
+ argument as was given to varnishd. Only processes which can read
+ the contents of this file, will be able to authenticate the CLI connection.
-n name
- Connect to the instance of varnishd with this name.
+ Connect to the instance of varnishd with this name.
+
+-T address:port
+ Connect to the management interface at the specified address and port.
+
The syntax and operation of the actual CLI interface is described in
the varnish-cli(7) manual page. Parameteres are described in
-varnishd(1) manual page.
+varnishd(1) manual page.
Additionally, a summary of commands can be obtained by issuing the
*help* command, and a summary of parameters can be obtained by issuing
@@ -61,9 +62,9 @@ EXAMPLES
Some ways you can use varnishadm::
- varnishadm -T localhost:999 -S /var/db/secret vcl.use foo
- echo vcl.use foo | varnishadm -T localhost:999 -S /var/db/secret
- echo vcl.use foo | ssh vhost varnishadm -T localhost:999 -S /var/db/secret
+ varnishadm -T localhost:999 -S /var/db/secret vcl.use foo
+ echo vcl.use foo | varnishadm -T localhost:999 -S /var/db/secret
+ echo vcl.use foo | ssh vhost varnishadm -T localhost:999 -S /var/db/secret
SEE ALSO
========
@@ -74,7 +75,7 @@ HISTORY
=======
The varnishadm utility and this manual page were written by Cecilie
-Fritzvold. Converted to reStructured and updated in 2010 by Per
+Fritzvold. Converted to reStructuredText and updated in 2010 by Per
Buer.
COPYRIGHT
diff --git a/doc/sphinx/reference/varnishd.rst b/doc/sphinx/reference/varnishd.rst
index 0f7d7fa..a93ecac 100644
--- a/doc/sphinx/reference/varnishd.rst
+++ b/doc/sphinx/reference/varnishd.rst
@@ -30,7 +30,7 @@ OPTIONS
=======
-a address[:port][,address[:port][...]
- Listen for client requests on the specified address and port. The address can be a host
+ Listen for client requests on the specified address and port. The address can be a host
name (“localhost”), an IPv4 dotted-quad (“127.0.0.1”), or an IPv6 address enclosed in
square brackets (“[::1]”). If address is not specified, varnishd will listen on all
available IPv4 and IPv6 interfaces. If port is not specified, the default HTTP port as
@@ -39,10 +39,10 @@ OPTIONS
-b host[:port]
Use the specified host as backend server. If port is not specified,
- the default is 8080.
+ the default is 8080.
--C Print VCL code compiled to C language and exit. Specify the VCL file
- to compile with the -f option.
+-C Print VCL code compiled to C language and exit. Specify the VCL file
+ to compile with the -f option.
-d Enables debugging mode: The parent process runs in the foreground with a CLI connection
on stdin/stdout, and the child process must be started explicitly with a CLI command.
@@ -78,9 +78,9 @@ OPTIONS
-P file Write the process's PID to the specified file.
-p param=value
- Set the parameter specified by param to the specified value. See Run-Time
- Parameters for a list of parameters. This option can be used multiple
- times to specify multiple parameters.
+ Set the parameter specified by param to the specified value. See
+ Run-Time Parameters for a list of parameters. This option can be
+ used multiple times to specify multiple parameters.
-S file Path to a file containing a secret used for authorizing access to the management port.
@@ -100,15 +100,13 @@ OPTIONS
Interface for a list of management commands.
-M address:port
- Connect to this port and offer the command line
- interface. Think of it as a reverse shell. When running with
- -M and there is no backend defined the child process (the cache)
- will not start initially.
+ Connect to this port and offer the command line interface.
+ Think of it as a reverse shell. When running with -M and there is
+ no backend defined the child process (the cache) will not start
+ initially.
--t ttl
- Specifies a hard minimum time to live for cached
- documents. This is a shortcut for specifying the
- default_ttl run-time parameter.
+-t ttl Specifies a hard minimum time to live for cached documents. This
+ is a shortcut for specifying the default_ttl run-time parameter.
-r param[,param...]
Make the listed parameters read only. This gives the
@@ -120,8 +118,8 @@ OPTIONS
-u user Specifies the name of an unprivileged user to which the child
process should switch before it starts accepting
- connections. This is a shortcut for specifying the user
- run- time parameter.
+ connections. This is a shortcut for specifying the user
+ runtime parameter.
If specifying both a user and a group, the user should be
specified first.
@@ -135,19 +133,19 @@ Hash Algorithms
The following hash algorithms are available:
simple_list
- A simple doubly-linked list. Not recommended for production use.
+ A simple doubly-linked list. Not recommended for production use.
classic[,buckets]
- A standard hash table. This is the default. The hash key is the
- CRC32 of the object's URL modulo the size of the hash table. Each
- table entry points to a list of elements which share the same hash
- key. The buckets parameter specifies the number of entries in the
- hash table. The default is 16383.
+ A standard hash table. This is the default. The hash key is the
+ CRC32 of the object's URL modulo the size of the hash table. Each
+ table entry points to a list of elements which share the same hash
+ key. The buckets parameter specifies the number of entries in the
+ hash table. The default is 16383.
critbit
- A self-scaling tree structure. The default hash algorithm in 2.1. In
- comparison to a more traditional B tree the critbit tree is almost
- completely lockless.
+ A self-scaling tree structure. The default hash algorithm in 2.1. In
+ comparison to a more traditional B tree the critbit tree is almost
+ completely lockless.
Storage Types
-------------
@@ -243,7 +241,7 @@ The varnishd daemon was developed by Poul-Henning Kamp in cooperation
with Verdens Gang AS, Varnish Software AS and Varnish Software.
This manual page was written by Dag-Erling Smørgrav with updates by
-Stig Sandbeck Mathisen <ssm at debian.org>
+Stig Sandbeck Mathisen <ssm at debian.org>.
COPYRIGHT
diff --git a/doc/sphinx/reference/varnishsizes.rst b/doc/sphinx/reference/varnishsizes.rst
index 91c37a9..af2e05b 100644
--- a/doc/sphinx/reference/varnishsizes.rst
+++ b/doc/sphinx/reference/varnishsizes.rst
@@ -76,6 +76,7 @@ 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
=========
diff --git a/doc/sphinx/reference/varnishtest.rst b/doc/sphinx/reference/varnishtest.rst
index 03f47da..a3a0eec 100644
--- a/doc/sphinx/reference/varnishtest.rst
+++ b/doc/sphinx/reference/varnishtest.rst
@@ -126,6 +126,7 @@ This manual page was originally written by Stig Sandbeck Mathisen
<ssm at linpro.no> and updated by Kristian Lyngstøl
<kristian at varnish-cache.org>.
+
COPYRIGHT
=========
diff --git a/doc/sphinx/reference/vsl-query.rst b/doc/sphinx/reference/vsl-query.rst
index 9547a59..f188113 100644
--- a/doc/sphinx/reference/vsl-query.rst
+++ b/doc/sphinx/reference/vsl-query.rst
@@ -4,11 +4,6 @@
Varnish VSL Query Expressions
=============================
-:Author: Martin Blix Grydeland
-:Date: 2013-09-26
-:Version: 0.1
-:Manual section: 7
-
OVERVIEW
========
@@ -238,3 +233,9 @@ QUERY EXPRESSION EXAMPLES
their ESI subrequests. (Assumes request grouping mode). ::
BerespStatus >= 500 or {2+}ReqEnd[5] > 1.
+
+HISTORY
+=======
+
+This document was written by Martin Blix Grydeland.
+
diff --git a/doc/sphinx/reference/vsl.rst b/doc/sphinx/reference/vsl.rst
index 7f79209..78c3456 100644
--- a/doc/sphinx/reference/vsl.rst
+++ b/doc/sphinx/reference/vsl.rst
@@ -8,12 +8,6 @@ VSL
Shared Memory Logging
---------------------
-:Author: Poul-Henning Kamp
-:Author: Martin Blix Grydeland
-:Date: 2013-10-16
-:Version: 1.0
-:Manual section: 7
-
OVERVIEW
========
@@ -26,6 +20,14 @@ VSL tags
.. include:: ../../../lib/libvarnishapi/vsl-tags.rst
+
+HISTORY
+=======
+
+This document was initially written by Poul-Henning Kamp, and later updated by
+Martin Blix Grydeland.
+
+
SEE ALSO
========
* varnishlog(1)
More information about the varnish-commit
mailing list