[thirdparty/strongswan.git] / doc / manpage.d / ipsec.8.html

Content-type: text/html

<HTML><HEAD><TITLE>Manpage of IPSEC</TITLE>
</HEAD><BODY>
<H1>IPSEC</H1>
Section: Maintenance Commands (8)<BR>Updated: 26 March 2002<BR><A HREF="#index">Index</A>
<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>


<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

ipsec - invoke IPsec utilities
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<B>ipsec</B>

command [ argument ...]
<P>
<B>ipsec</B>

<B>--help</B>

<BR>

<B>ipsec</B>

<B>--version</B>

<BR>

<B>ipsec</B>

<B>--versioncode</B>

<BR>

<B>ipsec</B>

<B>--copyright</B>

<BR>

<B>ipsec</B>

<B>--directory</B>

<BR>

<B>ipsec</B>

<B>--confdir</B>

<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

<I>Ipsec</I>

invokes any of several utilities involved in controlling the IPsec
encryption/authentication system,
running the specified
<I>command</I>

with the specified
<I>argument</I>s

as if it had been invoked directly.
This largely eliminates possible name collisions with other software,
and also permits some centralized services.
<P>

In particular,
<I>ipsec</I>

supplies the invoked
<I>command</I>

with a suitable PATH environment variable,
and also provides IPSEC_DIR,
IPSEC_CONFS, and IPSEC_VERSION environment variables,
containing respectively
the full pathname of the directory where the IPsec utilities are stored,
the full pathname of the directory where the configuration files live,
and the IPsec version number.
<P>

<B>ipsec --help</B>

lists the available commands.
Most have their own manual pages, e.g.
<I><A HREF="ipsec_auto.8.html">ipsec_auto</A></I>(8)

for
<I>auto</I>.

<P>

<B>ipsec --version</B>

outputs version information about Linux FreeS/WAN.
A version code of the form ``U<I>xxx</I>/K<I>yyy</I>''
indicates that the user-level utilities are version <I>xxx</I>
but the kernel portion appears to be version <I>yyy</I>
(this form is used only if the two disagree).
<P>

<B>ipsec --versioncode</B>

outputs <I>just</I> the version code,
with none of
<B>--version</B>'s

supporting information,
for use by scripts.
<P>

<B>ipsec --copyright</B>

supplies boring copyright details.
<P>

<B>ipsec --directory</B>

reports where
<I>ipsec</I>

thinks the IPsec utilities are stored.
<P>

<B>ipsec --confdir</B>

reports where
<I>ipsec</I>

thinks the IPsec configuration files are stored.
<A NAME="lbAE">&nbsp;</A>
<H2>FILES</H2>

/usr/local/lib/ipsec<TT>&nbsp;&nbsp;&nbsp;</TT>usual utilities directory<BR>
<A NAME="lbAF">&nbsp;</A>
<H2>ENVIRONMENT</H2>

<P>

The following environment variables control where FreeS/WAN finds its
components.
The
<B>ipsec</B>

command sets them if they are not already set.
<PRE>
IPSEC_EXECDIR   directory containing published commands
IPSEC_LIBDIR    directory containing internal executables
IPSEC_SBINDIR   directory containing <B>ipsec</B> command
IPSEC_CONFS     directory containing configuration files
</PRE>

<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>


<A HREF="ipsec.conf.5.html">ipsec.conf</A>(5), <A HREF="ipsec.secrets.5.html">ipsec.secrets</A>(5),
<A HREF="ipsec_auto.8.html">ipsec_auto</A>(8),
<A HREF="ipsec_barf.8.html">ipsec_barf</A>(8),
<A HREF="ipsec_setup.8.html">ipsec_setup</A>(8),
<A HREF="ipsec_showdefaults.8.html">ipsec_showdefaults</A>(8),
<A HREF="ipsec_showhostkey.8.html">ipsec_showhostkey</A>(8)


<P>

HTML documentation shipped with the release, starting with
<I>doc/index.html</I>.

<I>&lt;<A HREF="http://www.freeswan.org/doc.html">http://www.freeswan.org/doc.html</A>&gt;</I>

may also be of use.
<A NAME="lbAH">&nbsp;</A>
<H2>HISTORY</H2>

Written for Linux FreeS/WAN
&lt;<A HREF="http://www.freeswan.org">http://www.freeswan.org</A>&gt;
by Henry Spencer.
<A NAME="lbAI">&nbsp;</A>
<H2>BUGS</H2>

The provision of centralized services,
while convenient,
does compromise the original concept of making the utilities
invocable directly as well as via
<I>ipsec</I>.

<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">FILES</A><DD>
<DT><A HREF="#lbAF">ENVIRONMENT</A><DD>
<DT><A HREF="#lbAG">SEE ALSO</A><DD>
<DT><A HREF="#lbAH">HISTORY</A><DD>
<DT><A HREF="#lbAI">BUGS</A><DD>
</DL>
<HR>
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 21:40:17 GMT, November 11, 2003
</BODY>
</HTML>
Commit	Line	Data
997358a6 MW	1	Content-type: text/html
	2
	3	<HTML><HEAD><TITLE>Manpage of IPSEC</TITLE>
	4	</HEAD><BODY>
	5	<H1>IPSEC</H1>
	6	Section: Maintenance Commands (8)<BR>Updated: 26 March 2002<BR><A HREF="#index">Index</A>
	7	<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
	8
	9
	10	<A NAME="lbAB"> </A>
	11	<H2>NAME</H2>
	12
	13	ipsec - invoke IPsec utilities
	14	<A NAME="lbAC"> </A>
	15	<H2>SYNOPSIS</H2>
	16
	17	<B>ipsec</B>
	18
	19	command [ argument ...]
	20	<P>
	21	<B>ipsec</B>
	22
	23	<B>--help</B>
	24
	25	<BR>
	26
	27	<B>ipsec</B>
	28
	29	<B>--version</B>
	30
	31	<BR>
	32
	33	<B>ipsec</B>
	34
	35	<B>--versioncode</B>
	36
	37	<BR>
	38
	39	<B>ipsec</B>
	40
	41	<B>--copyright</B>
	42
	43	<BR>
	44
	45	<B>ipsec</B>
	46
	47	<B>--directory</B>
	48
	49	<BR>
	50
	51	<B>ipsec</B>
	52
	53	<B>--confdir</B>
	54
	55	<A NAME="lbAD"> </A>
	56	<H2>DESCRIPTION</H2>
	57
	58	<I>Ipsec</I>
	59
	60	invokes any of several utilities involved in controlling the IPsec
	61	encryption/authentication system,
	62	running the specified
	63	<I>command</I>
	64
65	with the specified
66	<I>argument</I>s
67
68	as if it had been invoked directly.
69	This largely eliminates possible name collisions with other software,
70	and also permits some centralized services.
71	<P>
72
73	In particular,
74	<I>ipsec</I>
75
76	supplies the invoked
77	<I>command</I>
78
79	with a suitable PATH environment variable,
80	and also provides IPSEC_DIR,
81	IPSEC_CONFS, and IPSEC_VERSION environment variables,
82	containing respectively
83	the full pathname of the directory where the IPsec utilities are stored,
84	the full pathname of the directory where the configuration files live,
85	and the IPsec version number.
86	<P>
87
88	<B>ipsec --help</B>
89
90	lists the available commands.
91	Most have their own manual pages, e.g.
92	<I><A HREF="ipsec_auto.8.html">ipsec_auto</A></I>(8)
93
94	for
95	<I>auto</I>.
96
97	<P>
98
99	<B>ipsec --version</B>
100
101	outputs version information about Linux FreeS/WAN.
102	A version code of the form ``U<I>xxx</I>/K<I>yyy</I>''
103	indicates that the user-level utilities are version <I>xxx</I>
104	but the kernel portion appears to be version <I>yyy</I>
105	(this form is used only if the two disagree).
106	<P>
107
108	<B>ipsec --versioncode</B>
109
110	outputs <I>just</I> the version code,
111	with none of
112	<B>--version</B>'s
113
114	supporting information,
115	for use by scripts.
116	<P>
117
118	<B>ipsec --copyright</B>
119
120	supplies boring copyright details.
121	<P>
122
123	<B>ipsec --directory</B>
124
125	reports where
126	<I>ipsec</I>
127
128	thinks the IPsec utilities are stored.
129	<P>
130
131	<B>ipsec --confdir</B>
132
133	reports where
134	<I>ipsec</I>
135
136	thinks the IPsec configuration files are stored.
137	<A NAME="lbAE"> </A>
138	<H2>FILES</H2>
139
140	/usr/local/lib/ipsec<TT>   </TT>usual utilities directory<BR>
141	<A NAME="lbAF"> </A>
142	<H2>ENVIRONMENT</H2>
143
144	<P>
145
146	The following environment variables control where FreeS/WAN finds its
147	components.
148	The
149	<B>ipsec</B>
150
151	command sets them if they are not already set.
152	<PRE>
153	IPSEC_EXECDIR directory containing published commands
154	IPSEC_LIBDIR directory containing internal executables
155	IPSEC_SBINDIR directory containing <B>ipsec</B> command
156	IPSEC_CONFS directory containing configuration files
157	</PRE>
158
159	<A NAME="lbAG"> </A>
160	<H2>SEE ALSO</H2>
161
162
163
164	<A HREF="ipsec.conf.5.html">ipsec.conf</A>(5), <A HREF="ipsec.secrets.5.html">ipsec.secrets</A>(5),
165	<A HREF="ipsec_auto.8.html">ipsec_auto</A>(8),
166	<A HREF="ipsec_barf.8.html">ipsec_barf</A>(8),
167	<A HREF="ipsec_setup.8.html">ipsec_setup</A>(8),
168	<A HREF="ipsec_showdefaults.8.html">ipsec_showdefaults</A>(8),
169	<A HREF="ipsec_showhostkey.8.html">ipsec_showhostkey</A>(8)
170
171
172	<P>
173
174	HTML documentation shipped with the release, starting with
175	<I>doc/index.html</I>.
176
177	<I><<A HREF="http://www.freeswan.org/doc.html">http://www.freeswan.org/doc.html</A>></I>
178
179	may also be of use.
180	<A NAME="lbAH"> </A>
181	<H2>HISTORY</H2>
182
183	Written for Linux FreeS/WAN
184	<<A HREF="http://www.freeswan.org">http://www.freeswan.org</A>>
185	by Henry Spencer.
186	<A NAME="lbAI"> </A>
187	<H2>BUGS</H2>
188
189	The provision of centralized services,
190	while convenient,
191	does compromise the original concept of making the utilities
192	invocable directly as well as via
193	<I>ipsec</I>.
194
195	<P>
196
197	<HR>
198	<A NAME="index"> </A><H2>Index</H2>
199	<DL>
200	<DT><A HREF="#lbAB">NAME</A><DD>
201	<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
202	<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
203	<DT><A HREF="#lbAE">FILES</A><DD>
204	<DT><A HREF="#lbAF">ENVIRONMENT</A><DD>
205	<DT><A HREF="#lbAG">SEE ALSO</A><DD>
206	<DT><A HREF="#lbAH">HISTORY</A><DD>
207	<DT><A HREF="#lbAI">BUGS</A><DD>
208	</DL>
209	<HR>
210	This document was created by
211	<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
212	using the manual pages.<BR>
213	Time: 21:40:17 GMT, November 11, 2003
214	</BODY>
215	</HTML>