home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 1 / FishNMoreVol1.bin / more / misc_utils / kramden / kramden.doc < prev    next >
Text File  |  1990-09-10  |  11KB  |  321 lines

  1. Kramden Utilities
  2. =================
  3.  
  4. NOTE: These utilities can only be used from CLI.  We have provided a
  5. CLI Icon for your convenience on this disk.
  6.  
  7. v2.0 - 10-Sep-89
  8.  
  9. This is the latest installment of the Kramden Utilities.  The original
  10. release of these tools were inspired (if not directly ripped off) from a
  11. certain set of hitherto unnamed MS-DOS utilities that have been known to
  12. be real _life_savers_.    This new release contains utilities that are
  13. more of a departure from the original plan (i.e. to release a set of
  14. tools similar to the MS-DOS tools) since they have no counterpart in the
  15. MS-DOS world.
  16.  
  17. New for this version:
  18.     . new utilities
  19.     . Clk        - yet another title bar clock (based on Mike Meyer's
  20.               mclk)
  21.     . Meter     - yet another memory meter (sort of based on GfxMem)
  22.     . SetCon    - allows you to modify a shell window's size,
  23.               position, and font.
  24.     . Stat        - a system status utility that lists tasks, fonts,
  25.               libraries, devices, resources, etc.
  26.  
  27.     . propaz.font - a proportional version of topaz.
  28.  
  29.     . revisions to original Kramden utilities
  30.     . FF - new display modes
  31.     . SI - new information and format
  32.  
  33.     . the correct spelling of Kramden (used to be Cramden) thanks to TV
  34.       Guide
  35.  
  36. All of the utilities use Arp release 3 (v39 of arp.library must be in
  37. your LIBS: directory).    If you don't have Arp release 3 you can probably
  38. get it from wherever you got this file.
  39.  
  40.  
  41. Utilities
  42. =========
  43.  
  44. Clk - Title Bar Clock
  45. ---------------------
  46.  
  47. This program displays a clock in a window in the Workbench title bar
  48. just to the left of the screen depth gadgets.  It bases its position on
  49. the actual size of the Workbench screen (for MoreRows users).
  50.  
  51.     syntax:
  52.     Clk
  53.  
  54. This program is based on Mike Meyer's mclk program.  It now
  55. self-detaches and displays only date and time (memory display was
  56. removed).
  57.  
  58.  
  59. FF - Find Files
  60. ---------------
  61.  
  62. This utility is used to find files with a particular file name or pattern
  63. in any directory on a disk.
  64.  
  65.     syntax:
  66.     ff <filespec>... [Short|Quick]
  67.  
  68.     <filespec> - any AmigaDOS (Arp actually) wild card pattern
  69.     Short       - lists files like "Dir all"
  70.     Quick       - makes a listings suitable for using with "Zoo aI"
  71.  
  72.     examples:
  73.     ff
  74.     ff *.c
  75.     ff sys:*.info
  76.     ff include:#?.(h|i) *.[hi] quick
  77.     ff quick | zoo aI ram:foo
  78.  
  79. Example 1 lists all the files starting at the current directory and
  80. proceeding through all subdirectories.    Example 2 lists all files that
  81. are suffixed by .c (like a.c, ff.c, etc) in the current directory and
  82. all subdirectories.  Example 3 finds all icon files on the volume named
  83. "sys:".  Example 4 lists all files suffixed .h or .i on include: and in
  84. the current directory and all subdirectories respectively.  This example
  85. also shows a couple of Arp synonyms for AmigaDOS wild cards.  Example 5
  86. shows how to collect the contents of the current directory and all subs
  87. into ram:foo.zoo.  This example requires using a shell that supports
  88. piping (like the Arp ASH).
  89.  
  90. NOTE:  Real sorry about the name conflict between this and Charlie
  91. Heath's FastFonts utility (now found on Workbench v1.3 disks).  I don't
  92. plan to change this since chances are you'll run this more frequently
  93. than FastFonts.  I therefore recommend that you rename the FastFonts
  94. "FF" to "FastFonts" (and fix your startup-sequence) prior to installing
  95. the Kramden FF in your command directory.
  96.  
  97.  
  98. Meter - Memory Meter
  99. --------------------
  100.  
  101. This memory meter displays a bar graph in a window in the upper left
  102. corner of the Workbench screen.
  103.  
  104.     syntax:
  105.     Meter
  106.  
  107. This program self-detaches.  If propaz.font/8 is in the current FONTS:
  108. directory, Meter will use it.  Otherwise topaz.font/8 is used.
  109.  
  110. This program is sort of based on GfxMem but vastly improved (at least
  111. from the code standpoint).
  112.  
  113.  
  114. SetCon - Set Console
  115. --------------------
  116.  
  117. This program allows the user to sets the dimensions and font used by a
  118. shell console window.
  119.  
  120.     syntax:
  121.     SetCon [left top width height] [Relative]
  122.            [Font name/size] [Report]
  123.  
  124.     left, top, width, height
  125.             - New dimensions for the console window.
  126.     Relative    - Indicates that dimensions specified are
  127.               relative to the current window dimensions.
  128.     Font name/size    - Permits a new font to be used within the
  129.               console window (topaz.font/11 for example).
  130.     Report        - Forces displaying the current console
  131.               settings.  When no other arguments are
  132.               present, this happens by default.
  133.  
  134.     examples:
  135.     SetCon        - reports the current shell console settings
  136.  
  137.     SetCon 0 20 328 80
  138.             - makes the shell console window a small window
  139.               in the upper left corner of the screen.
  140.  
  141.     SetCon font topaz/11
  142.             - sets the current shell font to topaz.font/11.
  143.  
  144. The font management is sort of a kludge.  The font opened by SetCon will
  145. never be closed (use "Stat fonts" to see open count).  If you place a
  146. SetCon command in your shell-startup file that always use the same font,
  147. this shortcoming won't cause much trouble since only one instance of the
  148. font will reside in memory.
  149.  
  150.  
  151. SI - System Info
  152. ----------------
  153.  
  154. This can be used to get a quick spec sheet on your Amiga.  It tells you
  155. things like operating system version number, 68xxx chips in your
  156. machine, video mode, memory configuration, and computing performance
  157. index (my favorite).
  158.  
  159.     syntax:
  160.     si
  161.  
  162. The display sizes and pixel aspect ratio are printed X x Y and X:Y
  163. respectively.  The pixel aspect ratio is based on the Dot/Meter values
  164. found in GfxBase and differ between NTSC and PAL machines.  For NTSC
  165. machines this value is 1:1.166 which means that the pixels are just a
  166. little taller than they are wide.
  167.  
  168. The Maximum Display Size horizontal value might look a bit high (I get
  169. 466).  According to the doc's on GfxBase (where this value comes from)
  170. this value has to do with the dot clock and isn't terribly meaningful to
  171. anyone else. This number is in lo-res such that comparing this value to
  172. the normal lo-res screen width of 320 or overscan width of 352 gives an
  173. estimate of the width of the horizontal blank area.  This number changes
  174. to a slightly more reasonable value with 1.4.
  175.  
  176. In the MS-DOS world the computing performance index is often used to
  177. compare PC clones with one another.  The Amiga version of SI contains
  178. two performance index tests.  The first is calculated using integer math
  179. operations which is affected mainly by CPU & memory access speed.  The
  180. second is calculated using floating point math operations and is
  181. therefore affected by all of the above and the presence of a math
  182. coprocessor or periperal chip.    For each test your Amiga is tested
  183. against times for a stock Amiga 1000 (see below for actual benchmark
  184. conditions) and a stock IBM/XT (the Integer test is the very same number
  185. used in MS-DOS circles and is fairly accurate).  Essentially these
  186. numbers tell you how many times the computing power your computer has
  187. over a stock Amiga 1000 and stock IBM/XT.
  188.  
  189. Disclaimers:  The Floating Point test results relative to IBM/XT is an
  190. approximation using similar (but not exact) code on an MS-DOS machine.
  191. The reason that I couldn't duplicate the code is that this test on the
  192. Amiga uses mathieeedoubbas.library which doesn't have any real
  193. counterpart on my MS-DOS machine, so I had to rely on my MS-DOS C
  194. compiler's math library to perform the operations.  I have no way of
  195. checking the relative efficiency in order to cancel it out of the
  196. performance index.
  197.  
  198. Also the integer index is easily fooled by instruction caches such that
  199. it will give a higher than accurate result for processors like a 68020
  200. and 68030.
  201.  
  202. Be aware that the computing performance tests are VERY sensitive to your
  203. current task loading.  This is intentional.  I could have Forbidden around
  204. the timing code section, but this way you can see the effects of task
  205. loading.  If you've got a bunch of other stuff running on your Amiga at the
  206. same time that you run SI, the performance of the task running SI will
  207. probably be lower than if it had the whole machine to itself (depending on
  208. relative task priorities).  In fact, if you run SI in two different CLI's
  209. with the same task priority, the performance index values returned should
  210. be exactly half of the values obtained when only one instance is running.
  211.  
  212. Incidentally, if anyone knows how to detect things like Amiga model
  213. number, or anything else that seems to be missing, please let me know.
  214.  
  215.  
  216. Stat - System Status
  217. --------------------
  218.  
  219. This program reports the contents of a number of system lists.
  220.  
  221.     syntax:
  222.     stat [opts] [Sort|Pri] [CIA] [CLI] [Devs] [Fonts] [Libs]
  223.          [Misc] [Ports] [Res=Resources] [Sem=Semaphores] [Tasks]
  224.  
  225.  
  226.     opts    - a list of single character shorthands for the other
  227.           status keywords (listed below).
  228.  
  229.  
  230.     Sort keywords:
  231.         Sort    - lists are sorted by name.
  232.         Pri     - lists are sorted by priority.
  233.         none    - lists are sorted by address.
  234.  
  235.     List keywords:
  236.  
  237.         key        opt report
  238.         ---        --- ------
  239.         CIA        CIA allocations
  240.         CLI     c  CLI's
  241.         Devs    d  Devices
  242.         Fonts    f  Fonts
  243.         Libs    l  Libraries
  244.         Misc       misc.resource allocation
  245.         Ports    p  Public message ports
  246.         Resources    r  Resources
  247.         Semaphores    s  Semaphores
  248.         Tasks    t  Tasks
  249.  
  250.     examples:
  251.     stat        - displays CLI's
  252.     stat l        - displays currently loaded libraries
  253.     stat t pri  - displays task list sorted by priority
  254.     stat f sort - displays fonts sorted by name
  255.  
  256. Be careful using "stat t" during serial receives.  It is necessary to
  257. turn off interrupts while collecting the task list.  This may cause the
  258. serial.device to miss receiving a byte.  The other status lists are
  259. safe.
  260.  
  261.  
  262. Revision History
  263. ================
  264.  
  265. v2.0  10-Sep-89
  266.     . added other utilities
  267.     . ff
  268.         . added Short and Quick display options
  269.     . si
  270.         . added ECS detection
  271.  
  272. v1.2  8-Sep-88 (internal release)
  273.     . ff
  274.         . File lengths of 0 now appear as Empty
  275.     . si
  276.         . Added MathIEEE.resource detection (thanks to Bill Coldwell of
  277.           Creative Microsystems, Inc for the suggestion and detection
  278.           code)
  279.         . Changed format of report
  280.         . Added memory list priority field
  281.         . Added floating point math benchmark (to show off your 68881
  282.           to your friends)
  283.  
  284. v1.1  (internal release)
  285.     . Corrected spelling of Kramden
  286.  
  287. v1.0  6-May-88
  288.     . Initial release
  289.  
  290.  
  291. Copyright & Distribution Rights
  292. ===============================
  293.  
  294. Copyright 1988 Pregnant Badger Software.  All Rights Reserved.
  295.  
  296. These utilities may be freely distributed without profit.
  297.  
  298. Any contributions (no amount is too small or too large) may be sent to
  299. the following address.
  300.  
  301.  
  302.     Bill Barton
  303.     Pregnant Badger Software
  304.     1111 El Sur Way
  305.     Sacramento, CA    95864
  306.     (916) 487-9472
  307.  
  308.     bix: peabody
  309.     plink: peabody
  310.     delphi: bbarton
  311.  
  312.  
  313. Special thanks to St. Peter, the patron saint of PC's, without whom
  314. these utilities would never have been written.
  315.  
  316. I'm honestly quite amazed with the rate at which the first version of The
  317. Kramden Utilities has propogated since I initially uploaded it to PLink &
  318. BIX.  I've never had one of my files move so far so fast before.  What a
  319. thrill!
  320.  
  321.