help - command line functions
There are a number of important command line functions; some are necessary (such as load, start, and stop), and some are useful for management (such as rename). In all cases, the commands are used by invoking the executable and appending the command with any required or optional inputs.
Please note that this help page may not always be completely current. To find a current list of available options and how to use them, using a terminal window:
# /usr/local/calliope/bin/calliope help
In a default installation, calliope has been added to the user path, and you should be able to shorten this to:
# calliope help
It's important to note that some command line options (start and stop for instance) require you to be the root user.
Syntax and usage: Anything surrounded by < > is a required variable, and must be filled out with appropriate values. Anything surrounded by [ ] is optional, and can be used if desired. Commands separated by | are equivalent, and can be used interchangeably.
| command | usage |
| burn | burn file [type] |
Calliope now supports cd burning via the web interface. Anyplace you see the
 icon, you
can (if you have permission, and burning is turned on) burn a wav or data
CD.
You can also burn from the command line, *if* you've exported an album or list (which will then be in the var directory), or you could manually create an m3u file that lists the correct files to burn, and point calliope at that. Note that from the command line, you must be root to use this feature. calliope burn album782.m3u - creates an audio CD |
|
| conf | conf |
| This simply prints out the parsed conf file in a generally readable format, so you can see the state of your configuration file. | |
| flushdb | flushdb [-ars] |
| This will flush all music data from your database. Handy if you want to reload the database
with different configuration settings to see what happens. It will not delete non-music data
such as users, permissions, etc - only mp3 related info. To completely clear the database, use
the -a directive.
The -r option will cause the database to reload after flushing, if you're only flushing music data. The -s option will save the music lists prior to flushing. You can combine -rs to save your lists, flush the music data, reload the music data, and restore your lists. These latter two options won't work with the -a directive, which requires you to manually re-insert user data, genre data, etc. |
|
| help | help | --help | h |
| Simply displays this usage information in an abbreviated form. | |
| kill | kill [channels] |
| Kills the current song. By default channel 1 is used (which is the default number if you only have one channel). | |
| listimport | listimport <file> <owner> |
| If you've previously exported all your lists into a single file, this will import
those lists back into calliope.
The format is:
user,listname,playorder,absolutefilepath If you used calliope (e.g. listexport) to do the exporting, the default name / location of that export is ~/var/alllists.m3u. Note that 'file' is the file name without the m3u extension, which is assumed, and that 'user' should be a current user in the system (who is thus the owner of the list). EX: ./calliope listimport <alllists> You can also import individual lists one at a time. Individual lists need only have the absolute path name to the song (but you must also provide the song owner). To import the list "sunrise" and make it owned by "spooky," type: EX: ./calliope listimport sunrise.m3u spooky |
|
| listexport | listexport [file] |
| Used to export all lists into alllists.m3u (or [file]). Use this if you're planning to flush the database and want to retain your lists. | |
| load | load [channels] |
| Find and load new songs, remove missing songs, missing albums, missing artists. Note that there are quite a number of important variations on the loading process in the conf file - see the conf file for more details. You can always use flushdb and try again if you don't like the way your data loaded. | |
| register | register <channel> <user> <host> |
| This manually binds a host to a listener. Hosts and listeners are part of the Icecast streaming system, which is admittedly untested for calliope as of this writing. | |
| rename | rename |
| This renames compilation songs for the loader to a single format. Many compilations have the artist specified in the song title, but there is no single format as to how those artists are specified -- generally it varies from compilation to compilation. Since songs can now have artists associated with them (multiple artists in fact), this feature will allow you to rename all your compilation song files to a single consistent format. The loader will then recognize that format, and associate the songs with the appropriate format. More on this feature can be found in INSTALL, and you can launch the renamer and type 'h' for more help on how to use it. | |
| start | start [channels] |
| Start calliope channel(s) playing. The default is all channels, or you can specify an individual channel by number. This is the primary method for starting calliope. | |
| stop | stop [channels] |
| Stop channel(s) from playing. The default is all channels, or specify a channel by number. | |
| version | version |
| Displays version information for calliope. | |