------------------------------------
        PMM v2.00   by Iita

           User's Manual
------------------------------------

===============
= Description =
===============

 PMM is a utility to view the contents of a compressed archive in LZH or PMA
 format. It can also decompress, delete, verify, or even create a
 self-extracting archive of files in the archive.


= Minimum system requirements =

 - MSX2 with 128kB VRAM and 128kB RAM
 - A mouse (optional)
 - MSX-DOS2

 Note: PMM can not handle archives with long file names. These can cause bugs.

=======
= Use =
=======

 Enter the following command from a DOS command line.

	A>PMM <Drive:><Path\><Name.Ext> </Options>

	<Drive:> is the name of the source disk (A: to H:). (optional)

	<Path\> is the path of source file. (optional)
	
	<Name.Ext> is the name of the command to which the configuration is
	           to be applied.

	</Options> can be one or more of the following options.
	
		/in	interlaced mode (n = 0 for OFF, 1 for ON)
		/Mn	Mouse (n = 0 if none, 1 for port 1, 2 for port 2)
		/2	Force display on 25 lines
		/3	Forces the display on 30 lines
		/Ln	Language (n = 0 for Japanese, 1 for English)
		/Vn	Kanji-ROM (n = 0 for MSXView, 1 for Standard)
		/Rn	Reserve a page of the Memory Mapper (1 = No)

	eg: PMM ZAP94-F.PMA

=============================================
= Installation and external commands needed =
=============================================

 To work PMM needs the following utilities to decompress the archives.
 
 - PMext (by PepperMint and Star)
 - LHrd (by H.Saito)
 - LHEXT (by Kyouju)

 As well as text editor, a text viewer, and a compression software.

 You will also need CS v3.10 or niewer (by Iita) to configure PMM.

 Copy these files at the root of the folders or in folders specified in the
 DOS2 PATH command.

=================
= Key functions =
=================

Main screen:

 [F1]/[?]	Display of the help menu. Functions can be called from this
                menu with the mouse.

 [F2]/[V]	View the selected text file.

 [F3]/[E]	Edit the selected text file.

 [F4]/[D]	Delete the selected file or those marked.

 [F5]/[U]	Unpack the selected file or the marked ones.

 [S]		Create a self-unpacking archive (PMA).

 [C]		Check the selected file or those marked.

 [ESC]		Quit PMM.

 [Q]		Quit directly PMM.

 [BS]		Move the cursor to the top/bottom of the list.

 [TAB]/[SPACE]	Mark the selected file.

 [HOME]		Mark or not all files.

 [CTRL]/[SHIFT]+[HOME]
		Reverse the marks.

 [X]		Allows execution of a MSX-DOS command.

 [H]		Quit PMM and back directly to the DOS.


Folder tree screen:

 [Up]/[Down]	Move the cursor to the up/down.

 [Left]/[Right]	Move the cursor to the left/right.
 
 [0]~[7]	Change destination disk. The folder tree of the corresponding
		disk will be displayed.

 [F]		Enable/Disable the display of the file names of the selected
		folder.

 [L]		Change destination disk. After pressing [L], press a key from
		[A] to [H] to select the disk, then press [Return]. The folder
		tree of the corresponding disk will be displayed.

 [W]		Write the data of the folder tree. The filename in which the
		data is written is specified in the PMM.CFG configuration
		file (at the parameter "treefile".) When the data has been
		saved, the folder tree is displayed faster. However, you must
		make sure to update this file each time you create or delete
		a folder.

 [SHIFT]+[Letter]
		Move the cursor to the next file whose name begins with the
		same letter.

 [ESC]		Quit the folder tree.

==============================
= Environment variables used =
==============================

 PMM	Specify parameters PMM at start. This variable is useful if you always
	start PMM with the same parameters because it avoids you to specify
	them each time in the command line. Parameters entered via the command
	line take precedence over those specified in the environment variable.

 TEMP	Drive and working file. If TEMP is not set, the TMP folder will be
	selected, otherwise it will be the player and the current folder.
	You can specify a fast drive such as a RAMDISK for example.

 DATE	This variable is used to display the date.

 TIME	This variable is used to display the time.

 PATH	This variable is used to retrieve external commands.

=================
= Configuration =
=================

 To configure PMM for your use, CS software by Iita is required.

Method:

 First, the CS.COM, PMM.COM, PMM.CFG files must be in the same folder. (You
 can specify the folder where CS.COM is located using the PATH command.)

 1 - Load PMM.CFG in a text editor
 2 - Modify PMM.CFG according to your wishes
 3 - Save PMM.CFG
 4 - Enter CS PMM[Return] in a command line

 Thus, PMM.COM is modified with the specified configuration.
 (To do this you need some free memory on the disk).

 To edit the configuration file, there are some rules to follow. For more
 details, please see the PMM.CFG file and the CS.COM documentation.

===============================================
= Description of the configuration parameters =
===============================================

 Here is the list of available parameters with the function of each one.

 The following parameters allow each to define an external command to be thrown
 whose function must correspond to what is indicated in the right column.

 editor		External commands to launch to text editor.

 pager		External commands to launch to text viewer.

 pma_extract	External commands to launch to unpack the files of an
		archive in the format -pm? -.
 pma_pack	External commands to launch to create an archive in the
		format -pm? -.
 pma_delete	External commands to launch to delete files from an archive in
		the format -pm? -.

 lzh_extract	External commands to launch to unpack the files of an
		format archive in the format -lh?-.
 lzh_pack	External commands to launch to create an archive in the
		format -lh?-.
 lzh_delete	External commands to launch to delete files from an archive in
		the format -lh?-.
 
 lh5_extract	External commands to launch to unpack the files of an
		archive -lh5-, -lh6- or lh7-.
 lh5_pack	External commands to launch to create an archive in the
		format -lh5-, -lh6- or lh7-.

 pma_crccheck	Check the files of an archive in pma format.
 lzh_crccheck	Check the files of an archive in lzh format.

 make_sfx	External commands to launch to create an archive in SFX
		format (auto-decompressable).

 ankfontfile	File name of the 8x8 character set to use. The format must
		be the same as those for MultiMente. (File of 1793 bytes
		containing data of the characters 32 to 255.)

 red		Red level of palette of the background color.
 green		Green level of palette of the background color.
 blue		Blue level of palette of the background color.
 
 markchr	Character used to mark files. (The arrow by default.)

 hisfile	Name of the file containing the history of the commands entered.
 phsfile	Name of the file containing the history of the folder paths.

 treefile	Name of the file containing the folder tree.
 
 short_msg	Set 1 to display simplified messages from PMM instead of those
		of the unpack tools when several files are marked. When this
		option is enabled, the tool messages are returned to a NULL
		device so no more messages are displayed. Keep this in mind
		if a error occurs when decompressing.
 
 lower		Set 1 to display the name of the files in lowercase.
 
 interlace_mode
 		Set 1 to display the PMM screen in interlaced mode.

 key_click	Set 1 to enable the clicking of keys.

 tree_fdisp	Set 1 to display the filenames into the frame of folder tree.
		You can also enable/disable the display of file names by
		pressing [F] key when the tree is displayed.

 nouse_mapper	PMM stores internal data on a page of the Memory Mapper when
		an external command is executed. This speeds up the return
		after running a child-process. However, you can choose not to
		use this page to preserve memory by setting this parameter to 1.

 nouse_viewfont
		When a Kanji-ROM for MSX View is detected, it is selected
		automatically. Set 1 to force the selection of the standard
		Kanji-ROM.

 use_mouse	Put 1 or 2 if you want to use a mouse connected to port 1 or 2.

 language	Put 0 to have the PMM messages in Japanese, 1 to have them in
		English.

 30		Set 1 to display the filenames on 30 lines instead of 25. Some
		Kanji can become difficult in 30-line mode.

===========================================
= Define a command based on the extension =
===========================================

 PMM can execute a command based on the extension of the selected file name.
 To do this, you must specify the extension and command to run in the
 configuration file (PMM.CFG) on a line as follows.

 Example :
 
 .MAG    = MAG $B
 
 The first character must be a point ".". Then write the extension (1 to 3
 characters) then the equal character "=" followed by the command to execute.
 Tabs and spaces before and after the equal separator (=) are ignored.

 The wildcards (* and?) Are used to define the extension.
 (One wildcard per extension.)

 Example :
 
 .SC?    = BLS $B
 
 This example displays images whose extension begins with "SC" with BLS.COM.

===========================================
= MACROs usable in the configuration file =
===========================================

 PMM has Macros to replace different strings such as file names to uncompress.
 A MACRO is represented by a letter preceded by a dollar character ($).
 Note that they must be written all uppercase (but lowercase macros could be
 added later).

 $A	Names of the drive and the file of the archive  (eg A:ARC.PMA)
 $B	Names of drive and file at cursor (eg A:FILENAME.EXT)
 $C	File name at cursor (with extension)
 $D	Working drive (The same as that of the TEMP variable)
 $E	Names of the drive, folder and archive file (eg A:\DIR\ARC.PMA)
 $F	Name of the destination drive
 $G	Name of the archive file (without extension)
 $H	Name of the archive drive (eg A:)
 $I	Name of the drive and destination folder
 $K	Waiting for a keypress after executing a command
 $N	Name of the drive and the current folder at the start of PMM
 $O	Current drive at the start of PMM
 $P	Folder path of the archive (without the drive name)
 $R	Next line (Used to execute an additional command)
 $S	Name of file at cursor (without extension)
 $$ =	Entry of "$"

===================================
= Rules of use & responsibilities =
===================================

 MM is free software. Iita holds the copyrights.

 Only free distribution is allowed.

 I am not responsible for any problems or damage caused during
 the use of PMM. Do some testing before using this version.

=============
= Feedbacks =
=============

 Make your comments on MRC (http://www.msx.org).
 
-----------------------------------------------------------------------------
 Traduction by gdx.