summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Pointner <equinox@spreadspace.org>2015-09-16 22:23:07 +0200
committerChristian Pointner <equinox@spreadspace.org>2015-09-16 22:23:07 +0200
commitf821dd3b4fda69f82ebefd2684b7d7c893340918 (patch)
tree62f037ca8fa3816858e07dd61712ac57f7ff423c /doc
parentremoved debian dir (diff)
renamed rhdropbox to dropnroll
added support for clang some fixes for Wall
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile28
-rw-r--r--doc/dropnroll.8.txt (renamed from doc/rhdropbox.8.txt)55
-rw-r--r--doc/rhdropbox.8195
3 files changed, 42 insertions, 236 deletions
diff --git a/doc/Makefile b/doc/Makefile
index f13f4ab..58ce90b 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,39 +1,39 @@
##
-## rhdropbox
+## dropnroll
##
-## Copyright (C) 2009 Christian Pointner <equinox@helsinki.at>
+## Copyright (C) 2009-2015 Christian Pointner <equinox@spreadspace.org>
##
-## This file is part of rhdropbox.
+## This file is part of dropnroll.
##
-## rhdropbox is free software: you can redistribute it and/or modify
+## dropnroll is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## any later version.
##
-## rhdropbox is distributed in the hope that it will be useful,
+## dropnroll is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
-## along with rhdropbox. If not, see <http://www.gnu.org/licenses/>.
+## along with dropnroll. If not, see <http://www.gnu.org/licenses/>.
##
-.PHONY: clean
+.PHONY: clean
all: manpage
-rhdropbox.8: rhdropbox.8.txt
+dropnroll.8: dropnroll.8.txt
a2x -f manpage $<
- @ sed -i -e 's/\[FIXME: source\]/rhdropbox/' $@
- @ sed -i -e 's/\[FIXME: manual\]/rhdropbox user manual/' $@
- @ sed -i -e 's/^rhdropbox$$/\\fBrhdropbox\\fR/' $@
+ @ sed -i -e 's/\[FIXME: source\]/dropnroll/' $@
+ @ sed -i -e 's/\[FIXME: manual\]/dropnroll user manual/' $@
+ @ sed -i -e 's/^dropnroll$$/\\fBdropnroll\\fR/' $@
@ sed -i -e 's/^ \[ \([^ ]*\)/ [ \\fB\1\\fR/' $@
-manpage: rhdropbox.8
+manpage: dropnroll.8
clean:
- rm -f rhdropbox.8.xml
+ rm -f dropnroll.8.xml
realclean:
- rm -f rhdropbox.8 \ No newline at end of file
+ rm -f dropnroll.8
diff --git a/doc/rhdropbox.8.txt b/doc/dropnroll.8.txt
index 6ec25fb..e9e4b86 100644
--- a/doc/rhdropbox.8.txt
+++ b/doc/dropnroll.8.txt
@@ -1,17 +1,17 @@
-rhdropbox(8)
+dropnroll(8)
============
NAME
----
-rhdropbox - radio helsinki dropbox daemon
+dropnroll - drop'n'roll daemon
SYNOPSIS
--------
....
-rhdropbox
+dropnroll
[ -h|--help ]
[ -D|--nodaemonize ]
[ -u|--username <username> ]
@@ -29,23 +29,24 @@ rhdropbox
DESCRIPTION
-----------
-*rhdropbox* is a small daemon which can be used to watch one or more
-directories for new files. When a new file is detected a external program.
-Additional directories can be added to the damons watch list using a simple
+*dropnroll* is a small daemon which can be used to watch one or more
+directories for new files. When a new file is detected an external program will
+get started.
+Additional directories can be added to the daemon's watch list using a simple
unix socket based command interface.
OPTIONS
-------
-The following options can be passed to the *rhdropbox* daemon:
+The following options can be passed to the *dropnroll* daemon:
*-D, --nodaemonize*::
- This option instructs *rhdropbox* to run in foreground
+ This option instructs *dropnroll* to run in foreground
instead of becoming a daemon which is the default.
*-u, --username '<username>'*::
- run as this user. If no group is specified (*-g*) the default group of
+ run as this user. If no group is specified (*-g*) the default group of
the user is used. The default is to not drop privileges.
*-g, --groupname '<groupname>'*::
@@ -53,31 +54,31 @@ The following options can be passed to the *rhdropbox* daemon:
The default is to not drop privileges.
*-C, --chroot '<path>'*::
- Instruct *rhdropbox* to run in a chroot jail. The default is
+ Instruct *dropnroll* to run in a chroot jail. The default is
to not run in chroot.
*-P, --write-pid '<filename>'*::
- Instruct *rhdropbox* to write it's pid to this file. The default is
+ Instruct *dropnroll* to write it's pid to this file. The default is
to not create a pid file.
*-L, --log '<target>:<level>[,<param1>[,<param2>[..]]]'*::
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
+ 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. +
The file target can be used more the once with different levels.
- If no target is provided at the command line a single target with the
- config *syslog:3,rhdropbox,daemon* is added. +
+ If no target is provided at the command line a single target with the
+ config *syslog:3,dropnroll,daemon* is added. +
The following targets are supported:
'syslog';; log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
'file';; log to file, parameters <level>[,<path>]
'stdout';; log to standard output, parameters <level>
- 'stderr';; log to standard error, parameters <level>
+ 'stderr';; log to standard error, parameters <level>
*-s|--command-sock '<unix sock>'*::
- *rhdropbox* will listen on this unix socket for incoming commands. See next
- chapter for details. The default is /var/run/rhdropbox/cmd.sock
+ *dropnroll* will listen on this unix socket for incoming commands. See next
+ chapter for details. The default is /var/run/dropnroll/cmd.sock
*-x|--script '<script>'*::
The script which should be called when a new file is found. The following parameter
@@ -100,11 +101,11 @@ The following options can be passed to the *rhdropbox* daemon:
COMMAND INTERFACE
-----------------
-*rhdropbox* is listening for incoming commands at the unix socket speciefied by the
+*dropnroll* is listening for incoming commands at the unix socket speciefied by the
*-s|--command-sock* parameter. You can connect to this socket for example using
socat:
- # socat UNIX-CONNECT:/var/run/rhdropbox/rhdropbox.sock STDIO
+ # socat UNIX-CONNECT:/var/run/dropnroll/dropnroll.sock STDIO
All commands have to end with '\n'. The following commands are supported:
@@ -121,10 +122,10 @@ All commands have to end with '\n'. The following commands are supported:
*listen [request|status|none]*::
Add the client to the status and or request listeners. When no parameter is passed to
- this command the client listens to all messages.
+ 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.
+ to the daemon.
A request listener also receives add and remove requests by other clients connected to
the command interface.
@@ -134,20 +135,20 @@ All commands have to end with '\n'. The following commands are supported:
BUGS
----
-Most likely there are some bugs in *rhdropbox*. If you find a bug, please let
-the developers know at equinox@helsinki.at. Of course, patches are preferred.
+Most likely there are some bugs in *dropnroll*. If you find a bug, please let
+the developers know at equinox@spreadspace.org. Of course, patches are preferred.
AUTHORS
-------
-Christian Pointner <equinox@heslinki.at>
+Christian Pointner <equinox@spreadspace.org>
COPYING
-------
-Copyright \(C) 2009 Christian Pointner. This program is free
-software: you can redistribute it and/or modify it under the terms
-of the GNU General Public License as published by the Free Software
+Copyright \(C) 2009-2015 Christian Pointner. This program is free
+software: you can redistribute it and/or modify it under the terms
+of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or any later version.
diff --git a/doc/rhdropbox.8 b/doc/rhdropbox.8
deleted file mode 100644
index 192059d..0000000
--- a/doc/rhdropbox.8
+++ /dev/null
@@ -1,195 +0,0 @@
-'\" t
-.\" Title: rhdropbox
-.\" Author: [see the "AUTHORS" section]
-.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
-.\" Date: 02/11/2010
-.\" Manual: rhdropbox user manual
-.\" Source: rhdropbox
-.\" Language: English
-.\"
-.TH "RHDROPBOX" "8" "02/11/2010" "rhdropbox" "rhdropbox user manual"
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-rhdropbox \- radio helsinki dropbox daemon
-.SH "SYNOPSIS"
-.sp
-.nf
-\fBrhdropbox\fR
- [ \fB\-h|\-\-help\fR ]
- [ \fB\-D|\-\-nodaemonize\fR ]
- [ \fB\-u|\-\-username\fR <username> ]
- [ \fB\-g|\-\-groupname\fR <groupname> ]
- [ \fB\-C|\-\-chroot\fR <path> ]
- [ \fB\-P|\-\-write\-pid\fR <filename> ]
- [ \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
-\fBrhdropbox\fR is a small daemon which can be used to watch one or more directories for new files\&. When a new file is detected a external program\&. Additional directories can be added to the damons watch list using a simple unix socket based command interface\&.
-.SH "OPTIONS"
-.sp
-The following options can be passed to the \fBrhdropbox\fR daemon:
-.PP
-\fB\-D, \-\-nodaemonize\fR
-.RS 4
-This option instructs
-\fBrhdropbox\fR
-to run in foreground instead of becoming a daemon which is the default\&.
-.RE
-.PP
-\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 \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 \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 \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 \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\&.
-
-The file target can be used more the once with different levels\&. If no target is provided at the command line a single target with the config
-\fBsyslog:3,rhdropbox,daemon\fR
-is added\&.
-
-The following targets are supported:
-.PP
-\fIsyslog\fR
-.RS 4
-log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
-.RE
-.PP
-\fIfile\fR
-.RS 4
-log to file, parameters <level>[,<path>]
-.RE
-.PP
-\fIstdout\fR
-.RS 4
-log to standard output, parameters <level>
-.RE
-.PP
-\fIstderr\fR
-.RS 4
-log to standard error, parameters <level>
-.RE
-.RE
-.PP
-\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 \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
-\fI<path>\fR
-.RS 4
-the path to the folder containing the new file
-.RE
-.PP
-\fI<filename>\fR
-.RS 4
-the name of the new file relative to <path>
-.RE
-.PP
-\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 \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:
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-# socat UNIX\-CONNECT:/var/run/rhdropbox/rhdropbox\&.sock STDIO
-.fi
-.if n \{\
-.RE
-.\}
-.sp
-All commands have to end with \fI\en\fR\&. The following commands are supported:
-.PP
-\fBadd <path>\fR
-.RS 4
-Add a path to the list of directories to be watched\&. If the command succeds nothing is returned\&. In case of an error a string of the form "Error: <reason>\en" is returned\&.
-.RE
-.PP
-\fBremove <path>\fR
-.RS 4
-Remove the path from the list of directories\&. If the command succeds nothing is returned\&. In case of an error a string of the form "Error: <reason>\en" is returned\&.
-.RE
-.PP
-\fBstatus\fR
-.RS 4
-Returns the complete list of all directories of the watch list\&.
-.RE
-.PP
-\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
-.PP
-\fBlog <text>\fR
-.RS 4
-Print <text> to the logtargets of the daemon\&.
-.RE
-.SH "BUGS"
-.sp
-Most likely there are some bugs in \fBrhdropbox\fR\&. If you find a bug, please let the developers know at equinox@helsinki\&.at\&. Of course, patches are preferred\&.
-.SH "AUTHORS"
-.sp
-Christian Pointner <equinox@heslinki\&.at>
-.SH "COPYING"
-.sp
-Copyright (C) 2009 Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&.