freeswan/doc/manpages.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
   2 <HTML>
   3 <HEAD>
   4 <TITLE> Introduction to FreeS/WAN</TITLE>
   5 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
   6 </HEAD>
   7 <BODY>
   8 <A HREF="toc.html">Contents</a>
   9 <A HREF="config.html">Previous</a>
  10 <A HREF="firewall.html">Next</a>
  11 <HR>
  12 <H1><A name="manpages">FreeS/WAN manual pages</A></H1>
  13 <P> The various components of Linux FreeS/WAN are of course documented
  14 in standard Unix manual pages, accessible via the man(1) command.</P>
  15 <P> Links here take you to an HTML version of the man pages.</P>
  16 <H2><A name="man.file">Files</A></H2>
  17 <DL>
  18 <DT><A href="manpage.d/ipsec.conf.5.html">ipsec.conf(5)</A></DT>
  19 <DD>IPSEC configuration and connections</DD>
  20 <DT><A href="manpage.d/ipsec.secrets.5.html">ipsec.secrets(5)</A></DT>
  21 <DD>preshared secrets for IKE/IPsec authentication</DD>
  22 </DL>
  23 <P> These files are also discussed in the <A href="config.html">
  24 configuration</A> section.</P>
  25 <H2><A name="man.command">Commands</A></H2>
  26 <P> Many users will never give most of the FreeS/WAN commands directly.
  27 Configure the files listed above correctly and everything should be
  28 automatic.</P>
  29 <P> One exception is:</P>
  30 <DL>
  31 <DT><A href="manpage.d/ipsec_rsasigkey.8.html">ipsec_rsasigkey(8)</A></DT>
  32 <DD>generate <A href="glossary.html#RSA">RSA</A> keys for use in Pluto
  33 authentication</DD>
  34 </DL>
  35 <P>Note that:</P>
  36 <UL>
  37 <LI>These keys are for <STRONG>authentication only</STRONG>. They are <STRONG>
  38  not secure for encryption</STRONG>.</LI>
  39 <LI>The utility uses random(4) as a source of <A href="glossary.html#random">
  40 random  numbers</A>. This may block for some time if there is not
  41 enough  activity on the machine to provide the required entropy. You
  42 may want to  give it some bogus activity such as random mouse movements
  43 or some  command such as <TT>du /usr &gt; dev/null </TT></LI>
  44 </UL>
  45 <P>The following commands are fairly likely to be used, if only for
  46 testing and status checks:</P>
  47 <DL>
  48 <DT><A href="manpage.d/ipsec.8.html">ipsec(8)</A></DT>
  49 <DD>invoke IPSEC utilities</DD>
  50 <DT><A href="manpage.d/ipsec_setup.8.html">ipsec_setup(8)</A></DT>
  51 <DD>control IPSEC subsystem</DD>
  52 <DT><A href="manpage.d/ipsec_auto.8.html">ipsec_auto(8)</A></DT>
  53 <DD>control automatically-keyed IPSEC connections</DD>
  54 <DT><A href="manpage.d/ipsec_manual.8.html">ipsec_manual(8)</A></DT>
  55 <DD>take manually-keyed IPSEC connections up and down</DD>
  56 <DT><A href="manpage.d/ipsec_ranbits.8.html">ipsec_ranbits(8)</A></DT>
  57 <DD>generate random bits in ASCII form</DD>
  58 <DT><A href="manpage.d/ipsec_look.8.html">ipsec_look(8)</A></DT>
  59 <DD>show minimal debugging information</DD>
  60 <DT><A href="manpage.d/ipsec_barf.8.html">ipsec_barf(8)</A></DT>
  61 <DD>spew out collected IPSEC debugging information</DD>
  62 </DL>
  63 <P>The lower-level utilities listed below are normally invoked via
  64 scripts listed above, but they can also be used directly when required.</P>
  65 <DL>
  66 <DT><A href="manpage.d/ipsec_eroute.8.html">ipsec_eroute(8)</A></DT>
  67 <DD>manipulate IPSEC extended routing tables</DD>
  68 <DT><A href="manpage.d/ipsec_klipsdebug.8.html">ipsec_klipsdebug(8)</A></DT>
  69 <DD>set Klips (kernel IPSEC support) debug features and level</DD>
  70 <DT><A href="manpage.d/ipsec_pluto.8.html">ipsec_pluto(8)</A></DT>
  71 <DD>IPsec IKE keying daemon</DD>
  72 <DT><A href="manpage.d/ipsec_spi.8.html">ipsec_spi(8)</A></DT>
  73 <DD>manage IPSEC Security Associations</DD>
  74 <DT><A href="manpage.d/ipsec_spigrp.8.html">ipsec_spigrp(8)</A></DT>
  75 <DD>group/ungroup IPSEC Security Associations</DD>
  76 <DT><A href="manpage.d/ipsec_tncfg.8.html">ipsec_tncfg(8)</A></DT>
  77 <DD>associate IPSEC virtual interface with real interface</DD>
  78 <DT><A href="manpage.d/ipsec_whack.8.html">ipsec_whack(8)</A></DT>
  79 <DD>control interface for IPSEC keying daemon</DD>
  80 </DL>
  81 <H2><A name="man.lib">Library routines</A></H2>
  82 <DL>
  83 <DT><A href="manpage.d/ipsec_atoaddr.3.html">ipsec_atoaddr(3)</A></DT>
  84 <DT><A href="manpage.d/ipsec_addrtoa.3.html">ipsec_addrtoa(3)</A></DT>
  85 <DD>convert Internet addresses to and from ASCII</DD>
  86 <DT><A href="manpage.d/ipsec_atosubnet.3.html">ipsec_atosubnet(3)</A></DT>
  87 <DT><A href="manpage.d/ipsec_subnettoa.3.html">ipsec_subnettoa(3)</A></DT>
  88 <DD>convert subnet/mask ASCII form to and from addresses</DD>
  89 <DT><A href="manpage.d/ipsec_atoasr.3.html">ipsec_atoasr(3)</A></DT>
  90 <DD>convert ASCII to Internet address, subnet, or range</DD>
  91 <DT><A href="manpage.d/ipsec_rangetoa.3.html">ipsec_rangetoa(3)</A></DT>
  92 <DD>convert Internet address range to ASCII</DD>
  93 <DT>ipsec_atodata(3)</DT>
  94 <DT><A href="manpage.d/ipsec_datatoa.3.html">ipsec_datatoa(3)</A></DT>
  95 <DD>convert binary data from and to ASCII formats</DD>
  96 <DT><A href="manpage.d/ipsec_atosa.3.html">ipsec_atosa(3)</A></DT>
  97 <DT><A href="manpage.d/ipsec_satoa.3.html">ipsec_satoa(3)</A></DT>
  98 <DD>convert IPSEC Security Association IDs to and from ASCII</DD>
  99 <DT><A href="manpage.d/ipsec_atoul.3.html">ipsec_atoul(3)</A></DT>
 100 <DT><A href="manpage.d/ipsec_ultoa.3.html">ipsec_ultoa(3)</A></DT>
 101 <DD>convert unsigned-long numbers to and from ASCII</DD>
 102 <DT><A href="manpage.d/ipsec_goodmask.3.html">ipsec_goodmask(3)</A></DT>
 103 <DD>is this Internet subnet mask a valid one?</DD>
 104 <DT><A href="manpage.d/ipsec_masktobits.3.html">ipsec_masktobits(3)</A></DT>
 105 <DD>convert Internet subnet mask to bit count</DD>
 106 <DT><A href="manpage.d/ipsec_bitstomask.3.html">ipsec_bitstomask(3)</A></DT>
 107 <DD>convert bit count to Internet subnet mask</DD>
 108 <DT><A href="manpage.d/ipsec_optionsfrom.3.html">ipsec_optionsfrom(3)</A>
 109 </DT>
 110 <DD>read additional ``command-line'' options from file</DD>
 111 <DT><A href="manpage.d/ipsec_subnetof.3.html">ipsec_subnetof(3)</A></DT>
 112 <DD>given Internet address and subnet mask, return subnet number</DD>
 113 <DT><A href="manpage.d/ipsec_hostof.3.html">ipsec_hostof(3)</A></DT>
 114 <DD>given Internet address and subnet mask, return host part</DD>
 115 <DT><A href="manpage.d/ipsec_broadcastof.3.html">ipsec_broadcastof(3)</A>
 116 </DT>
 117 <DD>given Internet address and subnet mask, return broadcast address</DD>
 118 </DL>
 119 <HR>
 120 <A HREF="toc.html">Contents</a>
 121 <A HREF="config.html">Previous</a>
 122 <A HREF="firewall.html">Next</a>
 123 </BODY>
 124 </HTML>