.TH AUDTOOL "1" "April 2009" "Version 3.2.4" .SH NAME .B audtool - a small tool to modify behavior of a running audacious2 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. .TP .I --current-song-tuple-data Returns the value of a tuple field for the current song. .TP .I --current-song-info Returns current song bitrate, frequency and 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 Adds a URI to the playlist. .TP .I --playlist-insurl Inserts a URL at specified position in the playlist. .TP .I --playlist-delete Deletes the song at from the playlist. .TP .I --playlist-length Returns the total length of the playlist. .TP .I --playlist-song Returns the title of the song at in the playlist. .TP .I --playlist-song-filename Returns the filename of the song at in the playlist. .TP .I --playlist-song-length Returns the length of the song at in the playlist. .TP .I --playlist-song-length-seconds Returns the length of the song at in the playlist in seconds. .TP .I --playlist-song-length-frames Returns the length of the song at 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 Jumps to 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. .TP .I --playlist-stop-after-status Queries whether the "stop after current song" option is set. .TP .I --playlist-stop-after-toggle Toggles the "stop after current song" option. .TP .I --playlist-tuple-data Returns the value of a tuple field for a song in the playlist. .PP .B Playqueue manipulation: .TP .I --playqueue-add Adds the song at in the playlist to the playqueue. .TP .I --playqueue-remove Removes the song at in the playlist from the playqueue. .TP .I --playqueue-is-queued Returns OK if the song at in the playlist is queued. .TP .I --playqueue-get-position Returns the playqueue position of the song at in the playlist. .TP .I --playqueue-get-queue-position Returns the playqueue position of a song in the given in the playlist. .TP .I --playqueue-get-list-position Returns the playlist position of a song in the given position 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 seconds. .TP .I --playback-seek-relative Performs a seek relative to the current position in seconds. .PP .B "Volume control:" .TP .I --get-volume Returns the current volume level in percent. .TP .I --set-volume Sets the current volume level in percent. .PP .B "Equalizer manipulation:" .TP .I --equalizer-activate Activates/deactivates the equalizer. .TP .I --equalizer-get Gets the equalizer settings. .TP .I --equalizer-set Sets the equalizer settings. .TP .I --equalizer-get-preamp Gets the equalizer pre-amplification. .TP .I --equalizer-set-preamp Gets the equalizer pre-amplification. .TP .I --equalizer-get-band Gets the equalizer value in specified band. .TP .I --equalizer-set-band Sets the equalizer value in specified band. .PP .B "Miscellaneous:" .TP .I --mainwin-show Shows/hides the main window. .TP .I --filebrowser-show Shows/hides the filebrowser. .TP .I --jumptofile-show Shows/hides the jump to file window. .TP .I --preferences-show Shows/hides the preferences window. .TP .I --about-show Shows/hides the about window. .TP .I --always-on-top Enables/disables always on top setting. .TP .I --version Displays Audacious version. .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 on www.redmine.audacious-media-player.org in the Audacious issue tracker. .SH AUTHORS .B audtool was written by George Averill and William Pitcock . .PP This manual page was written by Adam Cecile and Kiyoshi Aman . Some additional tweaks were done by William Pitcock and Tony Vroon . .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 source code 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" .BR audacious2 (1) .SH WEBSITE .I http://audacious-media-player.org