doc/src/manpages.html

   1 <html>
   2 <head>
   3   <meta http-equiv="Content-Type" content="text/html">
   4   <title>FreeS/WAN man pages</title>
   5   <meta name="keywords"
   6   content="Linux, IPsec, VPN, security, FreeSWAN, manpage, manual, page">
   7   <!--
   8
   9   Written by Sandy Harris for the Linux FreeS/WAN project
  10   Freely distributable under the GNU General Public License
  11
  12   More information at www.freeswan.org
  13   Feedback to users@lists.freeswan.org
  14
  15   CVS information:
  16   RCS ID:          $Id: manpages.html,v 1.1 2004/03/15 20:35:24 as Exp $
  17   Last changed:    $Date: 2004/03/15 20:35:24 $
  18   Revision number: $Revision: 1.1 $
  19
  20   CVS revision numbers do not correspond to FreeS/WAN release numbers.
  21   -->
  22 </head>
  23
  24 <body>
  25 <h1><a name="manpages">FreeS/WAN manual pages</a></h1>
  26
  27 <p>The various components of Linux FreeS/WAN are of course documented in
  28 standard Unix manual pages, accessible via the man(1) command.</p>
  29
  30 <p>Links here take you to an HTML version of the man pages.</p>
  31
  32 <h2><a name="man.file">Files</a></h2>
  33 <dl>
  34   <dt><a href="manpage.d/ipsec.conf.5.html">ipsec.conf(5)</a></dt>
  35     <dd>IPsec configuration and connections</dd>
  36   <dt><a href="manpage.d/ipsec.secrets.5.html">ipsec.secrets(5)</a></dt>
  37     <dd>secrets for IKE authentication, either pre-shared keys or RSA private
  38       keys</dd>
  39 </dl>
  40
  41 <p>These files are also discussed in the <a
  42 href="config.html">configuration</a> section.</p>
  43
  44 <h2><a name="man.command">Commands</a></h2>
  45
  46 <p>Many users will never give most of the FreeS/WAN commands directly.
  47 Configure the files listed above correctly and everything should be
  48 automatic.</p>
  49
  50 <p>The exceptions are commands for mainpulating the <a
  51 href="glossary.html#RSA">RSA</a> keys used in Pluto authentication:</p>
  52 <dl>
  53   <dt><a href="manpage.d/ipsec_rsasigkey.8.html">ipsec_rsasigkey(8)</a></dt>
  54     <dd>generate keys</dd>
  55   <dt><a href="manpage.d/ipsec_newhostkey.8.html">ipsec_newhostkey(8)</a></dt>
  56     <dd>generate keys in a convenient format</dd>
  57   <dt><a
  58   href="manpage.d/ipsec_showhostkey.8.html">ipsec_showhostkey(8)</a></dt>
  59     <dd>extract <a href="glossary.html#RSA">RSA</a> keys from <a
  60       href="manpage.d/ipsec.secrets.5.html">ipsec.secrets(5)</a> (or
  61       optionally, another file) and format them for insertion in <a
  62       href="manpage.d/ipsec.conf.5.html">ipsec.conf(5)</a> or in DNS
  63     records</dd>
  64 </dl>
  65
  66 <p>Note that:</p>
  67 <ul>
  68   <li>These keys are for <strong>authentication only</strong>. They are
  69     <strong>not secure for encryption</strong>.</li>
  70   <li>The utility uses random(4) as a source of <a
  71     href="glossary.html#random">random numbers</a>. This may block for some
  72     time if there is not enough activity on the machine to provide the
  73     required entropy. You may want to give it some bogus activity such as
  74     random mouse movements or some command such as <nobr><tt>du /usr &gt; /dev/null
  75     &amp;</tt></nobr>.</li>
  76 </ul>
  77
  78 <p>The following commands are fairly likely to be used, if only for testing
  79 and status checks:</p>
  80 <dl>
  81   <dt><a href="manpage.d/ipsec.8.html">ipsec(8)</a></dt>
  82     <dd>invoke IPsec utilities</dd>
  83   <dt><a href="manpage.d/ipsec_setup.8.html">ipsec_setup(8)</a></dt>
  84     <dd>control IPsec subsystem</dd>
  85   <dt><a href="manpage.d/ipsec_auto.8.html">ipsec_auto(8)</a></dt>
  86     <dd>control automatically-keyed IPsec connections</dd>
  87   <dt><a href="manpage.d/ipsec_manual.8.html">ipsec_manual(8)</a></dt>
  88     <dd>take manually-keyed IPsec connections up and down</dd>
  89   <dt><a href="manpage.d/ipsec_ranbits.8.html">ipsec_ranbits(8)</a></dt>
  90     <dd>generate random bits in ASCII form</dd>
  91   <dt><a href="manpage.d/ipsec_look.8.html">ipsec_look(8)</a></dt>
  92     <dd>show minimal debugging information</dd>
  93   <dt><a href="manpage.d/ipsec_barf.8.html">ipsec_barf(8)</a></dt>
  94     <dd>spew out collected IPsec debugging information</dd>
  95 </dl>
  96
  97 <p>The lower-level utilities listed below are normally invoked via scripts
  98 listed above, but they can also be used directly when required.</p>
  99 <dl>
 100   <dt><a href="manpage.d/ipsec_eroute.8.html">ipsec_eroute(8)</a></dt>
 101     <dd>manipulate IPsec extended routing tables</dd>
 102   <dt><a href="manpage.d/ipsec_klipsdebug.8.html">ipsec_klipsdebug(8)</a></dt>
 103     <dd>set Klips (kernel IPsec support) debug features and level</dd>
 104   <dt><a href="manpage.d/ipsec_pluto.8.html">ipsec_pluto(8)</a></dt>
 105     <dd>IPsec IKE keying daemon</dd>
 106   <dt><a href="manpage.d/ipsec_spi.8.html">ipsec_spi(8)</a></dt>
 107     <dd>manage IPsec Security Associations</dd>
 108   <dt><a href="manpage.d/ipsec_spigrp.8.html">ipsec_spigrp(8)</a></dt>
 109     <dd>group/ungroup IPsec Security Associations</dd>
 110   <dt><a href="manpage.d/ipsec_tncfg.8.html">ipsec_tncfg(8)</a></dt>
 111     <dd>associate IPsec virtual interface with real interface</dd>
 112   <dt><a href="manpage.d/ipsec_whack.8.html">ipsec_whack(8)</a></dt>
 113     <dd>control interface for IPsec keying daemon</dd>
 114 </dl>
 115
 116 <h2><a name="man.lib">Library routines</a></h2>
 117 <dl>
 118   <dt><a href="manpage.d/ipsec_atoaddr.3.html">ipsec_atoaddr(3)</a></dt>
 119   <dt><a href="manpage.d/ipsec_addrtoa.3.html">ipsec_addrtoa(3)</a></dt>
 120     <dd>convert Internet addresses to and from ASCII</dd>
 121   <dt><a href="manpage.d/ipsec_atosubnet.3.html">ipsec_atosubnet(3)</a></dt>
 122   <dt><a href="manpage.d/ipsec_subnettoa.3.html">ipsec_subnettoa(3)</a></dt>
 123     <dd>convert subnet/mask ASCII form to and from addresses</dd>
 124   <dt><a href="manpage.d/ipsec_atoasr.3.html">ipsec_atoasr(3)</a></dt>
 125     <dd>convert ASCII to Internet address, subnet, or range</dd>
 126   <dt><a href="manpage.d/ipsec_rangetoa.3.html">ipsec_rangetoa(3)</a></dt>
 127     <dd>convert Internet address range to ASCII</dd>
 128   <dt>ipsec_atodata(3)</dt>
 129   <dt><a href="manpage.d/ipsec_datatoa.3.html">ipsec_datatoa(3)</a></dt>
 130     <dd>convert binary data from and to ASCII formats</dd>
 131   <dt><a href="manpage.d/ipsec_atosa.3.html">ipsec_atosa(3)</a></dt>
 132   <dt><a href="manpage.d/ipsec_satoa.3.html">ipsec_satoa(3)</a></dt>
 133     <dd>convert IPsec Security Association IDs to and from ASCII</dd>
 134   <dt><a href="manpage.d/ipsec_atoul.3.html">ipsec_atoul(3)</a></dt>
 135   <dt><a href="manpage.d/ipsec_ultoa.3.html">ipsec_ultoa(3)</a></dt>
 136     <dd>convert unsigned-long numbers to and from ASCII</dd>
 137   <dt><a href="manpage.d/ipsec_goodmask.3.html">ipsec_goodmask(3)</a></dt>
 138     <dd>is this Internet subnet mask a valid one?</dd>
 139   <dt><a href="manpage.d/ipsec_masktobits.3.html">ipsec_masktobits(3)</a></dt>
 140     <dd>convert Internet subnet mask to bit count</dd>
 141   <dt><a href="manpage.d/ipsec_bitstomask.3.html">ipsec_bitstomask(3)</a></dt>
 142     <dd>convert bit count to Internet subnet mask</dd>
 143   <dt><a
 144   href="manpage.d/ipsec_optionsfrom.3.html">ipsec_optionsfrom(3)</a></dt>
 145     <dd>read additional ``command-line'' options from file</dd>
 146   <dt><a href="manpage.d/ipsec_subnetof.3.html">ipsec_subnetof(3)</a></dt>
 147     <dd>given Internet address and subnet mask, return subnet number</dd>
 148   <dt><a href="manpage.d/ipsec_hostof.3.html">ipsec_hostof(3)</a></dt>
 149     <dd>given Internet address and subnet mask, return host part</dd>
 150   <dt><a
 151   href="manpage.d/ipsec_broadcastof.3.html">ipsec_broadcastof(3)</a></dt>
 152     <dd>given Internet address and subnet mask, return broadcast address</dd>
 153 </dl>
 154 </body>
 155 </html>