File: workmandb.doc

package info (click to toggle)
workman 1.3a-8
  • links: PTS
  • area: main
  • in suites: hamm
  • size: 944 kB
  • ctags: 745
  • sloc: ansic: 9,810; makefile: 137; sh: 27
file content (330 lines) | stat: -rw-r--r-- 11,023 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330



workmandb(5)              FILE FORMATS               workmandb(5)



NAME
     workmanrc, workmandb - database and  preferences  files  for
     workman

SYNOPSIS
     $HOME/.workmanrc or value of WORKMANRC variable

     $HOME/.workmandb or value(s) of WORKMANDB variable

DESCRIPTION
     The .workmandb file stores information about compact  discs.
     It is generated by _w_o_r_k_m_a_n(1) based on user input.  Its com-
     panion file, .workmanrc, stores user  preferences  for  each
     disc.   The  distinction  between the two is that .workmandb
     contains only the hard information  about  a  CD  (the  disc
     name,  artist, track titles, etc.) and is often shared among
     several users.  .workmanrc, on the other hand, contains set-
     tings  like  the  default  volumes of particular tracks, the
     numbers of tracks to be avoided, and so  forth.   Each  user
     generally  maintains  a private .workmanrc, even if a shared
     .workmandb is being used.

     Though _w_o_r_k_m_a_n(1) stores different information in each file,
     both  files  have  an  identical format; most of this manual
     page will not distinguish between the two.  Each line of the
     file is of the form

     [s-]keyword    [_o_p_t_i_o_n_a_l _w_h_i_t_e_s_p_a_c_e-_s_e_p_a_r_a_t_e_d _a_r_g_u_m_e_n_t_s]

     Empty lines are ignored.  Lines starting  with  unrecognized
     keywords are retained and written back out verbatim when the
     database is saved.  The program preserves  the  ordering  of
     unrecognized  lines,  and  their  positions  relative to the
     track information.  This allows the database to be  extended
     to hold any sort of information desired by the user.

     Keywords that begin with "s-" apply to sections rather  than
     tracks.   See  the  sections keyword below.  A CD entry with
     "s-" keywords must have a sections keyword as well.  This is
     done  for  backward compatibility and will disappear eventu-
     ally, and in any case only  applies  to  keywords  found  in
     .workmandb (the assumption is that users won't downgrade the
     versions  they  run,  so  .workmanrc  doesn't  need  to   be
     backward-compatible.)

     Some keywords are delimiters that  modify  the  meanings  of
     keywords  that  follow;  others are position-independent and
     may occur anywhere in the file.  (In general, the  position-
     independent  keywords  are  concerned  with settings for the
     tool as a whole, rather than for a particular disc.)





Sun Release 4.1       Last change: 12/5/92                      1






workmandb(5)              FILE FORMATS               workmandb(5)



     The keywords, and  their  arguments,  follow.   All  numeric
     arguments are in decimal unless otherwise specified.

  Initial Keywords
     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 _w_o_r_k_m_a_n(1) when a CD
          is finished playing.  The default is stop.

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

  CD Information
     The rest of the keywords describe specific CDs.

     tracks _n_t_r_a_c_k_s _s_t_a_r_t_1 _s_t_a_r_t_2 ... _s_t_a_r_t_n _l_e_n_g_t_h
          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, _n_t_r_a_c_k_s, is
          the number of tracks on the  CD.   For  each  of  those
          tracks,  there  is a _s_t_a_r_t 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 _n_s_e_c_t_s _s_t_a_r_t_1 _s_t_a_r_t_2 ... _s_t_a_r_t_n
          _W_o_r_k_m_a_n(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 _n_a_m_e
          The name of the current disc, as supplied by the user.

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

     playmode _m_o_d_e
          The default play mode for the CD  is  _m_o_d_e,  a  numeric
          value.   0  is  the "normal" play mode (play all tracks



Sun Release 4.1       Last change: 12/5/92                      2






workmandb(5)              FILE FORMATS               workmandb(5)



          sequentially) and 1 is "shuffle" mode.  If _m_o_d_e is 2 or
          greater,  the default play sequence is a playlist (_m_o_d_e
          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 _v_o_l_u_m_e
          The default play volume of the CD, a value  from  0  to
          32.   If  _v_o_l_u_m_e  is  0,  the  CD has no default volume
          (since 0 is the default, cdvolume will usually  not  be
          present in that case.)

     playlist _n_a_m_e _n_u_m_b_e_r _t_r_a_c_k_1 _t_r_a_c_k_2 ...
          Define a playlist for the current CD.   The  _n_a_m_e  does
          not  contain any whitespace; whitespace is converted to
          "_" on output and "_" is  converted  to  whitespace  on
          input.  (See the BUGS section.)  The _n_u_m_b_e_r 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 [_n_a_m_e]
          The name of a track.  This  delimits  the  start  of  a
          track's information.  The _n_a_m_e 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  charac-
          ter on a display line, _w_o_r_k_m_a_n(1) will use the title or
          artist from the previous track, searching backwards  as
          necessary.  If a display line is empty, the correspond-
          ing 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 _t_r_a_c_k
          Don't play a track (specified by  number)  unless  it's
          specifically requested by the user.

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



Sun Release 4.1       Last change: 12/5/92                      3






workmandb(5)              FILE FORMATS               workmandb(5)



     mark _f_r_a_m_e _m_a_r_k-_i_d
          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 _f_r_a_m_e
          value is an absolute frame number.

EXAMPLE
     The first example is a .workmandb entry for  a  hypothetical
     disc.  At least, I hope it's hypothetical.

          tracks 6 150 10341 20449 45117 100104 150100 1609
          cdname Amazing Accordion Tunes - The Early Years
          artist The Hemophiliacs
          track Polka 'Till the Sun Goes Down
          track I've Got Rocks In My Heart, Baby...
          track ...But I Still Get Stoned On You
          continue
          track You Never Know How Late It Is Until the Clock Strikes Blue
          track +The Big Exhibition//@Mussorgsky//IX. La Cabane//Allegro
          track +//@////Andante mosso
          continue

     The third track is a continuation of the second.  The  fifth
     track  is  an excerpt from a larger work, originally written
     by someone else; it has a two-line track title.   The  sixth
     track is a continuation of the fifth; it uses the same title
     and artist, and the first line of the  track  title  is  the
     same, but the second is different.

     The .workmanrc entry for the same CD might look like:

          tracks 6 150 10341 20449 45117 100104 150100 1609
          cdvolume 32
          playmode 1
          playlist Originals 3 2 3 1
          autoplay
          dontplay 4
          volume 3 20

     The tracks line, naturally, is the same in both files, since
     it  identifies  which CD the entry is for.  This CD plays at
     maximum volume in shuffle mode by default.  It has one play-
     list  with tracks 2, 3, and 1.  When inserted, it will start
     up automatically.  Track 4 is  particularly  unpleasant,  so
     the  user  never  wants  to  hear it.  And track 3 should be
     played more quietly than the others.

SEE ALSO
     workman(1)





Sun Release 4.1       Last change: 12/5/92                      4






workmandb(5)              FILE FORMATS               workmandb(5)



BUGS
     The playlist keyword is  not  well  thought-out.   The  _n_a_m_e
     should  go  at  the  end of the line, so it can contain whi-
     tespace or whatever else the user likes.

     The file updating algorithm used by  _w_o_r_k_m_a_n(1)  leaves  big
     holes (consisting of empty lines) in the database files.  It
     makes an attempt to fill the holes when possible rather than
     growing the files.














































Sun Release 4.1       Last change: 12/5/92                      5