libdockapp: Fix for missing windowname and one more.
[dockapps.git] / ascd / ascd / ascd.man
blob29c0413de258c1b57967a8895d88fdbae74e33ac
1 .TH ascd 1 "17 may 1999" ascd
2 .UC
4 .SH NAME
6 \fBascd\fP \- An AfterStep and WindowMaker CD player
8 .SH SYNOPSIS
10 .B ascd
12 .BI \-help
14 .br
15 .B ascd
17 .BI \-version
19 .br
20 .B ascd
22 .BI \-themes
24 .br
25 .br
26 .B ascd
28 .BI \-geometry " geometry"
31 .BI \+/-withdrawn
34 .BI \-device " device"
37 .BI \-mixer " device"
40 .BI \+/-a
43 .BI \+/-p
46 .BI \+/-t
49 .BI \+/-B
52 .BI \-cue " time"
55 .BI \-ti " time"
58 .BI \-volume " volume"
61 .BI \-mvolume " volume"
64 .BI \-maxvolume " volume"
67 .BI \-minvolume " volume"
70 .BI \-fadestep " value"
73 .BI \-theme " theme directory"
76 .BI \+/-ia
79 .BI \+/-up
82 .BI \-showtitle
85 .BI \-showartist
88 .BI \-debug
91 .BI \-save
94 .SH DESCRIPTION
96 \fBascd\fP is CD player written to play audio CD's integrated in
97 afterstep's Wharf module or WindowMaker's dock.
98 \fBascd\fP handles mounted volumes, and opens and closes the tray.
100 .SH CONFIGURATION OPTIONS
102 .B -help, -h
103      print a list of commandline options and exit.
105 .B -version
107      print the version number and exit.
110 .B -themes
112      print the list of installed themes and exit.
114 .B -geometry <geom>
115      specifies the geometry of \fBascd\fP. The Geometry
116      works like the standard X-Window geometry option.
118 .B +/-withdrawn, +/-w
119     Turn on and off withdrawn mode. Use this option if
120     you use ascd with WindowMaker.
122 .B -device <device>
123      specifies the CDROM device which should be used by
124      ascd. If "-DNO_DEFAULT_DEVICE" was set at
125      compilation time this option will have no effect.
127 .B -mixer <device>
128      specifies the mixer device. Works only if mixer
129      support was enabled at compilation.
131 .B -cue <seconds>
132      specifies the time -in seconds- for \fBintro scan\fP
133      and \fBcue\fP modes.
135 .B -ti <seconds>
136      specifies the timeout for the help texts. The
137      default is 1 second.
139 .B +/-autoplay, +/-a
140      Turn on or off \fBautoplay mode\fP. When this is
141      turned on, ascd always wait for a CD, and play it
142      automatically when inserted.
144 .B +/-autoprobe, +/-p
145      Turn on or off \fBautoprobe mode\fP. This mode
146      checks for inserted CD. Default is on.
148 .B +/-autorepeat, +/-t
149      autorepeat mode: when ascd reaches the end of the
150      last track, the CD is not stopped and first track
151      is played.
153 .B +/-B
154      This option is no longer supported.
156 .B -maxvolume <value>
157      Set the CD driver max volume.
159 .B -minvolume <value>
160      Set the CD driver min volume.
162 .B -volume <value>
163      Set the CD driver volume, between 0 and maxvolume.
164      Note that the -volume option in independant from
165      the mixer. It controls the drive, not the sound
166      card.
168 .B -mvolume <value>
169      Set the CD driver volume for the mute mode.
171 .B -fadestep <value>
172      Set the fade in/out speed. Default is 5. Greater
173      values accelerate the fade.
175 .B -theme <theme dir>
176      Specify the visual theme to use.
178 .B +/-ia
179      When this option is enabled, AScd ignore the skip
180      orders found in WorkMan database and read all the
181      tracks of the CD.
183 .B +/-up
184      When enabled, all the message (and the track title
185      display) are forced in uppercase.
187 .B -showtitle
188      Show the track title if found in WorkMan database.
189      If the message panel is not large enough, AScd
190      scrolls the title.
192 .B -showartist
193      Add the artist name to the track title (-showtitle
194      option needed)
196 .B -debug
197      AScd verbose mode
199 .B -save
200      Save all the settings and exit. Usefull to 'make' a
201      new configuration file: set all the stuff you want
202      to set and put -save as last commandline option.
203      Example:
205      ascd +w +a -device /dev/cd0c -save
207      Then, you just call ascd without arguments, it will
208      use the settings you just saved.
210 .SH FILES
212 \fBascd\fP stores its settings in ~/.ascdrc.
214 The theme files are usually stored in /usr/local/share/AScd.
216 .SH INVOCATION
217 \fBascd\fP can be called from one of many ways.  The most common invocation
218 is the command line:
221         % ascd -device /dev/wcd0a +w +a &
224 With Afterstep, another way to call \fBascd\fP is from the window
225 manager:
228         *Wharf - - Swallow "ascd" ascd&
231 This line, when placed in the \fI.steprc\fP file in the users home directory
232 will cause \fBascd\fP to use the shape extensions so that it will be a
233 button on the \fBWharf (1)\fP button bar under the \fBafterstep (1)\fP
234 window manager.
236 .SH COPYRIGHTS
238 Copyright 1999, Rob Malda and Denis Bourez. No guarantees or
239 warranties or anything are provided or implied in any way whatsoever.
240 Use this program at your own risk. Permission to use this program for
241 any purpose is given, as long as the copyright is kept intact.
243 .SH AUTHORS
245 Denis Bourez <denis@rsn.fdn.fr>
246      application since 0.7
248 Rob Malda <malda@slashdot.org>
249      application until 0.6
251 Dirk Foersterling <milliByte@DeathsDoor.com>
252      WorkMan maintainer
254 Steven Grimm <koreth@Hyperion.COM>
255      WorkMan maintainer until 1.3
257 Erik O'Shaughnessy <eriko@austin.ibm.com>
258      AIX platform device driver
260 Michael Kurz <mkurz@rzws.fh-aalen.de>
261      changes and man page until 0.6
263 .SH MORE INFORMATION
265 <URL:http://worldserver.oleane.com/rsn/>
267 <URL:http://CmdrTaco.net/>