updated manpage

2 files changed, 87 insertions, 2 deletions

diff --git a/doc/rharchive.8 b/doc/rharchive.8
index 845f17a..74cc0ea 100644
--- a/doc/rharchive.8
+++ b/doc/rharchive.8
@@ -2,12 +2,12 @@
 .\"     Title: rharchive
 .\"    Author: [see the "AUTHORS" section]
 .\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
-.\"      Date: 02/15/2011
+.\"      Date: 04/28/2011
 .\"    Manual: rharchive user manual
 .\"    Source: rharchive trunk
 .\"  Language: English
 .\"
-.TH "RHARCHIVE" "8" "02/15/2011" "rharchive trunk" "rharchive user manual"
+.TH "RHARCHIVE" "8" "04/28/2011" "rharchive trunk" "rharchive user manual"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -32,6 +32,13 @@ rharchive \- Radio Helsinki Archive Daemon
   [ \fB\-P|\-\-write\-pid\fR <filename> ]
   [ \fB\-L|\-\-log\fR <target>:<level>[,<param1>[,<param2>[\&.\&.]]] ]
   [ \fB\-U|\-\-debug\fR ]
+  [ \fB\-s|\-\-source\fR <description> ]
+  [ \fB\-d|\-\-output\-dir\fR <path> ]
+  [ \fB\-f|\-\-name\-format\fR <format> ]
+  [ \fB\-m|\-\-mode\fR <value> ]
+  [ \fB\-i|\-\-interval\fR <value> ]
+  [ \fB\-o|\-\-offset\fR <value> ]
+  [ \fB\-x|\-\-post\-process\fR <script> ]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -112,9 +119,50 @@ to run in debug mode\&. It implicits
 \fBstdout:5\fR
 (logging with maximum level)\&. In future releases there might be additional output when this option is supplied\&.
 .RE
+.PP
+\fB\-s, \-\-source <description>\fR
+.RS 4
+a gstreamer\-style pipeline description which is used as a source\&. i\&.e\&.:
+\fB\fIpulsesrc ! audioconvert ! vorbisenc ! oggmux\fR\fR
+this pipeline gets directly connected to the writer element (multifdsink)\&.
+.RE
+.PP
+\fB\-d, \-\-output\-dir <path>\fR
+.RS 4
+the path to the output files\&.
+.RE
+.PP
+\fB\-f, \-\-name\-format <format>\fR
+.RS 4
+a format string for the filenames\&. The actual name is generated using strftime\&. Please consult the manpage of strftime for details\&. The default format is:
+\fB\fI%Y\-%m\-%d\-%H00\&.ogg\fR\fR\&.
+.RE
+.PP
+\fB\-m, \-\-mode <value>\fR
+.RS 4
+the octet string for the file permission bits\&.
+.RE
+.PP
+\fB\-i, \-\-interval <value>\fR
+.RS 4
+the interval in ms between the boundary checks\&. The default is to check every 50ms\&.
+.RE
+.PP
+\fB\-o, \-\-offset <value>\fR
+.RS 4
+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)\&.
+.RE
+.PP
+\fB\-x, \-\-post\-process <script>\fR
+.RS 4
+this script gets called for every finished file\&. By default no script gets called\&.
+.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 "SEE ALSO"
+.sp
+\fBstrftime\fR(3), \fBgst\-launch\fR(1)
 .SH "AUTHORS"
 .sp
 Christian Pointner <equinox@helsinki\&.at>
diff --git a/doc/rharchive.8.txt b/doc/rharchive.8.txt
index 9da537c..60dc83a 100644
--- a/doc/rharchive.8.txt
+++ b/doc/rharchive.8.txt
@@ -20,6 +20,13 @@ rharchive
   [ -P|--write-pid <filename> ]
   [ -L|--log <target>:<level>[,<param1>[,<param2>[..]]] ]
   [ -U|--debug ]
+  [ -s|--source <description> ]
+  [ -d|--output-dir <path> ]
+  [ -f|--name-format <format> ]
+  [ -m|--mode <value> ]
+  [ -i|--interval <value> ]
+  [ -o|--offset <value> ]
+  [ -x|--post-process <script> ]
 ....
 
 
@@ -76,6 +83,31 @@ The following options can be passed to the *rharchive* daemon:
    *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. 
+   i.e.: *'pulsesrc ! audioconvert ! vorbisenc ! oggmux'*
+   this pipeline gets directly connected to the writer element (multifdsink).
+
+*-d, --output-dir <path>*::
+   the path to the output files.
+
+*-f, --name-format <format>*::
+   a format string for the filenames. The actual name is generated using strftime.
+   Please consult the manpage of strftime for details. The default format is:
+   *'%Y-%m-%d-%H00.ogg'*.
+
+*-m, --mode <value>*::
+   the octet string for the file permission bits.
+
+*-i, --interval <value>*::
+   the interval in ms between the boundary checks. The default is to check every 50ms.
+
+*-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.
 
 
 BUGS
@@ -84,6 +116,11 @@ 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.
 
 
+SEE ALSO
+--------
+
+*strftime*(3), *gst-launch*(1)
+
 AUTHORS
 -------