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