@database 07e609c0-0 @master Work:Source/TinyMeter/TinyMeter/TinyMeter.guide @$VER: 3.0 @author "Tinic Urou" @(c) "1995" @remark Created with Heddley v1.1 (c) Edd Dumbill 1994 @node "Main" "TinyMeter V2.3 AmigaGuide documentation" @next "What is TinyMeter" @prev "Main" ---------------------------------------------------------------------------- @{b}@{fg shine}TinyMeter V3.1 public beta © by Tinic Urou in 1995 30.Aug 1995@{ub}@{fg text} ---------------------------------------------------------------------------- @{" What is TinyMeter? " link "What is TinyMeter" 0} @{" What's new in 3.1? " link "New" 0} @{"    Requirements    " link "Requirements" 0} @{"    Installation    " link "Installation" 0} @{"       Usage        " link "Usage" 0} @{"       Bugs!        " link "Bugs!" 0} @{"     The Author     " link "The Author" 0} @{"   To Do / Future   " link "Future" 0} @{"     Thanks  to     " link "Thanks" 0} @{"      History       " link "History" 0} @{"    Legal Stuff     " link "Legal Stuff" 0} ---------------------------------------------------------------------------- @endnode @node "What is TinyMeter" "What is TinyMeter" @next "New" @prev "Main" @{b}@{fg shine}TinyMeter 3.1@{ub}@{fg text} is a tool to show the memoryusage and/or the volumesusage graphically, with useful informations which are selectable. Look at the @{"preview picture" link "Preview/main" 0} @{b}@{u}Features:@{ub}@{uu} - Shows @{b}base-ram@{ub} after bootup. It is good to know how much memory the startup-tools take and if the applications really freed all the memory or if your bbs got uploads etc. - Uses the @{b}ScreenNotify.library@{ub} to automatically detect the changing of screenmode or font. - Can be opened on any @{b}PublicScreen@{ub}. - @{b}many options for the design/look@{ub} - @{b}Digital Clock/Date@{ub} - Realtime sizing and moving of the window (@{b}opaque window@{ub})! Don't worry, I did NOT made any patches to the system, only MoveWindow() and SizeWindow() was used. - Can use a @{b}background picture@{ub} if you have OS 3.0+ (Datatypes) - @{b}Font sensitive@{ub} - displays free memory with @{b}c-style formatting codes@{ub} to be very flexible. - etc 8) @endnode @node "Installation" "Installation" @next "Usage" @prev "Requirements" @{b}@{u}Automatic:@{ub}@{uu} Use the Installer icon @{b}@{u}Manual:@{ub}@{uu} - Copy "TinyMeter" and "TinyMeter.info" to WBStartup. - Copy "Prefs/TinyMeterPrefs" and "Prefs/TinyMeterPrefs.info" to SYS:Prefs. - Copy the contents of "Libs" into your LIBS:. - Start "TinyMeter", setup desired size and position. Press "S" to save these settings. - Setup the other configurations by starting "TinyMeterPrefs". @endnode @node "Usage" "Usage" @next "Bugs!" @prev "Installation" @{b}@{u}Usage of "TinyMeter":@{ub}@{uu} @{b}MouseAreas:@{ub} Upper left corner: End TinyMeter Lower right corner: Size TinyMeter by holding the left mousebutton Other Areas: Move TinyMeter window by holding the mousebutton @{b}Supported Keys:@{ub} @{i}(NOTE: Do not forget to click first on the TinyMeter window before you use these keys ! )@{ui} "q" or "Q" Quit TinyMeter "s" or "S" Saves window-position and size "f" or "F" Flushes the memory like "c:avail flush" All unused libraries, fonts etc. are removed from the memory. "p" or "P" Start preferences program. @{i}NOTE: TinyMeterPrefs must reside in SYS:Prefs/ to use this function.@{ui} RIGHT MOUSEBUTTON redefines base ram to the actual memoryusage @{b}@{u}Usage of "TinyMeterPrefs":@{ub}@{uu} @{b}Main Buttons:@{ub} Save Save actual settings Use Use actual settings until next reboot Test Test actual settings on running TinyMeter Cancel Discard any changes and quit TinyMeter @{b}Pages:@{ub} @{"    General    " link "General" 0} @{"    Colors     " link "Colors" 0} @{"     Design     " link "Design" 0} @{" Display what? " link "Display what?" 0} @{b}Menu:@{ub} About Informations about the program and the author Quit Discard any changes and quit TinyMeter @endnode @node "The Author" "The Author" @next "History" @prev "Bugs!" - -- --- ------------------------------------------------------ --- -- - @{b}To contact the author email to:@{ub} @{b}@{fg shine}tinic@tinic.mayn.sub.de@{ub}@{fg text} @{b}or snail to:@{ub} @{b} @{fg shine}Tinic Urou Steinriesstr. 13 88348 Saulgau - GERMANY -@{ub}@{fg text} - -- --- ------------------------------------------------------ --- -- - @endnode @node "Legal Stuff" "Legal Stuff" @next "Main" @prev "Legal Stuff" @{b}TinyMeter is EMAILWARE.@{ub} If you have access to internet and think this program is good and you regulary use it then simply write @{"me" link "The Author" 0} a mail. I can only release newer version if I get feedback from the users... @{b}@{i}Copyright@{ub}@{ui} TinyMeter is written and copyright © 1994-1995 by Tinic Urou. No parts of this program may be modified in any form. @{b}@{i}Disclaimer@{ub}@{ui} The author is in no way liable for any changes made to any part of the program, or consequences thereof as he is in no way liable for damages or loss of data directly or indirectly caused by this software. @{b}@{i}Distribution@{ub}@{ui} Neither fees may be charged nor profits may be made by distributing this piece of software. CD Manufactures are specifically granted the right to include this program on CD collections, as long as they are for the Public Domain. @{b}@{i}BGUI notice:@{ub}@{ui} `BGUI' release 1.1 (C) Copyright 1993-1994 Jaba Development (C) Copyright 1993-1994 Jan van den Baard Written using DICE v3.0 by SNail: Jan van den Baard Bakkerstraat 176 3082 HE Rotterdam Holland Fido: 2:286/407.53 (Jan van.den.Baard) EMail: jaba@grafix.wlink.nl @endnode @node "History" "History" @next "Legal Stuff" @prev "The Author" 1.0 (10.6.1995) - First public release 1.1 (14.6.1995) - Added screennotify.library support - Added DOUBLEBORER - Added RIGHT MOUSEBUTTON-support 2.0 (24.6.1995) - code completly redone in GNU C. - Added Preferences program. - Added Prefsfile and removed Tooltypes. - No longer uses prepainted picture. - Now fontsensitive. - Now the window is sizeable. - Added "S" to save window settings - Added realtime window-moving and -sizing 2.1 (27.6.1995) - fixed some bugs in publicscreen-handling - made code smarter - shows now free amount of memory - refresh interval can be set - screennotify.library can be turned off 2.2 (10.7.1995) - Added Test Button - removed iff.library usage and replaced it with datatypes.library - Largest block display - free mem display - removed bug displaying big fastmem values - optimized code - Added installer script 2.3 (19.7.1995) - Preferences now work on a 640x256 screen - Preferences texts redone - CANCEL button does now what he should do. - fixed an internal bug in the message system - Close button does now what he should do - added flush memory key - Backgroundcolor of gauge now selectable - rework on the documentation 3.0 (01.8.1995) - only works with OS3.0+ since 2.2, sorry!! - removed nasty bugs with 68040 processor - added 3D Gauges - added Window to Front and Window to back option - added NoBorder option - Position of window can now be set manually - Texts for "CHIP", "FAST" & "RETINA" can now be set manually - introduced c-style formatting codes for numbers - Largest block & mem line removed and replaced with InfoLine_1 and InfoLine_2 - Bordersizes selectable - background color of TinyMeter selectable - changed way how to display gauges completly, so its now possible to make more gauges in future - Total Mem gauge added - Retina Memory added - added tiling of background picture - No Base mem display-flag added - Border for gauges can be turned off - Space between gauges now selectable - "Q"-key added to end TinyMeter - slightly optimized the code. - added volumesusage - added 'P'-Key to run preferences program - fixed bug when screennoify was selected and used - added Refreshtime for volumes - normal window-moving added - snap from TinyMeter added 3.1 beta 1 (06.8.1995) - Colorrequester did not work with screen with more than 16 colors, it simply crashed (Oops!) - volumes which are not available are now ignored no more requests! - Colorrequester now uses reqtools.library IF available - ScreenNotify-selection-bug removed. - added Digital Clock + some fonts for this - all displays are now buffered using an own bitmap. No flickering anymore! - Gauges can now be turned off, keeping the texts with throughshinig background - A MinSize for the window is now defined, since the machine crashes using the BltBitMapRastPort with negative numbers - removed some unnecessary time_requests - memory, volumes and clock position can now be set to: left, right, center - rework on the volumes routines - TinyMeter now uses himself a priority "-3" 3.1 beta 2 - redone some of the code, now smaller - tried to fix a Enforcer hit. - tried to fix the trashing on a A4000/040 - made ClipBlit sure, all coordinates are checked. - made RectFill sure, all coordinates are checked. 3.1 beta 3 - tried to fix a Enforcer hit. - splitted the source to speed up compiling. 3.1 public beta (30.08.95) - finished MUI-Preferences program. - added "o" for occupied size in the textformat. @endnode @node "Bugs!" "Bugs!" @next "The Author" @prev "Usage" Since this is a public beta, there are some known bugs in and perhaps many others 8)): - There are still some Enforcer-hits in, which I couldn't locate until now (Geez! Even used gccfindhit!) 8(( - Some Users reported lockups when moving icons or choosing menus. I still don't know why, since this effect doesn't appear on my A4000. - On a A4000/040 TinyMeter produces bad crashes, the Workbench display is trashed. @{b}If someone has any idea how to locate the errors or wants to help me, simply contact me, he will get the sources.@{ub} Please write @{"me" link "The Author" 0}, if you find any bugs!!! TinyMeter V3.1 public beta has been sucessfully tested under these configurations: A2000 OS3.1 68030 6MB Ram Picasso A4000 OS3.0 68030 12MB Ram AGA @endnode @node "New" "Whats new in 2.3?" @next "Requirements" @prev "What is TinyMeter" - Preferences program now uses @{b}MUI@{ub}. - @{b}Priority@{ub} of TinyMeter now set to @{b}-3@{ub}. ( Some Users reported a performance loss with the 3.0 version ) - Display is now drawn using a buffer. The display should not flicker anymore. - @{b}Digital Clock and Date @{ub}(use the additional fonts to get a good look!) - @{b}Left, Right, Centered@{ub} for memory, volumes and clock - @{b}volumes changing@{ub} now supported. volumes which are not present are ignored - @{b}gauges can be turned off@{ub}, to show only the texts Have also look at @{"History" link "History" 0} @endnode @node "Requirements" "Requirements" @next "Installation" @prev "Requirements" To run TinyMeter, you will need: - AmigaOS 3.0+ - MUI 2.3 (could work with 2.0+, didn't test it) - enough memory 8) @endnode @node "Thanks" "Thanks to" Thanks must go to: - @{b}Aristotelis Grammatikakis@{ub} for his endless suggestions and for the hard testing 8)) - @{b}Jens Kreiensiek@{ub} for the "retina_lib.fd" and for the testing and all the others who did write me. @endnode @node "General" "General" @{b}@{u}General Page:@{ub}@{uu} @{b}PublicScreen name @{ub} defines a PublicScreen to open the window on. NOTE: If you put "Workbench" as PublicScreen name, TinyMeter will not reconize changes in the resolution, he will only reconize a complete closing of the workbench. Simply leave this free if you want to change the resolution or fonts. @{b}Wait before starting@{ub} Defines a period to wait before opening the TinyMeter and defining baseram. @{b}Refresh memory every@{ub} Refresh time for the memory gauges. @{b}Refresh volumes every@{ub} Refresh time for the volumes gauges. @{b}Window position @{ub} Should be clear 8)) @{b}Window size@{ub} Should be clear 8)) @{b}Snap from TinyMeter@{ub} Get actual windowposition and sizes from the running TinyMeter. Window handling - @{b}Always to Back@{ub} Puts the TinyMeterwindow always to the back. - @{b}Always to Front@{ub} Puts the TinyMeterwindow always to the front. - @{b}Default@{ub} No window handling. moving - @{b}opaque@{ub} enable moving and sizing with the opaque effect - @{b}normal@{ub} use standard moving and sizing system - @{b}fixed@{ub} disable possibility to move the TinyMeterwindow. Note, that the hidden gadgets are also disabled... @{b}Use ScreenNotify.library@{ub} Enables automatic detection of resolution changes or PublicScreen closing. @{i}NOTE: Do not forget to restart TinyMeter to become active.@{ui} @endnode @node "Colors" "Colors " Should be clear or not? Simply try it out! @endnode @node "Design" "Design" This is the most complex page: @{b}@{u}General@{ub}@{uu} @{b}Descriptions@{ub} defines the text to display for a memorytype. @{b}Font@{ub} defines the font to use for the TinyMeter window. @{b}Background Picture @{ub} defines the background picture to use. If you disable the background picture the TinyMeter background color is used. @{b}@{u}Borders@{ub}@{uu} Borderlook - @{b}Double@{ub} Use a double border - @{b}Simple@{ub} Use a standard border - @{b}None@{ub} Display no border @{b}3D Gauges@{ub} Try it! @{b}Border for Gauges @{ub} Try it! @{b}BorderWidth@{ub} defines the border in pixels to use on the left and righ side. @{b}BorderHeight@{ub} defines the border in pixels to use on upper and downer side. @{b}Space between Gauges@{ub} defines the space in pixels to use between the gauges or lines. @{b}@{u}Textformat@{ub}@{uu} This is a hard one for beginners 8) But I will try to explain it.. With this string you can define what should be displayed. The percentage free, Kilobytes etc. To display for example the free bytes you enter, where %d stands for the free memory or the free space on disk: "%d" ( without the quotes ) Result in the gauge: ______________________ |_______2342332________| Now there are several options you can use to make look this number better. Ex.: "%td free" Result in the gauge: ______________________ |____2.342.332 free____| As you can see you can add your own comments ("free"), the "t" stands for thousands seperators. There's not only %d but also these: @{b}%d@{ub} Free memory/space @{b}%b@{ub} Free memory/space at startup @{b}%a@{ub} Total memory/size @{b}%p@{ub} Percentage free @{b}%%@{ub} This code will display a simple "%" since "%" is normally reserved for the functions To all these you can add these options: @{b}t@{ub} display thousands seperators @{b}k@{ub} display kilobytes @{b}m@{ub} display megabytes @{b}@{i}NOTE: Put the options always in the right order, thats means it's not valid to use "%ktd" but "%tkd" is correct.@{ub}@{ui} Infolinesformat The same as Textformat, but other format codes are used: @{b}%o@{ub} Total memory. Free Chip and free Fast amounts are simply added here. Note that Retina memory will not be added. @{b}%c@{ub} Free Chip memory @{b}%f@{ub} Free Fast memory @{b}%r@{ub} Free Retina memory Options @{b}@{i}(Use the right order!)@{ub}@{ui}: @{b}t@{ub} display thousands seperators @{b}k@{ub} display kilobytes @{b}l@{ub} display largest block of selected memorytype "%lc" will give you the largest block in the Chipmemory @{b}a@{ub} display total amount of selected memorytype "%ac" will give you on a AGA-machine normally 2048 Kilobytes on a ECS-machine normally 1024 Kilobytes @endnode @node "Display what?" "Display what?" @{b}@{u}General@{ub}@{uu} @{b}memory/space-texts...@{ub} display a info using the numberformats selected in the gauges. @{b}No BaseMem display@{ub} Normally base mem and additional are drawed in different colors. If this sometimes looks ugly or you have simply no use of the BaseMem, you can disable displaying this information. Only the actual mem will be displayed then. @{b}@{u}Memory@{ub}@{uu} Simply try these out! @{b}@{u}Volumes@{ub}@{uu} Here you can select which Volumes should be displayed. @endnode @node "Future" "To Do / Future" These are the features I want to include: - more flexibility in the layout. - menus. - more memorytypes. - perhaps informations about other system vars. - other gauges-displays. perhaps a percentage scale - backdrop option. TinyMeter snaps the actual background, so that the workbench background shines through TinyMeter. - make it a commodity. - fixing bugs 8)) - lets see... @endnode