summaryrefslogtreecommitdiff
path: root/doc/rharchive.8
blob: 10f4681dba716439c17a71776f47c21c298dc806 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
'\" t
.\"     Title: rharchive
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 05/18/2015
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "RHARCHIVE" "8" "05/18/2015" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * 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
.\" -----------------------------------------------------------------
.\" 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 ]
  [ \fB\-s|\-\-source\fR <description> ]
  [ \fB\-d|\-\-output\-dir\fR <path> ]
  [ \fB\-f|\-\-name\-format\fR <format> ]
  [ \fB\-m|\-\-mode\fR <value> ]
  [ \fB\-n|\-\-nocache\fR ]
  [ \fB\-i|\-\-interval\fR <value> ]
  [ \fB\-o|\-\-offset\fR <value> ]
  [ \fB\-x|\-\-post\-process\fR <script> ]
.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
.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\-n, \-\-nocache\fR
.RS 4
When this option is given
\fBrharchive\fR
will use the O_DIRECT flag when opening files\&.
.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>
.SH "RESOURCES"
.sp
Radio Helsinki Website: http://www\&.helsinki\&.at
.SH "COPYING"
.sp
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\&.