XSNMPLOG Version 1.2.5 Beta
===========================

Updated: September 6, 2002

'xsnmplog' is a X interface to control the 'snmplogd' daemon and view the
log files produced by 'snmplogd'.

In order to use 'xsnmplog', you must have 'snmplogd' built and installed.

'xsnmplog' requires Gtk+ 1.2 or later (http://www.gtk.org).

'snmplogd' will log SNMP trap messages from a Linksys EtherFast Cable/DSL
router models BEFSR11, BEFSRU31 and BEFSR41.

You must have firmware revision 1.35 or later installed in your
Linksys EtherFast Cable/DSL router.  Prior firmware revisions, with
the exception of 1.30 Beta, did not provide the router with the capability
of broadcasting SNMP trap messages.

Before using 'snmplogd', make sure that you have enabled the option to
broadcast SNMP trap messages on you Linksys EtherFast Cable/DSL router.
See your router documentation for instructions on how to do this.

This is BETA software.  Please use it at your own risk.  'snmplogd' is
a begnign listener, so it has little if any potential to harm a Unix
system.

Changes:
--------

May 11, 2002

Closed a hole in the logic where a malformed message in the snmplog.messages
file could exceed the 'xsnmplog' internal message buffer.  Malformed messages
originate from certain versions of the Linksys EtherFast Cable/DSL router
firmware where some messages are not terminated with a newline character.


May 17, 2002

Added and icon to the interface.  Cleaned up status message display.


September 6, 2002

No functional changes, only minor code cleanup of some superfluous calls.

To build xsnmplog:
------------------

1. cd <unzip directory>

2. Edit the 'Makefile' default paths as desired:

   CMDNAME=snmplogd 
   This is the name of the 'snmplogd' daemon executable.

   CMDPATH=\"/usr/local/snmplog/snmplog-1.2.5-Beta/$(CMDNAME)\"
   This is the full path to the 'snmplogd' daemon executable.

   LOGFILE=\"/var/log/snmplog/snmplog.messages\"
   This is the location of the command pipe for the currently running daemon.

   TIMER=5
   This is the frequency in seconds that 'xsnmplog' will refresh
   its message list with new messages (if there are any).

   ICNPATH=\"/var/local/snmplog/icon.xpm\"
   Definition for the optional icon image on the 'xsnmplog' window.  The
   icon is simply not displayed if it doesn't exits.

   Alternately, instead of modifying the 'Makefile', you can supply the
   desired paths to make as parameters as follows:

   make CMDNAME="snmplogd"                                        \
        CMDPATH="/usr/local/snmplog/snmplog-1.2.5-Beta/$(CMDNAME) \
        LOGFILE="/var/log/snmplog/snmplog.messages" TIMER=5 

   Note:
   =====

   If you experience problems with the gcc optimizing compiler, try lowering
   the optimization level in the Makefile (CPP_FLAGS) from '-O3' to '-O2' and
   finally to just '-O' if necessary.
   
4. make clean

5. make

6. make install

Note:   At this time the 'install' option is a dummy that produces nothing
-----   more than a message.

        You could set up a symbolic link in a public binary directory
        (such as /usr/bin) to point to the 'xsnmplog' executable.

        For example:

        cd /usr/bin
        ln -s /usr/local/snplog/snmplog-1.2.5-Beta/xsnmplog/xsnmplog xsnmplog

        (Assuming that you have authority to create files in /usr/bin).

        'xsnmplog' requires no special permissions for execution.

Start xsnmplog:
---------------

1.      At an X terminal, simply run the 'xsnmplog' executable as follows:

        /usr/local/snmplog/snmplog-1.2.5-Beta/xsnmplog/xsnmplog &

2.      'xsnmplog' will display whether the 'snmplogd' daemon is running
        or not at the top of the window.  It will also display the number
        of messages buffered (contained in the xsnmplog scrolling list)
        regardless whether the 'snmplogd' daemon is running or not.

3.      At the bottom of the 'xsnmplog' window, you will find three
        buttons and one checkbox.

        'Exit'    - simply terminates the 'xsnmplog' process.

        'Flush'   - forces the 'snmplogd' daemon to "flush"
                    its buffers.  'snmplogd' bufferes messages from
                    your Linksys router for performance reasons.  This
                    means that messages are stored internally in the
                    'snmplogd' daemon buffers before they are physically
                    written to the 'snmplog.messages' log file.  Only
                    when the buffer becomes exhausted are the messages
                    physically written to the 'snmplog.messages' log.
                    "Flush" causes the 'snmplogd' daemon to write any
                    buffered messages to the 'snmplog.messages' file
                    regardless whether the buffer is exhausted or not.

        'Start'   - If 'xsnmplog' detects that the 'snmplogd' daemon
                    is not running, it displays this button.

                    Clicking on this button causes 'xsnmplog' to
                    start the 'snmplogd' daemon.

        'Stop'    - If 'xsnmplog' detects that the 'snmplogd' daemon
                    is running, it displays this button.

                    Clicking on this button causes 'xsnmplog' to
                    terminate the running 'snmplogd' daemon.       

        'Auto     - By default, 'xsnmplog' automatically scrolls
         Scroll'    to the end of the message list as new messages
                    are added to the list.

                    The "Auto Scroll" toggle can be used to stop
                    'xsnmplog' from automatically scrolling to the
                    end of its list.

                    Clicking this toggle again will cause 'xsnmplog'
                    to resume automatic scrolling.

License:
--------

'xsnmplog' is free software and may be freely distributed provided
that it is distributed in its original form and entirety.  Credit
to the authors (Marc Niegowski and Gregory Whitehouse) must be
present with any distribution of this software.

'xsnmplog' is provided with NO WARRANTY whatsoever, either expressed
or implied.

Copyright
---------

Copyright  2002, Marc Niegowski
Connectivity, Inc.
All rights reserved.

23 W. Fourth Street
Media, PA 19063-2805
USA

Phone: 610-566-0227
Fax:   610-566-0641

Email: Marc@Tech-Center.com
Web:   http://www.marcsweb.com
Ftp:   ftp://ftp.marcsweb.com

(END)
