doc/aiccu.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   3 <!-- Process this file with docbook-to-man to generate an nroff manual
   4      page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
   5      the manual page with: `docbook-to-man manpage.sgml | nroff -man |
   6      less'.  A typical entry in a Makefile or Makefile.am is:
   7
   8 manpage.1: manpage.sgml
   9         docbook-to-man $< > $@
  10   -->
  11
  12   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  13   <!ENTITY dhfirstname "<firstname>Jeroen</firstname>">
  14   <!ENTITY dhsurname   "<surname>Massar</surname>">
  15   <!-- Please adjust the date whenever revising the manpage. -->
  16   <!ENTITY dhdate      "<date>January 09, 2005</date>">
  17   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  18        allowed: see man(7), man(1). -->
  19   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  20   <!ENTITY dhemail     "<email>jeroen@sixxs.net</email>">
  21   <!ENTITY dhusername  "Jeroen Massar">
  22   <!ENTITY dhucpackage "<refentrytitle>AICCU</refentrytitle>">
  23   <!ENTITY dhpackage   "AICCU">
  24
  25   <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  26   <!ENTITY gnu         "<acronym>GNU</acronym>">
  27 ]>
  28
  29 <refentry>
  30   <refentryinfo>
  31     <address>
  32       &dhemail;
  33     </address>
  34     <author>
  35       &dhfirstname;
  36       &dhsurname;
  37     </author>
  38     <copyright>
  39       <year>2005</year>
  40       <holder>&dhusername;</holder>
  41     </copyright>
  42     &dhdate;
  43   </refentryinfo>
  44   <refmeta>
  45     &dhucpackage;
  46
  47     &dhsection;
  48   </refmeta>
  49   <refnamediv>
  50     <refname>&dhpackage;</refname>
  51
  52     <refpurpose>Automatic IPv6 Connectivity Configuration Utility</refpurpose>
  53   </refnamediv>
  54   <refsynopsisdiv>
  55     <cmdsynopsis>
  56       <command>aiccu </command>
  57       <arg choice="req">&lt;start|stop|tunnels|test|autotest|license&gt;</arg>
  58       <arg choice="opt"><replaceable>config</replaceable></arg>
  59
  60     </cmdsynopsis>
  61   </refsynopsisdiv>
  62   <refsect1>
  63     <title>DESCRIPTION</title>
  64
  65     <para>
  66 AICCU makes it very easy for anybody to get IPv6 connectivity
  67 everywhere they want. It uses the TIC (Tunnel Information & Control)
  68 protocol to request the information needed to setup a tunnel through
  69 which the connectivity is created.
  70
  71 AICCU supports the following tunneling protocols:
  72  - 6in4 static    (RFC 2893)
  73  - 6in4 heartbeat (RFC 2893 + draft-massar-v6ops-heartbeat)
  74  - tinc           (http://www.tinc-vpn.org)
  75  - AYIYA          (draft-massar-v6ops-ayiya)
  76
  77 As AYIYA even works from behind NAT's, thus unless there is a very
  78 restrictive firewall in place, anybody should be able to get IPv6
  79 connectivity without problems and everywhere they want.
  80 </para>
  81
  82   </refsect1>
  83   <refsect1>
  84     <title>OPTIONS</title>
  85
  86     <variablelist>
  87
  88       <varlistentry>
  89         <term>start</term>
  90         <listitem>
  91           <para>
  92             Starts aiccu service.
  93           </para>
  94         </listitem>
  95       </varlistentry>
  96
  97       <varlistentry>
  98         <term>stop</term>
  99         <listitem>
 100           <para>
 101             Stops aiccu service.
 102           </para>
 103         </listitem>
 104       </varlistentry>
 105
 106       <varlistentry>
 107         <term>tunnels</term>
 108         <listitem>
 109           <para>
 110             Prints a list of currently available tunnels.
 111           </para>
 112         </listitem>
 113       </varlistentry>
 114
 115       <varlistentry>
 116         <term>test</term>
 117         <listitem>
 118           <para>
 119             Builds the connection and runs a simple selftest allowing a user
 120             to report this back as it should show most obvious problems.
 121           </para>
 122         </listitem>
 123       </varlistentry>
 124
 125       <varlistentry>
 126         <term>autotest</term>
 127         <listitem>
 128           <para>
 129             Decription here
 130           </para>
 131         </listitem>
 132       </varlistentry>
 133
 134       <varlistentry>
 135         <term>license</term>
 136         <listitem>
 137           <para>
 138             Shows the license aiccu is released under.
 139           </para>
 140         </listitem>
 141       </varlistentry>
 142
 143       <varlistentry>
 144         <term><replaceable>config</replaceable></term>
 145         <listitem>
 146           <para>
 147             Read the configuration from <replaceable>config</replaceable> file.
 148           </para>
 149         </listitem>
 150       </varlistentry>
 151
 152     </variablelist>
 153   </refsect1>
 154
 155   <refsect1>
 156     <title>SEE ALSO</title>
 157
 158     <para>The AICCU <ulink url="http://www.sixxs.net/tools/aiccu/">page</ulink> at sixxs.
 159     </para>
 160
 161   </refsect1>
 162   <refsect1>
 163     <title>AUTHOR</title>
 164
 165     <para>AICCU was written by Jeroen Massar with contributions supplied a number of people as mentioned in the Changelog.</para>
 166
 167   </refsect1>
 168 </refentry>
 169
 170 <!-- Keep this comment at the end of the file
 171 Local variables:
 172 mode: sgml
 173 sgml-omittag:t
 174 sgml-shorttag:t
 175 sgml-minimize-attributes:nil
 176 sgml-always-quote-attributes:t
 177 sgml-indent-step:2
 178 sgml-indent-data:t
 179 sgml-parent-document:nil
 180 sgml-default-dtd-file:nil
 181 sgml-exposed-tags:nil
 182 sgml-local-catalogs:nil
 183 sgml-local-ecat-files:nil
 184 End:
 185 -->