help.commands = "exit version start stop restart status log queue tag shows sched search events help"

exit.desc = "Exits the shell"
exit.detail = "This command will exit the UBS shell.  If the UBS is running, this command will not stop it; the daemons will continue to run in the background."

version.desc = "Display version information"
version.detail = "Prints out a brief blurb about the current version of the UBS."

start.desc = "Starts the UBS"
start.detail = "If a daemon name is specified, then the start command will start the respective daemon.  Otherwise, it will launch all known daemons into the background."
start.flags = "w c e s h"
startflags.w = "Web-based HTML output"
startflags.c = "Comma separated value output"
startflags.e = "Regular English output"
startflags.s = "Silent"
startflags.h = "Displays this help screen"

stop.desc = "Stops the UBS"
stop.detail = "If a daemon name is specified, then the stop command will stop the respective daemon.  Otherwise, it stops all known daemons."
stop.flags = "w c e s h"
stopflags.w = "Web-based HTML output"
stopflags.c = "Comma separated value output"
stopflags.e = "Regular English output"
stopflags.s = "Silent"
stopflags.h = "Displays this help screen"

restart.desc = "Restarts the UBS"
restart.detail = "If a daemon name is specified, then the restart command will restart that particular daemon.  Otherwise, it restarts all known daemons."
restart.flags = "w c e s h"
restartflags.w = "Web-based HTML output"
restartflags.c = "Comma separated value output"
restartflags.e = "Regular English output"
restartflags.s = "Silent"
restartflags.h = "Displays this help screen"

status.desc = "Displays the status of the UBS"
status.detail = "If a particular daemon is specified, then the status command displays the status for that daemon.  Otherwise, it will display the status for all known daemons."
status.flags = "w c e s h"
statusflags.w = "Web-based HTML output"
statusflags.c = "Comma separated value output"
statusflags.e = "Regular English output"
statusflags.s = "Silent"
statusflags.h = "Displays this help screen"

log.desc = "Display information from logfiles"
log.detail = "The log command will display the last part of a logfile, which must be specified on the command line by the short name (ie, error refers to the filename error.log)."
log.flags = "l n w c e s h"
logflags.l = "List all known logfiles"
logflags.n = "Number of lines to display (default 10)"
logflags.w = "Web-based HTML output"
logflags.c = "Comma separated value output"
logflags.e = "Regular English output"
logflags.s = "Silent"
logflags.h = "Displays this help screen"

queue.desc = "Displays the queue"
queue.detail = "With no arguments, this command displays the contents of the queue.  Arguments to this command can be used to modify the queue."
queue.flags = "d z a p w c e s h"
queueflags.d = "Displays the contents of the queue"
queueflags.z = "Zeros out (erases the contents) of the queue"
queueflags.a = "Appends a file to the end of the queue"
queueflags.p = "Prepends a file to the front of the queue"
queueflags.w = "Web-based HTML output"
queueflags.c = "Comma separated value output"
queueflags.e = "Regular English output"
queueflags.s = "Silent"
queueflags.h = "Displays this help screen"

tag.desc = "Display ID3/Vorbis tags"
tag.detail = "Given a filename, the tag command will display the ID3 or Vorbis tag of the file.  At this point, only the artist and song name are displayed."
tag.flags = "w c e s h"
tagflags.w = "Web-based HTML output"
tagflags.c = "Comma separated value output"
tagflags.e = "Regular English output"
tagflags.s = "Silent"
tagflags.h = "Displays this help screen"

shows.desc = "Display information about shows"
shows.detail = "With no arguments, this command will display a list of all known shows and their respective attributes.  Otherwise, switches can be used to display information about the current song or the current show."
shows.flags = "n p w c e s h"
showsflags.n = "Display the current show being played from"
showsflags.p = "Display the song currently being played"
showsflags.w = "Web-based HTML output"
showsflags.c = "Comma separated value output"
showsflags.e = "Regular English output"
showsflags.s = "Silent"
showsflags.h = "Displays this help screen"

sched.desc = "Display information about the schedule"
sched.detail = "This command will output the entire week, ordered by date, and show what programs are to be played on what days.  The week is ordered from 0-6, with 0 being Sunday and 6 being Saturday"
sched.flags = "w c e s h"
schedflags.w = "Web-based HTML output"
schedflags.c = "Comma separated value output"
schedflags.e = "Regular English output"
schedflags.s = "Silent"
schedflags.h = "Displays this help screen"

search.desc = "Search for files matching a query"
search.detail = "Given a case-insensitive search query, this command will go through all known shows searching for music files that match part of the query.  This includes the actual filename, and any information within the ID3/Vorbis tag."
search.flags = "r w c e s h"
searchflags.r = "Recache information for the search engine"
searchflags.w = "Web-based HTML output"
searchflags.c = "Comma separated value output"
searchflags.e = "Regular English output"
searchflags.s = "Silent"
searchflags.h = "Displays this help screen"

events.desc = "Display information about events"
events.detail = "This command displays all known events that will be handled by the ubs-event daemon."
events.w = "Web-based HTML output"
events.c = "Comma separated value output"
events.e = "Regular English output"
events.s = "Silent"
events.h = "Displays this help screen"

help.desc = "Display help about commands"
help.detail = "With no arguments, the help command lists all known UBS shell commands.  With an actual argument, it will display information about that particular command."
