audtool - a small tool to control Audacious from the
command line.
audtool [instance] command [parameter
...] ...
audtool sends commands to a running instance of
Audacious.
It can send many common commands, such as to skip to the next song
in the playlist, and can also print status information, such as the title of
the current song.
instance may be given as -1, -2, etc. (up to
-9) to specify which instance of Audacious to control when multiple
instances have been started.
- --select-displayed
- Specifies that any subsequent playlist commands should apply to the
playlist currently displayed by Audacious, regardless of which playlist is
playing. This setting takes effect until it is overridden by
--select-playing or Audacious is restarted.
The following commands are also affected:
--current-song
--current-song-filename
--current-song-length[-seconds,-frames]
--current-song-tuple-data
- --select-playing
- Specifies that when playback is active, any subsequent playlist commands
should apply to the playlist currently playing. When playback is stopped,
the behavior is the same as --select-displayed. This setting is the
default.
- --number-of-playlists
- Print the number of open playlists.
- --current-playlist
- Print the number of the current playlist, where "current" is
interpreted according to --select-displayed or
fB--select-playing.
- --play-current-playlist
- Start playback in the current playlist, resuming from the last point
played if possible. When --select-displayed is in effect, this
command can be used to switch playback to the displayed playlist.
- --set-current-playlist
playlist
- Display the given playlist. When --select-playing is in effect and
a different playlist is playing, this command will also switch playback to
the given playlist. The --select-displayed option disables this
behavior.
- --current-playlist-name
- Print the title of the current playlist.
- --set-current-playlist-name
title
- Set the title of the current playlist.
- --new-playlist
- Insert a new playlist after the current one and switch to it as if
--set-current-playlist were used.
- --delete-current-playlist
- Remove the current playlist.
- --mainwin-show
[on|off]
- Show or hide the Audacious window.
- --filebrowser-show
[on|off]
- Show or hide the Add Files window.
- --jumptofile-show
[on|off]
- Show or hide the Jump to Song window.
- --preferences-show
[on|off]
- Show or hide the Settings window.
- --about-show
[on|off]
- Show or hide the About window.
- --version
- Print version information.
- --plugin-is-enabled
plugin
- Return an exit code of 0 (true) if the given plugin is enabled. The plugin
is specified using its installed filename minus the folder path and
suffix: for example, crossfade for
${prefix}/lib/x86_64-linux-gnu/audacious/Effect/crossfade.so.
- --plugin-enable
plugin [on|off]
- Enable or disable the given plugin. Note that interface and output plugins
cannot be disabled directly since one of each must always be active.
Enabling an interface or output plugin will automatically disable the
previous plugin.
- --config-get
[section:]name
- Print the value of a configuration setting. Any use of this command is
entirely unsupported. How to find the section and name of a
given setting is left as an exercise for the reader.
- --config-set
[section:]name value
- Change the value of a configuration setting. This command is unsupported
and dangerous. It might have unexpected side effects (such as crashing
Audacious), or it might have no effect at all. Use it at your own
risk!
- --shutdown
- Shut down Audacious.
- --help
- Print a brief summary of audtool commands.
Commands may be prefixed with `--' (GNU-style long options) or
not, your choice.
There are no known bugs in audtool at this time; if you find any
please report them at
https://redmine.audacious-media-player.org/projects/audacious.
audtool was written by George Averill <nhjm@nhjm.net>
and William Pitcock <nenolod@atheme.org>.
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> and Tony Vroon <chainsaw@gentoo.org>. The
manual page was updated for Audacious 3.7 and later by John Lindgren
<john@jlindgren.net>.
This work is licensed under a Creative Commons Attribution 3.0
Unported License <https://creativecommons.org/licenses/by/3.0/>.
https://audacious-media-player.org