Mercurial > audlegacy
view man/audtool.1.in @ 4003:400b5e4cfc19
further changes
| author | Tomasz Mon <desowin@gmail.com> |
|---|---|
| date | Sun, 25 Nov 2007 11:16:53 +0100 |
| parents | 582eaba533ac |
| children |
line wrap: on
line source
.TH AUDTOOL 1 "November 2006" "Version @VERSION@" .SH NAME .B audtool - a small tool to modify behavior of a running audacious instance. .SH SYNOPSIS .B audtool [\-\-[[handler [parameters]] [...] .SH DESCRIPTION .B audtool is designed to send commands to a running audacious. .PP It can handle various things like jumping to the next track in playlist or returning the current playing track title, as well as other status information. .SH OPTIONS .B "Now playing information:" .TP .I --current-song Returns current song title. .TP .I --current-song-filename Returns current song filename. .TP .I --current-song-length Returns current song length. .TP .I --current-song-length-seconds Returns current song length in seconds. .TP .I --current-song-length-frames Returns current song length in frames. .TP .I --current-song-output-length Returns current song output length. .TP .I --current-song-output-length-seconds Returns current song output length in seconds. .TP .I --current-song-output-length-frames Returns current song output length in frames. .TP .I --current-song-bitrate Returns current song bitrate in bits per second. .TP .I --current-song-bitrate-kbps Returns current song bitrate in kilobits per second. .TP .I --current-song-frequency Returns current song frequency in hertz. .TP .I --current-song-frequency-khz Returns current song frequency in kilohertz. .TP .I --current-song-channels Returns current song channels. .PP .B "Playlist manipulation:" .TP .I --playlist-advance Go to the next song in the playlist. .TP .I --playlist-reverse Go to the previous song in the playlist. .TP .I --playlist-addurl <uri> Adds a uri to the playlist. .TP .I --playlist-delete <position> Deletes the song at <position> from the playlist. .TP .I --playlist-length Returns the total length of the playlist. .TP .I --playlist-song <position> Returns the title of the song at <position> in the playlist. .TP .I --playlist-song-filename <position> Returns the filename of the song at <position> in the playlist. .TP .I --playlist-song-length <position> Returns the length of the song at <position> in the playlist. .TP .I --playlist-song-length-seconds <position> Returns the length of the song at <position> in the playlist in seconds. .TP .I --playlist-song-length-frames <position> Returns the length of the song at <position> in the playlist in frames. .TP .I --playlist-display Returns the entire playlist. .TP .I --playlist-position Returns the current position in the playlist. .TP .I --playlist-jump <position> Jumps to <position> in the playlist. .TP .I --playlist-clear Clears the playlist. .TP .I --playlist-repeat-status Returns the status of playlist repeat. .TP .I --playlist-repeat-toggle Toggles playlist repeat. .TP .I --playlist-shuffle-status Returns the status of playlist shuffle. .TP .I --playlist-shuffle-toggle Toggles playlist shuffle. .PP .B Playqueue manipulation: .TP .I --playqueue-add <position> Adds the song at <position> in the playlist to the playqueue. .TP .I --playqueue-remove <position> Removes the song at <position> in the playlist from the playqueue. .TP .I --playqueue-is-queued <position> Returns OK if the song at <postion> in the playtlist is queued. .TP .I --playqueue-get-position <position> Returns the playqueue position of the song at <position> in the playlist. .TP .I --playqueue-get-qposition <qposition> Returns the playlist position of the song at <qposition> in the playqueue. .TP .I --playqueue-length Returns the length of the playqueue. .TP .I --playqueue-display Returns a list of currently\-queued songs. .TP .I --playqueue-clear Clears the playqueue. .PP .B "Playback manipulation:" .TP .I --playback-play Starts/unpauses song playback. .TP .I --playback-pause (Un)pauses song playback. .TP .I --playback-playpause Plays/(un)pauses song playback. .TP .I --playback-stop Stops song playback. .TP .I --playback-playing Returns OK if audacious is playing. .TP .I --playback-paused Returns OK if audacious is paused. .TP .I --playback-stopped Returns OK if audacious is stopped. .TP .I --playback-status Returns the playback status. .TP .I --playback-seek Performs an absolute seek in milliseconds. .TP .I --playback-seek-relative Performs a seek relative to the current position in milliseconds. .PP .B "Volume control:" .TP .I --get-volume Returns the current volume level in percent. .TP .I --set-volume <level> Sets the current volume level in percent. .PP .B "Miscellaneous:" .TP .I --preferences Shows/hides the preferences window. .TP .I --jumptofile Shows the jump to file window. .TP .I --shutdown Shuts down audacious. .PP .B "Help system:" .TP .I --list-handlers Shows handlers list. .TP .I --help Shows handlers list. .PP Handlers may be prefixed with `\-\-' (GNU\-style long\-options) or not, your choice. .SH BUGS There are no known bugs in audtool at this time; if you find any please report them to <bugs+audtool@atheme.org>. .SH AUTHORS .B audtool was written by George Averill <nhjm@nhjm.net> and William Pitcock <nenolod@atheme.org>. .PP This manual page was written by Adam Cecile <gandalf@le-vert.net> and Kiyoshi Aman <kiyoshi@atheme.org>. Some additional tweaks were done by William Pitcock <nenolod@atheme.org>. .PP Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation. .PP The complete text of the GNU General Public License is available in the sourcecode of Audacious, and is typically included with binary packages as well. .PP If installed with an operating system, see your Operating System's documentation for licensing details. .SH SEE ALSO .B Homepage: http://audacious-media-player.org/