Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
V
varnish-cache
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Commits
Open sidebar
varnishcache
varnish-cache
Commits
f127a119
Commit
f127a119
authored
Feb 08, 2021
by
Poul-Henning Kamp
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Sort the reference manual index page
parent
b9d8f84b
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
84 additions
and
56 deletions
+84
-56
index.rst
doc/sphinx/reference/index.rst
+84
-56
No files found.
doc/sphinx/reference/index.rst
View file @
f127a119
...
...
@@ -4,21 +4,22 @@
The Varnish Reference Manual
%%%%%%%%%%%%%%%%%%%%%%%%%%%%
The VCL language
----------------
.. toctree::
:maxdepth:
2
:maxdepth:
1
vcl.rst
VCL - Varnish Configuration Language <vcl>
states.rst
varnish-cli.rst
varnishadm.rst
varnishd.rst
varnishhist.rst
varnishlog.rst
varnishncsa.rst
varnishstat.rst
varnishtest.rst
varnishtop.rst
vsm.rst
vmod.rst
Bundled VMODs
-------------
.. toctree::
:maxdepth: 1
vmod_blob.rst
vmod_cookie.rst
vmod_directors.rst
...
...
@@ -26,50 +27,77 @@ The Varnish Reference Manual
vmod_purge.rst
vmod_std.rst
vmod_unix.rst
The CLI interface
-----------------
.. toctree::
:maxdepth: 1
VarnishAdm - Control program for Varnish <varnishadm>
VCLI - The commands varnish understands <varnish-cli>
Logging and monitoring
----------------------
.. toctree::
:maxdepth: 1
VSL - The log records Varnish generates <vsl>
VSLQ - Filter/Query expressions for VSL <vsl-query>
VarnishLog - Logging raw VSL <varnishlog>
VarnishNCSA - Logging in NCSA format <varnishncsa>
VarnishHist - Realtime reponse histogram display <varnishhist>
VarnishTop - Realtime activity display <varnishtop>
Counters and statistics
-----------------------
.. toctree::
:maxdepth: 1
VSC - The statistics Varnish collects <varnish-counters>
VarnishStat - Watching and logging statistics <varnishstat>
The Varnishd program
--------------------
.. toctree::
:maxdepth: 1
VarnishD - The program which does the actual work <varnishd>
Varnishtest
-----------
.. toctree::
:maxdepth: 1
VTC - Language for writing test cases <vtc>
VarnishTest - execute test cases <varnishtest>
vmod_vtc.rst
vmod.rst
directors.rst
varnish-counters.rst
vsl.rst
vsl-query.rst
vtc.rst
vtla.rst
.. vmod_debug left out deliberately ?
.. todo::
The programs:
. varnishd manual page
. varnishstat
. - counters explained
. common filtering options for shmlog tools
. varnishlog ..
. varnishtop ..
. varnishncsa ..
. varnishhist ..
The CLI:
. connections: -T -S -M
. varnishadm
. CLI commands and what they do
. - vcl.load
. - stop
. - start
. - ...
VCL language
. The subroutines:
. - vcl_recv
. - vcl_miss
. ---
. The things you can do
. - set
. - unset
. - esi
. - rollback
Varnishtest
. syntax etc.
Shared Memory
. internals
. Log records
Libvarnishapi
. function descriptions
For Developers
--------------
.. toctree::
:maxdepth: 1
VSM - Shared memory use <vsm.rst>
VDIR - Backends & Directors <directors>
.. Vmod_debug ?
.. Libvarnishapi
.. VRT
.. VRT compat levels
Code-book
---------
.. toctree::
:maxdepth: 1
vtla.rst
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment