home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD5.iso / workbench / libs / rexmooslib.lha / MOOS / Docs / english / rexx_exec.doc < prev    next >
Encoding:
Text File  |  1997-02-03  |  3.8 KB  |  172 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. --background--
  6. rexx_exec.library/AvailMem
  7. rexx_exec.library/FlushMem
  8. rexx_exec.library/ReBoot
  9.  
  10.  
  11. --background--                                                  --background--
  12.  
  13.  $(C): (1996, Rocco Coluccelli, Bologna)
  14.  $VER: rexx_exec.library 37.00 (30.01.97)
  15.  
  16.     rexx_exec.library
  17.  
  18.     This sub-library of the rexxMOOS.library let ARexx programmers
  19.     use some function from the system exec.library
  20.  
  21.         AvailMem()
  22.         FlushMem()
  23.         ReBoot()
  24.  
  25.     NOTES
  26.  
  27.         Is part of the MOOS package.
  28.  
  29.     TODO
  30.  
  31.     BUGS
  32.  
  33. rexx_exec.library/AvailMem                          rexx_exec.library/AvailMem
  34.  
  35.     NAME
  36.  
  37.         AvailMem -- Returns information about the available memory.
  38.  
  39.     SYNOPSIS
  40.  
  41.         size = AvailMem(options)
  42.  
  43.     FUNCTION
  44.  
  45.         Use this function to know how much memory is currently
  46.         available in the system or to returns the largest free block
  47.         of memory, according with any class of memory (see below).
  48.  
  49.     INPUTS
  50.  
  51.             options - "Flags/N,Outstem,Largest=L/S"
  52.  
  53.                 "Flags"   - A bit mask to select which value we need
  54.                             to be returned:
  55.  
  56.                                 Mem_Any      = 0
  57.                                 Mem_Public   = 1
  58.                                 Mem_Chip     = 2
  59.                                 Mem_Fast     = 4
  60.                                 Mem_Local    = 128
  61.                                 Mem_24bitdma = 256
  62.                                 Mem_Kick     = 512
  63.  
  64.                 "Outstem" - The function may fill a given stem with values
  65.                             of the available memory:
  66.  
  67.                                 <stem.>Mem_Any
  68.                                     Any type of memory
  69.  
  70.                                 <stem.>Mem_Public
  71.  
  72.                                 <stem.>Mem_Chip
  73.  
  74.                                 <stem.>Mem_Fast
  75.  
  76.                                 <stem.>Mem_Local
  77.                                     Memory that does not go away at RESET
  78.  
  79.                                 <stem.>Mem_24bitdma
  80.                                     Memory within 24 bits of address and
  81.                                     usable in DMA mode.
  82.  
  83.                                 <stem.>Mem_Kick
  84.                                     Memory that can be used for KickTags
  85.  
  86.                 "Largest" - Instead of return the total size of memory
  87.                             available, the function can return the largest
  88.                             contiguous block of free mem.
  89.  
  90.     RESULT
  91.  
  92.         The total size of available memory in the classes specified with
  93.         flags, or the largest block size specifying the "Largest" option.
  94.  
  95.     EXAMPLE
  96.  
  97.         SAY AvailMem()
  98.  
  99.     NOTES
  100.  
  101.         Due to the effect of multitasking, the value returned may not
  102.         actually be the amount of free memory available at that instant.
  103.  
  104.     SEE ALSO
  105.  
  106.         exec.library/AvailMem(), exec.library/AllocMem()
  107.  
  108. rexx_exec.library/FlushMem                          rexx_exec.library/FlushMem
  109.  
  110.     NAME
  111.  
  112.         FlushMem -- Flush all class of memory.
  113.  
  114.     SYNOPSIS
  115.  
  116.         FlushMem()
  117.  
  118.     FUNCTION
  119.  
  120.         Force the system for freeing all un-needed memory.
  121.  
  122.     INPUTS
  123.  
  124.     RESULT
  125.  
  126.     EXAMPLE
  127.  
  128.         CALL FlushMem()
  129.  
  130.     NOTES
  131.  
  132.     SEE ALSO
  133.  
  134.         exec.library/AllocMem()
  135.  
  136. rexx_exec.library/ReBoot                              rexx_exec.library/ReBoot
  137.  
  138.     NAME
  139.  
  140.         ReBoot -- Reboot the Amiga.
  141.  
  142.     SYNOPSIS
  143.  
  144.         ReBoot()
  145.  
  146.     FUNCTION
  147.  
  148.         Reboot the machine.  All external memory and periperals will be
  149.         RESET, and the machine will start its power up diagnostics.
  150.         This function never returns.
  151.  
  152.     INPUTS
  153.  
  154.         All that we wants.
  155.  
  156.     RESULT
  157.  
  158.         An altogether totally integrated living system.
  159.  
  160.     EXAMPLE
  161.  
  162.         SAY "Bye, bye..."
  163.         CALL ReBoot()
  164.  
  165.     NOTES
  166.  
  167.     SEE ALSO
  168.  
  169.         exec.library/ColdReboot()
  170.  
  171.  
  172.