mpdscribble(1)

1mpdscribble(1)                   User Manuals                   mpdscribble(1)
2
3
4

NAME

6       mpdscribble - A Music Player Daemon (MPD) client which submits informa‐
7       tion about tracks being played to a scrobbler (e.g. last.fm).
8

SYNOPSIS

10       mpdscribble [options]
11

DESCRIPTION

13       mpdscribble is a client for MPD, the Music Player  Daemon.  mpdscribble
14       connects  to  an MPD running on the local network and works in parallel
15       with other MPD clients on the network.
16
17       By default it will get the hostname and port for mpd from the  MPD_HOST
18       and MPD_PORT environment variables. mpdscribble will use localhost:6600
19       if those are not set. The hostname and port can also  be  specified  in
20       the configuration file or on the command line.
21
22       $ mpdscribble --host myhost --port=12345
23
24       Values  specified on the command line override values from the configu‐
25       ration file or environment variables.
26
27       If you want to use mpdscribble with a password-protected MPD,  set  the
28       environment  variable MPD_HOST to password@host, or specify the host in
29       the configuration file similarly.
30
31       On submission failure, mpdscribble waits for some  time  then  retries.
32       Sending  a USR1 signal to a running mpdscribble process makes it submit
33       immediately.
34
35

OPTIONS

37       --help Display help and exit.
38
39       --version
40              Display version information and exit.
41
42       --no-daemon
43              Don't daemonize mpdscribble, run it in foreground.
44
45       --pidfile FILE
46              Write the process id to this file.
47
48       --daemon-user USERNAME
49              Change to this system user after daemonization.
50
51       --log FILE
52              Specify log file.  The special value "syslog" makes  mpdscribble
53              use  the  local syslog daemon (which is the default).  "-" means
54              log to stderr.
55
56       --conf FILE
57              Read configuration options from file.  /etc/mpdscribble.conf  is
58              used by default (if --sysconfdir=/etc).
59
60       --host [PASSWORD@]HOSTNAME
61              Specify  host protected by password.  To connect via Unix Domain
62              Socket, specify an absolute path here.
63
64       --port PORT
65              Specify which port the MPD listens on.
66
67       --proxy URL
68              HTTP proxy URL.
69
70       --verbose LEVEL
71              Specify how verbosely mpdscribble should log.   Possible  values
72              are 0 to 3, defaulting to 1.
73

CONFIGURATION

75       mpdscribble  looks  for  its configuration file in the following order:
76       $XDG_CONFIG_HOME/mpdscribble/mpdscribble.conf,      ~/.config/mpdscrib‐
77       ble/mpdscribble.conf,  ~/.mpdscribble/mpdscribble.conf,  /etc/mpdscrib‐
78       ble.conf (if --sysconfdir=/etc) but this can be overridden by  specify‐
79       ing  an  alternate  configuration  file  using  the command line option
80       --conf.
81
82       Supported configuration options:
83
84       pidfile = FILE
85              Write the process id to this file.
86
87       log = FILE
88              The file to which mpdscribble should output  debugging  informa‐
89              tion.   The special value "syslog" makes mpdscribble use the lo‐
90              cal syslog daemon (which is the  default).   "-"  means  log  to
91              stderr.
92
93       host = [PASSWORD@]HOSTNAME
94              The host running MPD, possibly protected by a password.  To con‐
95              nect via Unix Domain Socket, specify an absolute path here.
96
97       port = PORT
98              The port that the MPD listens on and mpdscribble should  try  to
99              connect to.
100
101       proxy = URL
102              HTTP proxy URL.
103
104       verbose = 0, 1, 2, 3
105              How verbose mpdscribble's logging should be.  Default is 1.  "0"
106              means log only critical errors (e.g. "out of memory"); "1"  also
107              logs  non-critical  errors (e.g. "server unreachable"); "2" logs
108              informational messages (e.g. "new song"); "3" prints  a  lot  of
109              debugging messages.
110

SCROBBLERS

112       These  options are followed by at least one scrobbler section (choose a
113       unique section name like "libre.fm" which only appears in the log file;
114       the name "mpdscribble" is reserved).
115
116       file = PATH
117              Log  to a file instead of submitting the songs to an AudioScrob‐
118              bler server.
119
120       url = URL
121              The handshake URL of the scrobbler.  Example:  "https://post.au‐
122              dioscrobbler.com/", "http://turtle.libre.fm/"
123
124       username = USERNAME
125              Your audioscrobbler username.
126
127       password = MD5SUM
128              Your Last.fm password, either cleartext or its MD5 sum.
129
130       journal = FILE
131              The  file where mpdscribble should store its journal in case you
132              do not have a connection to the scrobbler.  This option used  to
133              be called "cache".  It is optional.
134

FILES

136       /etc/mpdscribble.conf
137              The system wide configuration file.
138
139       ~/.config/mpdscribble/mpdscribble.conf
140              Per user configuration file.
141
142       /var/cache/mpdscribble/mpdscribble.cache
143              The system wide Last.fm cache file.
144
145       ~/.cache/mpdscribble/mpdscribble.cache
146              Per user Last.fm cache file.
147
148       /var/log/mpdscribble/mpdscribble.log
149              The system wide log file.
150
151

BUGS

153       File permissions on cache/log file may be insecure by default.
154
155       Please   report  new  bugs  to  the  MPD  bug  tracker:  http://www.mu‐
156       sicpd.org/mantis
157
158