summaryrefslogtreecommitdiffstats
path: root/contrib/bsnmp/snmpd/bsnmpd.1
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/bsnmp/snmpd/bsnmpd.1')
-rw-r--r--contrib/bsnmp/snmpd/bsnmpd.195
1 files changed, 57 insertions, 38 deletions
diff --git a/contrib/bsnmp/snmpd/bsnmpd.1 b/contrib/bsnmp/snmpd/bsnmpd.1
index bfc792d..9da7456 100644
--- a/contrib/bsnmp/snmpd/bsnmpd.1
+++ b/contrib/bsnmp/snmpd/bsnmpd.1
@@ -1,4 +1,7 @@
.\"
+.\" Copyright (c) 2004-2005
+.\" Hartmut Brandt.
+.\" All rights reserved.
.\" Copyright (c) 2001-2003
.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
.\" All rights reserved.
@@ -26,14 +29,14 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Begemot: bsnmp/snmpd/bsnmpd.1,v 1.6 2005/02/25 11:56:01 brandt_h Exp $
+.\" $Begemot: bsnmp/snmpd/bsnmpd.1,v 1.9 2005/10/04 08:46:54 brandt_h Exp $
.\"
-.Dd August 15, 2002
+.Dd October 4, 2005
.Dt SNMPD 1
.Os
.Sh NAME
-.Nm snmpd
-.Nd "simple and extendable SNMP daemon"
+.Nm bsnmpd
+.Nd "simple and extensible SNMP daemon"
.Sh SYNOPSIS
.Nm
.Op Fl dh
@@ -46,9 +49,10 @@
.Sh DESCRIPTION
The
.Nm
-daemon servers the internet SNMP (Simple Network Managment Protocol).
+daemon servers the internet SNMP (Simple Network Management Protocol).
It is intended to serve only the absolute basic MIBs and implement all other
-MIBs through loadable modules. In this way the
+MIBs through loadable modules.
+In this way the
.Nm
can be used in unexpected ways.
.Pp
@@ -78,11 +82,13 @@ This causes the debugging level of the event library (see
to be set to 10.
.It Cm trace Ns Cm = Ns Cm level
This option causes the snmp library trace flag to be set to the specified
-value. The value can be specified in the usual C-syntax for numbers.
+value.
+The value can be specified in the usual C-syntax for numbers.
.El
.It Fl I Ar paths
This option specifies a colon separated list of directories to search for
-configuration include files. The default is
+configuration include files.
+The default is
.Pa /etc:/usr/etc/:/usr/local/etc .
These paths are only searched for include specified within <> parentheses.
.It Fl l Ar prefix
@@ -98,8 +104,8 @@ Specify an alternate pid file instead of the default one.
The
.Nm
reads its configuration from either the default or the user specified
-configuration file. The configuration file consists of the following types of
-lines:
+configuration file.
+The configuration file consists of the following types of lines:
.Bl -bullet -offset indent
.It
variable assignments
@@ -112,18 +118,21 @@ MIB variable assignments
.El
.Pp
If a line is too long it can be continued on the next line by ending it with
-a backslash. Empty lines and lines in which the first non-blank character is a
+a backslash.
+Empty lines and lines in which the first non-blank character is a
.Dq #
sign are ignored.
.Pp
All MIB variable assignments of the entire configuration (including nested
-configuration files) are handled as one transaction, i.e. as if they arrived
-in a single SET PDU. Any failure during the initial configuration read causes
+configuration files) are handled as one transaction, i.e., as if they arrived
+in a single SET PDU.
+Any failure during the initial configuration read causes
.Nm
-to exit. A failure during the configuration read caused by a module load
+to exit.
+A failure during the configuration read caused by a module load
causes the loading of the module to fail.
.Pp
-The configuration is read during initialisation of
+The configuration is read during initialization of
.Nm ,
when a module is loaded and when
.Nm
@@ -138,23 +147,25 @@ variable ?= string
The string reaches from the first non-blank character after the
equal sign until the first new line or
.Dq #
-character. In the first case
+character.
+In the first case
the string is assigned to the variable unconditionally, in the second case the
variable is only assigned if it does not exist yet.
.Pp
Variable names must begin with a letter or underscore and contain only letters,
digits or underscores.
.Ss SECTION SEPARATORS
-The configuration consists of named sections. The MIB variable assignments in
-the section named
+The configuration consists of named sections.
+The MIB variable assignments in the section named
.Dq snmpd
are executed only during initial setup or when
.Nm
-receives a SIGHUP. All other sections are executed when either a module
+receives a SIGHUP.
+All other sections are executed when either a module
with the same name as the section is loaded or
.Nm
-receives a SIGHUP and that module is already loaded. The default section
-at the start of the configuration is
+receives a SIGHUP and that module is already loaded.
+The default section at the start of the configuration is
.Dq snmpd .
One can switch to another section with the syntax
.Bd -unfilled -offset indent
@@ -163,10 +174,11 @@ One can switch to another section with the syntax
.Pp
Where
.Ar secname
-is the name of the section. The same
+is the name of the section.
+The same
.Ar secname
-can be used in more than one place in the configuration. All of these parts are
-collected into one section.
+can be used in more than one place in the configuration.
+All of these parts are collected into one section.
.Ss INCLUDE DIRECTIVES
Another configuration file can be included into the current one with the
include directive that takes one of two forms:
@@ -177,8 +189,8 @@ include directive that takes one of two forms:
.Pp
The first form causes the file to be searched in the current directory, the
second form causes the file to be searched in the directories specified in
-the system include path. Nesting depth is only restricted by available
-memory.
+the system include path.
+Nesting depth is only restricted by available memory.
.Ss MIB VARIABLE ASSIGNMENTS
A MIB variable is assigned with the syntax
.Bd -unfilled -offset indent
@@ -186,17 +198,23 @@ oid [ suboids ] = value
.Ed
.Pp
.Va oid
-is the name of the variable to be set. Only the last component of the entire
-name is used here. If the variable is a scalar, the index (.0) is automatically
-appended and need not to be specified. If the variable is a table column,
-the index
+is the name of the variable to be set.
+Only the last component of the entire name is used here.
+If the variable is a scalar, the index (.0) is automatically
+appended and need not to be specified.
+If the variable is a table column, the index
.Pq Va suboids
-must be specified. The index consist of elements each seperated from the
-previous one by a dot. Elements may be either numbers, strings or hostnames
-enclosed in [] brackets. If the element is a number it is appended
-to the current oid. If the element is a string, its length and the
+must be specified.
+The index consist of elements each separated from the
+previous one by a dot.
+Elements may be either numbers, strings or hostnames
+enclosed in [] brackets.
+If the element is a number it is appended
+to the current oid.
+If the element is a string, its length and the
.Tn ASCII
-code of each of its characters are appended to the current oid. If the
+code of each of its characters are appended to the current oid.
+If the
element is a hostname, the IP address of the host is looked up and the four
elements of the IP address are appended to the oid.
.Pp
@@ -213,7 +231,8 @@ myvariable.27.6.102.111.111.111.108.108.127.0.0.1.38.94.33
The value of the assignment may be either empty, a string or a number.
If a string starts with a letter or an underscore and consists only of
letters, digits, underscores and minus signs, it can be written without
-quotes. In all other cases the string must be enclosed in double quotes.
+quotes.
+In all other cases the string must be enclosed in double quotes.
.Sh SUBSTITUTIONS
A variable substitution is written as
.Bd -unfilled -offset indent
@@ -222,8 +241,8 @@ $(variable)
.Pp
where
.Ar variable
-is the name of the variable to substitute. Using an undefined variable is
-considered an error.
+is the name of the variable to substitute.
+Using an undefined variable is considered an error.
.Sh FILES
.Bl -tag -width ".It Pa /var/run/ Ns Ao Ar prefix Ac Ns \&.pid" -compact
.It Pa /etc/ Ns Ao Ar prefix Ac Ns \&.config
OpenPOWER on IntegriCloud