]> git.ipfire.org Git - people/ms/strongswan.git/blob - linux/lib/libfreeswan/version.3
06c5f01e3e4c7c7dac811811e463ca3be2196487
[people/ms/strongswan.git] / linux / lib / libfreeswan / version.3
1 .TH IPSEC_VERSION 3 "21 Nov 2001"
2 .\" RCSID $Id: version.3,v 1.1 2004/03/15 20:35:26 as Exp $
3 .SH NAME
4 ipsec ipsec_version_code \- get IPsec version code
5 .br
6 ipsec ipsec_version_string \- get full IPsec version string
7 .br
8 ipsec ipsec_copyright_notice \- get IPsec copyright notice
9 .SH SYNOPSIS
10 .B "#include <freeswan.h>
11 .sp
12 .B "const char *ipsec_version_code(void);"
13 .br
14 .B "const char *ipsec_version_string(void);"
15 .br
16 .B "const char **ipsec_copyright_notice(void);"
17 .SH DESCRIPTION
18 These functions provide information on version numbering and copyright
19 of the Linux FreeS/WAN IPsec implementation.
20 .PP
21 .I Ipsec_version_code
22 returns a pointer to a string constant
23 containing the current IPsec version code,
24 such as ``1.92'' or ``snap2001Nov19b''.
25 .PP
26 .I Ipsec_version_string
27 returns a pointer to a string constant giving a full version identification,
28 consisting of the version code preceded by a prefix identifying the software,
29 e.g. ``Linux FreeS/WAN 1.92''.
30 .PP
31 .I Ipsec_copyright_notice
32 returns a pointer to a vector of pointers,
33 terminated by a
34 .BR NULL ,
35 which is the text of a suitable copyright notice.
36 Each pointer points to a string constant (possibly empty) which is one line
37 of the somewhat-verbose copyright notice.
38 The strings are NUL-terminated and do not contain a newline;
39 supplying suitable line termination for the output device is
40 the caller's responsibility.
41 .SH SEE ALSO
42 ipsec(8)
43 .SH HISTORY
44 Written for the FreeS/WAN project by Henry Spencer.