This is the mail archive of the
ecos-patches@sources.redhat.com
mailing list for the eCos project.
snmp agent doc tweaks
- From: Jonathan Larmour <jlarmour at jifvik dot org>
- To: ecos-patches at sources dot redhat dot com
- Date: Wed, 5 Feb 2003 13:55:54 GMT
- Subject: snmp agent doc tweaks
Index: ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos-opt/snmp/agent/current/ChangeLog,v
retrieving revision 1.21
diff -u -5 -p -r1.21 ChangeLog
--- ChangeLog 3 Feb 2003 16:34:44 -0000 1.21
+++ ChangeLog 5 Feb 2003 13:55:53 -0000
@@ -1,5 +1,10 @@
+2003-02-05 Jonathan Larmour <jifl@eCosCentric.com>
+
+ * doc/snmp.sgml: Fix a doc build failure, and tweak some duff links and
+ a few typos.
+
2003-02-03 Andrew Lunn <andrew.lunn@ascom.ch>
* doc/prepare-manpages.sh: New file. Convert from man to sgml.
* doc/manpages/snmpd.conf.5: New file: Manual page for snmpd.conf.
* doc/snmp-manpages.sgml: New file. The converted man page
Index: doc/snmp.sgml
===================================================================
RCS file: /cvs/ecos/ecos-opt/snmp/agent/current/doc/snmp.sgml,v
retrieving revision 1.3
diff -u -5 -p -r1.3 snmp.sgml
--- doc/snmp.sgml 3 Feb 2003 16:34:45 -0000 1.3
+++ doc/snmp.sgml 5 Feb 2003 13:55:53 -0000
@@ -244,11 +244,13 @@ again.
<SECT1 id="net-snmp-configuring-ecos">
<TITLE>Configuring eCos</TITLE>
<PARA>
Apart from adding the networking, common ethernet device drivers,
snmp library and snmp agent packages, there is no configuration
-required.
+required. However there are a number of configuration options
+that can be set such as some details for the System MIB, and
+disabling SNMPv3 support (see below).
</PARA>
<PARA>
Starting the SNMP agent is not integrated into network
tests other than <FILENAME>snmpping</FILENAME> below, nor is it
started automatically in normal eCos startup -
@@ -264,25 +266,26 @@ following implications :
</PARA>
<PARA> 1. There is no community authentication for v1 and v2c.</PARA>
<PARA>2. Security provided by v3 can be bypassed by using v1/v2c protocol.</PARA>
<PARA>
To provide the dispatcher with rfc 2571 type functionality, it is required to
-setup security models and access profiles. This can be provided in the normal
+set up security models and access profiles. This can be provided in the normal
Unix style by writing the required configurations in <LITERAL>snmpd.conf</LITERAL>
file. Application code may setup profiles in <LITERAL>snmpd.conf</LITERAL> and
optionally set the environment variable <LITERAL>SNMPCONFPATH</LITERAL> to
point to the file if it is not in the usual location. The whole concept works
in the usual way as with the standard UCD-SNMP distribution.
</PARA>
+</SECT2>
<SECT2 id="Traps">
<TITLE>Traps</TITLE>
<PARA>
-The support of <LITERAL>trapsink</LITERAL> command in
-<ulink url="net-snmp-snmpd.conf.html"> snmpd.conf</ulink> file is not tested
-and may have problems in working as expected. Moreover, in systems that do not
-filesystem support, there is no way to configure a trap-session in conventional
-way.
+The support of the <LITERAL>trapsink</LITERAL> command in the
+<link linkend="SNMPD.CONF">snmpd.conf</link> file is not tested
+and there may be problems for it working as expected. Moreover, in systems that do not
+have filesystem support, there is no way to configure a trap-session in the
+conventional way.
</PARA>
<PARA>
For reasons mentioned above, applications need to initialize their own trap
sessions and pass it the details of trap-sink. The following is a small sample
for initializing a v1 trap session :
@@ -319,21 +322,21 @@ if (trapsink.ip != 0) {
Using snmpd.conf requires the inclusion of one of the file-system packages
(eg. CYGPKG_RAMFS) and CYGPKG_FILEIO. With these two packages included, the
SNMP sub-system will read the snmpd.conf file from the location specified in
<LITERAL>SNMPCONFPATH</LITERAL>, or the standard builtin locations, and use
these profiles. Only the profiles specified in the <LITERAL>ACCESS-CONTROL</LITERAL>
-section of <ulink url="net-snmp-snmpd.conf.html">snmpd.conf</ulink> file have
+section of <link linkend="SNMPD.CONF">snmpd.conf</link> file have
been tested and shown to work. Other profiles which have been implemented in
<LITERAL>UCD-SNMP-4.1.2</LITERAL>'s <LITERAL>snmpd.conf</LITERAL> may not work
because the sole purpose of adding support for the snmpd.conf file has been to
-setup <LITERAL>ACCESS-CONTROL</LITERAL> models.
+set up <LITERAL>ACCESS-CONTROL</LITERAL> models.
</PARA>
<PARA>
At startup, the SNMP module tries to look for file <FILENAME>snmp.conf</FILENAME>.
If this file is not available, the module successively looks for files
<FILENAME>snmpd.conf</FILENAME>, <FILENAME>snmp.local.conf</FILENAME> and
-<FILENAME>snmpd.local.conf</FILENAME> at location pointed to by <LITERAL>
+<FILENAME>snmpd.local.conf</FILENAME> at the locations pointed to by <LITERAL>
SNMPCONFPATH</LITERAL> environment variable. In case <LITERAL>SNMPCONFPATH
</LITERAL> is not defined, the search sequence is carried out in default directories.
The default directories are :<FILENAME>/usr/share/snmp</filename>, <filename>
/usr/local/share/snmp</filename> and <filename>$(HOME)/.snmp</filename>.
The configurations read from these files are used to control both, SNMP
@@ -469,12 +472,12 @@ an empty list.
<PARA>
<filename>PACKAGES/net/snmp/lib/VERSION/src/read_config.c</filename>
contains two systems:
</PARA>
<PARA>
-The first tries to read the configuration file as described in
-<ulink url="net-snmp-configuring-ecos.html">snmpd.conf file</ulink> section and
+The first tries to read the configuration file as described in the
+<link linkend="net-snmp-configuring-ecos">snmpd.conf file</link> section and
the second system contains code to record persistent data as files in a
directory (typically <filename>/var/ucd-snmp</filename>) thus preserving the
state permanently.
</PARA>
<PARA>