summaryrefslogtreecommitdiff
path: root/doc/dropnroll.8
diff options
context:
space:
mode:
Diffstat (limited to 'doc/dropnroll.8')
-rw-r--r--doc/dropnroll.848
1 files changed, 44 insertions, 4 deletions
diff --git a/doc/dropnroll.8 b/doc/dropnroll.8
index 76f8f81..2120d14 100644
--- a/doc/dropnroll.8
+++ b/doc/dropnroll.8
@@ -2,12 +2,12 @@
.\" Title: dropnroll
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 09/16/2015
+.\" Date: 09/20/2015
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "DROPNROLL" "8" "09/16/2015" "\ \&" "\ \&"
+.TH "DROPNROLL" "8" "09/20/2015" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -40,9 +40,11 @@ dropnroll \- drop\*(Aqn\*(Aqroll daemon
[ \fB\-C|\-\-chroot\fR <path> ]
[ \fB\-P|\-\-write\-pid\fR <filename> ]
[ \fB\-L|\-\-log\fR <target>:<level>[,<param1>[,<param2>[\&.\&.]]] ]
+ [ \fB\-U|\-\-debug\fR ]
[ \fB\-s|\-\-command\-sock\fR <unix sock> ]
[ \fB\-x|\-\-script\fR <script> ]
[ \fB\-m|\-\-max\-children\fR <#of children> ]
+ [ \fB\-p|\-\-children\-policy\fR (defer|drop|kill\-oldest) ]
[ \fB\-d|\-\-dir\fR <path> ]
.fi
.SH "DESCRIPTION"
@@ -114,10 +116,23 @@ log to standard error, parameters <level>
.RE
.RE
.PP
+\fB\-U, \-\-debug\fR
+.RS 4
+This option instructs
+\fBdropnroll\fR
+to run in debug mode\&. It implicits
+\fB\-D\fR
+(don\(cqt daemonize) and adds a log target with the configuration
+\fIstdout:5\fR
+(logging with maximum level)\&. In future releases there might be additional output when this option is supplied\&.
+.RE
+.PP
\fB\-s|\-\-command\-sock \fR\fB\fI<unix sock>\fR\fR
.RS 4
\fBdropnroll\fR
-will listen on this unix socket for incoming commands\&. See next chapter for details\&. The default is /var/run/dropnroll/cmd\&.sock
+will listen on this unix socket for incoming commands\&. See next chapter for details\&. If there are directories specified using the
+\fB\-\-dir\fR
+option and this is kept empty the command socket is deactivated\&. If no directories are added it defaults to /var/run/dropnroll/cmd\&.sock
.RE
.PP
\fB\-x|\-\-script \fR\fB\fI<script>\fR\fR
@@ -146,6 +161,31 @@ Limits the total concurrent executions of
\fB\-x|\-\-script\fR\&. A value of 0 means no limit\&.
.RE
.PP
+\fB\-p|\-\-children\-policy \fR\fB\fI(defer|drop|kill\-oldest)\fR\fR
+.RS 4
+Specifies what
+\fBdropnroll\fR
+should do when the client limit has been reached:
+.PP
+\fIdefer\fR
+.RS 4
+defer the execution of
+\fB\-\-script\fR
+until the number of children is below the limit
+.RE
+.PP
+\fIdrop\fR
+.RS 4
+ingore the new file and don\(cqt call
+\fB\-\-script\fR
+.RE
+.PP
+\fIkill\-oldest\fR
+.RS 4
+kill the oldest child (using SIGKILL)
+.RE
+.RE
+.PP
\fB\-d|\-\-dir \fR\fB\fI<path>\fR\fR
.RS 4
Add
@@ -183,7 +223,7 @@ Remove the path from the list of directories\&. If the command succeds nothing i
Returns the complete list of all directories of the watch list\&.
.RE
.PP
-\fBlisten [request|status|none]\fR
+\fBlisten (request|status|none)\fR
.RS 4
Add the client to the status and or request listeners\&. When no parameter is passed to this command the client listens to all messages\&. A status listener gets a list of all directories whenever somebody else adds or removes a path to the watch list\&. It also receives the list when somebody sends a status command to the daemon\&. A request listener also receives add and remove requests by other clients connected to the command interface\&.
.RE