diff options
Diffstat (limited to 'lib/otp_mibs/doc/src')
| -rw-r--r-- | lib/otp_mibs/doc/src/Makefile | 115 | ||||
| -rw-r--r-- | lib/otp_mibs/doc/src/book.xml | 48 | ||||
| -rw-r--r-- | lib/otp_mibs/doc/src/fascicules.xml | 19 | ||||
| -rw-r--r-- | lib/otp_mibs/doc/src/introduction.xml | 46 | ||||
| -rw-r--r-- | lib/otp_mibs/doc/src/make.dep | 20 | ||||
| -rw-r--r-- | lib/otp_mibs/doc/src/mibs.xml | 70 | ||||
| -rw-r--r-- | lib/otp_mibs/doc/src/note.gif | bin | 0 -> 1539 bytes | |||
| -rw-r--r-- | lib/otp_mibs/doc/src/notes.xml | 149 | ||||
| -rw-r--r-- | lib/otp_mibs/doc/src/otp_mib.xml | 69 | ||||
| -rw-r--r-- | lib/otp_mibs/doc/src/part.xml | 38 | ||||
| -rw-r--r-- | lib/otp_mibs/doc/src/part_notes.xml | 37 | ||||
| -rw-r--r-- | lib/otp_mibs/doc/src/ref_man.xml | 37 |
12 files changed, 648 insertions, 0 deletions
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 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE book SYSTEM "book.dtd"> + +<book xmlns:xi="http://www.w3.org/2001/XInclude"> + <header titlestyle="normal"> + <copyright> + <year>2003</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>OTP_Mibs</title> + <prepared>Ingela Anderton</prepared> + <docno></docno> + <date>2003-04-15</date> + <rev>A</rev> + </header> + <insidecover> + </insidecover> + <pagetext>OTP_Mibs application</pagetext> + <preamble> + <contents level="2"></contents> + </preamble> + <parts lift="no"> + <xi:include href="part.xml"/> + </parts> + <applications> + <xi:include href="ref_man.xml"/> + </applications> + <releasenotes> + <xi:include href="notes.xml"/> + </releasenotes> + <index></index> +</book> + + 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 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE fascicules SYSTEM "fascicules.dtd"> + +<fascicules> + <fascicule file="part" href="part_frame.html" entry="no"> + User's Guide + </fascicule> + <fascicule file="ref_man" href="ref_man_frame.html" entry="yes"> + Reference Manual + </fascicule> + <fascicule file="part_notes" href="part_notes_frame.html" entry="no"> + Release Notes + </fascicule> + <fascicule file="" href="../../../../doc/print.html" entry="no"> + Off-Print + </fascicule> +</fascicules> + + 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 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2003</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>Introduction</title> + <prepared>Ingela Anderton</prepared> + <docno></docno> + <date>2003-05-19</date> + <rev>A</rev> + <file>introduction.xml</file> + </header> + + <section> + <title>Purpose</title> + <p>The purpose of the OTP_Mibs application is to provide an SNMP + management information base for Erlang nodes.</p> + </section> + + <section> + <title>Pre-requisites</title> + <p>It is assumed that the reader is familiar with the Erlang + programming language, concepts of OTP and has a basic knowledge + of SNMP.</p> + </section> +</chapter> + + 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 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2003</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>Mibs</title> + <prepared>Ingela Anderton</prepared> + <docno></docno> + <date>2003-05-19</date> + <rev>A</rev> + <file>mibs.xml</file> + </header> + + <section> + <title>Structure</title> + <p>The OTP mibs are stored in the + <c>$OTP_ROOT/lib/otp_mibs/mibs/</c> directory. They + are defined in SNMPv2 SMI syntax. An SNMPv1 version of the mib is + delivered in the <c>mibs/v1</c> directory. The compiled MIB is + located under <c>priv/mibs</c>, and the generated <c>.hrl</c> + file under the <c>include</c> directory. To compile a MIB that + IMPORTS a MIB in the OTP_Mibs application, give the option + <c>{il, ["otp_mibs/priv/mibs"]}</c> to the MIB compiler.</p> + </section> + + <section> + <title>OTP-MIB</title> + <p>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 + <c>otp_mib:load/1</c>.</p> + </section> + + <section> + <title>OTP-REG</title> + <p>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.</p> + </section> + + <section> + <title>OTP-TC</title> + <p>The OTP-TC mib provides the textual convention datatype + <c>OwnerString</c>.</p> + </section> +</chapter> + + diff --git a/lib/otp_mibs/doc/src/note.gif b/lib/otp_mibs/doc/src/note.gif Binary files differnew file mode 100644 index 0000000000..6fffe30419 --- /dev/null +++ b/lib/otp_mibs/doc/src/note.gif 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 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2004</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>OTP_Mibs Release Notes</title> + <prepared>otp_appnotes</prepared> + <docno>nil</docno> + <date>nil</date> + <rev>nil</rev> + <file>notes.xml</file> + </header> + <p>This document describes the changes made to the OTP_Mibs + application.</p> + +<section><title>Otp_Mibs 1.0.6</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + 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.</p> + <p> + Own Id: OTP-8201</p> + </item> + </list> + </section> + +</section> + +<section><title>Otp_Mibs 1.0.5</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p>The copyright notices have been updated.</p> + <p> + Own Id: OTP-7851</p> + </item> + </list> + </section> + +</section> + + <section> + <title>Otp_Mibs 1.0.4.1</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Minor Makefile changes.</p> + <p>Own Id: OTP-6689</p> + </item> + </list> + </section> + </section> + + <section> + <title>OTP_Mibs 1.0.4</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Replaced calls to deprecated functions in <c>snmp</c> + with calls to the equivalent functions in <c>snmpa</c>.</p> + <p>Own Id: OTP-6112</p> + </item> + </list> + </section> + </section> + + <section> + <title>OTP_Mibs 1.0.3</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>The <c>otp_mib</c> module has been cleaned up to improve the + maintainability. It should have no effect on the + functionality of the OTP_Mibs application.</p> + <p>Own Id: OTP-4982</p> + </item> + </list> + </section> + </section> + + <section> + <title>OTP_Mibs 1.0.2</title> + + <section> + <title>Fixed Bugs and Malfunctions</title> + <list type="bulleted"> + <item> + <p>Incorrect <c>.app</c> file (missing mandatory + <c>registered</c>).</p> + <p>Own Id: OTP-4823 Aux Id: Seq8145, OTP-4801 </p> + </item> + </list> + </section> + </section> + + <section> + <title>OTP_Mibs 1.0.1</title> + + <section> + <title>Fixed Bugs and Malfunctions</title> + <list type="bulleted"> + <item> + <p>Missing <c>.app</c> and <c>appup</c> files in <c>ebin</c>.</p> + <p>Own Id: OTP-4801 Aux Id: Seq8145 </p> + </item> + </list> + </section> + </section> + + <section> + <title>OTP_Mibs 1.0</title> + <p>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.</p> + <p>Own Id: OTP-4686</p> + </section> +</chapter> + + 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 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2003</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>otp_mib</title> + <prepared>Ingela Anderton</prepared> + <docno></docno> + <date></date> + <rev></rev> + </header> + <module>otp_mib</module> + <modulesummary>Handles the OTP-MIB</modulesummary> + <description> + <p>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.</p> + </description> + <funcs> + <func> + <name>load(Agent) -> ok | {error, Reason}</name> + <fsummary>Load the OTP-MIB</fsummary> + <type> + <v>Agent = pid() | atom()</v> + <v>Reason = term()</v> + </type> + <desc> + <p>Loads the OTP-MIB.</p> + </desc> + </func> + <func> + <name>unload(Agent) -> ok | {error, Reason}</name> + <fsummary>Unload the OTP-MIB</fsummary> + <type> + <v>Agent = pid() | atom()</v> + <v>Reason = term()</v> + </type> + <desc> + <p>Unloads the OTP-MIB.</p> + </desc> + </func> + </funcs> + + <section> + <title>See Also</title> + <p>snmp(3)</p> + </section> +</erlref> + + 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 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE part SYSTEM "part.dtd"> + +<part xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2003</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>OTP_Mibs User's Guide</title> + <prepared>Ingela Anderton</prepared> + <docno></docno> + <date>2002-09-17</date> + <rev>A</rev> + </header> + <description> + <p>The <em>OTP_Mibs</em> application provides an SNMP management + information base for Erlang nodes.</p> + </description> + <xi:include href="introduction.xml"/> + <xi:include href="mibs.xml"/> +</part> + + 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 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE part SYSTEM "part.dtd"> + +<part xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2004</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>OTP_Mibs Release Notes</title> + <prepared>Ingela Anderton Andin</prepared> + <docno></docno> + <date>2004-09-07</date> + <rev></rev> + </header> + <description> + <p>The <em>OTP_Mibs</em> application provides an SNMP management + information base for Erlang nodes.</p> + </description> + <xi:include href="notes.xml"/> +</part> + + 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 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE application SYSTEM "application.dtd"> + +<application xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2003</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>OTP_Mibs Reference Manual</title> + <prepared>Ingela Anderton</prepared> + <docno></docno> + <date>2002-09-13</date> + <rev>A</rev> + </header> + <description> + <p>The <em>OTP_Mibs</em> application provides an SNMP management + information base for Erlang nodes.</p> + </description> + <xi:include href="otp_mib.xml"/> +</application> + + |
