From: tfheen <tfheen@d4fa192b-c00b-0410-8231-f00ffab90ce4>
Date: Thu, 6 Nov 2008 11:57:05 +0000 (+0000)
Subject: Document the size parameter to -s malloc
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=716093ba30d86cc167a955d21c19828414d43e62;p=varnish

Document the size parameter to -s malloc

Fixes #362


git-svn-id: svn+ssh://projects.linpro.no/svn/varnish/trunk@3362 d4fa192b-c00b-0410-8231-f00ffab90ce4
---

diff --git a/varnish-cache/bin/varnishd/varnishd.1 b/varnish-cache/bin/varnishd/varnishd.1
index cbfd3f5d..63c7144b 100644
--- a/varnish-cache/bin/varnishd/varnishd.1
+++ b/varnish-cache/bin/varnishd/varnishd.1
@@ -236,9 +236,27 @@ The default is 16383.
 .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.