File: mpdscribble.1

package info (click to toggle)
mpdscribble 0.19-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 832 kB
  • ctags: 310
  • sloc: sh: 4,175; ansic: 2,351; makefile: 81
file content (187 lines) | stat: -rw-r--r-- 5,003 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
179
180
181
182
183
184
185
186
187
.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
.TH mpdscribble 1 "JANUARY 2009" Linux "User Manuals"
.SH NAME
mpdscribble - A Music Player Daemon (MPD) client which submits
information about tracks being played to a scrobbler (e.g. last.fm).
.SH SYNOPSIS
.B mpdscribble [options] 
.SH DESCRIPTION
.B mpdscribble
is a client for MPD, the Music Player Daemon. mpdscribble connects to
an MPD running on the local network and works in parallel with other
MPD clients on the network.

By default it will get the hostname and port for mpd from the MPD_HOST 
and MPD_PORT environment variables. mpdscribble will use localhost:6600 
if those are not set. The hostname and port can also be specified in the
configuration file or on the command line. 

$ mpdscribble \-\-host myhost \-\-port=12345

Values specified on the command line override values from the configuration 
file or environment variables.

If you want to use mpdscribble with a password-protected MPD, set the 
environment variable MPD_HOST to password@host, or specify the host in the
configuration file similarly.

.SH "OPTIONS"
.TP
.B \-\-help
Display help and exit.
.TP
.B \-\-version
Display version information and exit.
.TP
.B \-\-no-daemon
Don't daemonize mpdscribble, run it in foreground.
.TP
.B \-\-pidfile FILE
Write the process id to this file.
.TP
.B \-\-daemon-user USERNAME
Change to this system user after daemonization.
.TP
.B \-\-log FILE
Specify log file.  The special value "syslog" makes mpdscribble use
the local syslog daemon (which is the default).  "-" means log to
stderr.
.TP
.B \-\-conf FILE
Read configuration options from file. /etc/mpdscribble.conf
is used by default (if \-\-sysconfdir=/etc).
.TP
.B \-\-host [PASSWORD@]HOSTNAME
Specify host protected by password. 
To connect via Unix Domain Socket, specify an absolute path here.
.TP
.B \-\-port PORT
Specify which port the MPD listens on.
.TP
.B \-\-proxy URL
HTTP proxy URL.
.TP
.B \-\-verbose LEVEL
Specify how verbosely mpdscribble should log.  Possible values are 0
to 3, defaulting to 1.
.SH CONFIGURATION
mpdscribble looks for its configuration file first at 
~/.mpdscribble/mpdscribble.conf and then at /etc/mpdscribble.conf
(if \-\-sysconfdir=/etc)
but this can be overridden by specifying an alternate configuration
file using the command line option
\-\-conf.

Supported configuration options:
.TP
.B pidfile = FILE
Write the process id to this file.
.TP
.B log = FILE
The file to which mpdscribble should output debugging information.
The special value "syslog" makes mpdscribble use the local syslog
daemon (which is the default).  "-" means log to stderr.
.TP
.B host = [PASSWORD@]HOSTNAME
The host running MPD, possibly protected by a password.
To connect via Unix Domain Socket, specify an absolute path here.
.TP
.B port = PORT
The port that the MPD listens on and mpdscribble should try to connect to.
.TP
.B proxy = URL
HTTP proxy URL.
.TP
.B verbose = 0, 1, 2, 3
How verbose mpdscribble's logging should be.  Default is 1.  "0" means
log only critical errors (e.g. "out of memory"); "1" also logs
non-critical errors (e.g. "server unreachable"); "2" logs
informational messages (e.g. "new song"); "3" prints a lot of
debugging messages.
.SH SCROBBLERS
These options are followed by at least one scrobbler section (choose a
unique section name like "libre.fm" which only appears in the log
file; the name "mpdscribble" is reserved).
.TP
.B url = URL
The handshake URL of the scrobbler.  Example:
"http://post.audioscrobbler.com/", "http://turtle.libre.fm/"
.TP
.B username = USERNAME
Your audioscrobbler username.
.TP
.B password = MD5SUM
Your Last.fm password, either cleartext or its MD5 sum.
.TP
.B journal = FILE
The file where mpdscribble should store its journal in case you do not
have a connection to the scrobbler.  This option used to be called
"cache".  It is optional.
.SH FILES
.I /etc/mpdscribble.conf
.RS
The system wide configuration file. 
.RE

.I ~/.mpdscribble/mpdscribble.conf
.RS
Per user configuration file. 
.RE

.I /var/cache/mpdscribble/mpdscribble.cache
.RS
The system wide Last.fm cache file.
.RE

.I ~/.mpdscribble/mpdscribble.cache
.RS
Per user Last.fm cache file.
.RE

.I /var/log/mpdscribble/mpdscribble.log
.RS
The system wide log file. 
.RE

.I ~/.mpdscribble/mpdscribble.log
.RS
Per user log file. 
.RE
.SH BUGS
File permissions on cache/log file may be insecure by default.

Please report new bugs to the MPD bug tracker:
http://www.musicpd.org/mantis

.SH CREDITS
Current maintainer: Max Kellermann <max@duempel.org>
.RS
http://max.kellermann.name/
.RE

Original author: Kuno Woudt <kuno@frob.nl>
.RS
http://www.audioscrobbler.com/user/warp/
.RE

Various patches: Nikki
.RS
http://www.audioscrobbler.com/user/cikkolata/
.RE

The name mpdscribble coined by: honey in #audioscrobbler
.RS
http://www.audioscrobbler.com/user/honeypea/
.RE

Manpage written by: Trevor Caira <trevor.caira@gmail.com>
.RS
http://www.audioscrobbler.com/user/TrevorCaira/
.RE

.SH "SEE ALSO"
.BR mpd (1),
.BR mpc (1)