summaryrefslogtreecommitdiff
path: root/src/pianobar.1
blob: a27b606ab2c2ade7b8e9411b6babab9601222681 (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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
.TH pianobar 1

.SH NAME
pianobar \- console pandora.com music player

.SH SYNOPSIS
.B pianobar

.SH DESCRIPTION
.B pianobar
is a lightweight console music player for the personalized online radio
pandora.com.

.SH FILES
.I $XDG_CONFIG_HOME/pianobar/config
or
.I ~/.config/pianobar/config
.RS
Per-user configuration file. See
.B CONFIGURATION.
.RE

.I /etc/libao.conf
or
.I ~/.libao
.RS
Global/per-user audio output configuration. See libao documentation at
http://xiph.org/ao/doc/config.html
.RE

.SH CONFIGURATION
The configuration file consists of simple
.B key = value
lines. Each terminated with a newline (\\n) character. Keys and values are both
case sensitive. act_*-keys control 
.B pianobar's
key-bindings.

.TP
.B act_help = ?
Show keybindings.

.TP
.B act_songlove = +
Love currently played song.

.TP
.B act_songban = -
Ban current track. It will not be played again and can only removed using the
pandora.com web interface.

.TP
.B act_stationaddmusic = a
Add more music to current station. You will be asked for a search string. Just
follow the instructions. If you're clueless try '?' (without quotes).

.TP
.B act_bookmark = b
Bookmark current song or artist.

.TP
.B act_stationcreate = c
Create new station. You have to enter a search string and select the song or
artist of your choice.

.TP
.B act_stationdelete = d
Delete current station.

.TP
.B act_songexplain = e
Explain why this song is played.

.TP
.B act_stationaddbygenre = g
Add genre station provided by pandora.

.TP
.B act_history = h
Show history.

.TP
.B act_songinfo = i
Print information about currently played song/station.

.TP
.B act_addshared = j
Add shared station by id. id is a very long integer without "sh" at the
beginning.

.TP
.B act_songmove = m
Move current song to another station

.TP
.B act_songnext = n
Skip current song.

.TP
.B act_songpause = p
Pause/Continue

.TP
.B act_quit = q
Quit
.B pianobar.

.TP
.B act_stationrename = r
Rename currently played station.

.TP
.B act_stationchange = s
Select another station.

.TP
.B act_songtired = t
Ban song for one month.

.TP
.B act_upcoming = u
Show next songs in playlist.

.TP
.B act_stationselectquickmix = x
Select quickmix stations.

.TP
.B audio_format = {aacplus,mp3,mp3-hifi}
Select audio format. aacplus is default if both libraries (faad, mad) are
available. mp3-hifi is available for Pandora One customers only.

.TP
.B autostart_station = stationid
Play this station when starting up. You can get the
.B stationid
by pressing
.B i
or the key you defined in
.B act_songinfo.

.TP
.B ban_icon = </3
Icon for banned songs.

.TP
.B control_proxy = http://host:port/
Non-american users need a proxy to use pandora.com. Only the xmlrpc interface
will use this proxy. The music is streamed directly.

.TP
.B event_command = path
File that is executed when event occurs. See section
.B EVENTCMD

.TP
.B history = 5
Keep a history of the last n songs (5, by default). You can rate these songs.

.TP
.B love_icon = <3
Icon for loved songs.

.TP
.B password = plaintext_password
Your pandora.com password. Plain-text.

.TP
.B proxy = http://host:port/
Use a http proxy. Note that this setting overrides the http_proxy environment
variable.

.TP
.B sort = {name_az, name_za, quickmix_01_name_az, quickmix_01_name_za, quickmix_10_name_az, quickmix_10_name_za}
Sort station list by name or type (is quickmix) and name. name_az for example
sorts by name from a to z, quickmix_01_name_za by type (quickmix at the
bottom) and name from z to a.

.TP
.B user = your@user.name
Your pandora.com username.

.SH REMOTE CONTROL
.B pianobar
can be controlled through a fifo. You have to create it yourself by executing

 mkfifo ~/.config/pianobar/ctl

Adjust the path if you set up a $XDG_CONFIG_HOME. Afterwards you can write
commands directly into the fifo. Example (next song):

 echo -n 'n' > ~/.config/pianobar/ctl

.B n
is the keybinding for "next song". If you customized your keybindings you have to use these characters to control
.B pianobar.
.I This behaviour may change in the future!

Another example:

 while true; do;
    nc -l -p 12345 -s localhost localhost > ~/.config/pianobar/ctl;
    sleep 1;
 done

 echo -ne 'n\\x1a' | nc -q 0 127.0.0.1 12345

.SH EVENTCMD

.B pianobar
can report certain "events" to an external application (see
.B CONFIGURATION
). This application is started with the event name as it's first argument. More
information (artist, title, album, stationName, error code, error description,
song length in milliseconds, rating) is supplied through stdin.

Currently supported events are: artistbookmark, songban, songbookmark,
songexplain, songfinish, songlove, songmove, songshelf, songstart,
stationaddmusic, stationaddshared, stationcreate, stationdelete,
stationfetchplaylist, stationquickmixtoggle, stationrename

An example script can be found in the contrib/ directory of
.B pianobar's
source distribution.

.SH AUTHOR
Lars-Dominik Braun <PromyLOPh@lavabit.com>