@DATABASE "Default"
@NODE "MAIN" "Main"




                            @{b}@{u}@{fg highlight}LedA version 1.4@{ub}@{uu}@{fg text}

                Tiny frontend for AmiTCP and related tools.

                        © 1997,1998 Marek Jablonski.


                               
                @{"            Introduction              " Link "Introduction"}
                @{"         System Requirements          " Link "SystemReq"}
                @{"            Installation              " Link "Installation"}
                @{"            Configuration             " Link "Configuration"}
                @{"         Contacting the Author        " Link "Contact"}
                @{"             Disclaimer               " Link "Disclaimer"}
                @{"            Distribution              " Link "Distribution"}
                @{"       ***  New features  ***         " Link "Configuration" 209}



@ENDNODE

@NODE "Distribution" "Distribution"

 Distribution
 ------------

 The program and files in this distribution are freely distributable, but
 are also Copyright (c) Marek Jablonski (with one exception: The led.image
 file is Copyright (c) 1994 Commodore-Amiga, Inc.). They may be freely
 distributed as long as no more than a nominal fee is charged to cover time
 and copying costs.

@ENDNODE

@NODE "Installation" "Installation"

 Installation
 ------------

 'LedA' can be located anywhere on your system. 'LedA' requires 'led.image'
 (included) to work. It must be present in your sys:classes/images
 directory (or in libs:images if you prefer). If you'd like to use 'fancy'
 feature you should read @{" this " LINK "Configuration" 116}, too.

@ENDNODE

@NODE "Introduction" "Introduction"

 Introduction
 ------------

 I was always looking for utility allowing me to launch my favourite
 Internet tools while keeping an eye on on-line time. Well, I could not
 find any so, with the little help of excellent EasyGUI by Jason R.
 Hulance, 'LedA' was born.

 'LedA' allows the user to:

 * Start/Stop AmiTCP

 * Start the following programs

   * WWW (AWeb, IBrowse etc.)
   * FTP (AmFTP, AmiFTP...)
   * Mail (Thor, Yam...)
   * IRC (I'm not an IRC fan ;)
   * Telnet (AmTelnet, Telnet etc.)

 * Log your connections

 * Calculate on-line cost

@ENDNODE

@NODE "SystemReq" "System Requirements"

 System requirements
 -------------------

 * An Amiga with Kickstart 2.0 or higher.

 Tested on
 ---------

 * A4000/040, 2 Mb Chip, 20 Mb Fast Ram
 * A600, 2 meg Chip.

@ENDNODE


@NODE "Configuration" "Configuration"

 Configuration
 -------------

 You can set up 'LedA' by editing tooltypes of its (her?) icon.
 These are supported tooltypes:


  @{b}START@{ub} - (re)starts the AmiTCP/IP protocol stack. Resets and (optionally)
          starts the counter.
          e.g. START=AmiTCP:Bin/startnet

          Note:
          -----
          Script files (like 'startnet') MUST have 's' flag set. It can be
          done from shell:
          @{i}1> protect AmiTCP:Bin/startnet S ADD@{ui}
          It is important to always use full path to the command in your
          scripts e.g. 'sys:rexxc/rx' not just 'rx' (or insert line
          'path sys:rexxc add' somewhere in the beginning of the startnet
          script).

          Problems that you may encounter are mostly caused by commands
          like 'rx' being not in the path. Wbstarter (Aminet:util/libs/WBStart.lha)
          by Stefan Becker probably will solve most of them.

          e.g. START=wbstarter AmiTCP:bin/startnet

  @{b}STOP@{ub} -  stops AmiTCP/IP protocol stack if possible. Stops the counter.
          Saves start/stop/elapsed time to log file.
          e.g. STOP=AmiTCP:bin/stopnet

          Important:
          ----------
          Clicking the close gadget will cause an action defined in STOP tooltype
          before quitting.

  @{b}EMAIL@{ub} - Mail program of your choice.
          e.g. EMAIL=Mail:Thor/Thor

  @{b}IRC@{ub}  -  As above-mentioned but for IRC
          e.g. IRC=dh1:comms/amirc/amirc

  @{b}WWW@{ub}  -  I think it is quite obvious ;-)

  @{b}FTP@{ub}  -  Isn't it?

  @{b}TELNET@{ub}  - TELNET=Work:comms/AmTelnet would be nice.

  @{b}XCOOR@{ub} - X position of the left top corner of the LedA's window
          e.g. XCOOR=400

  @{b}YCOOR@{ub} - same for the Y coordinate.

  @{b}LOG@{ub}  -  Name of the log file. Default is T:LedA.log. BTW, from
          version 0.92 'LedA' waits for CARRIER and when detected starts
          the timer. This is default (ufortunately it works only with
          built-in serial port), however you can force it (her) to behave
          in a different way (see: @{b}DUMB@{ub}, @{b}S2DEVICE@{ub})
          e.g. LOG=AmiTCP:log/my.log

  @{b}DUMB@{ub} - Turns off carrier detection. Timer starts when you click
          on 'Start' button.

  @{b}ASPECT@{ub} - You may want to use it when 'led display' does not resize
          properly. OK, I have to face the music - I wasn't able to find out an
          universal sizing formula for certain fonts (after all I'm only
          'sunday programmer') so I decided to left it to you, dear user ;-)

          e.g. ASPECT=25

  @{b}S2DEVICE@{ub} - From now on it is possible to automagically start the
         timer when SANA-II compatible device (e.g. ppp.device) comes online
         (BIG thanks to Patryk Logiewa for his kind cooperation).  This tooltype
         turns off carrier detection. It also overrides @{b}DUMB@{ub} option if
         it is activated (Oops! Did not work in 0.98. Fixed in 0.99)

          e.g. S2DEVICE=ppp.device

  @{b}S2UNIT@{ub} - SANA-II device unit number. '0' if not specified.

         @{b}I guess that you should know that SANA-II related stuff
         is a bit untested at the moment. AmiTCP users are hard to find
         these days...All I can say is that it works for me.@{ub}

  @{b}OFFSET@{ub} - As you may have spotted it takes time for your and
         remote modems to negotiate connection. Offset can be added to
         the total online time. Both positive and negative values are accepted.

          e.g. OFFSET=-13 (13 seconds are ADDED to your online time)
               OFFSET=20 (20 secs are SUBTRACTED frm online time)

  @{b}BUTTONS@{ub} - Allows you to specify your own button texts instead
         of build-in ones. 20 characters (max.) per button, comma to separate.
         Use @{b}ASPECT@{ub} to correct horizontal size.

          e.g. BUTTONS=button1,button2,button3,click me!,format,Amiga,Rulez!

          Note:
          -----
          Just to keep things as clear as possible. These are tooltypes
          responsible for particular buttons (no matter how you name them):

          +--------------------------------------+
          | LedA 0.99f                           |
          +--------------------------------------+
          +-------+------------------------------+
          | START |                              |
          +-------+                              |
          | STOP  |                              |
          +-------+                              |
          | EMAIL |                              |
          +-------+---------+---------+----------+
          |  IRC  |   WWW   |   FTP   |  TELNET  |
          +-------+---------+---------+----------+

  @{b}FANCY@{ub} - Replaces text buttons with user configurable icon gadgets
         (suggested by Alvaro Thompson, made possible by Fabio Rotondo). A brief
         note for those who want to create their own icons -- I wish I could say
         that size doesn't matter ;-) but, unfortunately, it does. The only way
         to work out correct horizontal/vertical size is by trial and error.
         Challenging, isn't it? I strongly encourage you to send me your
         OWN creations. I'd be delighted to include them in future releases
         of LedA.


  @{b}ICONPATH@{ub} - Specifies the directory your icons are in (defaults to
         'PROGDIR:Icons/set0').

         e.g. ICONPATH=sys:storage/newicons

         From v1.2 the default icon set is in MagicWB style (icons supplied by
         Maciej 'Juma' Gozdek). The other two are NewIcons.

         From the version 1.0 there is a simple phone cost calculation
         routine implemented (suggested by Bill Duxbury). It was designed
         with British Telecom rates in mind (let me know if it works as it
         should) but, if you are lucky enough it may work for you too,
         wherever you live (unless you're German of course ;-)


  @{b}DAYRATE@{ub} - This one enables phone cost accounting. Let's say
         your phone company charges 4p per minute:

         e.g. DAYRATE=0.04/60


  @{b}NITERATE@{ub} - Should be specified if your rates depends on the
         time of the day:

         e.g. NITERATE=18:00-8:00 0.017/60

         NITERATE did not work correctly in v1.0 (reported by Bill
         Duxbury). Fixed in v1.2

  @{b}WEEKENDRATE@{ub} - from midnight Friday to midnight Sunday.

         e.g. WEEKENDRATE=0.01/60


  @{b}ACCUMULATE@{ub} - If you activate this option your @{" log " LINK "Configuration" 52} will be scanned
         after every succesfull connection and the total cost will be computed.

         e.g. ACCUMULATE


   @{b}WARN@{ub} - notifies the user after @{i}n@{ui} minutes spent on-line.
         It deactivates itself after 15 seconds (new in v1.2)

         e.g. WARN=10


   @{b}WARNSAMPLE@{ub} - Warning can be made audiable with this one.
         Useful, if you're working on screen different than the LedA's one.

         e,g, WARNSAMPLE=sys:audio/samples/beep

         Note:
        ------
         You HAVE to use samples in raw format.


   @{b}STARTDATE@{ub} - It requires ACCUMULATE to be activated. Once
         specified, total cost is calculated from the given date up to the
         latest entry (the date you enter MUST be present in your logfile).

         e.g. STARTDATE=01-Mar-98

         (note the leading zero and uppercase char.)


   @{b}NOLED@{ub} - Minimizes LedA's window by getting rid of LED display.
         It works in @{"FANCY" LINK "Configuration" 116} mode only. On-line time, number of log entries
         and total on-line time are now displayed on window title bar
         (just trying to deal with Miguel de Abreu who complained about
         size of LedA's window ;).
         Ah I almost forgot, number of log entries and total on-line time are
         affected by @{"STARTDATE" LINK "Configuration" 182}.


   @{b}MINTIME@{ub} - I guess that it can be somewhat annoying to have all
         those 'busy' calls written into the log file (if you have @{"DUMB" LINK "Configuration" 61}
         mode activated). You can avoid that using MINTIME=@{i}sec@{ui}.

         e.g. MINTIME=10

         means that calls lasting <10 seconds will be excluded from logging.


   What's new in version 1.4:

    * fixed a bug concerning BUTTONS tooltype.
    * improved behaviour on non-english localized systems
    * added ability to view log file from within programm.
    * added simple stats calculations performed on log file. May produce
      starange results if you're editing your log manually.



























@ENDNODE

@NODE "Contact" "Contact"

 Contact
 -------

 If you have any suggestions, bug reports, whatever...

 EMail: mjab69@uznam.top.pl


@ENDNODE

@NODE "Disclaimer" "Disclaimer"

 Disclaimer
 ----------

 Author takes no responsibility [...] etc. In other words: Have fun ;-)

@ENDNODE

