Skip to content

Latest commit

 

History

History
274 lines (142 loc) · 4.83 KB

jukebox.pod

File metadata and controls

274 lines (142 loc) · 4.83 KB

NAME

jukebox - music player for large collections of music files

SYNOPSIS

jukebox [-nocheck] [-noscan] [-demo] [-ro] [-rotags] [-play] [-nodbus] [-gst0|-nogst] [-server] [-port N] [-cfg FILE] [-fifo FIFO|-nofifo] [-debug] [-verbose] [-layout NAME] [-plugin NAME] [-searchpath FOLDER] [-use-gnome-session] [-workspace N] [-cmd CMD] [-ifnotrunning MODE] [-dbus-id KEY] FOLDER_OR_FILE ...
jukebox [-listcmd]
jukebox -tagedit FOLDER_OR_FILE ...

DESCRIPTION

This manual page explains the jukebox program.

jukebox can play and manage your songs, currently supports mp3, ogg, flac, mpc file formats.

The options are as follows:

-c, -nocheck

don't check for updated/deleted songs on startup

-s, -noscan

don't scan folders for songs on startup

-demo

don't save settings/tags on exit

-ro

prevent modifying/renaming/deleting song files

-rotags

prevent modifying tags of music files

-play

start playing on startup

-nogst

do not load any gstreamer librairies

-gst0

prefer gstreamer-0.10 over gstreamer-1.x if both are available

-nodbus

do not use DBus

-server

send playing song to connected icecast client

-port N

listen for connection on port N in icecast server mode

-C FILE, -cfg FILE

use FILE as configuration file (instead of jukeboxrc in default folder), if FILE is a folder (or ends with /), it will be used as base folder instead of ~/.config/jukebox/

-F FIFO, -fifo FIFO

use FIFO as named pipe to receive commands (instead of jukebox.fifo in default folder)

-nofifo

do not use/create named pipe

-dbus-id KEY

append .KEY to the DBus service id used by jukebox (org.jukebox)

-verbose

print some info, like the file being played

-debug

print lots of useless information, implies -verbose

-backtrace

print a backtrace for every warning

-l NAME, -layout NAME

use layout NAME for player window

-plugin NAME

deactivate plugin identified by NAME

+plugin NAME

activate plugin identified by NAME

-noplugins

deactivate all plugins

-searchpath FOLDER

add FOLDER to the list of folders searched for plugins and layouts

-use-gnome-session

Use gnome libraries to save tags/settings on session logout (needs the Gnome2 perl module).

-workspace N

Move initial window to workspace N (needs the Gnome2::Wnck perl module).

-cmd CMD

add CMD to the list of commands to execute. If a running instance of jukebox is found, these commands will be sent via the fifo file or via DBus. If there is no running instance of jukebox, the behavior depends on option -ifnotrunning

-ifnotrunning MODE

change behavior when no running jukebox instance is found, MODE can be one of:

normal (default)

launch a new instance and execute commands

nocmd

launch a new instance but discard commands

abort

do nothing

Running instances of jukebox are detected via the fifo or via DBus. To run more than one instance, use a unique fifo and a unique DBus-id, or deactivate them.

-listcmd

list the available commands and exit

-listlayout

list the available layouts and exit

-listplugin

list the available plugins and exit

-tagedit FOLDER_OR_FILE ...

Load songs in FOLDER_OR_FILE and display a dialog to edit their tags.

FILES

~/.jukebox/tags

contains songs tags and program options

/usr/share/jukebox/plugins/, ~/.jukebox/plugins/

files with extension .pm in these folders are loaded as plugins on startup

/usr/share/jukebox/layouts/*.layout, ~/.jukebox/layouts/*.layout

contains layouts definitions

~/.jukebox/jukebox.fifo

can be used to send commands to a running jukebox, e.g.:

echo CMD >~/.jukebox/jukebox.fifo

where CMD is (run "jukebox -listcmd" for an up-to-date list of commands):

NextSong

Skip current song

PrevSong

choose previously played song

PlayPause

toggle Play/Pause mode

Stop

stop playing

Rewind SEC

rewind SEC seconds

Forward SEC

forward SEC seconds

Browser

open browser window

ShowHide

hide/show jukebox windows

Quit

quit jukebox

Save

immediately save settings/song tags in ~/.jukebox/tags

ChangeDisplay DISPLAY

migrate the program to display DISPLAY (example : ":1")

SEE ALSO

https://github.com/zeppe-lin/jukebox

AUTHORS