contrib/ngatm/man/libngatm.3

   1 .\"
   2 .\" Copyright (c) 2004-2005
   3 .\"     Hartmut Brandt
   4 .\"     All rights reserved.
   5 .\" Copyright (c) 2001-2003
   6 .\"     Fraunhofer Institute for Open Communication Systems (FhG Fokus).
   7 .\"     All rights reserved.
   8 .\"
   9 .\" Author: Hartmut Brandt <harti@FreeBSD.org>
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $Begemot: libunimsg/man/libngatm.3,v 1.6 2005/06/15 11:37:07 brandt_h Exp $
  33 .\"
  34 .Dd May 23, 2005
  35 .Dt LIBNGATM 3
  36 .Os
  37 .Sh NAME
  38 .Nm libngatm
  39 .Nd "ATM signalling library"
  40 .Sh LIBRARY
  41 Begemot ATM signalling library
  42 .Pq libngatm, -lngatm
  43 .Sh DESCRIPTION
  44 The Begemot UNI signalling library handles message decoding and encoding as
  45 well as the Q.2110 and Q.2120 transport protocols and adaptation layers, and
  46 ATM-Forum UNI 4.0 compliant signalling.
  47 Because of this complexity the description is broken down in several man pages:
  48 .Bl -tag -width XXXX
  49 .It Xr unimsg 3
  50 Describes a data structure and functions for handling of variable sized
  51 messages.
  52 .It Xr unistruct 3
  53 describes data structures for the decoding, encoding and printing functions
  54 in the library.
  55 .It Xr unifunc 3
  56 describes the decoding, encoding and printing functions.
  57 .\" .It Xr sscop 3
  58 .\" describes the SSCOP transport protocol functions.
  59 .\" .It Xr sscfu 3
  60 .\" describes the SSCF at the UNI functions.
  61 .\" .It Xr uni 3
  62 .\" describes the UNI 4.0 signalling functions.
  63 .It Xr uniaddr 3
  64 describes address structures and handling functions.
  65 .It Xr unisap 3
  66 .\" describes ATM-Forum ATM-API service access point structures and
  67 .\" handling functions.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr sscop 1
  71 .Sh STANDARDS
  72 This implementation conforms to the applicable ITU-T
  73 recommendations and ATM Forum standards.
  74 .Sh AUTHORS
  75 .An Hartmut Brandt Aq harti@FreeBSD.org