userapps/opensource/libosip2/help/man/osip.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   3
   4   <!ENTITY dhfirstname "<firstname>Aymeric</firstname>">
   5   <!ENTITY dhsurname   "<surname>MOIZARD</surname>">
   6   <!ENTITY dhdate      "<date>May 15, 2002</date>">
   7   <!ENTITY dhsection   "<manvolnum>SECTION</manvolnum>">
   8   <!ENTITY dhemail     "<email>jack@atosc.org</email>">
   9   <!ENTITY dhusername  "Aymeric Moizard">
  10   <!ENTITY dhucpackage "<refentrytitle>LIBOSIP</refentrytitle>">
  11   <!ENTITY dhpackage   "libosip">
  12
  13   <!ENTITY debian      "<productname>Debian</productname>">
  14   <!ENTITY gnu         "<acronym>GNU</acronym>">
  15 ]>
  16
  17 <refentry>
  18   <refentryinfo>
  19     <address>
  20       &dhemail;
  21     </address>
  22     <author>
  23       &dhfirstname;
  24       &dhsurname;
  25     </author>
  26     <copyright>
  27       <year>2001</year>
  28       <holder>&dhusername;</holder>
  29     </copyright>
  30     &dhdate;
  31   </refentryinfo>
  32   <refmeta>
  33     &dhucpackage;
  34
  35     &dhsection;
  36   </refmeta>
  37   <refnamediv>
  38     <refname>&dhpackage;</refname>
  39
  40     <refpurpose>The GNU oSIP library is a low layer SIP implementation.
  41     </refpurpose>
  42   </refnamediv>
  43   <refsynopsisdiv>
  44     <cmdsynopsis>
  45       <command>#include &#60;smsg.h&#62;</command>
  46       </cmdsynopsis>
  47     <cmdsynopsis>
  48       <command>#include &#60;url.h&#62;</command>
  49       </cmdsynopsis>
  50     <cmdsynopsis>
  51       <command>#include &#60;sdp.h&#62;</command>
  52       </cmdsynopsis>
  53     <cmdsynopsis>
  54       <command>-losip</command>
  55       <arg><option>The url, SIP and SDP parsers</option></arg>
  56       </cmdsynopsis>
  57     <cmdsynopsis>
  58       <command>#include &#60;osip.h&#62;</command>
  59       </cmdsynopsis>
  60     <cmdsynopsis>
  61       <command>-lfsmtl</command>
  62       <arg><option>The SIP transaction manager, the dialog manager</option></arg>
  63     </cmdsynopsis>
  64   </refsynopsisdiv>
  65   <refsect1>
  66     <title>DESCRIPTION</title>
  67
  68     <para>This manual page documents briefly the
  69       <command>&dhpackage;</command> library.</para>
  70
  71     <para>API reference & FAQ can be found at http://www.fsf.org/software/osip/</para>
  72
  73 <!--    <para><command>&dhpackage;</command> is a program that...</para>
  74 -->
  75
  76   </refsect1>
  77
  78 <!--
  79   <refsect1>
  80     <title>OPTIONS</title>
  81
  82     <para>These programs follow the usual GNU command line syntax,
  83       with long options starting with two dashes (`-').  A summary of
  84       options is included below.  For a complete description, see the
  85       <application>Info</application> files.</para>
  86
  87 -->
  88
  89 <!--
  90     <variablelist>
  91       <varlistentry>
  92         <term><option>-h</option>
  93           <option>-help</option>
  94         </term>
  95         <listitem>
  96           <para>Show summary of options.</para>
  97         </listitem>
  98       </varlistentry>
  99       <varlistentry>
 100         <term><option>-v</option>
 101           <option>-version</option>
 102         </term>
 103         <listitem>
 104           <para>Show version of program.</para>
 105         </listitem>
 106       </varlistentry>
 107     </variablelist>
 108
 109
 110   </refsect1>
 111 -->
 112
 113 <!--
 114
 115   <refsect1>
 116     <title>SEE ALSO</title>
 117     <para>bar (1), baz (1).</para>
 118
 119     <para>The programs are documented fully by <citetitle>The Rise and
 120       Fall of a Fooish Bar</citetitle> available via the
 121       <application>Info</application> system.</para>
 122
 123
 124     <variablelist>
 125       <varlistentry>
 126         <term><option>-h</option>
 127           <option>-help</option>
 128         </term>
 129         <listitem>
 130           <para>Show summary of options.</para>
 131         </listitem>
 132       </varlistentry>
 133       <varlistentry>
 134         <term><option>-v</option>
 135           <option>-version</option>
 136         </term>
 137         <listitem>
 138           <para>Show version of program.</para>
 139         </listitem>
 140       </varlistentry>
 141     </variablelist>
 142
 143   </refsect1>
 144
 145 -->
 146
 147   <refsect1>
 148     <title>AUTHOR</title>
 149
 150     <para>This manual page was written by &dhusername; &dhemail; for
 151       the &debian; system (but may be used by others).  Permission is
 152       granted to copy, distribute and/or modify this document under
 153       the terms of the <acronym>GNU</acronym> Free Documentation
 154       License, Version 1.1 or any later version published by the Free
 155       Software Foundation; with no Invariant Sections, no Front-Cover
 156       Texts and no Back-Cover Texts.</para>
 157
 158   </refsect1>
 159 </refentry>
 160
 161 <!-- Keep this comment at the end of the file
 162 Local variables:
 163 mode: sgml
 164 sgml-omittag:t
 165 sgml-shorttag:t
 166 sgml-minimize-attributes:nil
 167 sgml-always-quote-attributes:t
 168 sgml-indent-step:2
 169 sgml-indent-data:t
 170 sgml-parent-document:nil
 171 sgml-default-dtd-file:nil
 172 sgml-exposed-tags:nil
 173 sgml-local-catalogs:nil
 174 sgml-local-ecat-files:nil
 175 End:
 176 -->
 177
 178