diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 8 | ||||
| -rw-r--r-- | doc/rharchive.8 | 21 | ||||
| -rw-r--r-- | doc/rharchive.8.txt | 22 |
3 files changed, 30 insertions, 21 deletions
diff --git a/doc/Makefile b/doc/Makefile index 3b8c361..afb48aa 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -2,10 +2,10 @@ ## rharchive ## ## The Radio Helsinki Archive Daemon -## ## -## Copyright (C) 2010-2011 Christian Pointner <equinox@helsinki.at> -## +## +## Copyright (C) 2010-2014 Christian Pointner <equinox@helsinki.at> +## ## This file is part of rharchive. ## ## rharchive is free software: you can redistribute it and/or modify @@ -24,7 +24,7 @@ VERSION=$(shell cat ../version) -.PHONY: clean +.PHONY: clean all: manpage diff --git a/doc/rharchive.8 b/doc/rharchive.8 index 74cc0ea..e54fc51 100644 --- a/doc/rharchive.8 +++ b/doc/rharchive.8 @@ -1,13 +1,22 @@ '\" t .\" Title: rharchive .\" Author: [see the "AUTHORS" section] -.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/> -.\" Date: 04/28/2011 -.\" Manual: rharchive user manual -.\" Source: rharchive trunk +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 12/27/2013 +.\" Manual: \ \& +.\" Source: \ \& .\" Language: English .\" -.TH "RHARCHIVE" "8" "04/28/2011" "rharchive trunk" "rharchive user manual" +.TH "RHARCHIVE" "8" "12/27/2013" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -171,4 +180,4 @@ Christian Pointner <equinox@helsinki\&.at> 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\&. +Copyright (C) 2010\-2014 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 index 60dc83a..ed63374 100644 --- a/doc/rharchive.8.txt +++ b/doc/rharchive.8.txt @@ -47,7 +47,7 @@ The following options can be passed to the *rharchive* daemon: 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>*:: @@ -55,20 +55,20 @@ The following options can be passed to the *rharchive* daemon: The default is to not drop privileges. *-C, --chroot <path>*:: - Instruct *rharchive* to run in a chroot jail. The default is + 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 + 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 + 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 + 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: @@ -78,13 +78,13 @@ The following options can be passed to the *rharchive* daemon: *stderr*;; log to standard error, parameters <level> *-U, --debug*:: - This option instructs *rharchive* to run in debug mode. It implicits *-D* + 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. *-s, --source <description>*:: - a gstreamer-style pipeline description which is used as a source. + a gstreamer-style pipeline description which is used as a source. i.e.: *'pulsesrc ! audioconvert ! vorbisenc ! oggmux'* this pipeline gets directly connected to the writer element (multifdsink). @@ -105,7 +105,7 @@ The following options can be passed to the *rharchive* daemon: *-o, --offset <value>*:: the offset in ms between the real boundary and the time the file actually starts/stops. A positive number means that the file starts too late. The default is no offset (0ms). - + *-x, --post-process <script>*:: this script gets called for every finished file. By default no script gets called. @@ -136,7 +136,7 @@ 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 +Copyright \(C) 2010-2014 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. |