~ubuntu-branches/ubuntu/wily/pianobar/wily-proposed

« back to all changes in this revision

Viewing changes to src/pianobar.1

  • Committer: Bazaar Package Importer
  • Author(s): Luke Faraone
  • Date: 2011-02-08 17:23:25 UTC
  • mfrom: (1.3.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20110208172325-0qf3sxpsu37j5ez9
Tags: 2011.01.24-1
* New upstream version. 
* Switch to DEP5 copyright.
* Augment CFLAGS to use the c99 standard.
* Don't install the now-removed AUTHORS file into docs.
* Drop dep on cmake.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH pianobar 1
2
 
 
3
 
.SH NAME
4
 
pianobar \- console pandora.com music player
5
 
 
6
 
.SH SYNOPSIS
7
 
.B pianobar
8
 
 
9
 
.SH DESCRIPTION
10
 
.B pianobar
11
 
is a lightweight console music player for the personalized online radio
12
 
pandora.com.
13
 
 
14
 
.SH FILES
15
 
.I $XDG_CONFIG_HOME/pianobar/config
16
 
or
17
 
.I ~/.config/pianobar/config
18
 
.RS
19
 
Per-user configuration file. See
20
 
.B CONFIGURATION.
21
 
.RE
22
 
 
23
 
.I /etc/libao.conf
24
 
or
25
 
.I ~/.libao
26
 
.RS
27
 
Global/per-user audio output configuration. See libao documentation at
28
 
http://xiph.org/ao/doc/config.html
29
 
.RE
30
 
 
31
 
.SH CONFIGURATION
32
 
The configuration file consists of simple
33
 
.B key = value
34
 
lines. Each terminated with a newline (\\n) character. Keys and values are both
35
 
case sensitive. act_*-keys control 
36
 
.B pianobar's
37
 
key-bindings.
38
 
 
39
 
.TP
40
 
.B act_help = ?
41
 
Show keybindings.
42
 
 
43
 
.TP
44
 
.B act_songlove = +
45
 
Love currently played song.
46
 
 
47
 
.TP
48
 
.B act_songban = -
49
 
Ban current track. It will not be played again and can only removed using the
50
 
pandora.com web interface.
51
 
 
52
 
.TP
53
 
.B act_stationaddmusic = a
54
 
Add more music to current station. You will be asked for a search string. Just
55
 
follow the instructions. If you're clueless try '?' (without quotes).
56
 
 
57
 
.TP
58
 
.B act_bookmark = b
59
 
Bookmark current song or artist.
60
 
 
61
 
.TP
62
 
.B act_stationcreate = c
63
 
Create new station. You have to enter a search string and select the song or
64
 
artist of your choice.
65
 
 
66
 
.TP
67
 
.B act_stationdelete = d
68
 
Delete current station.
69
 
 
70
 
.TP
71
 
.B act_songexplain = e
72
 
Explain why this song is played.
73
 
 
74
 
.TP
75
 
.B act_stationaddbygenre = g
76
 
Add genre station provided by pandora.
77
 
 
78
 
.TP
79
 
.B act_history = h
80
 
Show history.
81
 
 
82
 
.TP
83
 
.B act_songinfo = i
84
 
Print information about currently played song/station.
85
 
 
86
 
.TP
87
 
.B act_addshared = j
88
 
Add shared station by id. id is a very long integer without "sh" at the
89
 
beginning.
90
 
 
91
 
.TP
92
 
.B act_songmove = m
93
 
Move current song to another station
94
 
 
95
 
.TP
96
 
.B act_songnext = n
97
 
Skip current song.
98
 
 
99
 
.TP
100
 
.B act_songpause = p
101
 
Pause/Continue
102
 
 
103
 
.TP
104
 
.B act_quit = q
105
 
Quit
106
 
.B pianobar.
107
 
 
108
 
.TP
109
 
.B act_stationrename = r
110
 
Rename currently played station.
111
 
 
112
 
.TP
113
 
.B act_stationchange = s
114
 
Select another station.
115
 
 
116
 
.TP
117
 
.B act_songtired = t
118
 
Ban song for one month.
119
 
 
120
 
.TP
121
 
.B act_upcoming = u
122
 
Show next songs in playlist.
123
 
 
124
 
.TP
125
 
.B act_stationselectquickmix = x
126
 
Select quickmix stations.
127
 
 
128
 
.TP
129
 
.B audio_format = {aacplus,mp3,mp3-hifi}
130
 
Select audio format. aacplus is default if both libraries (faad, mad) are
131
 
available. mp3-hifi is available for Pandora One customers only.
132
 
 
133
 
.TP
134
 
.B autostart_station = stationid
135
 
Play this station when starting up. You can get the
136
 
.B stationid
137
 
by pressing
138
 
.B i
139
 
or the key you defined in
140
 
.B act_songinfo.
141
 
 
142
 
.TP
143
 
.B control_proxy = http://host:port/
144
 
Non-american users need a proxy to use pandora.com. Only the xmlrpc interface
145
 
will use this proxy. The music is streamed directly.
146
 
 
147
 
.TP
148
 
.B event_command = path
149
 
File that is executed when event occurs. See section
150
 
.B EVENTCMD
151
 
 
152
 
.TP
153
 
.B history = 5
154
 
Keep a history of the last n songs (5, by default). You can rate these songs.
155
 
 
156
 
.TP
157
 
.B password = plaintext_password
158
 
Your pandora.com password. Plain-text.
159
 
 
160
 
.TP
161
 
.B proxy = http://host:port/
162
 
Use a http proxy. Note that this setting overrides the http_proxy environment
163
 
variable.
164
 
 
165
 
.TP
166
 
.B sort = {name_az, name_za, quickmix_01_name_az, quickmix_01_name_za, quickmix_10_name_az, quickmix_10_name_za}
167
 
Sort station list by name or type (is quickmix) and name. name_az for example
168
 
sorts by name from a to z, quickmix_01_name_za by type (quickmix at the
169
 
bottom) and name from z to a.
170
 
 
171
 
.TP
172
 
.B user = your@user.name
173
 
Your pandora.com username.
174
 
 
175
 
.SH REMOTE CONTROL
176
 
.B pianobar
177
 
can be controlled through a fifo. You have to create it yourself by executing
178
 
 
179
 
 mkfifo ~/.config/pianobar/ctl
180
 
 
181
 
Adjust the path if you set up a $XDG_CONFIG_HOME. Afterwards you can write
182
 
commands directly into the fifo. Example (next song):
183
 
 
184
 
 echo -n 'n' > ~/.config/pianobar/ctl
185
 
 
186
 
.B n
187
 
is the keybinding for "next song". If you customized your keybindings you have to use these characters to control
188
 
.B pianobar.
189
 
.I This behaviour may change in the future!
190
 
 
191
 
Another example:
192
 
 
193
 
 while true; do;
194
 
    nc -l -p 12345 -s localhost localhost > ~/.config/pianobar/ctl;
195
 
    sleep 1;
196
 
 done
197
 
 
198
 
 echo -ne 'n\\x1a' | nc -q 0 127.0.0.1 12345
199
 
 
200
 
.SH EVENTCMD
201
 
 
202
 
.B pianobar
203
 
can report certain "events" to an external application (see
204
 
.B CONFIGURATION
205
 
). This application is started with the event name as it's first argument. More
206
 
information (artist, title, album, stationName, error code, error description,
207
 
song length in milliseconds, rating) is supplied through stdin.
208
 
 
209
 
Currently supported events are: artistbookmark, songban, songbookmark,
210
 
songexplain, songfinish, songlove, songmove, songshelf, songstart,
211
 
stationaddmusic, stationaddshared, stationcreate, stationdelete,
212
 
stationfetchplaylist, stationquickmixtoggle, stationrename
213
 
 
214
 
An example script can be found in the contrib/ directory of
215
 
.B pianobar's
216
 
source distribution.
217
 
 
218
 
.SH AUTHOR
219
 
Lars-Dominik Braun <PromyLOPh@lavabit.com>