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