freeswan/utils/ipsec.8

   1 .TH IPSEC 8 "26 March 2002"
   2 .\" RCSID $Id: ipsec.8,v 1.16 2002/03/26 17:49:43 henry Exp $
   3 .SH NAME
   4 ipsec \- invoke IPsec utilities
   5 .SH SYNOPSIS
   6 .B ipsec
   7 command [ argument ...]
   8 .sp
   9 .B ipsec
  10 .B \-\-help
  11 .br
  12 .B ipsec
  13 .B \-\-version
  14 .br
  15 .B ipsec
  16 .B \-\-versioncode
  17 .br
  18 .B ipsec
  19 .B \-\-copyright
  20 .br
  21 .B ipsec
  22 .B \-\-directory
  23 .br
  24 .B ipsec
  25 .B \-\-confdir
  26 .SH DESCRIPTION
  27 .I Ipsec
  28 invokes any of several utilities involved in controlling the IPsec
  29 encryption/authentication system,
  30 running the specified
  31 .I command
  32 with the specified
  33 .IR argument s
  34 as if it had been invoked directly.
  35 This largely eliminates possible name collisions with other software,
  36 and also permits some centralized services.
  37 .PP
  38 In particular,
  39 .I ipsec
  40 supplies the invoked
  41 .I command
  42 with a suitable PATH environment variable,
  43 and also provides IPSEC_DIR,
  44 IPSEC_CONFS, and IPSEC_VERSION environment variables,
  45 containing respectively
  46 the full pathname of the directory where the IPsec utilities are stored,
  47 the full pathname of the directory where the configuration files live,
  48 and the IPsec version number.
  49 .PP
  50 .B "ipsec \-\-help"
  51 lists the available commands.
  52 Most have their own manual pages, e.g.
  53 .IR ipsec_auto (8)
  54 for
  55 .IR auto .
  56 .PP
  57 .B "ipsec \-\-version"
  58 outputs version information about Linux FreeS/WAN.
  59 A version code of the form ``U\fIxxx\fR/K\fIyyy\fR''
  60 indicates that the user-level utilities are version \fIxxx\fR
  61 but the kernel portion appears to be version \fIyyy\fR
  62 (this form is used only if the two disagree).
  63 .PP
  64 .B "ipsec \-\-versioncode"
  65 outputs \fIjust\fR the version code,
  66 with none of
  67 .BR \-\-version 's
  68 supporting information,
  69 for use by scripts.
  70 .PP
  71 .B "ipsec \-\-copyright"
  72 supplies boring copyright details.
  73 .PP
  74 .B "ipsec \-\-directory"
  75 reports where
  76 .I ipsec
  77 thinks the IPsec utilities are stored.
  78 .PP
  79 .B "ipsec \-\-confdir"
  80 reports where
  81 .I ipsec
  82 thinks the IPsec configuration files are stored.
  83 .SH FILES
  84 /usr/local/lib/ipsec    usual utilities directory
  85 .SH SEE ALSO
  86 .hy 0
  87 .na
  88 ipsec.conf(5), ipsec.secrets(5),
  89 ipsec_auto(8),
  90 ipsec_barf(8),
  91 ipsec_setup(8),
  92 ipsec_showdefaults(8),
  93 ipsec_showhostkey(8)
  94 .ad
  95 .hy
  96 .PP
  97 HTML documentation shipped with the release, starting with
  98 .IR doc/index.html .
  99 .I <http://www.freeswan.org/doc.html>
 100 may also be of use.
 101 .SH HISTORY
 102 Written for Linux FreeS/WAN
 103 <http://www.freeswan.org>
 104 by Henry Spencer.
 105 .SH BUGS
 106 The provision of centralized services,
 107 while convenient,
 108 does compromise the original concept of making the utilities
 109 invocable directly as well as via
 110 .IR ipsec .