From 92b2fd6b18d052cd49e8921626ad0abbcedc0b0b Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Thu, 3 Mar 2011 18:32:59 +0100 Subject: Added documentation file (snmpc_cmd.xml) for the snmpc command line tool. Also updated the central .gitignore file. --- .gitignore | 1 + lib/snmp/doc/src/snmpc_cmd.xml | 191 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 192 insertions(+) create mode 100644 lib/snmp/doc/src/snmpc_cmd.xml diff --git a/.gitignore b/.gitignore index 54bfadea9a..0bd5e1ff2c 100644 --- a/.gitignore +++ b/.gitignore @@ -303,6 +303,7 @@ make/win32/ # snmp /lib/snmp/bin/snmp-v2tov1 +/lib/snmp/bin/snmpc /lib/snmp/examples/ex1/EX1-MIB.bin /lib/snmp/mibs/Makefile /lib/snmp/mibs/v1/OTP-SNMPEA-MIB.mib.v1 diff --git a/lib/snmp/doc/src/snmpc_cmd.xml b/lib/snmp/doc/src/snmpc_cmd.xml new file mode 100644 index 0000000000..18ff71631c --- /dev/null +++ b/lib/snmp/doc/src/snmpc_cmd.xml @@ -0,0 +1,191 @@ + + + + +
+ + 20112011 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + snmpc + + + + + + + + snmpc_cmd.xml +
+ snmpc + SNMP MIB compiler frontend + +

The program provides a way to run + the SNMP MIB compiler of the Erlang system.

+ + + + + snmpc [options] file.mib | file.bin + Compile MIBs + +

compile a SNMP MIB file, + see compile/1,2 for + more info.

+

It can also be used to generate a header file (.hrl) + with definitions of Erlang constants for the objects in + the MIB, see + mib_to_hrl/1.

+ + + + +
+ Compiler options +

The following options are supported (note that most of these relate + to the compilation of the MIB file):

+ + --help + +

Prints help info.

+ + + --version + +

Prints application and mib format version.

+ + + --verbosity verbosity + +

Print debug info.

+

verbosity = trace | debug | log | info | silence

+

Defaults to silence.

+ + + --warnings + +

Print warning messages.

+ + + --o directory + +

The directory where the compiler should place the output files. + If not specified, output files will be placed in the current working + directory.

+ + + --i Directory + +

Specifies the path to search for imported (compiled) MIB files. + By default, the current working directory is always included.

+

This option can be present several times, each time specifying + one path.

+ + + --il Directory + +

This option (include_lib), specifies a list of directories to + search for imported MIBs. It assumes that the first element in + the directory name corresponds to an OTP application. The compiler + will find the current installed version. For example, the value + ["snmp/mibs/"] will be replaced by ["snmp-3.1.1/mibs/"] (or what + the current version may be in the system). The current directory + and the "snmp-home"/priv/mibs/ are always listed last in the + include path.

+ + + --sgc + +

This option (skip group check), if present, disables the + group check of the mib compiler. + That is, should the OBJECT-GROUP and the NOTIFICATION-GROUP + macro(s) be checked for correctness or not.

+ + + --dep + +

Keep deprecated definition(s). + If not specified the compiler will ignore deprecated definitions.

+ + + --desc + +

The DESCRIPTION field will be included.

+ + + --ref + +

The REFERENCE field will be included.

+ + + --imp + +

The IMPORTS field will be included.

+ + + --mi + +

The MODULE-IDENTITY field will be included.

+ + + --mc + +

The MODULE-COMPLIANCE field will be included.

+ + + --ac + +

The AGENT-CAPABILITIES field will be included.

+ + + --mod module + +

The module which implements all the instrumentation functions.

+

The name of all instrumentation functions must be the + same as the corresponding managed object it implements.

+ + + --nd + +

The default instrumentation functions will not be + used if a managed object have no instrumentation function. + Instead this will be reported as an error, and the compilation + aborts.

+ + + --rrnac + +

This option, if present, specifies that the row name assign check + shall not be done strictly according to the SMI (which allows only + the value 1).

+

With this option, all values greater than zero is allowed (>= 1). + This means that the error will be converted to a warning.

+

By default it is not included, but if this option is present + it will be.

+ + + +
+ +
+ SEE ALSO +

erlc(1), + compile(3), + snmpc(3)

+
+ + -- cgit v1.2.3