From 843f5fba386f9787c1562ce02bea42bfdfc09898 Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Sun, 14 Aug 2005 00:47:37 +0000
Subject: * add resource limit enforcement to the daemon * add ne options
 --no-rlimits, --no-drop-root, --syslog and --debug

git-svn-id: file:///home/lennart/svn/public/avahi/trunk@311 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
---
 man/avahi-daemon.8.xml.in      | 23 ++++++++++++++++++++++-
 man/avahi-daemon.conf.5.xml.in | 38 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+), 1 deletion(-)

(limited to 'man')

diff --git a/man/avahi-daemon.8.xml.in b/man/avahi-daemon.8.xml.in
index 93002ec..ce8ab81 100644
--- a/man/avahi-daemon.8.xml.in
+++ b/man/avahi-daemon.8.xml.in
@@ -65,9 +65,29 @@
 
 	  <option>
 		<p><opt>-D | --daemonize</opt></p>
-		<optdesc><p>Daemonize after startup and redirect log messages to syslog.</p></optdesc>
+		<optdesc><p>Daemonize after startup. Implies <opt>--syslog</opt></p></optdesc>
 	  </option>
 
+      <option>
+        <p><opt>-s | --syslog</opt></p>
+        <optdesc><p>Log to syslog instead of STDERR. Implied by <opt>--daemonize</opt></p></optdesc>
+      </option>
+
+      <option>
+        <p><opt>--debug</opt></p>
+        <optdesc><p>Increase verbosity to debug level</p></optdesc>
+      </option>
+
+      <option>
+        <p><opt>--no-rlimits</opt></p>
+        <optdesc><p>Don't enforce resource limits as specified in the configuration file. (See <manref section="2" name="setrlimit"/> for more information)</p></optdesc>
+      </option>
+
+      <option>
+        <p><opt>--no-drop-root</opt></p>
+        <optdesc><p>Don't drop root priviliges after startup and don't require daemon to be started as root. We recommend not to use this option.</p></optdesc>
+      </option>
+
 	  <option>
 		<p><opt>-k | --kill</opt></p>
 		<optdesc><p>Kill an already running avahi-daemon. (equivalent to sending a SIGTERM)</p></optdesc>
@@ -100,6 +120,7 @@
 		<optdesc><p>Show version information </p></optdesc>
 	  </option>
 
+
 	</options>
 
 
diff --git a/man/avahi-daemon.conf.5.xml.in b/man/avahi-daemon.conf.5.xml.in
index 45fdf9f..cac0717 100644
--- a/man/avahi-daemon.conf.5.xml.in
+++ b/man/avahi-daemon.conf.5.xml.in
@@ -173,6 +173,44 @@
       </option>
     </section>
 
+    <section name="Section [rlimits]">
+      <p>This section is used to define system resource limits for the
+      daemon. See <manref section="2" name="setrlimit"/> for more
+      information. If any of the options is not specified in the configuration
+      file, avahi-daemon does not change it from the system
+      defaults.</p>
+
+
+      <option>
+        <p><opt>rlimit-as=</opt> Value in bytes for RLIMIT_AS (maximum size of the process's virtual memory). Sensible values are heavily system dependent.</p>
+      </option>
+
+      <option>
+        <p><opt>rlimit-core=</opt> Value in bytes for RLIMIT_CORE (maximum core file size). Unless you want to debug avahi-daemon, it is safe to set this to 0.</p>
+      </option>
+
+      <option>
+        <p><opt>rlimit-data=</opt> Value in bytes for RLIMIT_DATA (maximum size of the process's data segment). Sensible values are heavily system dependent.</p>
+      </option>
+
+      <option>
+        <p><opt>rlimit-fsize=</opt> Value for RLIMIT_FSIZE (maximum size of files the process may create). Since avahi-daemon shouldn't write any files to disk, it is safe to set this to 0.</p>
+      </option>
+
+      <option>
+        <p><opt>rlimit-nofile=</opt> Value for RLIMIT_NOFILE (open file descriptors). avahi-daemon shouldn't need more than 15 to 20 open file descriptors concurrently.</p>
+      </option>
+
+      <option>
+        <p><opt>rlimit-stack=</opt> Value in bytes for RLIMIT_STACK (maximum size of the process stack). Sensible values are heavily system dependent.</p>
+      </option>
+
+      <option>
+        <p><opt>rlimit-nproc=</opt> Value for RLIMIT_NPROC (number of process of user). Since only a single avahi-daemon process is usually running you can set this safely to 1.</p>
+      </option>
+
+    </section>
+
 	<section name="Authors">
 	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
-- 
cgit