diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 47 | ||||
| -rw-r--r-- | doc/rharchive.8 | 126 | ||||
| -rw-r--r-- | doc/rharchive.8.txt | 105 |
3 files changed, 278 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..4d559d0 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,47 @@ +## +## rharchive +## +## rharchive is a simple tcp connection proxy which combines the +## features of rinetd and 6tunnel. rharchive supports IPv4 and +## IPv6 and also supports connections from IPv6 to IPv4 +## endpoints and vice versa. +## +## +## Copyright (C) 2010-2011 Christian Pointner <equinox@helsinki.at> +## +## This file is part of rharchive. +## +## rharchive 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. +## +## rharchive 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 rharchive. If not, see <http://www.gnu.org/licenses/>. +## + +VERSION=$(shell cat ../version) + +.PHONY: clean + +all: manpage + +rharchive.8: rharchive.8.txt + a2x -f manpage $< + @ sed -i -e 's/\[FIXME: source\]/rharchive ${VERSION}/' $@ + @ sed -i -e 's/\[FIXME: manual\]/rharchive user manual/' $@ + @ sed -i -e 's/^rharchive$$/\\fBrharchive\\fR/' $@ + @ sed -i -e 's/^ \[ \([^ ]*\)/ [ \\fB\1\\fR/' $@ + +manpage: rharchive.8 + +clean: + rm -f rharchive.8.xml + +realclean: clean + rm -f rharchive.8 diff --git a/doc/rharchive.8 b/doc/rharchive.8 new file mode 100644 index 0000000..845f17a --- /dev/null +++ b/doc/rharchive.8 @@ -0,0 +1,126 @@ +'\" t +.\" Title: rharchive +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/> +.\" Date: 02/15/2011 +.\" Manual: rharchive user manual +.\" Source: rharchive trunk +.\" Language: English +.\" +.TH "RHARCHIVE" "8" "02/15/2011" "rharchive trunk" "rharchive user manual" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +rharchive \- Radio Helsinki Archive Daemon +.SH "SYNOPSIS" +.sp +.nf +\fBrharchive\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\-U|\-\-debug\fR ] +.fi +.SH "DESCRIPTION" +.sp +\fBrharchive\fR rharchive is small program based on gstreamer\&. It converts a raw audio stream into flac or ogg and writes files for every hour\&. +.SH "OPTIONS" +.sp +The following options can be passed to the \fBrharchive\fR daemon: +.PP +\fB\-D, \-\-nodaemonize\fR +.RS 4 +This option instructs +\fBrharchive\fR +to run in foreground instead of becoming a daemon which is the default\&. +.RE +.PP +\fB\-u, \-\-username <username>\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 +.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 +.RS 4 +Instruct +\fBrharchive\fR +to run in a chroot jail\&. The default is to not run in chroot\&. +.RE +.PP +\fB\-P, \-\-write\-pid <filename>\fR +.RS 4 +Instruct +\fBrharchive\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 +.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 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 +\fBsyslog:3,rharchive,daemon\fR +is added\&. + +The following targets are supported: +.PP +\fBsyslog\fR +.RS 4 +log to syslog daemon, parameters <level>[,<logname>[,<facility>]] +.RE +.PP +\fBfile\fR +.RS 4 +log to file, parameters <level>[,<path>] +.RE +.PP +\fBstdout\fR +.RS 4 +log to standard output, parameters <level> +.RE +.PP +\fBstderr\fR +.RS 4 +log to standard error, parameters <level> +.RE +.RE +.PP +\fB\-U, \-\-debug\fR +.RS 4 +This option instructs +\fBrharchive\fR +to run in debug mode\&. It implicits +\fB\-D\fR +(don\(cqt daemonize) and adds a log target with the configuration +\fBstdout:5\fR +(logging with maximum level)\&. In future releases there might be additional output when this option is supplied\&. +.RE +.SH "BUGS" +.sp +Most likely there are some bugs in \fBrharchive\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@helsinki\&.at> +.SH "RESOURCES" +.sp +Radio Helsinki Website: http://www\&.helsinki\&.at +.SH "COPYING" +.sp +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\&. 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. |