These keywords must appear before the first CD's entry, and represent global settings for the tool. They are usually found in .workmanrc.

whendone eject | stop | repeat

Select the default action taken by workman(1) when a CD is finished playing. The default is stop.

playnew

If specified, workman(1) will play unknown CDs (those not listed in .workmanrc) when they're inserted.

cddbprotocol cddbp | http | proxy

Protocol to be used for CDDB requests. workman(1) can either use the CDDBP or the HTTP protocol. PROXY denotes the use of a proxy server for CDDBP requests. If this keyword is not set workman(1) does not use CDDB support.

cddbserver host[:port]

name of the CDDB server to be used, e.g. freedb.freedb.org. If port is not provided we use port 888 for CDDBP requests and port 80 for HTTP requests.

cddbmailaddress email-address

This is the user's email address that will be sent to the CDDB server. It must be given in the form user@host. If this address is not provided an identification based on the login name and the hostname will be sent.

cddbpathtocgi path

If the HTTP protocol is used this keyword provides the path to the CGI script answering the CDDB requests. This is usually /~cddb/cddb.cgi

cddbproxy host[:port]

The name of a proxy that can be used for CDDB requests. If port is not provided port 80 will be used.

The rest of the keywords describe specific CDs.

tracks ntracks start1 start2 ... startn length

This keyword delimits the start of a particular CD's entry (and thus the end of the previous entry.) Its arguments contain the information used to distinguish one disc from another. The first argument, ntracks, is the number of tracks on the CD. For each of those tracks, there is a start value, which is the starting frame of the track (a frame is approximately 1/75th of a second.) The final argument is the length of the CD in seconds.

sections nsects start1 start2 ... startn

Workman(1) allows the user to split a CD's physical tracks into smaller virtual tracks called sections. The sections keyword, which must immediately follow tracks, defines the starting positions of the sections. Sections are inserted into the track list, and track numbers are adjusted accordingly, e.g. section 1.2 as presented to the user is represented as track 2 in the database file. If the sections listed in .workmandb and .workmanrc differ, .workmandb takes precedence, and sections listed only in .workmanrc are discarded.

cdname name

The name of the current disc, as supplied by the user.

artist name

The artist's name for the current disc, as supplied by the user.

playmode mode

The default play mode for the CD is mode, a numeric value. 0 is the "normal" play mode (play all tracks sequentially) and 1 is "shuffle" mode. If mode is 2 or greater, the default play sequence is a playlist (mode 2 meaning the first playlist, 3 meaning the second, etc.)

autoplay

If autoplay is present, this CD will begin playing immediately when it is inserted.

cdvolume volume

The default play volume of the CD, a value from 0 to 32. If volume is 0, the CD has no default volume (since 0 is the default, cdvolume will usually not be present in that case.)

playlist name number track1 track2 ...

Define a playlist for the current CD. The name does not contain any whitespace; whitespace is converted to "_" on output and "_" is converted to whitespace on input. (See the BUGS section.) The number argument is the number of tracks contained in the playlist; the rest of the line is a list of track numbers. Playlists are ordered; see the playmode keyword above.

track [name]

The name of a track. This delimits the start of a track's information. The name argument is optional; it will not be present unless the user has supplied a track name. This line may be divided into display lines with the "//" token. Additionally, a display line beginning with "+" indicates that the rest of the display line contains a replacement disc title (usually the name of a group of tracks, such as "Symphony No. 2" on a disc with more than one piece of music.) A display line beginning with "@" replaces the artist's name for the track. If "+" or "@" is the only character on a display line, workman(1) will use the title or artist from the previous track, searching backwards as necessary. If a display line is empty, the corresponding display line from the previous track is used.

continue

The current track is a continuation of the previous one (e.g. the second movement of a symphony.)

dontplay track

Don't play a track (specified by number) unless it's specifically requested by the user.

volume track volume

The default play volume for track, specified by number. volume is a number from 0 to 32. See cdvolume above.

mark frame mark-id

Define a mark. Marks with IDs other than START and END are currently ignored. Those two marks represent the start and end of the part of the CD to be repeated (as set from the Goodies popup) respectively. The frame value is an absolute frame number.