|
| 1 | + |
| 2 | + |
| 3 | + |
| 4 | +About agentXcpp |
| 5 | +=============== |
| 6 | + |
| 7 | +What is agentXcpp ? |
| 8 | +------------------- |
| 9 | + |
| 10 | +AgentXcpp is a C++ implementation of the AgentX protocol (RFC 2741). The AgentX |
| 11 | +protocol is used to implement SNMP MIBs as subagents, which are separate |
| 12 | +processes connecting to a master agent. The master agent in turn provides an |
| 13 | +SNMP interface to the outside world. |
| 14 | + |
| 15 | +You may visit the project's website: [agentxcpp.org](http://agentxcpp.org) |
| 16 | + |
| 17 | + |
| 18 | +Status of the project |
| 19 | +--------------------- |
| 20 | + |
| 21 | +All basic functions are implemented. |
| 22 | + |
| 23 | +Somewhat advanced features, e.g. GetBulk requests, contexts (used by SNMPv3) |
| 24 | +and agent capabilities, are not implemented. Also, TCP is not supported for |
| 25 | +agentX connections (only unix domain sockets are), so the library will not work |
| 26 | +on windows. Further, index allocating (needed to combine variables from |
| 27 | +multiple subagents into a single table) is not available. Currently, the |
| 28 | +library is also missing logging capabilities. |
| 29 | + |
| 30 | + |
| 31 | +License |
| 32 | +------- |
| 33 | + |
| 34 | +Copyright 2011-2016 Tanjeff-Nicolai Moos <tanjeff@cccmz.de> |
| 35 | + |
| 36 | +This file is part of the agentXcpp library. |
| 37 | + |
| 38 | +AgentXcpp is free software: you can redistribute it and/or modify |
| 39 | +it under the terms of the AgentXcpp library license, version 1, which |
| 40 | +consists of the GNU General Public License and some additional |
| 41 | +permissions. |
| 42 | + |
| 43 | +AgentXcpp is distributed in the hope that it will be useful, |
| 44 | +but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 45 | +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 46 | +GNU General Public License for more details. |
| 47 | + |
| 48 | +See the AgentXcpp library license in the LICENSE file of this package |
| 49 | +for more details. |
| 50 | + |
| 51 | +**IMPORTANT:** The software contained in the `site_scons` directory is |
| 52 | +distributed under its own license. See the files there for details. |
| 53 | + |
| 54 | + |
| 55 | +The Documentation |
| 56 | +================= |
| 57 | + |
| 58 | + |
| 59 | +There are two types of documentation: The |
| 60 | +"[API documentation](http://tanjeff.github.io/agentXcpp/docs/0.3/api/html/index.html)" |
| 61 | +and the |
| 62 | +"[internals documentation](http://tanjeff.github.io/agentXcpp/docs/0.3/internals/html/index.html)". |
| 63 | + |
| 64 | +The API documentation describes the AgentXcpp API and is intended for the user |
| 65 | +of the library. It contains not only the complete API reference, but also a |
| 66 | +tutorial to get started. |
| 67 | + |
| 68 | +The internals documentation explains all internals of the library, including |
| 69 | +descriptions of the used concepts, how the build system is configured and how |
| 70 | +releases should be created. Of course, it contains also the reference of the |
| 71 | +whole code. |
| 72 | + |
| 73 | +This section describes how to build the documentation from the source. |
| 74 | + |
| 75 | + |
| 76 | +Building the Documentation |
| 77 | +-------------------------- |
| 78 | + |
| 79 | +### Prerequisites |
| 80 | + |
| 81 | +To build agentXcpp, the following is needed: |
| 82 | + |
| 83 | +- Standard build environment (compiler, linker, etc.) |
| 84 | +- The QT4 library (devel package, e.g. libqt4-dev on linux systems) |
| 85 | +- Doxygen, to build the documentation |
| 86 | +- The `dot` tool from the graphviz package, which is used by doxygen to |
| 87 | + generate diagrams |
| 88 | +- SCons, to control the build process |
| 89 | +You can build the documentation using SCons or without SCons. |
| 90 | + |
| 91 | +### Build Commands |
| 92 | + |
| 93 | + 1. With SCons: |
| 94 | + cd into the `doc/` directory and type |
| 95 | + |
| 96 | + scons |
| 97 | + |
| 98 | + This builds both documentations (API and internal). |
| 99 | + |
| 100 | + 1. Without SCons: |
| 101 | + cd into the `doc/` directory and type |
| 102 | + |
| 103 | + doxygen api.doxyfile |
| 104 | + |
| 105 | + respectively |
| 106 | + |
| 107 | + doxygen internals.doxyfile |
| 108 | + |
| 109 | +After building, the documentation can be displayed by pointing a web browser to |
| 110 | +`doc/api/html/index.html` respectively `doc/internals/html/index.html`. |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | +Directory Structure of this Repository |
| 115 | +====================================== |
| 116 | + |
| 117 | + |
| 118 | +This top level directory contains the following elements: |
| 119 | + |
| 120 | + * __artwork/__ |
| 121 | + |
| 122 | + Here is the agentXcpp logo, and possibly other artwork. |
| 123 | + |
| 124 | + * __AUTHORS__ |
| 125 | + |
| 126 | + Contains the author(s) of the agentXcpp library. |
| 127 | + |
| 128 | + * __ChangeLog__ |
| 129 | + |
| 130 | + The Changelog. |
| 131 | + |
| 132 | + * __create-release.py__ |
| 133 | + |
| 134 | + A script to create an agentXcpp release. |
| 135 | + |
| 136 | + * __doc/__ |
| 137 | + |
| 138 | + This directory contains the documentation. The documentation is created |
| 139 | + using Doxygen and most of the content is contained in the source code. The |
| 140 | + doc/ directory contains the doxygen configs, some additional documentation |
| 141 | + files (*.dox) and the RFC 2741. |
| 142 | + |
| 143 | + * __getversion.py__ |
| 144 | + |
| 145 | + A script to reliably obtain the version of this agentXcpp copy. |
| 146 | + |
| 147 | + * __LICENSE__ |
| 148 | + |
| 149 | + Contains the AgentXcpp library LICENSE, which consists of the GPL and an |
| 150 | + additional linking exception. |
| 151 | + |
| 152 | + * __GPLv3__ |
| 153 | + |
| 154 | + The GNU GENERAL PUBLIC LICENSE, Version 3. |
| 155 | + |
| 156 | + * __README__ |
| 157 | + |
| 158 | + This file. |
| 159 | + |
| 160 | + * __SConstruct__ |
| 161 | + |
| 162 | + AgentXcpp is built using SCons. This file defines how to build the library |
| 163 | + and the documentation. |
| 164 | + |
| 165 | + * __site\_scons/__ |
| 166 | + |
| 167 | + This directory contains SCons supplements. The software contained in this |
| 168 | + directory is published under another license than agentXcpp, as it is not |
| 169 | + part of the agentXcpp software. Distribution is done for convenience. |
| 170 | + |
| 171 | + |
| 172 | + * __src/__ |
| 173 | + |
| 174 | + This directory contains the source code of the library. |
| 175 | + |
| 176 | + |
| 177 | + |
| 178 | + |
0 commit comments