Nevelex Corporation Nevelex Utilities 1.1.4 09/06/2003
Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

Nevelex Utilities HOWTO and API Documentation

1.1.4 09/06/2003

Table of Contents

Introduction

Object management utilities, simple logging framework, ACE helper methods and STL helpers.

  • Nevelex provides a prebuilt binary RPM.
  • To extract, just perform the following step:
    • base_dir$ tar xfz nevelex_util_bin.tar.gz

Requirements

Supported OSes

  • Should work on all platforms that support STL and ACE.
  • Test on:
    • Linux - Make sure you define 'Linux' when compiling. (i.e. -DLinux on GCC command-line.)
    • Mac OS X - Make sure you define 'Darwin' when compiling. (i.e. -DDarwin on GCC command-line.)

3rd Party APIs

Tools

License (BSD Style)

Copyright © 2003, NEVELEX CORPORATION All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of NEVELEX CORPORATION nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Change Log

The change log file is here.

Installation / Building

Building the Source Code

  • Untar the nevelex_util_src-X.X.X.tar.gz. Where X.X.X is the version number.
    • base_dir$ tar xvfz SANDS_src-X.X.X.tar.gz
  • The Makefile has one configurable option:
    • PREFIX - The installation prefix. Defaults to /usr/local.
  • Run the following commands.
The binaries are now ready for use.

Installing from an RPM

These instructions assume you have already installed ACE and have set the ACE_ROOT environment variable.

  • Run the following command as root.
    • # rpm -Uvh nevelex_util-X.X.X-X.i386.rpm

Additional Make Targets

In addition to making the code, the following make targets are available.

  • nevelex_util$ make apidocs
    • Makes the API documentation for the entire project.
    • Will create the following directory: nevelex_util/apidocs/html
  • nevelex_util$ make apidocs_clean
    • Removes all the generated documentation.
  • nevelex_util# make rpm
    • Creates the nevelex_util RPM.
    • You will probably need to become 'root'.