|
2323
|
1 .TH AUDTOOL 1 "November 2006" "Version @VERSION@"
|
|
|
2 .SH NAME
|
|
|
3 .B audtool
|
|
|
4 - a small tool to modify behavior of a running audacious instance.
|
|
|
5 .SH SYNOPSIS
|
|
|
6 .B audtool
|
|
|
7 [\-\-[[handler [parameters]]
|
|
|
8 .SH DESCRIPTION
|
|
|
9 .B audtool
|
|
|
10 is designed to send commands to a running audacious.
|
|
|
11 .PP
|
|
|
12 It can handle various things like jumping to the next track in playlist
|
|
|
13 or returning the current playing track title, as well as other status
|
|
|
14 information.
|
|
|
15 .SH OPTIONS
|
|
|
16 .B "Now playing information:"
|
|
|
17 .TP
|
|
|
18 .I --current-song
|
|
|
19 Returns current song title.
|
|
|
20 .TP
|
|
|
21 .I --current-song-filename
|
|
|
22 Returns current song filename.
|
|
|
23 .TP
|
|
|
24 .I --current-song-length
|
|
|
25 Returns current song length.
|
|
|
26 .TP
|
|
|
27 .I --current-song-length-seconds
|
|
|
28 Returns current song length in seconds.
|
|
|
29 .TP
|
|
|
30 .I --current-song-length-frames
|
|
|
31 Returns current song length in frames.
|
|
|
32 .TP
|
|
|
33 .I --current-song-output-length
|
|
|
34 Returns current song output length.
|
|
|
35 .TP
|
|
|
36 .I --current-song-output-length-seconds
|
|
|
37 Returns current song output length in seconds.
|
|
|
38 .TP
|
|
|
39 .I --current-song-output-length-frames
|
|
|
40 Returns current song output length in frames.
|
|
|
41 .TP
|
|
|
42 .I --current-song-bitrate
|
|
|
43 Returns current song bitrate in bits per second.
|
|
|
44 .TP
|
|
|
45 .I --current-song-bitrate-kbps
|
|
|
46 Returns current song bitrate in kilobits per second.
|
|
|
47 .TP
|
|
|
48 .I --current-song-frequency
|
|
|
49 Returns current song frequency in hertz.
|
|
|
50 .TP
|
|
|
51 .I --current-song-frequency-khz
|
|
|
52 Returns current song frequency in kilohertz.
|
|
|
53 .TP
|
|
|
54 .I --current-song-channels
|
|
|
55 Returns current song channels.
|
|
|
56 .PP
|
|
|
57 .B "Playlist manipulation:"
|
|
|
58 .TP
|
|
|
59 .I --playlist-advance
|
|
|
60 Go to the next song in the playlist.
|
|
|
61 .TP
|
|
|
62 .I --playlist-reverse
|
|
|
63 Go to the previous song in the playlist.
|
|
|
64 .TP
|
|
|
65 .I --playlist-addurl <uri>
|
|
|
66 Adds a uri to the playlist.
|
|
|
67 .TP
|
|
|
68 .I --playlist-delete <position>
|
|
|
69 Deletes the song at <position> from the playlist.
|
|
|
70 .TP
|
|
|
71 .I --playlist-length
|
|
|
72 Returns the total length of the playlist.
|
|
|
73 .TP
|
|
|
74 .I --playlist-song <position>
|
|
|
75 Returns the title of the song at <position> in the playlist.
|
|
|
76 .TP
|
|
|
77 .I --playlist-song-filename <position>
|
|
|
78 Returns the filename of the song at <position> in the playlist.
|
|
|
79 .TP
|
|
|
80 .I --playlist-song-length <position>
|
|
|
81 Returns the length of the song at <position> in the playlist.
|
|
|
82 .TP
|
|
|
83 .I --playlist-song-length-seconds <position>
|
|
|
84 Returns the length of the song at <position> in the playlist in seconds.
|
|
|
85 .TP
|
|
|
86 .I --playlist-song-length-frames <position>
|
|
|
87 Returns the length of the song at <position> in the playlist in frames.
|
|
|
88 .TP
|
|
|
89 .I --playlist-display
|
|
|
90 Returns the entire playlist.
|
|
|
91 .TP
|
|
|
92 .I --playlist-position
|
|
|
93 Returns the current position in the playlist.
|
|
|
94 .TP
|
|
|
95 .I --playlist-jump <position>
|
|
|
96 Jumps to <position> in the playlist.
|
|
|
97 .TP
|
|
|
98 .I --playlist-clear
|
|
|
99 Clears the playlist.
|
|
|
100 .TP
|
|
|
101 .I --playlist-repeat-status
|
|
|
102 Returns the status of playlist repeat.
|
|
|
103 .TP
|
|
|
104 .I --playlist-repeat-toggle
|
|
|
105 Toggles playlist repeat.
|
|
|
106 .TP
|
|
|
107 .I --playlist-shuffle-status
|
|
|
108 Returns the status of playlist shuffle.
|
|
|
109 .TP
|
|
|
110 .I --playlist-shuffle-toggle
|
|
|
111 Toggles playlist shuffle.
|
|
|
112 .PP
|
|
|
113 .B Playqueue manipulation:
|
|
|
114 .TP
|
|
|
115 .I --playqueue-add <position>
|
|
|
116 Adds the song at <position> in the playlist to the playqueue.
|
|
|
117 .TP
|
|
|
118 .I --playqueue-remove <position>
|
|
|
119 Removes the song at <position> in the playlist from the playqueue.
|
|
|
120 .TP
|
|
|
121 .I --playqueue-is-queued <position>
|
|
|
122 Returns OK if the song at <postion> in the playtlist is queued.
|
|
|
123 .TP
|
|
|
124 .I --playqueue-get-position <position>
|
|
|
125 Returns the playqueue position of the song at <position> in the playlist.
|
|
|
126 .TP
|
|
|
127 .I --playqueue-get-qposition <qposition>
|
|
|
128 Returns the playlist position of the song at <qposition> in the playqueue.
|
|
|
129 .TP
|
|
|
130 .I --playqueue-length
|
|
|
131 Returns the length of the playqueue.
|
|
|
132 .TP
|
|
|
133 .I --playqueue-display
|
|
|
134 Returns a list of currently\-queued songs.
|
|
|
135 .TP
|
|
|
136 .I --playqueue-clear
|
|
|
137 Clears the playqueue.
|
|
|
138 .PP
|
|
|
139 .B "Playback manipulation:"
|
|
|
140 .TP
|
|
|
141 .I --playback-play
|
|
|
142 Starts/unpauses song playback.
|
|
|
143 .TP
|
|
|
144 .I --playback-pause
|
|
|
145 (Un)pauses song playback.
|
|
|
146 .TP
|
|
|
147 .I --playback-playpause
|
|
|
148 Plays/(un)pauses song playback.
|
|
|
149 .TP
|
|
|
150 .I --playback-stop
|
|
|
151 Stops song playback.
|
|
|
152 .TP
|
|
|
153 .I --playback-playing
|
|
|
154 Returns OK if audacious is playing.
|
|
|
155 .TP
|
|
|
156 .I --playback-paused
|
|
|
157 Returns OK if audacious is paused.
|
|
|
158 .TP
|
|
|
159 .I --playback-stopped
|
|
|
160 Returns OK if audacious is stopped.
|
|
|
161 .TP
|
|
|
162 .I --playback-status
|
|
|
163 Returns the playback status.
|
|
|
164 .TP
|
|
|
165 .I --playback-seek
|
|
|
166 Performs an absolute seek in milliseconds.
|
|
|
167 .TP
|
|
|
168 .I --playback-seek-relative
|
|
|
169 Performs a seek relative to the current position in milliseconds.
|
|
|
170 .PP
|
|
|
171 .B "Volume control:"
|
|
|
172 .TP
|
|
|
173 .I --get-volume
|
|
|
174 Returns the current volume level in percent.
|
|
|
175 .TP
|
|
|
176 .I --set-volume <level>
|
|
|
177 Sets the current volume level in percent.
|
|
|
178 .PP
|
|
|
179 .B "Miscellaneous:"
|
|
|
180 .TP
|
|
|
181 .I --preferences
|
|
|
182 Shows/hides the preferences window.
|
|
|
183 .TP
|
|
|
184 .I --jumptofile
|
|
|
185 Shows the jump to file window.
|
|
|
186 .TP
|
|
|
187 .I --shutdown
|
|
|
188 Shuts down audacious.
|
|
|
189 .PP
|
|
|
190 .B "Help system:"
|
|
|
191 .TP
|
|
|
192 .I --list-handlers
|
|
|
193 Shows handlers list.
|
|
|
194 .TP
|
|
|
195 .I --help
|
|
|
196 Shows handlers list.
|
|
|
197 .PP
|
|
|
198 Handlers may be prefixed with `\-\-' (GNU\-style long\-options) or not, your choice.
|
|
|
199 .SH BUGS
|
|
|
200 There are no known bugs in audtool at this time; if you find any please
|
|
|
201 report them to <bugs+audtool@atheme.org>.
|
|
|
202 .SH AUTHORS
|
|
|
203 .B audtool
|
|
|
204 was written by George Averill <nhjm@nhjm.net> and William
|
|
|
205 Pitcock <nenolod@atheme.org>.
|
|
|
206 .PP
|
|
|
207 This manual page was written by Adam Cecile <gandalf@le-vert.net> and
|
|
|
208 Kiyoshi Aman <kiyoshi@atheme.org>. Some additional tweaks were done by
|
|
|
209 William Pitcock <nenolod@atheme.org>.
|
|
|
210 .PP
|
|
|
211 Permission is granted to copy, distribute and/or modify this document
|
|
|
212 under the terms of the GNU General Public License, Version 2 or any
|
|
|
213 later version published by the Free Software Foundation.
|
|
|
214 .PP
|
|
|
215 The complete text of the GNU General Public License is available in the
|
|
|
216 sourcecode of Audacious, and is typically included with binary packages
|
|
|
217 as well.
|
|
|
218 .PP
|
|
|
219 If installed with an operating system, see your Operating System's
|
|
|
220 documentation for licensing details.
|
|
|
221 .SH SEE ALSO
|
|
|
222 .B Homepage:
|
|
|
223 http://audacious-media-player.org/
|
