diff options
Diffstat (limited to 'doc/rhdropbox.8')
-rw-r--r-- | doc/rhdropbox.8 | 39 |
1 files changed, 24 insertions, 15 deletions
diff --git a/doc/rhdropbox.8 b/doc/rhdropbox.8 index c9f0ae5..192059d 100644 --- a/doc/rhdropbox.8 +++ b/doc/rhdropbox.8 @@ -33,6 +33,8 @@ rhdropbox \- radio helsinki dropbox daemon [ \fB\-L|\-\-log\fR <target>:<level>[,<param1>[,<param2>[\&.\&.]]] ] [ \fB\-s|\-\-command\-sock\fR <unix sock> ] [ \fB\-x|\-\-script\fR <script> ] + [ \fB\-m|\-\-max\-children\fR <#of children> ] + [ \fB\-d|\-\-dir\fR <path> ] .fi .SH "DESCRIPTION" .sp @@ -48,31 +50,31 @@ This option instructs to run in foreground instead of becoming a daemon which is the default\&. .RE .PP -\fB\-u, \-\-username <username>\fR +\fB\-u, \-\-username \fR\fB\fI<username>\fR\fR .RS 4 run as this user\&. If no group is specified (\fB\-g\fR) the default group of the user is used\&. The default is to not drop privileges\&. .RE .PP -\fB\-g, \-\-groupname <groupname>\fR +\fB\-g, \-\-groupname \fR\fB\fI<groupname>\fR\fR .RS 4 run as this group\&. If no username is specified (\fB\-u\fR) this gets ignored\&. The default is to not drop privileges\&. .RE .PP -\fB\-C, \-\-chroot <path>\fR +\fB\-C, \-\-chroot \fR\fB\fI<path>\fR\fR .RS 4 Instruct \fBrhdropbox\fR to run in a chroot jail\&. The default is to not run in chroot\&. .RE .PP -\fB\-P, \-\-write\-pid <filename>\fR +\fB\-P, \-\-write\-pid \fR\fB\fI<filename>\fR\fR .RS 4 Instruct \fBrhdropbox\fR to write it\(cqs pid to this file\&. The default is to not create a pid file\&. .RE .PP -\fB\-L, \-\-log <target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR +\fB\-L, \-\-log \fR\fB\fI<target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR\fR .RS 4 add log target to logging system\&. This can be invoked several times in order to log to different targets at the same time\&. Every target hast its own log level which is a number between 0 and 5\&. Where 0 means disabling log and 5 means debug messages are enabled\&. @@ -82,59 +84,66 @@ is added\&. The following targets are supported: .PP -\fBsyslog\fR +\fIsyslog\fR .RS 4 log to syslog daemon, parameters <level>[,<logname>[,<facility>]] .RE .PP -\fBfile\fR +\fIfile\fR .RS 4 log to file, parameters <level>[,<path>] .RE .PP -\fBstdout\fR +\fIstdout\fR .RS 4 log to standard output, parameters <level> .RE .PP -\fBstderr\fR +\fIstderr\fR .RS 4 log to standard error, parameters <level> .RE .RE .PP -\fB\-s|\-\-command\-sock <unix sock>\fR +\fB\-s|\-\-command\-sock \fR\fB\fI<unix sock>\fR\fR .RS 4 \fBrhdropbox\fR will listen on this unix socket for incoming commands\&. See next chapter for details\&. The default is /var/run/rhdropbox/cmd\&.sock .RE .PP -\fB\-x|\-\-script <script>\fR +\fB\-x|\-\-script \fR\fB\fI<script>\fR\fR .RS 4 The script which should be called when a new file is found\&. The following parameter are passed to the scipt: .PP -\fB<path>\fR +\fI<path>\fR .RS 4 the path to the folder containing the new file .RE .PP -\fB<filename>\fR +\fI<filename>\fR .RS 4 the name of the new file relative to <path> .RE .PP -\fB<filesize>\fR +\fI<filesize>\fR .RS 4 the size of the file right after the event was received, this can be used to determine wheter the file is complete\&. The script should consider a file to be complete when it size doesn\(cqt change 3\-5seconds after the event got received\&. .RE .RE .PP -\fB\-m|\-\-max\-children <#of children>\fR +\fB\-m|\-\-max\-children \fR\fB\fI<#of children>\fR\fR .RS 4 Limits the total concurrent executions of \fB\-x|\-\-script\fR\&. A value of 0 means no limit\&. .RE +.PP +\fB\-d|\-\-dir \fR\fB\fI<path>\fR\fR +.RS 4 +Add +\fI<path>\fR +to the watch list\&. This can be invoked serveral times\&. +.RE .SH "COMMAND INTERFACE" .sp \fBrhdropbox\fR is listening for incoming commands at the unix socket speciefied by the \fB\-s|\-\-command\-sock\fR parameter\&. You can connect to this socket for example using socat: |