home *** CD-ROM | disk | FTP | other *** search
/ PC Online 1998 November / PCO_1198.ISO / filesbbs / os2 / sbr2_014.arj / SBR2_014.ZIP / docs / ReadMe.Eng < prev    next >
Encoding:
Text File  |  1998-09-14  |  18.8 KB  |  425 lines
  1.  
  2.  
  3.                                   SysBar/2
  4.                                  ~~~~~~~~~~
  5.                     toolbar-style utility set for OS/2 PM
  6.                                 version 0.14
  7.                      (http://www.lab321.ru/~dip/sysbar2)
  8.  
  9.                      (c) Dmitry I. Platonoff, 1995-1998
  10.                              (2:5004/8.4@fidonet
  11.                                 dip@lab321.ru)
  12.  
  13.  
  14.                                *************
  15.                                 README file
  16.                                *************
  17.  
  18.  
  19. ===============================================================================
  20.                                   OVERVIEW
  21. -------------------------------------------------------------------------------
  22. SysBar/2 is a next generation of SysBar, a toolbar-style utility. The first
  23. version (Win16) was written in 1995 under the impression of Win95 taskbar
  24. (once seen in early betas). It looked like a OS/2 Warp 4.0 WarpCenter (more
  25. than year before it! ;) with the same functionality - taskbar, trays & info
  26. displays. I use it now as a Win-OS/2 shell and even in Win NT 3.51 as a
  27. program launcher.
  28.  
  29. In this new generation I've decided to split the whole product into a set of
  30. small utilities. The set consists now of the four modules:
  31.    - clock (the one I really missed from Windows SysBar) - it lives well
  32.     on the top of WarpCenter's clock :) ;
  33.    - a floating task switcher;
  34.    - a pipe monitor - the utility which can retrieve system information,
  35.         can read data from any number of named pipes and display it in the
  36.         useful form as a row of cells;
  37.    - a CD player (I don't like huge windows like CD-in-a-Box or Albatros).
  38.  
  39.  
  40. ===============================================================================
  41.                                 DISTRIBUTION
  42. -------------------------------------------------------------------------------
  43. SysBar/2 is a *FREEWARE* product. This program is developed and distributed
  44. in the hope that it will be useful, but WITHOUT ANY WARRANTY.
  45.  
  46.  
  47. ===============================================================================
  48.                              SYSTEM REQUIREMENTS
  49. -------------------------------------------------------------------------------
  50. All you need is a 486 or better computer and OS/2 Warp 4.0. It will work also
  51. under 3.0 (and even 2.1x - I just have no such a system to check, please report
  52. me the results if you try). TCP/IP services (if installed in your system)
  53. will also add some extra functionality to SysBar/2 (although, it works well
  54. without these services - dynamic DLL bindings are used).
  55.  
  56.  
  57. ===============================================================================
  58.                                 INSTALLATION
  59. -------------------------------------------------------------------------------
  60. There's no sophisticated installation software supplied. Just unzip the
  61. package in any directory and enjoy! ;)  There is a folder creation script,
  62. called SB2_FLDR.CMD. It will create the SysBar/2 folder on your desktop and
  63. all the required program icons.
  64.  
  65. The files in package are:
  66.     FILE_ID .DIZ      349  - package description
  67.     SB2_CD  .Exe   31,676  - CD player executable
  68.     SB2_CLCK.Exe   21,344  - clock executable
  69.     SB2_FLD1.ICO    4,026  - folder icon
  70.     SB2_FLD2.ICO    4,026  - open folder icon
  71.     SB2_FLDR.CMD    1,080  - folder creation script
  72.     SB2_Pipe.Exe   59,451  - pipe monitor executable
  73.     SB2_TSWT.Exe   30,728  - task switcher executable
  74.     sysbar2 .dll   20,097  - a DLL with common GUI subroutines
  75.         \docs               - documentation
  76.         \info_src              - information source script sample
  77.  
  78.  
  79. ===============================================================================
  80.                                     USAGE
  81. -------------------------------------------------------------------------------
  82. All the modules have the same look, behaviour & controls. You can drag them
  83. anywhere with left mouse button and invoke a pop-up menu with right button
  84. (with the one exception: in Task Switcher it will work only when clicking
  85. the empty edge of the window, in other cases you'll get a task-specific
  86. action).
  87.  
  88. All the modules have modern-looking properties dialogs. All the changes you
  89. make will apply immediately. Each module stores configuration in its own
  90. text .Cfg file. You can view and alter these files easily (if needed).
  91. You can also specify a config file name as a first command-line parameter
  92. (it is useful, for example, when starting multiple pipe monitor instances
  93. to show different pipe sets).
  94.  
  95. All the actions are simple and easy to understand. In addition I'll describe
  96. some task-specific features...
  97.  
  98. * CLOCK
  99.     It does the only thing - it displays time, month and date and
  100.          allows you to adjust these values. That's all.
  101.  
  102. * TASK SWITCHER
  103.     It displays a set of icons representing all the current jobs and
  104.          windows. You can filter them (hide or show) and perform a number
  105.          of actions.
  106.  
  107.     You may define exceptions to control application visibility and
  108.          other parameters. Every exception must have a title to match the
  109.          application title beginning. (For example, "Desktop" entry will
  110.          apply to the desktop icon, and "OS/2" entry will match all the
  111.          windows such as "OS/2 Command Prompt", "OS/2 System", etc.).
  112.          For every exception entry you can set its visibility in Task
  113.          Switcher window and in system task list (called with Ctrl-Esc).
  114.          You can also make it "non-jumpable" (exclude from Alt-Esc switch
  115.          sequence).
  116.         DO NOT ADD AN EMPTY STRING TO THE FILTER!
  117.  
  118.         Mouse controls (when clicking an icon):
  119.           LEFT BUTTON - switch to task if this task is inactive or minimize
  120.             if it has focus currently;
  121.           RIGHT BUTTON - pop-up menu (a complete copy of task's system menu);
  122.           RIGHT with LEFT (clicking RIGHT BUTTON when holding LEFT already) -
  123.                 minimize task's window;
  124.           LEFT with RIGHT - close window (kill task).
  125.         Mouse button can be swapped of course.
  126.  
  127. * PIPE MONITOR
  128.     It can:
  129.         - display CPU load percentage;
  130.         - display available physical memory;
  131.         - display available drive space;
  132.         - monitor specified file size and count;
  133.         - display current power or battery usage status;
  134.         - display current time;
  135.         - display current date;
  136.         - display system uptime;
  137.         - display the number of currently running processes and threads;
  138.         - monitor POP3 mailox;
  139.         - display network interface traffic statistics;
  140.     - open a number of named pipes (in the server mode) and read data
  141.          from these sources. Any text arrived through the pipe will be
  142.          displayed in a separate (for every pipe) cell using its own
  143.          colour. This is useful for displaying system information, for
  144.          debugging purposes, messaging, etc.
  145.  
  146.         Number formatting options.
  147.         ~~~~~~~~~~~~~~~~~~~~~~~~~
  148.         There are some types of cells which can display byte amounts (like
  149.          a filesize or available drive space). These number formatting
  150.          options allow you to setup how to show numbers, when the Pipe
  151.          Monitor should use Mbytes, Kbytes and bytes and how to name them.
  152.         For each cell of this type you can setup its own number formatting
  153.          options or use default (they are on the second page of display
  154.          settings.)
  155.  
  156.     Cell setup.
  157.         ~~~~~~~~~~
  158.         There is a "Cells" page in the properties notebook. It allows you
  159.          to manage information cells of the Pipe Monitor. You can create
  160.          cells, setup them, assign special parameters, etc.
  161.  
  162.         Every cell has its own name and color. You can also type a string
  163.          in the "Prefix" field. This string will be placed in the beginning
  164.          of the cell text (to let you know what this cell about :). Another
  165.          field named "Empty" defines a string which will be displayed when
  166.          the empty message arrived or when nothing to display (for example,
  167.          no files for file monitor).
  168.  
  169.         You can assign two applications for each cell: one to launch when
  170.          you double-click the cell and another to launch at every text change
  171.          (USE IT WITH CAUTION! Do not setup such a thing for frequently
  172.          updated cells like clock or CPU meter! But this is good to start
  173.          your mail reader when your mail arrived. Note also that this program
  174.          will not be launched on empty message or of you clear the text
  175.          manually.) Just enter an executable name, e.g. "d:\my_dir\my_app.exe",
  176.          or use "Browse" button.
  177.  
  178.         All the cell changes may be logged in the internal buffer or external
  179.          log file. You can assign the file name, turn on timestamping and
  180.          select the size of internal buffer which allows you to browse the
  181.          latest changes.
  182.  
  183.         When creating a cell you must setup its data type and some special
  184.          parameters. If you press "Setup" button a cell setup dialog will
  185.          appear. You must select cell type and set its options.
  186.  
  187.     There are the following cell types exist:
  188.  
  189.         - "CPU load meter", a cell that shows CPU load percentage. It has
  190.             refresh timeout (in seconds) and the ability to limit CPU
  191.                 load value to 99% (to stay in two chcracters).
  192.                 There's an alternate CPU meter available on some systems
  193.                 with latest fixpacks (it will appear as "Use newer
  194.                 DosPerfSysCall method" checkbox). The old one caused traps
  195.                 in some systems while working fine with others, so I've
  196.                 included this new one;
  197.  
  198.         - "available memory", shows the amount of free phisical memory. It
  199.             also has refresh timeout only;
  200.  
  201.         - "pipe listener", a named pipe reader. It will accept any text
  202.             arrived through the pipe and display it in the cell.
  203.                 It has two parameters: the exact pipe device name (e.g.
  204.                 "\pipe\my_pipe", it's a name of pipe for your information
  205.                 source program to send data to) and the expire timeout
  206.                 (optional). This timeout lets you make cell's content time-
  207.                 censitive, it will "expire" and disappear after specified
  208.                 number of seconds (useful for irregular info sources);
  209.  
  210.         - "disk free space", a cell that displays available space on the
  211.             specified drive. Its parameters are: drive, refresh timeout
  212.                 and number formatting options;
  213.  
  214.         - "file monitor", a file monitor which shows size and (or) count
  215.             of the file(s) specified by mask. Its parameters are: file
  216.                 specification, refresh timeout and number formatting options;
  217.  
  218.         - "battery status", a power or battery usage monitor. Its parameter
  219.             is the refresh timeout. NOTE: it will work only if you have
  220.                 advanced power management driver installed (APM.SYS);
  221.  
  222.         - "clock", shows current time. It has the same refresh timeout and
  223.             two switches: to turn on/off seconds and AM/PM or 24-h mode;
  224.  
  225.         - "calendar", shows current date. It has same refresh timeout and
  226.             four switches: to turn on/off day of the week, month, year
  227.                 and month format. Actually calendar and clock cells do more
  228.                 than Clock module itself. But I like its LCD style.
  229.  
  230.                 You can also replace weekday and month names in the end of
  231.                 SB2_PIPE.Cfg file with your own ones (possibly, in your
  232.                 language).
  233.  
  234.         - "system uptime", shows how long your system works since last reboot.
  235.                 It has refresh timeout (as always) and two switches: to turn
  236.                 on/off seconds and days;
  237.  
  238.         - "system processes", shows count of active tasks, processes, threads
  239.             and modules. It has its refresh timeout and four switches to
  240.                 control the appearance of all the numbers mentioned above;
  241.  
  242.     - "POP3 mailbox", shows the number of messages and their total size
  243.             in a POP3 mailbox. It has its refresh timeout (I discommend
  244.                 you to use timeout lesser than a minute or so), server URL,
  245.                 and three switches to control the appearance of message
  246.                 count, total size and communiaction errors.
  247.  
  248.                 URL must be in the standard form of "user:password@host:port",
  249.                 e.g. "scott:tiger@oracle.com". Port is optional, default value
  250.                 is 110;
  251.  
  252.     - "incoming IP traffic" and "outgoing IP traffic", show incoming and
  253.             outgoing IP traffic statistics, such as current, average,
  254.                 peak CPS, and total tranferred bytes amount. It has its
  255.                 refresh timeout, interface selection control (to select an
  256.                 interface to monitor, e.g. LAN, PPP, etc.), an four switches
  257.                 to control the appearance of statistics components.
  258.  
  259.                 It is recommended to place these two traffic cells into the
  260.                 separate window (by creating another instance of monitor --
  261.                 just specify a different config filename as its first
  262.                 commandline parameter) -- to avoid the unnecessary main
  263.                 window blinking because of its high refresh rate.
  264.  
  265.         There is an information source example supplied. A REXX script, that
  266.          shows a few simple ways to retrieve system information like hard disk
  267.          space, swap file size, scan inbound directories, etc. You can modify
  268.          it for your own needs.
  269.         All external sources (as well as your own ones) must be started
  270.          manually from startup.cmd, Startup folder, of from where you like.
  271.         AND DON'T FORGET TO SETUP APPROPRIATE PIPES IN MONITOR!!!
  272.  
  273. * CD PLAYER
  274.     It can play audio CDs. The commands are: play, stop, pause, eject,
  275.          next track & previous track. There are four time display modes -
  276.          try 00-00 button.
  277.         It doesn't use OS/2 multimedia support.
  278.  
  279.  
  280. ===============================================================================
  281.                                 FUTURE PLANS
  282. -------------------------------------------------------------------------------
  283. * COMMON
  284.     - "stick together" feature (=> Terje Flaaronning);
  285.     - colour drag'n'drop (=> Terje Flaaronning);
  286.         - activation corners and screen edges (=> Thorsten Haude);
  287.     - rollup feature (=> Ronny Ko).
  288.         ...all this stuff will be implemented in SysBar III.
  289.  
  290. * CD PLAYER
  291.         - disc recognition, disc & track name display;
  292.         - CDDB support (both local files and internet connections);
  293.         - programmable track order (=> Ingmar Hensler).
  294.  
  295. * CLOCK
  296.     - alarms (pop-up messages & scheduler) (=> Alexander Ernst);
  297.         - a calendar (=> Tibor Nagy).
  298.  
  299. * PIPE MONITOR
  300.     - more powerful information source.
  301.  
  302. * TASK SWITCHER
  303.     - window attribute control;
  304.         - global task management commands.
  305.  
  306. * !!! NEW COMPONENTS
  307.         - launch panel;
  308.     - calculator (=> George Brink).
  309.  
  310. * !!! IMPORTANT
  311.     - I'm looking for beta testers;
  312.         - if you think that SysBar/2 docs should be translated to any
  313.            language you like - just translate and send all this stuff to
  314.            me. It will be included in the next release of the product;
  315.         - if you want to write your own version of English docs - DO IT!
  316.            I need a fresh look at all this software.
  317.  
  318.  
  319. ===============================================================================
  320.                               ACKNOWLEDGEMENTS
  321. -------------------------------------------------------------------------------
  322. I want to thank these people which helped (and still help) me in my work:
  323.  
  324.     Andrew Tereshechkin (aka Red Alligator)
  325.              for the inspiration that made me to start this project,
  326.              for criticizing all the CD players in the world (including
  327.              mine :), for ideas, suggestions and a lot of testing work
  328.  
  329.     my wife Helga
  330.              for love and support
  331.  
  332.     Igor E. Fedorenko
  333.              for OS/2 API tips and some ideas;
  334.                 for POP3 mailbox peeker code
  335.  
  336.     Maxim Penzin
  337.              for testing and for some useful ideas (especially for the
  338.                 idea of Pipe Monitor)
  339.  
  340.         Sergey I. Yevtushenko
  341.             for CPU load meter code samples and PM API tips
  342.  
  343.     Peter Fitzsimmons
  344.              for showing me the way to access the system menus
  345.  
  346.     Gianluca Della Vedova
  347.         for Italian version of README
  348.  
  349.     Thomas Voggenreiter
  350.         for German version of README
  351.  
  352.     Chris Wenham
  353.             for the articles in OS/2 e-Zine magazine
  354.  
  355.     Ronny Ko
  356.             for the review in OS/2 Computing! magazine
  357.  
  358.     beta-testers:
  359.             Andrew Tereshechkin
  360.         Maxim Penzin
  361.         Gianluca Della Vedova
  362.         Thorsten Haude
  363.         Bjorn Tore Hoem
  364.                 Antonio Manara
  365.                 Denis Dubensky
  366.                 Stepan Kazakov
  367.                 Vit Timchishin
  368.                 Eugen Kuleshov
  369.  
  370.     and also...
  371.         George Brink
  372.         Stanislav Grushko
  373.         Serge Popov
  374.                 Alexander Ernst
  375.         Emmanuele Vigni
  376.                 David Cougle
  377.         Panacea Tech Support
  378.                 Alexander Bezborodov
  379.                 Thorsten Haude
  380.             Yasushi Ono
  381.             Alexander Krapivin
  382.                 Andrey Buzanakow
  383.                 Alexander Cherkaew
  384.                 Andrey Serdiukov
  385.              ...for additional testing and for attention to the product
  386.  
  387.  
  388. ===============================================================================
  389.                                   SUPPORT
  390. -------------------------------------------------------------------------------
  391. WWW support page: http://www.lab321.ru/~dip/sysbar2/
  392. FTP server: ftp://sysbar:sysbar@lab321.ru
  393.  
  394. There's a mailing list exists for SysBar support and discussions: 
  395.     sysbar-project@lab321.ru.
  396.  
  397. To subscribe (subscription is free) send a message to majordomo@lab321.ru
  398. with "subscribe sysbar-project" in the message body.
  399.  
  400. If you don't want to deal with this list you can send your questions
  401. to sysbar@lab321.ru or directly to me.
  402.  
  403. All your notes, suggestions, bug reports, etc. are welcomed via e-mail
  404. or in that mailing list. Please report your SysBar/2 version when
  405. sending a message (especially with bug reports).
  406.  
  407.  
  408. ===============================================================================
  409.                             CONTACTING THE AUTHOR
  410. -------------------------------------------------------------------------------
  411. The author of SysBar product series is Dmitry I. Platonoff, 25-year software
  412. engineer from Omsk, Russia (West Siberia) (excuse me for my English :).
  413.  
  414. E-mail: dip@lab321.ru
  415.     2:5004/8.4@fidonet
  416.  
  417. WWW homepage: http://www.lab321.ru/~dip/
  418.  
  419. I also can be found on IRC as "dip" (or "busy_dip") in #OS2Russian, sometimes
  420. in #os2prog, #os2coders rooms on EFnet.
  421.  
  422.  
  423. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  424.  
  425.