userapps/opensource/net-snmp/README

   1                README file for net-snmp Version: 5.0.8
   2
   3 DISCLAIMER
   4
   5   The Authors assume no responsibility for damage or loss of system
   6   performance as a direct or indirect result of the use of this
   7   software.  This software is provided "as is" without express or
   8   implied warranty.
   9
  10 TABLE OF CONTENTS
  11
  12   Disclaimer
  13   Table Of Contents
  14   Introduction
  15 * Supported Architectures
  16   Availability
  17   Web Page
  18 * Installation
  19   Copying And Copyrights
  20 * Frequently Asked Questions
  21   Helping Out
  22 * Code Update Announcements
  23 * Mailing Lists
  24   Agent Extensibility
  25   Example Agent Configuration and Usage
  26   Configuration
  27   Submitting Bug Reports
  28   Closing
  29   Thanks
  30
  31   * = Required Reading.
  32
  33 INTRODUCTION
  34
  35   This package was originally based on the CMU 2.1.2.1 snmp code.  It
  36   has been greatly modified, restructured, enhanced and fixed.  It
  37   hardly looks the same as anything that CMU has ever released.  It
  38   was renamed from cmu-snmp to ucd-snmp in 1995 and later renamed from
  39   ucd-snmp to net-snmp in November 2000.
  40
  41 SUPPORTED ARCHITECTURES
  42
  43   Please see the FAQ for this information.
  44
  45   Please let us know if you compile it on other OS versions and it
  46   works for you so we can add them to the above list.
  47
  48   Porting:  Please! read the PORTING file.
  49
  50 AVAILABILITY
  51
  52   Download:
  53     - http://www.net-snmp.org/download/
  54     - ftp://ftp.net-snmp.org/pub/sourceforge/net-snmp/
  55   Web page:
  56     - http://www.net-snmp.org/
  57   Sourceforge Project page:
  58     - http://www.net-snmp.org/project/
  59   Mirrors:
  60     - US:        ftp://ftp.freesnmp.com/mirrors/net-snmp/
  61     - Bulgaria:  http://rtfm.uni-svishtov.bg/net-snmp/
  62     - Japan:     ftp://ftp.ayamura.org/pub/net-snmp/
  63     - Germany:   ftp://ftp.mpg.goe.ni.schule.de/pub/internet/net-snmp/
  64
  65   The old ucd-snmp.ucdavis.edu web site and ftp server is now
  66   offline and should not be accessed any longer.
  67
  68 WEB PAGES
  69
  70   http://www.net-snmp.org/
  71   http://www.net-snmp.org/project/
  72
  73   Make sure you check out the logo there, which is created using
  74   postcards submitted from various locations that make use of the
  75   net-snmp package.
  76
  77 INSTALLATION
  78
  79   See the INSTALL file distributed with this package.
  80
  81 COPYING AND COPYRIGHTS
  82
  83   See the COPYING file distributed with this package.
  84
  85 FREQUENTLY ASKED QUESTIONS
  86
  87   See the FAQ file distributed with this package.
  88
  89 HELPING OUT
  90
  91   This is a project worked on by people around the net.  We'd love
  92   your help, but please read the PORTING file first.  Also, subscribe
  93   to the net-snmp-coders list described below and mention what you're
  94   going to work on to make sure no one else is already doing so!
  95   You'll also need to keep up to date with the latest code snap shot,
  96   which can be obtained from CVS using the information found at
  97   http://www.net-snmp.org/cvs/.
  98
  99   Contributions to the Net-SNMP source code in any form are greatly
 100   appreciated.  We expect the parties providing such contributions to
 101   have the right to contribute them to the Net-SNMP project or that
 102   the parties that do have the right have directed the person
 103   submitting the contribution to do so.  In addition, all contributors
 104   need to be aware that if the contribution is accepted and
 105   incorporated into the Net-SNMP project, it will be redistributed
 106   under the terms of the license agreement used for the entire body of
 107   work that comprises the Net-SNMP project (see the COPYING file for
 108   details).  If this license agreement ever changes the contribution
 109   will continue to be released under any new licenses as well.  Thank
 110   you, in advance, for your gracious contributions.
 111
 112 CODE UPDATE ANNOUNCEMENTS
 113
 114   See the NEWS file and the ChangeLog file for details on what has
 115   changed between releases.
 116
 117   We hate broadcasting announce messages to other mailing lists and
 118   newsgroups, so there is a mailing list set up to handle release
 119   announcements.  Any time we put new software out for ftp, we'll mail
 120   this fact to net-snmp-announce@lists.sourceforge.net.  See the
 121   MAILING LISTS section described below to sign up for these
 122   announcements.
 123
 124   We will post new announcements on a very infrequent basis to the
 125   other channels (the other snmp mailing lists and newsgroups like
 126   comp.protocols.snmp), but only for major code revisions and not for
 127   bug-fix patches or small feature upgrades.
 128
 129 MAILING LISTS
 130
 131   The lists:
 132
 133     The following mailing lists have been created for your use:
 134
 135       net-snmp-announce@lists.sourceforge.net  -- For announcements
 136       net-snmp-users@lists.sourceforge.net     -- For usage discussions
 137       net-snmp-coders@lists.sourceforge.net    -- For development discussions
 138       net-snmp-cvs@lists.sourceforge.net       -- For cvs update announcements
 139
 140     To subscribe to these lists, please see:
 141
 142       http://www.net-snmp.org/lists/
 143
 144     The lists you definitely want to subscribe to is the
 145     net-snmp-announce@lists.sourceforge.net list and the
 146     net-snmp-users@lists.sourceforge.net list.
 147
 148     Please do *NOT* send messages to both -users and -coders lists.
 149     This is completely unnecessary, and simply serves to further
 150     overload (and annoy) the core development team.  Thank you.
 151
 152   Archives:
 153     The archives for these mailing lists can be found by following links at
 154
 155       http://www.net-snmp.org/lists/
 156
 157 AGENT EXTENSIBILITY
 158
 159   The agent that comes with this package is extensible through use of
 160   shell scripts and other methods.  See the configuration manual pages
 161   (like snmpd.conf) and run the snmpconf perl script for further details.
 162
 163   You can also extend the agent by writing C code directly.  The agent
 164   is extremely modular in nature and you need only create new files,
 165   re-run configure and re-compile (or link against its libraries).  No
 166   modification of the distributed source files are necessary.  See the
 167   following files for details on how to go about this:
 168   http://www.net-snmp.org/tutorial-5/toolkit/,
 169   agent/mibgroup/examples/*.c
 170
 171   Also, see the local/mib2c program and its README file for help in
 172   turning a textual mib description into a C code template.
 173
 174   We now support AgentX for subagent extensibility.  The net-snmp
 175   agent can run as both a master agent and a subagent.  Additionally,
 176   a toolkit is provided that enables users of it to easily embed a
 177   agentx client into external applications.  See the tutorial at
 178   http://www.net-snmp.org/tutorial-5/toolkit/ for an example of how
 179   go about doing this.
 180
 181 CONFIGURATION
 182
 183   See the man/snmp.conf.5 manual page.
 184
 185   For the agent, additionally see the man/snmpd.conf.5 manual page.
 186
 187   For the snmptrapd, see the man/snmptrapd.conf.5 manual page.
 188
 189   You can also run the snmpconf perl script to help you create some of
 190   these files.
 191
 192 SUBMITTING BUG REPORTS
 193
 194   Important: *Please* include what version of the net-snmp (or
 195   ucd-snmp) package you are using and what architecture(s) you're
 196   using, as well as detailed information about exactly what is wrong.
 197
 198   To submit a bug report, please use the web interface at
 199   http://www.net-snmp.org/bugs/.  It is a full-fledged
 200   bug-tracking system that will allow you to search for already
 201   existing bug reports as well as track the status of your report as
 202   it is processed by the core developers.
 203
 204   If you intend to submit a patch as well, please read the PORTING
 205   file before you do so and then submit it to
 206   http://www.net-snmp.org/patches/.
 207
 208 CLOSING
 209
 210   We love patches.  Send some to us!  But before you do, please see
 211   the 'PORTING' file for information on helping us out with the
 212   process of integrating your patches (regardless of whether its a new
 213   feature implementation or a new port).
 214
 215   Also, We're interested if anyone actually uses/likes/hates/whatever
 216   this package...  Mail us a note and let us know what you think of it!
 217
 218   Have fun and may it make your life easier,
 219
 220     The net-snmp developers
 221
 222 THANKS
 223
 224   The following people have contributed various patches and
 225   improvements.  To them we owe our deepest thanks (and you do too!):
 226
 227     Wes Hardaker <hardaker@users.sourceforge.net>
 228     Steve Waldbusser <waldbusser@nextbeacon.com>
 229     Dan A. Dickey <ddickey@transition.com>
 230     Dave Shield <D.T.Shield@csc.liv.ac.uk>
 231     Giovanni S. Marzot <gmarzot@nortelnetworks.com>
 232     Niels Baggesen <recnba@mediator.uni-c.dk>
 233     Simon Leinen <simon@limmat.switch.ch>
 234     David T. Perkins <dperkins@dsperkins.com>
 235     Mike Perik <mikep@crt.com>
 236     Sanjai Narain <narain@thumper.bellcore.com>
 237     francus@metsny.delphi.com
 238     Gary Palmer <gpalmer@freebsd.org>
 239     Marc G. Fournier <scrappy@ki.net>
 240     Gary A. Hayward <gah@bellcore.com>
 241     Jennifer Bray <jbray@origin-at.co.uk>
 242     Philip Guenther <guenther@gac.edu>
 243     Elwyn B Davies <edavies@origin-at.co.uk>
 244     Simon Burge <simonb@telstra.com.au>
 245     David Paul Zimmerman <dpz@apple.com>
 246     Alan Batie <batie@aahz.jf.intel.com>
 247     Michael Douglass <mikedoug@texas.net>
 248     Ted Rule <Ted_Rule@FLEXTECH.CO.UK>
 249     Craig Bevins <craigb@bitcom.net.au>
 250     Arther Hyun <arthur@psi.com>
 251     Cristian Estan <Cristian.Estan@net.utcluj.ro>
 252     Eugene Polovnikov <eugen@rd.zgik.zaporizhzhe.ua>
 253     Jakob Ellerstedt <jakob@dynarc.se>
 254     Michael J. Slifcak <slif@bellsouth.net>
 255     Jonas Olsson <jolsson@erv.ericsson.se>
 256     James H. Young <sysjhy@gsu.edu>
 257     Jeff Johnson <jbj@redhat.com>
 258     Markku Laukkanen <marlaukk@stybba.ntc.nokia.com>
 259     Derek Simkowiak <dereks@kd-dev.com>
 260     David F. Newman <dnewman@epnet.com>
 261     Nick Amato <naamato@merit.edu>
 262     Mike Baer <baerm@calweb.com>
 263     Patrick Lawrence <pjlawrence@ucdavis.edu>
 264     Russ Mundy <mundy@tislabs.com>
 265     Olafur Gudmundsson <ogud@tislabs.com>
 266     David Reeder <dreeder@tislabs.com>
 267     Ed Lewis <lewis@tislabs.com>
 268     Bill Babson <wbabson@tislabs.com>
 269     Chris Smith <csmith@platform.com>
 270     Mike Michaud <mikemichaud@earthlink.net>
 271     Andy Hood <ahood@westpac.com.au>
 272     Robert Story <rstory@freesnmp.com>
 273     Bert Driehuis <driehuis@playbeing.org>
 274     Juergen Schoenwaelder <schoenw@ibr.cs.tu-bs.de>
 275     Frank Strauss <strauss@ibr.cs.tu-bs.de>
 276     Ragnar Kjørstad <ucd@ragnark.vestdata.no>
 277     Jochen Kmietsch <jochen.kmietsch@tu-clausthal.de>
 278     Jun-ichiro itojun Hagino <itojun@iijlab.net>
 279     John L Villalovos <john.l.villalovos@intel.com>
 280     Christoph Mammitzsch <Christoph.Mammitzsch@tu-clausthal.de>
 281     Arne Oesleboe <Arne.Oesleboe@item.ntnu.no>
 282     Jeff Cours <jeff@ultradns.com>
 283     Karl Schilke <karl_schilke@eli.net>
 284     John Naylon <jbpn@cambridgebroadband.com>
 285     Ken Hornstein <kenh@cmf.nrl.navy.mil>
 286     Martin Oldfield <m@mail.tc>
 287     Harrie Hazewinkel <harrie@users.sourceforge.net>
 288     Mark Ferlatte <ferlatte@users.sourceforge.net>
 289     Marus Meissner <marcusmeissner@users.sourceforge.net>
 290     Stephan Wenzer <stephanwenzel@users.sourceforge.net>
 291     Ron Mevissen <ron.mevissen@eed.ericsson.se>
 292     T.J. Mather <tjmather@tjmather.com>
 293     Craig Setera <seterajunk@charter.net>
 294     Katsuhisa ABE <abekatsu@cysols.com>
 295     Axel Kittenberger <Axel.Kittenberger@maxxio.com>
 296     Johannes Schmidt-Fischer <jsf@InterFace-AG.com>
 297     Jeffrey Watson <nostaw@users.sourceforge.net>
 298     Bruce Shaw <Bruce.Shaw@gov.ab.ca>
 299     Stefan Radman <sradman@users.sourceforge.net>
 300
 301   We've probably forgotten people on this list.  Let us know if you've
 302   contributed code and we've left you out.