diff options
author | Christian Pointner <equinox@helsinki.at> | 2011-02-15 11:00:00 (GMT) |
---|---|---|
committer | Christian Pointner <equinox@helsinki.at> | 2011-02-15 11:00:00 (GMT) |
commit | cef04da3c24cdcf1c1ffeb214c74f6ef0aaaa0ad (patch) | |
tree | faa46b65dbeb61beab0d713ff075d6da18b1c1a8 /doc/rharchive.8.txt | |
parent | d32fab197970b9aac76ef90fb2f48adbbebea978 (diff) |
added initial version
Diffstat (limited to 'doc/rharchive.8.txt')
-rw-r--r-- | doc/rharchive.8.txt | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/doc/rharchive.8.txt b/doc/rharchive.8.txt new file mode 100644 index 0000000..9da537c --- /dev/null +++ b/doc/rharchive.8.txt @@ -0,0 +1,105 @@ +rharchive(8) +============ + +NAME +---- + +rharchive - Radio Helsinki Archive Daemon + + +SYNOPSIS +-------- + +.... +rharchive + [ -h|--help ] + [ -D|--nodaemonize ] + [ -u|--username <username> ] + [ -g|--groupname <groupname> ] + [ -C|--chroot <path> ] + [ -P|--write-pid <filename> ] + [ -L|--log <target>:<level>[,<param1>[,<param2>[..]]] ] + [ -U|--debug ] +.... + + +DESCRIPTION +----------- + +*rharchive* rharchive is small program based on gstreamer. It converts +a raw audio stream into flac or ogg and writes files for every +hour. + +OPTIONS +------- + +The following options can be passed to the *rharchive* daemon: + +*-D, --nodaemonize*:: + This option instructs *rharchive* 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 + the user is used. The default is to not drop privileges. + +*-g, --groupname <groupname>*:: + run as this group. If no username is specified (*-u*) this gets ignored. + The default is to not drop privileges. + +*-C, --chroot <path>*:: + Instruct *rharchive* to run in a chroot jail. The default is + to not run in chroot. + +*-P, --write-pid <filename>*:: + Instruct *rharchive* 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 + has 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 than once with different levels. + If no target is provided at the command line a single target with the + config *syslog:3,rharchive,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> + +*-U, --debug*:: + This option instructs *rharchive* to run in debug mode. It implicits *-D* + (don't daemonize) and adds a log target with the configuration + *stdout:5* (logging with maximum level). In future releases there might + be additional output when this option is supplied. + + + +BUGS +---- +Most likely there are some bugs in *rharchive*. If you find a bug, please let +the developers know at equinox@helsinki.at. Of course, patches are preferred. + + +AUTHORS +------- + +Christian Pointner <equinox@helsinki.at> + + +RESOURCES +--------- + +Radio Helsinki Website: http://www.helsinki.at + + +COPYING +------- + +Copyright \(C) 2011 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. |