From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/otp_mibs/doc/src/Makefile | 115 ++++++++++++++++++++++++++ lib/otp_mibs/doc/src/book.xml | 48 +++++++++++ lib/otp_mibs/doc/src/fascicules.xml | 19 +++++ lib/otp_mibs/doc/src/introduction.xml | 46 +++++++++++ lib/otp_mibs/doc/src/make.dep | 20 +++++ lib/otp_mibs/doc/src/mibs.xml | 70 ++++++++++++++++ lib/otp_mibs/doc/src/note.gif | Bin 0 -> 1539 bytes lib/otp_mibs/doc/src/notes.xml | 149 ++++++++++++++++++++++++++++++++++ lib/otp_mibs/doc/src/otp_mib.xml | 69 ++++++++++++++++ lib/otp_mibs/doc/src/part.xml | 38 +++++++++ lib/otp_mibs/doc/src/part_notes.xml | 37 +++++++++ lib/otp_mibs/doc/src/ref_man.xml | 37 +++++++++ 12 files changed, 648 insertions(+) create mode 100644 lib/otp_mibs/doc/src/Makefile create mode 100644 lib/otp_mibs/doc/src/book.xml create mode 100644 lib/otp_mibs/doc/src/fascicules.xml create mode 100644 lib/otp_mibs/doc/src/introduction.xml create mode 100644 lib/otp_mibs/doc/src/make.dep create mode 100644 lib/otp_mibs/doc/src/mibs.xml create mode 100644 lib/otp_mibs/doc/src/note.gif create mode 100644 lib/otp_mibs/doc/src/notes.xml create mode 100644 lib/otp_mibs/doc/src/otp_mib.xml create mode 100644 lib/otp_mibs/doc/src/part.xml create mode 100644 lib/otp_mibs/doc/src/part_notes.xml create mode 100644 lib/otp_mibs/doc/src/ref_man.xml (limited to 'lib/otp_mibs/doc/src') diff --git a/lib/otp_mibs/doc/src/Makefile b/lib/otp_mibs/doc/src/Makefile new file mode 100644 index 0000000000..bd2810034b --- /dev/null +++ b/lib/otp_mibs/doc/src/Makefile @@ -0,0 +1,115 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2003-2009. 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. +# +# %CopyrightEnd% +# + +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(OTP_MIBS_VSN) +APPLICATION=otp_mibs + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- +XML_APPLICATION_FILES = ref_man.xml +XML_REF3_FILES = otp_mib.xml + +XML_PART_FILES = part.xml part_notes.xml +XML_CHAPTER_FILES = \ + introduction.xml \ + mibs.xml \ + notes.xml + +BOOK_FILES = book.xml + +XML_FILES = \ + $(BOOK_FILES) $(XML_CHAPTER_FILES) \ + $(XML_PART_FILES) $(XML_REF3_FILES) $(XML_APPLICATION_FILES) + +GIF_FILES = note.gif + +# ---------------------------------------------------- + +HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) + +INFO_FILE = ../../info + +MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) + +HTML_REF_MAN_FILE = $(HTMLDIR)/index.html + +TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- +XML_FLAGS += +DVIPS_FLAGS += + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +$(HTMLDIR)/%.gif: %.gif + $(INSTALL_DATA) $< $@ + +docs: pdf html man + +$(TOP_PDF_FILE): $(XML_FILES) + +pdf: $(TOP_PDF_FILE) + +html: gifs $(HTML_REF_MAN_FILE) + +man: $(MAN3_FILES) + +gifs: $(GIF_FILES:%=$(HTMLDIR)/%) + +debug opt: + +clean clean_docs: + rm -rf $(HTMLDIR)/* + rm -f $(MAN3DIR)/* + rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) + rm -f errs core *~ + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + +release_docs_spec: docs + $(INSTALL_DIR) $(RELSYSDIR)/doc/pdf + $(INSTALL_DATA) $(TOP_PDF_FILE) $(RELSYSDIR)/doc/pdf + $(INSTALL_DIR) $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(HTMLDIR)/* \ + $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR) + $(INSTALL_DIR) $(RELEASE_PATH)/man/man3 + $(INSTALL_DATA) $(MAN3DIR)/* $(RELEASE_PATH)/man/man3 + +release_spec: + diff --git a/lib/otp_mibs/doc/src/book.xml b/lib/otp_mibs/doc/src/book.xml new file mode 100644 index 0000000000..11d08b8a41 --- /dev/null +++ b/lib/otp_mibs/doc/src/book.xml @@ -0,0 +1,48 @@ + + + + +
+ + 20032009 + 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. + + + + OTP_Mibs + Ingela Anderton + + 2003-04-15 + A +
+ + + OTP_Mibs application + + + + + + + + + + + + + + + + diff --git a/lib/otp_mibs/doc/src/fascicules.xml b/lib/otp_mibs/doc/src/fascicules.xml new file mode 100644 index 0000000000..101e745722 --- /dev/null +++ b/lib/otp_mibs/doc/src/fascicules.xml @@ -0,0 +1,19 @@ + + + + + + User's Guide + + + Reference Manual + + + Release Notes + + + Off-Print + + + + diff --git a/lib/otp_mibs/doc/src/introduction.xml b/lib/otp_mibs/doc/src/introduction.xml new file mode 100644 index 0000000000..c1ed0fed78 --- /dev/null +++ b/lib/otp_mibs/doc/src/introduction.xml @@ -0,0 +1,46 @@ + + + + +
+ + 20032009 + 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. + + + + Introduction + Ingela Anderton + + 2003-05-19 + A + introduction.xml +
+ +
+ Purpose +

The purpose of the OTP_Mibs application is to provide an SNMP + management information base for Erlang nodes.

+
+ +
+ Pre-requisites +

It is assumed that the reader is familiar with the Erlang + programming language, concepts of OTP and has a basic knowledge + of SNMP.

+
+ + + diff --git a/lib/otp_mibs/doc/src/make.dep b/lib/otp_mibs/doc/src/make.dep new file mode 100644 index 0000000000..2885155315 --- /dev/null +++ b/lib/otp_mibs/doc/src/make.dep @@ -0,0 +1,20 @@ +# ---------------------------------------------------- +# >>>> Do not edit this file <<<< +# This file was automaticly generated by +# /home/otp/bin/docdepend +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# TeX files that the DVI file depend on +# ---------------------------------------------------- + +book.dvi: book.tex introduction.tex mibs.tex otp_mib.tex \ + part.tex ref_man.tex + +# ---------------------------------------------------- +# Source inlined when transforming from source to LaTeX +# ---------------------------------------------------- + +book.tex: ref_man.xml + diff --git a/lib/otp_mibs/doc/src/mibs.xml b/lib/otp_mibs/doc/src/mibs.xml new file mode 100644 index 0000000000..16d2ac201a --- /dev/null +++ b/lib/otp_mibs/doc/src/mibs.xml @@ -0,0 +1,70 @@ + + + + +
+ + 20032009 + 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. + + + + Mibs + Ingela Anderton + + 2003-05-19 + A + mibs.xml +
+ +
+ Structure +

The OTP mibs are stored in the + $OTP_ROOT/lib/otp_mibs/mibs/ directory. They + are defined in SNMPv2 SMI syntax. An SNMPv1 version of the mib is + delivered in the mibs/v1 directory. The compiled MIB is + located under priv/mibs, and the generated .hrl + file under the include directory. To compile a MIB that + IMPORTS a MIB in the OTP_Mibs application, give the option + {il, ["otp_mibs/priv/mibs"]} to the MIB compiler.

+
+ +
+ OTP-MIB +

The OTP-MIB mib represents information about Erlang nodes such as + node name, number of running processes, virtual machine version + etc. If the MIB should be used in a system, it should be + loaded into an SNMP agent by using the API function + otp_mib:load/1.

+
+ +
+ OTP-REG +

The OTP-REG mib defines the unique OTP subtree of object + identifiers under the Ericsson subtree. Under the OTP subtree + several object identifiers are defined. This module is typically + included by OTP applications defining their own mibs, or ASN.1 + modules in general, that require unique object identifiers under + the OTP subtree.

+
+ +
+ OTP-TC +

The OTP-TC mib provides the textual convention datatype + OwnerString.

+
+ + + diff --git a/lib/otp_mibs/doc/src/note.gif b/lib/otp_mibs/doc/src/note.gif new file mode 100644 index 0000000000..6fffe30419 Binary files /dev/null and b/lib/otp_mibs/doc/src/note.gif differ diff --git a/lib/otp_mibs/doc/src/notes.xml b/lib/otp_mibs/doc/src/notes.xml new file mode 100644 index 0000000000..94c1dd4228 --- /dev/null +++ b/lib/otp_mibs/doc/src/notes.xml @@ -0,0 +1,149 @@ + + + + +
+ + 20042009 + 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. + + + + OTP_Mibs Release Notes + otp_appnotes + nil + nil + nil + notes.xml +
+

This document describes the changes made to the OTP_Mibs + application.

+ +
Otp_Mibs 1.0.6 + +
Improvements and New Features + + +

+ The documentation is now built with open source tools + (xsltproc and fop) that exists on most platforms. One + visible change is that the frames are removed.

+

+ Own Id: OTP-8201

+ + +
+ +
+ +
Otp_Mibs 1.0.5 + +
Improvements and New Features + + +

The copyright notices have been updated.

+

+ Own Id: OTP-7851

+ + +
+ +
+ +
+ Otp_Mibs 1.0.4.1 + +
+ Improvements and New Features + + +

Minor Makefile changes.

+

Own Id: OTP-6689

+ + +
+
+ +
+ OTP_Mibs 1.0.4 + +
+ Improvements and New Features + + +

Replaced calls to deprecated functions in snmp + with calls to the equivalent functions in snmpa.

+

Own Id: OTP-6112

+ + +
+
+ +
+ OTP_Mibs 1.0.3 + +
+ Improvements and New Features + + +

The otp_mib module has been cleaned up to improve the + maintainability. It should have no effect on the + functionality of the OTP_Mibs application.

+

Own Id: OTP-4982

+ + +
+
+ +
+ OTP_Mibs 1.0.2 + +
+ Fixed Bugs and Malfunctions + + +

Incorrect .app file (missing mandatory + registered).

+

Own Id: OTP-4823 Aux Id: Seq8145, OTP-4801

+ + +
+
+ +
+ OTP_Mibs 1.0.1 + +
+ Fixed Bugs and Malfunctions + + +

Missing .app and appup files in ebin.

+

Own Id: OTP-4801 Aux Id: Seq8145

+ + +
+
+ +
+ OTP_Mibs 1.0 +

The OTP mibs that where included in the SASL application + have been moved to this new application OTP_Mibs. The OTP + mibs had no real connection to SASL and it is desirable that + the core of Erlang/OTP is not dependent on SNMP.

+

Own Id: OTP-4686

+
+ + + diff --git a/lib/otp_mibs/doc/src/otp_mib.xml b/lib/otp_mibs/doc/src/otp_mib.xml new file mode 100644 index 0000000000..c96b31a1d4 --- /dev/null +++ b/lib/otp_mibs/doc/src/otp_mib.xml @@ -0,0 +1,69 @@ + + + + +
+ + 20032009 + 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. + + + + otp_mib + Ingela Anderton + + + +
+ otp_mib + Handles the OTP-MIB + +

The SNMP application should be used to start an SNMP agent. Then + the API functions below can be used to load/unload the OTP-MIB + into/from the agent. The instrumentation of the OTP-MIB uses + Mnesia, hence Mnesia must be started prior to loading the OTP-MIB.

+ + + + load(Agent) -> ok | {error, Reason} + Load the OTP-MIB + + Agent = pid() | atom() + Reason = term() + + +

Loads the OTP-MIB.

+ + + + unload(Agent) -> ok | {error, Reason} + Unload the OTP-MIB + + Agent = pid() | atom() + Reason = term() + + +

Unloads the OTP-MIB.

+ + + + +
+ See Also +

snmp(3)

+
+ + + diff --git a/lib/otp_mibs/doc/src/part.xml b/lib/otp_mibs/doc/src/part.xml new file mode 100644 index 0000000000..40988fda69 --- /dev/null +++ b/lib/otp_mibs/doc/src/part.xml @@ -0,0 +1,38 @@ + + + + +
+ + 20032009 + 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. + + + + OTP_Mibs User's Guide + Ingela Anderton + + 2002-09-17 + A +
+ +

The OTP_Mibs application provides an SNMP management + information base for Erlang nodes.

+ + + + + + diff --git a/lib/otp_mibs/doc/src/part_notes.xml b/lib/otp_mibs/doc/src/part_notes.xml new file mode 100644 index 0000000000..a7bdde9b64 --- /dev/null +++ b/lib/otp_mibs/doc/src/part_notes.xml @@ -0,0 +1,37 @@ + + + + +
+ + 20042009 + 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. + + + + OTP_Mibs Release Notes + Ingela Anderton Andin + + 2004-09-07 + +
+ +

The OTP_Mibs application provides an SNMP management + information base for Erlang nodes.

+ + + + + diff --git a/lib/otp_mibs/doc/src/ref_man.xml b/lib/otp_mibs/doc/src/ref_man.xml new file mode 100644 index 0000000000..1b5d91e9db --- /dev/null +++ b/lib/otp_mibs/doc/src/ref_man.xml @@ -0,0 +1,37 @@ + + + + +
+ + 20032009 + 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. + + + + OTP_Mibs Reference Manual + Ingela Anderton + + 2002-09-13 + A +
+ +

The OTP_Mibs application provides an SNMP management + information base for Erlang nodes.

+ + + + + -- cgit v1.2.3