Add getopt_long from NetBSD
[dragonfly.git] / lib / libipsec / ipsec_strerror.3
1 .\"     $KAME: ipsec_strerror.3,v 1.9 2001/08/17 07:21:36 itojun Exp $
2 .\"     $FreeBSD: src/lib/libipsec/ipsec_strerror.3,v 1.2.2.7 2002/04/28 05:40:25 suz Exp $
3 .\"     $DragonFly: src/lib/libipsec/ipsec_strerror.3,v 1.2 2003/06/17 04:26:49 dillon Exp $
4 .\"
5 .\" Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project.
6 .\" All rights reserved.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 3. Neither the name of the project nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .Dd May 6, 1998
33 .Dt IPSEC_STRERROR 3
34 .Os
35 .\"
36 .Sh NAME
37 .Nm ipsec_strerror
38 .Nd error message for IPsec policy manipulation library
39 .\"
40 .Sh SYNOPSIS
41 .In netinet6/ipsec.h
42 .Ft "const char *"
43 .Fn ipsec_strerror
44 .\"
45 .Sh DESCRIPTION
46 .Pa netinet6/ipsec.h
47 declares
48 .Pp
49 .Dl extern int ipsec_errcode;
50 .Pp
51 which is used to pass an error code from IPsec policy manipulation library
52 to an user program.
53 .Fn ipsec_strerror
54 can be used to obtain the error message string for the error code.
55 .Pp
56 The array pointed to is not to be modified by the program.
57 Since
58 .Fn ipsec_strerror
59 uses
60 .Xr strerror 3
61 as underlying function, calling
62 .Xr strerror 3
63 after
64 .Fn ipsec_strerror
65 would make the return value from
66 .Fn ipsec_strerror
67 invalid, or overwritten.
68 .\"
69 .Sh RETURN VALUES
70 .Fn ipsec_strerror
71 always return a pointer to C string.
72 The C string must not be overwritten by user programs.
73 .\"
74 .Sh SEE ALSO
75 .Xr ipsec_set_policy 3
76 .\"
77 .Sh HISTORY
78 .Fn ipsec_strerror
79 first appeared in WIDE/KAME IPv6 protocol stack kit.
80 .\"
81 .Sh BUGS
82 .Fn ipsec_strerror
83 will return its result which may be overwritten by subsequent calls.
84 .Pp
85 .Va ipsec_errcode
86 is not thread safe.