File: CONFIG

package info (click to toggle)
irmp3 0.4.3pre6-2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 584 kB
  • ctags: 374
  • sloc: ansic: 3,955; makefile: 212; pascal: 39
file content (178 lines) | stat: -rw-r--r-- 5,561 bytes parent folder | download
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

IRMP3 does read all its configuration from a config-file which
is a simple text file. By default it reads /etc/irmp3.conf, but
you can specify any other config-file with the -c command line
option. See the examples subdir for config-file examples.

The config-file is a simple text file. Each line may have a
configuration directive or a comment. Empty lines or lines
beginning with a '#' are treated as comments and thus are
ignored.

Each other line is parsed as a <key>: <value> pair, where
<key> represents a configuration key and <value> its assigned
value. Any unknown or unsupported keys (e.g. because you don't
have included the assigned module) are ignored silently.

MPG123 CONFIGURATION KEYS
-------------------------

mpg123_param: <parameter>
	Additional mpg123 parameter like buffer, proxies
	(for streaming) or priority changes. See
	mpg123 --help for a list of supported parameters.
	Default: none
abort_on_unknown_mpg123_status: <yes|no>
	should IRMP3 halt playback when mpg123 reports
	unknown status?

MIXER CONFIGURATION KEYS
------------------------

mixer_volume: <value>
mixer_balance: <value>
mixer_bass: <value>
mixer_treble: <value>
	These keys set the initial mixer values when
	starting IRMP3. Only absolute values are
	allowed (see COMMANDS). If you don't want to
	set startup values, just comment them out.
mixer_vol_channel: <name>
	The name of the mixer channel which IRMP3 should
	use for manipulating volume.  (usually "vol")


LIRC CONFIGURATION KEYS
-----------------------

Note: These keys are only applicable if you compiled with
MOD_LIRC support.

lirc_config: <lircrc>
	Path and filename to your LIRC configuration file. You
	may use any valid IRMP3 command at the "config =" line
	in your lircrc. See the list of IRMP3 commands and the
	LIRC documentation for more information.
	Default: ~/.lircrc


LCDPROC CONFIGURATION KEYS
--------------------------

Note: These keys are only applicable if you compiled with
MOD_LCDPROC support.

lcdproc_host: <hostname/IP>
lcdproc_port: <port>
	Set host and port for connection with LCDproc server.
	Default: localhost, 13666
lcdproc_key_<key>: <command>
	Execute <command> (see COMMANDS) if <key> on external
	keypad is pressed.
lcdproc_timestr: <fmt>
lcdproc_datestr: <fmt>
	strftime() formats for time and date


ENV CONFIGURATION KEYS
----------------------

Note:  These keys are only applicable if you compiled with
MOD_ENV support.

environment_<name>: <irmp3 command>;<irmp3 command>;<irmp3 command>
	keys like this will execute a group of commands when irmp3
	receives the command "environment <name>"

ALARM CONFIGURATION KEYS
------------------------

Note:  These keys are only applicable if you compiled with
MOD_ALARM and MOD_ENV support.

environment_alarm1: <irmp3 command>;<irmp3 command>;<irmp3 command>
	Group of commands that will be executed when irmp3 
	receives a SIG_USR1 signal.
environment_alarm2: <irmp3 command>;<irmp3 command>;<irmp3 command>
	Group of commands that will be executed when irmp3 
	receives a SIG_USR2 signal.

BEEP CONFIGURATION KEYS
-----------------------

Note:  These keys are only applicable if you compiled with
MOD_BEEP support.

beep_on: <soundfile>
beep_off: <soundfile>
	The files which irmp3 will play when turning a feature
	on or off.  irmp3 doesn't care about the file format,
	because it execs a different application to play
	the sounds.  (see beep_play below)
beep_device: <dsp device>
	The sound device through which to play the beep sounds.
	This cannot be the same device which mpg123 uses.  I 
	use /dev/dsp1.
	Note that most sound drivers provide multiple dsp devices.
beep_play: <play-command>
	The unix command to play a sound on your system.  You may
	use %d and %f in this command string to substitute for
	beep_device and the beep soundfile.
	Example- beep_play: /usr/bin/sox %f -t ossdsp -w -s %d


NETWORK CONFIGURATION KEYS
--------------------------

Note: These keys are only applicable if you compiled with
MOD_NETCTL support.

network_port: <port>
	The network port number which IRMP3 will listen to for
	incoming netctl connections.

AUTOSHUTDOWN CONFIGURATION KEYS
-------------------------------

Note: These keys are only applicable if you compiled with
MOD_AUTOSHUTDOWN support.

autoshutdown_time: <time>
	The time is an integer which represents the minutes of
	inactivity which must occur before IRMP3 will auto-
	matically terminate.

IDLE CONFIGURATION KEYS
-------------------------------
idle_interval: <time>
	How long (in seconds) between idle checks/announcements

CD CONFIGURATION KEYS
-------------------------------
cd_device: <device>	
	CDROM device. Default: /dev/cdrom	
cd_mountpoint: <mountpoint>
    CD mountpoint. Default: /cdrom
cd_scandir_pattern: <pattern>
    Pattern for creating playlist for data CD.
	For details see command: playlist loaddir
	Default:
cd_externmount: yes | no
    If set to yes, external command mount is called for mounting data cd
	There should be a line in /etc/fstab for cd_mountpoint.
	If set to no, then to external command for mounting is called, 
	irmp3 mounts cd itself.
	It must have root privileges

LOG CONFIGURATION KEYS
-------------------------------
log_timestr: <fmt>
	strftime() format for reporting the date/time in the logfile.

PLAYLIST CONFIGURATION KEYS
-------------------------------
playlist_repeat:  [all|current|off]
	sets the default playlist repeat mode
playlist_skip_back_timeout: <time>
	time is an integer which represents the number of seconds after which
	a "playlist jump -1" command will restart the current song.