home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / diagutil / mm42s.zip / MM.DOC < prev    next >
Text File  |  1993-09-05  |  11KB  |  306 lines
  1. Memory Map (MM) v4.2S Documentation (Shareware Version)
  2. Copyright (c) 1992-1993 Andrew Powell
  3.  
  4. Features
  5. ────────
  6.  
  7.         ■ Displays Location of Master Environment
  8.         ■ Help Screen
  9.         ■ Auto Configuration from Environment    ** Registerd Version Only **
  10.         ■ 'Easy' Mode Available                  ** Registerd Version Only **
  11.         ■ Automatically Pauses Between Pages
  12.         ■ Reports Total and Free Memory
  13.         ■ Will Run Under MS-Windows(r)
  14.         ■ Fast
  15.         ■ Optional Display of DOS v5.0 UMB Usage ** Registerd Version Only **
  16.         ■ Optional Display of Upper Memory Blocks
  17.         ■ Optional Display of Device Driver Chain
  18.         ■ Optional Display of Current Environment
  19.         ■ Optional Display of Master Environment ** Registerd Version Only **
  20.  
  21. The following documentation is based on this shareware version!!
  22.  
  23. Command-Line
  24. ────────────
  25.  
  26.         If you run MM without any options on the command line you will
  27.         get the default display. The default display with no command 
  28.         line options and no environment variable is a fairly technical 
  29.         display of the contents of memory. Below is a list of all the 
  30.         command line options. You can also get this list by running MM 
  31.         with the /? as follows:
  32.  
  33.                         MM /?
  34.  
  35.         Here is a list of all the available options in this shareware
  36.         version:
  37.  
  38.         Option          What it does
  39.  
  40.         /d              List Device Drivers
  41.         /ec             Display Current Environment
  42.         /b              Show DOS v5.0+ Upper Memory Blocks
  43.         /?              Help List
  44.  
  45.         Examples:
  46.  
  47.         - To see a list of installed device drivers type:
  48.  
  49.                         MM /d
  50.  
  51.         - To see a the current environment type:
  52.  
  53.                         MM /ec
  54.  
  55. The Display
  56. ───────────
  57.  
  58.         When you run MM without any parameters you get a list of all the 
  59.         Memory Control Blocks (MCBs) and relevant information. You also get 
  60.         the amount free memory and whether UMBs are used (even if not 
  61.         displayed). The top of the display looks like this:
  62.  
  63.         Total DOS Memory  xxxK                  DOS version: m.mm
  64.         Free Memory       yyyK                  DOS 5+ UMBs: [Yes/No]
  65.         EBDA Allocated    [No/Yes sizeK]        Processor: [pro. type]
  66.  
  67.         Total DOS Memory
  68.         ────────────────
  69.  
  70.                 The total amount of Low (below 640K) memory. This field is
  71.                 usually 640K but can be lower on some IBM PS/2 models because 
  72.                 of the Extended BIOS Data Area (EBDA). This is an area of
  73.                 memory used to store some configuration infomation for the
  74.                 BIOS. This area can be as little as 1K and usually sits at
  75.                 the top of memory (This will not show up on the memory list.)
  76.  
  77.         Free Memory
  78.         ───────────
  79.  
  80.                 The largest available memory block, i.e. The largest
  81.                 executable program size. This is the maximum amount of
  82.                 memory a program can use. It is usually about 550K, but 
  83.                 with modern memory managers (like 386MAX, QEMM) the 
  84.                 amount of free memory can be about 618K.
  85.  
  86.         DOS Version
  87.         ───────────
  88.  
  89.                 The DOS version currently running. This is cannot be 
  90.                 changed by the DOS 5+ SETVER program.
  91.  
  92.         DOS 5+ UMBs
  93.         ───────────
  94.  
  95.                 Reports whether UMBs are available for use regardless
  96.                 wether the are displayed.
  97.  
  98.         EBDA Allocated
  99.         ──────────────
  100.  
  101.                 If this field shows Yes the Extended BIOS Data Area (EBDA)
  102.                 is allocated the size size in kilobytes is also shown. The 
  103.                 field is No, if the EBDA is not allocated. For more
  104.                 infomation see the section Total DOS Memory.
  105.  
  106.         Processor Type
  107.         ──────────────
  108.  
  109.                 This field is the processor type. The processor is the
  110.                 main microchip in the computer. It controls the entire
  111.                 computer and carries out all program execution and
  112.                 arithmetic. The types this program can detect are as
  113.                 follows:
  114.  
  115.                         Intel 8088
  116.                         Intel 8086
  117.                         NEC V20
  118.                         NEC V30
  119.                         Intel 80188
  120.                         Intel 80186
  121.                         Intel 80286
  122.                         Intel 80386SX
  123.                         Intel 80386DX
  124.                         Intel 80486
  125.  
  126.         The memory status display shows infomation an the Memory
  127.         Control Blocks (MCBs). Memory is split into blocks, each
  128.         block in owned by a program. The MCB holds infomation
  129.         about the block and the name of the program which ownes
  130.         it. Each field of the memory status display is outlined below.
  131.  
  132.         MCB
  133.         ───
  134.  
  135.                 The segment in memory of the MCB. PC Memory is split
  136.                 into 64K segments. The first segment starts at
  137.                 absolute address 0. This is written in Segment:Offset
  138.                 form as 0:0. From then a new segment begins at each
  139.                 16 byte interval. There are A000h (40960) segments
  140.                 in the 640K low memory. An MCB begins at Seg:0.
  141.  
  142.         PSP
  143.         ───
  144.  
  145.                 The Program Segment Prefix (PSP) that owns the MCB.
  146.                 A PSP is a 256 byte block that contains infomation
  147.                 about a program in memory.
  148.  
  149.         Parent
  150.         ──────
  151.  
  152.                 The Parent PSP of the PSP that owns the MCB. The parent
  153.                 PSP is usually the PSP of the program that executed the
  154.                 owner of the current MCB. The DOS shell, i.e. COMMAND.COM
  155.                 is its own parent.
  156.  
  157.         Size
  158.         ────
  159.  
  160.                 The size in bytes of the area that the MCB controls.
  161.  
  162.         Env.
  163.         ────
  164.  
  165.                 If this field is blank, this is not the MCB of an 
  166.                 environment.
  167.                 If this field has one box '■' in it, it is an MCB 
  168.                 that controls an environment.
  169.                 If this field has two boxes '■■' in it, it is the MCB 
  170.                 that controls the master environment. The master environment
  171.                 is the environment of the current primary command
  172.                 interpreter. This routine will fail if you load another 
  173.                 copy of COMMNAD with the /P (primary) switch. The Master
  174.                 Environment is not shown in Easy mode.
  175.                 
  176.         Owner
  177.         ─────
  178.  
  179.                 The name of the program that owns the MCB with the
  180.                 following exceptions:
  181.  
  182.                 <DOS Shell> is the command interpreter, usually COMMAND.COM
  183.                 <DOS Kernel> is MSDOS.SYS (or IBMDOS.COM)
  184.                 <Free> is a free block
  185.                 <N/A> means the name cannot be determined
  186.  
  187.         Hooked Interrupts
  188.         ─────────────────
  189.  
  190.                 This is a list of all the interrupts that point into
  191.                 the area controlled by the MCB.  
  192.  
  193.         Command Line  ** Registed Version Only **
  194.         ────────────
  195.  
  196.                 The command line of the program as it was run.
  197.                 This is taken from the PSP. The command line might not 
  198.                 be available because DOS also puts the default DTA 
  199.                 (Disk Transfer Area) in the same place.
  200.  
  201. ** Easy Mode and UMB Usage are available in the Registerd Version Only **
  202.  
  203.         If MM is run in 'Easy' mode the display will be slightly different. 
  204.         It will show the PSP, Size, Env., Owner, Command Line, and some 
  205.         Hooked Interrupts. (See Hooked Interrupts section) If MM is run with 
  206.         the /u switch to show UMB Usage, the UMB Usage will follow on from 
  207.         the normal MCBs display in the same format.
  208.  
  209. Device Driver List
  210. ──────────────────
  211.  
  212.         This is shown using the /d switch
  213.  
  214.         A device driver is a program which provides standerdised access
  215.         to any perhiphial attached to the computer.
  216.  
  217.         Device Name
  218.         ───────────
  219.  
  220.                 If it is a character device driver it will display
  221.                 the name of the device driver. Otherwise, if it is
  222.                 a block device driver it will display the number of
  223.                 block devices (disk drives, CD-ROMs, etc.) it controls.
  224.  
  225.         High
  226.         ────
  227.  
  228.                 If the field is blank, the device driver is loaded in 
  229.                 low memory. (below 640K)
  230.                 If the field one box '■' in it, the device driver is 
  231.                 loaded in an UMB.
  232.  
  233. Upper Memory Blocks
  234. ───────────────────
  235.  
  236.         This shows the actual UMBs and their addresses in memory but
  237.         does not show their usage. You can only see their usage in
  238.         the registered version.
  239.  
  240.         Start
  241.         ─────
  242.  
  243.                 The Segment in memory where the UMB begins. For more
  244.                 infomation see section on MCBs
  245.  
  246.         Size
  247.         ────
  248.  
  249.                 The Size in bytes of the UMB.
  250.  
  251.         Type
  252.         ────
  253.  
  254.                 This can be either 'UMB' which means it is
  255.                 an Upper Memory Block, or 'SM' which means
  256.                 a gap between UMBs or a name, eg. COMPAQ
  257.                 for COMPAQ CEMM Memory Manager.
  258.  
  259. Environment [Current / Master] ** Master in Registerd Version Only **
  260. ──────────────────────────────
  261.  
  262.         This shows the current environment, which is the
  263.         environment used by the current program being executed
  264.         [This Program], or the master environment, which is
  265.         the environment of the <Dos Shell>.
  266.  
  267.         Env. Variable
  268.         ─────────────
  269.                                 
  270.                 The name of the environment variable.
  271.  
  272.         Contents
  273.         ────────
  274.  
  275.                 The contents of the environment variable.
  276.  
  277.  
  278. Return Codes
  279. ────────────
  280.  
  281.         These are numbers which can be detected by the DOS ERRORLEVEL
  282.         command. They return infomation about how the program ran.
  283.         In MM the return codes are as follows:
  284.  
  285.                 0 - The program run without any problems
  286.                 255 - Wrong DOS Version
  287.                 254 - A bad command line option
  288.                 253 - MM was loaded high (with DOS 5+ LOADHIGH command)
  289.                 252 - No Upper Memory Blocks (when using /b switch)
  290.  
  291.         To use these codes you make a batch file with a line as follows:
  292.  
  293.                 IF ERRORLEVEL == 252 THEN GOTO ERROR
  294.  
  295.         This means that if a number of 252 OR GREATER has been returned
  296.         goto the label ERROR.
  297.         A sample batch file has been included with this program called
  298.         MMRUN.BAT
  299.  
  300. Notes
  301. ─────
  302.  
  303.         This program is compressed with LZEXE v0.91
  304.  
  305. <END>
  306.