README
1$Id: README,v 1.3 2005/02/17 22:24:24 xi Exp $
2
3Introduction
4============
5simplemod is a minimalistic module player. It was designed to be used by a
6frontend and thus it's output is easy to parse.
7
8
9Usage
10=====
11 simplemod [-k position] [-e host] [-r] filename
12
13If a position is specified with the -k switch, the module will be played
14starting at that position.
15
16If a host is specified with the -e switch, simplemod will use the esound driver
17and connect to that host.
18
19If the -r switch is specified, simplemod will write raw output to stdout.
20
21Parsing the output
22==================
23The output from simplemod starts with a static banner followed by a line that
24starts with 'Title: ' followed bu the title stored inside the module.
25
26During playback lines on the form 'P:<seconds>,<position> <some blanks>'
27are written to stderr and all ending with a carriage return.
28
29The field containing seconds is always 5 characters wide.
30
31Credits
32=======
33Lots of credits to the guys who wrote the mikmod library for making it
34incredibly easy to write this small program.
35
36Enjoy!
37
38Christian Laursen
39xi@borderworlds.dk
40