home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #27 / NN_1992_27.iso / spool / alt / sources / 2527 / workman.man < prev   
Encoding:
Text File  |  1992-11-15  |  17.1 KB  |  529 lines
  1.  
  2.  
  3.  
  4. workman(1)               USER COMMANDS                 workman(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      workman - play audio compact discs on a SCSI CD player
  10.  
  11. SYNOPSIS
  12.      workman [ _g_e_n_e_r_i_c-_t_o_o_l-_a_r_g_u_m_e_n_t_s ] [ -bdoeXn ] [ -p  pidfile
  13.      ] [ -c device ] [ -l n ]
  14.  
  15. DESCRIPTION
  16.      workman is a graphical tool for playing audio compact  discs
  17.      on  a  SunCD drive or other compatible unit.  It has most of
  18.      the features available on standalone CD players, such  as  a
  19.      shuffle  mode, programmable playlists, and elapsed/remaining
  20.      timers.  But it also has extra features, foremost  of  which
  21.      is the ability to store information about CDs in a database,
  22.      then automatically extract that information when the  CD  is
  23.      inserted  later.  Workman stores the artist's name, the disc
  24.      title, the names of individual tracks,  and  even  remembers
  25.      which tracks you don't want to hear!  All in an easy-to-use,
  26.      attractive OPEN LOOK graphical interface.
  27.  
  28.      Its only weakness, in fact, is that this is the end  of  the
  29.      Description section of the manpage.
  30.  
  31. INTERFACE
  32.      Most controls have spot help; hit the Help key (F1 on type-3
  33.      keyboards)  over  a  control  to find out what it does.  The
  34.      following is a quick rundown of the controls; for  the  most
  35.      part, they're pretty self-explanatory.
  36.  
  37.   The main window
  38.      The  main  window  contains  the  basic  display  and   most
  39.      commonly-used controls.  Moving from top to bottom and read-
  40.      ing left to right, you'll see:
  41.  
  42.      The artist's name.
  43.  
  44.      The name of the CD or the  title  of  the  currently-playing
  45.      piece of music, if it takes up more than one track.
  46.  
  47.      The title of the current track.  This may occupy  more  than
  48.      one row on the screen.
  49.  
  50.      The track selection buttons.   Click  on  these  buttons  to
  51.      select  a starting track, or to change to a new track if the
  52.      CD is playing.
  53.  
  54.      The track-position slider.  This is  updated  once  every  5
  55.      seconds  while  the  CD is playing; you can also use it as a
  56.      sort of jog dial to move around in a track.
  57.  
  58.      The volume slider.  Up is louder; down is quiet.
  59.  
  60.  
  61.  
  62.  
  63. Sun Release 4.1       Last change: 11/15/92                     1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. workman(1)               USER COMMANDS                 workman(1)
  71.  
  72.  
  73.  
  74.      The main controls (for lack of a better term.)  The  buttons
  75.      on  the  top  row move to the previous track, start playing,
  76.      and move to the next track, respectively.  The  bottom  but-
  77.      tons  pause,  stop, or eject the CD.  When the CD is paused,
  78.      playing may be resumed by clicking on either the pause  but-
  79.      ton or the play button.
  80.  
  81.      The "stop mode" selector.  When workman is  done  playing  a
  82.      CD,  it  can  stop,  play the CD over again (the _R_e_p_e_a_t set-
  83.      ting), or eject it.  Click the MENU mouse button to select a
  84.      stop  mode;  or  click SELECT on the pull-down item to cycle
  85.      through the available choices.
  86.  
  87.      The "play mode" selector.  This determines the playing order
  88.      of the tracks.  Two selections are always available: _N_o_r_m_a_l,
  89.      which plays the CD from start to  end,  and  _S_h_u_f_f_l_e,  which
  90.      plays the tracks in random order.  In addition, if any play-
  91.      lists have been defined, they'll appear here as well.
  92.  
  93.      A gauge indicating how long the CD has been playing and  how
  94.      much longer is left.
  95.  
  96.      Three buttons that bring up the About, CD Info, and  Goodies
  97.      popups.
  98.  
  99.   The About popup
  100.      There's not much to say about this; it's the credits with  a
  101.      couple of dumb pictures.
  102.  
  103.   The CD Info popup
  104.      This popup is used to enter information about a CD.   Again,
  105.      from the top:
  106.  
  107.      The artist's name.
  108.  
  109.      The title of the CD as a whole.
  110.  
  111.      A scrolling list of tracks and their titles.   This  can  be
  112.      used  to  view  the  tracks on a CD, or to select tracks for
  113.      editing using the controls below.
  114.  
  115.      The name of the track that's selected on the scrolling list.
  116.      As a shortcut, if RETURN is typed to enter a track name, the
  117.      scrolling list selection will automatically advance  to  the
  118.      next track.  This allows you to type in all the track titles
  119.      without using  the  mouse.   The  track  title  can  contain
  120.      several   special  symbols  that  alter  the  main  window's
  121.      display.  "//" separates the title into  separate  lines  on
  122.      the display (usually used if the title won't fit on the main
  123.      window.) If a line begins with "+", the main  window's  disc
  124.      title  display is replaced with the text after the "+" (use-
  125.      ful for classical CDs, with several tracks that are part  of
  126.  
  127.  
  128.  
  129. Sun Release 4.1       Last change: 11/15/92                     2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. workman(1)               USER COMMANDS                 workman(1)
  137.  
  138.  
  139.  
  140.      the  same  work.)   If  a  line  begins  with  "@", the main
  141.      window's artist display is replaced with the text after  the
  142.      "@"  (useful  for  compilation  CDs  with  tracks by several
  143.      artists.)  Both "+" and "@" may be used alone on a line,  in
  144.      which  case  the  program  uses the title or artist from the
  145.      previous track.
  146.  
  147.      The "Continuation"  selector.   If  this  is  selected,  the
  148.      current  track  is a continuation of the previous one.  This
  149.      is taken into account when the CD is played in shuffle mode;
  150.      if,  for example, three tracks are part of the same piece of
  151.      music (indicated by setting "Continuation" on the second and
  152.      third tracks), they will be played together in shuffle mode.
  153.  
  154.      The "Don't play" selector.  If this is selected, the program
  155.      will  avoid  the  track  when playing the CD (though you can
  156.      still play the track by selecting it directly using the main
  157.      window's track selection buttons.)
  158.  
  159.      The default volume setting.  Use this if a  particular  disc
  160.      or  track should be played especially loudly or quietly.  If
  161.      the slider is all the way to the left, there is  no  default
  162.      setting and the current volume will be used.
  163.  
  164.      The default play mode setting.  When the CD is inserted, the
  165.      main  window's  play  mode selector will be set according to
  166.      this item.  "From List" will select the first playlist.
  167.  
  168.      The auto-play setting.  If this is  selected,  the  CD  will
  169.      start  playing automatically when it's inserted (even if the
  170.      main window is closed to an icon!)
  171.  
  172.      Apply and Reset buttons.  Apply will save the CD information
  173.      to disk.  Reset undoes any changes you've made.
  174.  
  175.      A button to bring up the "Playlists" popup.
  176.  
  177.   The Playlists popup
  178.      This contains the controls for creating  user-defined  play-
  179.      lists.  Any number of playlists may be created, and they can
  180.      be as long as you like (until your workstation runs  out  of
  181.      memory, anyway.)  The controls:
  182.  
  183.      A scrolling list, from which you can select  a  playlist  to
  184.      edit or maim.
  185.  
  186.      The name of a scrolling list to create, or the new name  for
  187.      the current list.
  188.  
  189.      A button which creates a new list, using the name above or a
  190.      boring system-generated one if no name has been entered.
  191.  
  192.  
  193.  
  194.  
  195. Sun Release 4.1       Last change: 11/15/92                     3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. workman(1)               USER COMMANDS                 workman(1)
  203.  
  204.  
  205.  
  206.      A button to rename the current list to whatever  is  in  the
  207.      Name field.
  208.  
  209.      A button to delete the current list.
  210.  
  211.      The tracks in the current playlist.  To add tracks, use  the
  212.      popup menu (which appears when you hit the MENU mouse button
  213.      over the scrolling list.) The popup menu is pinnable, so you
  214.      can keep it on the screen and select tracks quickly.
  215.  
  216.      A button to delete the  currently-selected  track  from  the
  217.      playlist.
  218.  
  219.   The Goodies popup
  220.      This popup contains some infrequently-used,  perhaps  frivo-
  221.      lous, controls:
  222.  
  223.      The balance setting.
  224.  
  225.      The time display setting.  The running times to the left  of
  226.      the  slider  and gauge in the main window can display either
  227.      elapsed time (the default) or remaining time;  use  this  to
  228.      choose.
  229.  
  230.      The auto-play setting for unknown CDs (CDs which you haven't
  231.      seen  before,  or  which  you saw before but didn't Apply to
  232.      your database file from the CD Info  window.)   If  this  is
  233.      selected, unknown CDs will be played when they're inserted.
  234.  
  235.      The controls for the A-B repeat function.  While the  CD  is
  236.      playing,  click the Start button to mark the start of a pas-
  237.      sage to be repeated; then click the End button when  the  CD
  238.      reaches  the  end of the passage.  Click on the "Repeat sec-
  239.      tion of CD" item to start  repeating  the  passage  (and  to
  240.      stop, once you've started.)
  241.  
  242.      The Split button.  This button allows you to split any track
  243.      in  two.   Select  a track from the main window, and use the
  244.      track-position slider to choose the split point.   Then  hit
  245.      the  Split button and the track will be divided.  You can do
  246.      everything with the new section that you can with a  regular
  247.      track, including choosing a name.  Tracks may be split while
  248.      the CD is stopped or paused, or while it's playing.  This is
  249.      useful  if  you  wish  to  mark  a  section  of  a song, for
  250.      instance; you can listen for the start of the  section,  and
  251.      hit Split as soon as you hear it beginning.
  252.  
  253.      The Delete button.  Use this to put a  split-up  track  back
  254.      together.  You can't delete the first section of a track.
  255.  
  256.      A button to scan for index marks.  If a CD already has  sec-
  257.      tions marked via index marks (usually indicated in the liner
  258.  
  259.  
  260.  
  261. Sun Release 4.1       Last change: 11/15/92                     4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. workman(1)               USER COMMANDS                 workman(1)
  269.  
  270.  
  271.  
  272.      notes), hit this button to search for them.   Searching  for
  273.      marks  can  take  a  while  depending  on the particular CD.
  274.      Every time an index mark is encountered, its track  will  be
  275.      split as if you'd used the Split button.
  276.  
  277. OPTIONS
  278.      -_d   Don't display any title information in the main window.
  279.           This  results  in  a  smaller  main  window.  The title
  280.           information can still be seen and edited using  the  CD
  281.           Info popup.
  282.  
  283.      -_b   Put Dismiss buttons on all popups and a Quit button  on
  284.           the  main  window.  Useful for users of window managers
  285.           other than olwm.
  286.  
  287.      -_c _d_e_v_i_c_e
  288.           Use a device other than the default (/dev/rdsk/c0t6d0s2
  289.           under Solaris 2 and /dev/sr0 under Solaris 1).  This is
  290.           useful if the CD drive is on a second SCSI  controller,
  291.           or more than one drive is present on the system.
  292.  
  293.      -_o   This option prevents the Solaris 2 version  of  workman
  294.           from  spawning  a  background job to keep the CD device
  295.           open.  There is a bug in Solaris 2 that causes  the  CD
  296.           player  to  stop when its device is opened, unless some
  297.           other process on the  system  already  has  the  device
  298.           open.   When this option is specified, the CD will stop
  299.           playing if workman is exited then restarted.  When  the
  300.           background job is present (-_o is absent) the eject but-
  301.           ton on the CD player does not work even after  quitting
  302.           from workman.
  303.  
  304.      -_l _n Reserve some lines for track titles in the main window.
  305.           If  _n  is  a  positive number, that many lines of track
  306.           title will always be displayed, even if some are blank.
  307.           If  _n  is zero, the main window will grow and shrink to
  308.           accomodate multiline titles.  If  _n  is  negative  (the
  309.           default), the main window will grow when necessary, but
  310.           will never shrink, even when a shorter title is  subse-
  311.           quently displayed.
  312.  
  313.      -_e   Check once for the presence of a CD at startup.  If  no
  314.           CD  is  present, wait for the user to select the square
  315.           (stop) icon from the main window.  The  default  is  to
  316.           check for a CD every 5 seconds; on some SunOS versions,
  317.           the CD-ROM driver prints a message to the console every
  318.           time  the  tool  checks  for a CD.  After a CD has been
  319.           detected once,  workman  will  revert  to  its  default
  320.           behavior (since the driver message only occurs if work-
  321.           man has not yet found a CD in the drive.)   Specify  -_e
  322.           more  than  once  to  disable checking for CD insertion
  323.           permanently.
  324.  
  325.  
  326.  
  327. Sun Release 4.1       Last change: 11/15/92                     5
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. workman(1)               USER COMMANDS                 workman(1)
  335.  
  336.  
  337.  
  338.      -_X   Exit automatically when the CD is ejected.
  339.  
  340.      -_p _f_i_l_e
  341.           Write the program's process ID to a different _f_i_l_e.  By
  342.           default,  the PID is written to "/tmp/.wm_pid" to allow
  343.           signals to be sent more easily (see the SIGNALS section
  344.           below.)
  345.  
  346.      -_n   No file locking.  On some  systems,  workman's  use  of
  347.           file  locking  is a significant performance hit (and on
  348.           older systems, file locking didn't work  too  well;  on
  349.           those  machines, workman can freeze up when it tries to
  350.           lock the database file.)  Use of  this  option  is  not
  351.           recommended  when  several  people share a database via
  352.           NFS; if two people save CD entries to the  database  at
  353.           the  same  time and one of them is not using file lock-
  354.           ing, one or both of the new entries may  be  erased  or
  355.           stored incorrectly.
  356.  
  357.           Apply  Sun  patch  100075  to  your  system  (and  your
  358.           fileserver,  if you're NFS-mounting the database files)
  359.           and you probably won't need to use the -n flag at all.
  360.  
  361. ENVIRONMENT
  362.      WORKMANRC
  363.           The location of the personal  preferences  file.   This
  364.           file  contains  information such as the default volumes
  365.           of CDs, playlists, and the numbers of tracks  to  avoid
  366.           playing.   It is usually not shared among several users
  367.           of workman, since it does not contain  any  information
  368.           about the CDs themselves.
  369.  
  370.      WORKMANDB
  371.           Specifies the location  of  the  CD  database  file  or
  372.           files.   Several  files  may be specified by separating
  373.           them with colons a la the  PATH  shell  variable.   For
  374.           example,          setting          WORKMANDB         to
  375.           "$HOME/.workmandb:/home/user2/.workmandb"  would  cause
  376.           workman  to  look  first  in  $HOME/.workmandb, then in
  377.           /home/user2/.workmandb.  New entries are saved  to  the
  378.           first  database in the list; modified entries are saved
  379.           to the database in which they were originally found, or
  380.           the first database if that one is not writable.
  381.  
  382. SIGNALS
  383.      SIGUSR1
  384.           When this signal is received, the CD will be paused  if
  385.           it is playing.
  386.  
  387.      SIGUSR2
  388.           When this signal is received, the CD will start playing
  389.           if it is paused.
  390.  
  391.  
  392.  
  393. Sun Release 4.1       Last change: 11/15/92                     6
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400. workman(1)               USER COMMANDS                 workman(1)
  401.  
  402.  
  403.  
  404.      These signals, in combination with the pidfile (see  the  -_p
  405.      option  description  above),  allow simple control of the CD
  406.      player from programs or scripts.  For instance, the  follow-
  407.      ing csh commands will create mute and unmute commands:
  408.  
  409.           alias mute 'kill -USR1 `cat /tmp/.wm_pid`'
  410.  
  411.           alias unmute 'kill -USR2 `cat /tmp/.wm_pid`'
  412.  
  413. FILES
  414.      $HOME/.workmanrc
  415.           Default location of  personal  preferences  file.   See
  416.           WORKMANRC  under  "Environment"  as  well as  workmandb
  417.           (4).
  418.  
  419.      $HOME/.workmandb
  420.           Default location of CD database  file.   See  WORKMANDB
  421.           under "Environment" and  workmandb (4).
  422.  
  423. BUGS
  424.      The program leaks memory with XView 3.0 (but  not  3.0.1  or
  425.      higher)  due  to  a library bug.  The leak only occurs while
  426.      the About popup is displayed.
  427.  
  428.      Due to another library bug, the program will dump core  when
  429.      the  default  volume  slider is wiggled back and forth under
  430.      Solaris 2.  (The Sun bug ID is 1097908.)
  431.  
  432.      Sections aren't displayed properly in the Goodies popup when
  433.      the Start and End buttons are used.
  434.  
  435.      There is no way to choose a playlist other  than  the  first
  436.      one as the default.
  437.  
  438.      Some of the options and environment variables should be done
  439.      with X resources or a properties sheet.
  440.  
  441.      The database should have an index of some sort  for  quickly
  442.      looking  up  CDs,  since the current linear search can get a
  443.      little slow on big databases.
  444.  
  445.      Interaction with data CDs, especially ones that are  mounted
  446.      as  filesystems,  is  spotty  at  best.   The program should
  447.      unmount a CD before ejecting it.
  448.  
  449.      The CD Info  popup's  interaction  with  mouseless  mode  is
  450.      annoying.
  451.  
  452.      The program's name is a pretty moronic pun.
  453.  
  454. AUTHOR
  455.      Steven  Grimm  (koreth@hyperion.com).   Feel  free  to  send
  456.  
  457.  
  458.  
  459. Sun Release 4.1       Last change: 11/15/92                     7
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466. workman(1)               USER COMMANDS                 workman(1)
  467.  
  468.  
  469.  
  470.      comments, criticisms, suggestions, or unadulterated praise.
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525. Sun Release 4.1       Last change: 11/15/92                     8
  526.  
  527.  
  528.  
  529.