--- name: "vuxctl" section: "1" platform: "linux" package: "vux" version: "0.4.9" release: "Debian 6.0 (Squeeze)" platforms: ["linux"] url: "https://new.carta.tech/vuxctl" --- # vuxctl(1) vux ogg/mp3 player control interface ## NAME vuxctl – vux ogg/mp3 player control interface ## SYNOPSIS **vuxctl** \[*commands*\]\ ## DESCRIPTION **vuxctl** is a control interface to the **vux** program. It provides greater control than the two signals provided by **vux** itself. See **[vux(1)](/vux/1.md)** for details. ## COMMANDS Most commands are mutually exclusive with other commands. When given on the same command line, only the last of these commands will be honored. **vuxctl** with no arguments is equivalent to **vuxctl help**. - **start** Invokes **vux -x play** in the background if no playing **vux** exists. This command causes all other commands given on the same line to be ignored. - **clean** Removes possibly stale files in the vux directory that would prevent vux from running. Files removed are the vuxctl socket and any lockfiles. By default, these are: **.vux/ctl**, **.vux/vux.pid**, **.vux/scorelist.lock**, **.vux/agelist.lock** and **.vux/countlist.lock**. - **double** Double the rating multiplier for current song. Mutually exclusive with **half**. - **half** Halve the rating multiplier for current song. Since the rating multiplier is an integer, halving the initial rating multiplier of 1 has no effect. Mutually exclusive with **double**. - **up** Increase the rating of the current song using the current rating increase method. Mutually exclusive with **down** and *number*. - **down** Decrease the rating of the current song using the current rating decrease method. Mutually exclusive with **up** and *number*. - *number* Change the rating of the current song to *number*. Mutually exclusive with **up** and **down**. - **next** Proceed to next song. This does not effect current rating unless **up**, **down** or *number* is also given. Mutually exclusive with **previous**, **forward** and **replay**. - **previous** Proceed to previous song. This does not effect current rating unless **up**, **down** or *number* is also given. If no previous song exists, **previous** acts as **replay**. Mutually exclusive with **next**, **forward** and **replay**. - **forward** Proceed to next random song, ignoring history. This does not effect current rating unless **up**, **down** or *number* is also given. Mutually exclusive with **next**, **previous** and **replay**. - **replay** Replay current song. This does not effect current rating unless **up**, **down** or *number* is also given. Mutually exclusive with **next**, **previous** and **forward**. - **pause** Pause or resume running ogg or mp3 player and its child. This will only work as a toggle if ps supports the **-o** option (ps from procps in Debian does.) Mutually exclusive with **resume**, **stop**, **reload**, **save**, **after** and **history**. - **resume** Resume running ogg or mp3 player and its child. Mutually exclusive with **pause**, **stop**, **reload**, **save**, **after** and **history**. - **stop** Quit **vux**. Mutually exclusive with **pause**, **resume**, **reload**, **save**, **after** and **history**. - **after** Quit **vux** after the current playing song is finished. Mutually exclusive with **pause**, **stop**, **resume**, **reload**, **save** and **history**. - **reload** Reload scorelist. Mutually exclusive with **pause**, **resume**, **stop**, **save**, **after** and **history**. - **save** Save scorelist. Mutually exclusive with **pause**, **resume**, **stop**, **reload**, **after** and **history**. - **history** Show previous/next history of songs. As stated above, output is generated by **vux**. Mutually exclusive with **pause**, **resume**, **stop**, **reload**, **after** and **save**. - **help** Show summary of options. As stated above, output is generated by **vux**. This command causes all other commands given on the same line to be ignored. ## DIAGNOSTICS **vuxctl** will exit 0 if there are no errors. Otherwise, the following exit codes are used: - **1** Command failed. - **2** Start command was given, but vux.pid already exists. - **3** Command given, but no vux.pid exists. ## EXAMPLES - **vuxctl next** Proceed to the next song without changing the rating of the current song. - **vuxctl up next** Increase the rating of the current song and proceed to the next song. - **vuxctl 50** Set the rating of the current song to 50. - **vuxctl replay** Replay current song. - **vuxctl previous** Proceed to the previous song without changing the rating of the current song. - **vuxctl up previous** Increase the rating of the current song and proceed to the previous song. - **vuxctl double up next** Increase the rating of the current song by twice the usual amount and proceed to the next song. - **vuxctl double down** Decrease the rating of the current song by twice the usual amount but continue playing it. - **vuxctl double** Double the rating multiplier, affecting the rating change when the song is skipped or played fully. ## BUGS Use the Debian Bug Tracking System for reporting bugs and making suggestions. ## SEE ALSO **[vux(1)](/vux/1.md)** ## FILES - /etc/vuxrc system configuration file - $HOME/.vux/vuxrc user configuration file - $HOME/.vux/scorelist default scorelist - $HOME/.vux/\*.bak default backup file; made before saving - $HOME/.vux/\*.lock default lockfile preventing a file save or load while saving - $HOME/.vux/vux.pid file containing PID of any vux process using -x play - $HOME/.vux/ctl vux control socket ## AUTHOR This manual page was written by Brian Nelson \, for the Debian GNU/Linux system (but may be used by others).