r3362 - trunk/varnish-cache/bin/varnishd

[tfheen at projects.linpro.no]

Author: tfheen
Date: 2008-11-06 12:57:05 +0100 (Thu, 06 Nov 2008)
New Revision: 3362

Modified:
   trunk/varnish-cache/bin/varnishd/varnishd.1
Log:
Document the size parameter to -s malloc

Fixes #362


Modified: trunk/varnish-cache/bin/varnishd/varnishd.1
===================================================================
--- trunk/varnish-cache/bin/varnishd/varnishd.1	2008-11-06 11:46:31 UTC (rev 3361)
+++ trunk/varnish-cache/bin/varnishd/varnishd.1	2008-11-06 11:57:05 UTC (rev 3362)
@@ -236,9 +236,27 @@
 .Ss Storage Types
 The following storage types are available:
 .Bl -tag -width 4n
-.It Cm malloc
+.It Cm malloc Ns Op Ns , Ns Ar size Ns
 Storage for each object is allocated with
 .Xr malloc 3 .
+.Pp
+The
+.Ar size
+parameter specifies the maximum amount of memory varnishd will allocate.
+The size is assumed to be in bytes, unless followed by one of the
+following suffixes:
+.Bl -tag -width indent
+.It K, k
+The size is expressed in kibibytes.
+.It M, m
+The size is expressed in mebibytes.
+.It G, g
+The size is expressed in gibibytes.
+.It T, t
+The size is expressed in tebibytes.
+.El
+.Pp
+The default size is unlimited.
 .It Cm file Ns Op Ns , Ns Ar path Ns Op Ns , Ns Ar size Ns Op Ns , Ns Ar granularity
 Storage for each object is allocated from an arena backed by a file.
 This is the default.