home *** CD-ROM | disk | FTP | other *** search
/ Audio 4.94 - Over 11,000 Files / audio-11000.iso / msdos / modplay / qml11 / qml.doc < prev    next >
Text File  |  1993-10-25  |  3KB  |  89 lines
  1. Quadri's Mod Lister
  2.  
  3. Version 1.1
  4.  
  5. (c) Yossi Zinger, 1993
  6.  
  7. Description
  8. ===========
  9. Quadri's Mod Lister (QML) is a small utility for creating mod files list. 
  10. The list format is configurable.
  11. QML identify .MOD files, with 4/6/8 tracks and 15/31 instruments.
  12. It can display the file's name,size,date and time, and 
  13. the mod's name and type.
  14.  
  15. Running QML
  16. ===========
  17. The command line is:
  18. QML [<list_file_name>]
  19. If run without parameters, the list will be created in a file 
  20. called MOD.LST.
  21.  
  22. Keys while running
  23. ==================
  24. Pressing the Esc key will return immediatly to DOS.
  25. Pressing any other key will skip to the next directory, or return to DOS
  26. if you're in the last directory.
  27. In any case, the word "stopped" will be written to the list to indicate
  28. the search was not stopped by the user.
  29.  
  30. Configuring QML
  31. ============================
  32. The configuration file is called (surprise surprise...) QML.CFG. 
  33. Comments lines begins with a semicolon.
  34. the following elements can be configured:
  35. * The directories in which QML will search mod files.
  36.   the line format:  DIR = <pathname>.
  37.   QML supports up to 10 directories.
  38. * The format of a line in the list.
  39.   QML can list 6 fields for each mod file:
  40.   FILE_NAME  - the name of the mod file.
  41.   FILE_SIZE  - the size of the mod file.
  42.   FILE_DATE  - the date of the mod file.
  43.   FILE_TIME  - the time of the mod file.
  44.   MOD_NAME   - the name of the mod.
  45.   MOD_TYPE   - the type of the mod: 4/6/8 tracks, 15/31 insturments.
  46.   For each field, the config file should include the following line:
  47.   <field_name> = On | Off
  48.   On means include this field on the list. 
  49.   Off means not include this field.
  50.   Fields missing from the config file are not included in the list.
  51.   The order of these field in the config file is their order in the list.
  52. * Another field is SIZE_IN_KB. Turning this field on will cause
  53.   QML to print the file size in KB, and not in bytes (the default).
  54.   It has no effect if the FILE_SIZE field is off.
  55. * The list header.
  56.   To add a header to the list, add this line to QML.CFG:
  57.   HEADER = <header>.
  58.   to remove this option, simply delete this line, or put a semicolon in 
  59.   front of it.
  60. * The list summaries.
  61.   You can turn on or off these two options:
  62.   TOTAL_DIR - when on, QML will add to the list the number of file processed 
  63.   for each directory. 
  64.   TOTAL_LIST - when on, QML will add to the list the total number of file 
  65.   processed.
  66.  
  67. NOTE: QML.CFG must be at the same directory as QML.EXE.
  68.  
  69. Future Features
  70. ===============
  71. - NST,STM,669,S3M and AMF Support
  72. - List number of patterns
  73. - Estimated playing time
  74. - Search inside ZIP/ARJ/LZH 
  75. - Sort the list
  76.  
  77. Send any comment, suggestions, requests etc. to :
  78.  
  79. * Internet: 
  80.   quadri@libra.math.tau.ac.il (until July 1994)
  81.  
  82. * Snail-Mail:
  83.   Yossi Zinger
  84.   Toledano 11 Petah Tikva
  85.   49501
  86.   Israel
  87.  
  88.  
  89.