d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
e611a320a6
freebsd-dev/lib/libipsec/ipsec_strerror.3

90 lines
2.8 KiB
Groff
Raw Normal View History

just merged cosmetic changes from KAME to ease sync between KAME and FreeBSD. (based on freebsd4-snap-20020128) Reviewed by: ume MFC after: 1 week
2002-04-19 04:46:24 +00:00
.\" $KAME: ipsec_strerror.3,v 1.9 2001/08/17 07:21:36 itojun Exp $
- errx() doesn't need `\n'. - use %u for unsigned variable. Obtained from: KAME
2003-10-26 12:00:27 +00:00
.\" $FreeBSD$
synchronize with latest kame tree. behavior change: policy syntax was changed. you may need to update your setkey(8) configuration files.
2000-07-04 16:22:05 +00:00
.\"
Sync with recent KAME. This work was based on kame-20010528-freebsd43-snap.tgz and some critical problem after the snap was out were fixed. There are many many changes since last KAME merge. TODO: - The definitions of SADB_* in sys/net/pfkeyv2.h are still different from RFC2407/IANA assignment because of binary compatibility issue. It should be fixed under 5-CURRENT. - ip6po_m member of struct ip6_pktopts is no longer used. But, it is still there because of binary compatibility issue. It should be removed under 5-CURRENT. Reviewed by: itojun Obtained from: KAME MFC after: 3 weeks
2001-06-11 12:39:29 +00:00
.\" Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project.
libipsec and IPsec related apps. (and some KAME related man pages) Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
2000-01-06 12:40:54 +00:00
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the project nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd May 6, 1998
.Dt IPSEC_STRERROR 3
. remove some unneeded comments . replace .Os value with empty value since this library is not KAME only anymore . add a note about IPv6 and IPsec integration to the FreeBSD
2000-05-01 14:42:09 +00:00
.Os
synchronize with latest kame tree. behavior change: policy syntax was changed. you may need to update your setkey(8) configuration files.
2000-07-04 16:22:05 +00:00
.\"
libipsec and IPsec related apps. (and some KAME related man pages) Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
2000-01-06 12:40:54 +00:00
.Sh NAME
.Nm ipsec_strerror
Sync with recent KAME. This work was based on kame-20010528-freebsd43-snap.tgz and some critical problem after the snap was out were fixed. There are many many changes since last KAME merge. TODO: - The definitions of SADB_* in sys/net/pfkeyv2.h are still different from RFC2407/IANA assignment because of binary compatibility issue. It should be fixed under 5-CURRENT. - ip6po_m member of struct ip6_pktopts is no longer used. But, it is still there because of binary compatibility issue. It should be removed under 5-CURRENT. Reviewed by: itojun Obtained from: KAME MFC after: 3 weeks
2001-06-11 12:39:29 +00:00
.Nd error message for IPsec policy manipulation library
synchronize with latest kame tree. behavior change: policy syntax was changed. you may need to update your setkey(8) configuration files.
2000-07-04 16:22:05 +00:00
.\"
libipsec and IPsec related apps. (and some KAME related man pages) Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
2000-01-06 12:40:54 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In netinet6/ipsec.h
Sync with recent KAME. This work was based on kame-20010528-freebsd43-snap.tgz and some critical problem after the snap was out were fixed. There are many many changes since last KAME merge. TODO: - The definitions of SADB_* in sys/net/pfkeyv2.h are still different from RFC2407/IANA assignment because of binary compatibility issue. It should be fixed under 5-CURRENT. - ip6po_m member of struct ip6_pktopts is no longer used. But, it is still there because of binary compatibility issue. It should be removed under 5-CURRENT. Reviewed by: itojun Obtained from: KAME MFC after: 3 weeks
2001-06-11 12:39:29 +00:00
.Ft "const char *"
synchronize with latest kame tree. behavior change: policy syntax was changed. you may need to update your setkey(8) configuration files.
2000-07-04 16:22:05 +00:00
.Fn ipsec_strerror
.\"
libipsec and IPsec related apps. (and some KAME related man pages) Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
2000-01-06 12:40:54 +00:00
.Sh DESCRIPTION
mdoc(7): Properly mark C headers.
2003-09-10 19:24:35 +00:00
.In netinet6/ipsec.h
libipsec and IPsec related apps. (and some KAME related man pages) Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
2000-01-06 12:40:54 +00:00
declares
.Pp
Sync with recent KAME. This work was based on kame-20010528-freebsd43-snap.tgz and some critical problem after the snap was out were fixed. There are many many changes since last KAME merge. TODO: - The definitions of SADB_* in sys/net/pfkeyv2.h are still different from RFC2407/IANA assignment because of binary compatibility issue. It should be fixed under 5-CURRENT. - ip6po_m member of struct ip6_pktopts is no longer used. But, it is still there because of binary compatibility issue. It should be removed under 5-CURRENT. Reviewed by: itojun Obtained from: KAME MFC after: 3 weeks
2001-06-11 12:39:29 +00:00
.Dl extern int ipsec_errcode;
.Pp
which is used to pass an error code from IPsec policy manipulation library
to an user program.
The .Fn function. Spelling.
2003-02-06 11:29:40 +00:00
The
libipsec and IPsec related apps. (and some KAME related man pages) Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
2000-01-06 12:40:54 +00:00
.Fn ipsec_strerror
The .Fn function. Spelling.
2003-02-06 11:29:40 +00:00
function can be used to obtain the error message string for the error code.
synchronize with latest kame tree. behavior change: policy syntax was changed. you may need to update your setkey(8) configuration files.
2000-07-04 16:22:05 +00:00
.Pp
The array pointed to is not to be modified by the program.
Since
.Fn ipsec_strerror
uses
.Xr strerror 3
as underlying function, calling
.Xr strerror 3
after
.Fn ipsec_strerror
would make the return value from
.Fn ipsec_strerror
invalid, or overwritten.
.\"
libipsec and IPsec related apps. (and some KAME related man pages) Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
2000-01-06 12:40:54 +00:00
.Sh RETURN VALUES
The .Fn function. Spelling.
2003-02-06 11:29:40 +00:00
The
libipsec and IPsec related apps. (and some KAME related man pages) Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
2000-01-06 12:40:54 +00:00
.Fn ipsec_strerror
The .Fn function. Spelling.
2003-02-06 11:29:40 +00:00
function always returns a pointer to C string.
libipsec and IPsec related apps. (and some KAME related man pages) Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
2000-01-06 12:40:54 +00:00
The C string must not be overwritten by user programs.
.\"
synchronize with latest kame tree. behavior change: policy syntax was changed. you may need to update your setkey(8) configuration files.
2000-07-04 16:22:05 +00:00
.Sh SEE ALSO
.Xr ipsec_set_policy 3
libipsec and IPsec related apps. (and some KAME related man pages) Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
2000-01-06 12:40:54 +00:00
.\"
.Sh HISTORY
The .Fn function. Spelling.
2003-02-06 11:29:40 +00:00
The
Sync with recent KAME. This work was based on kame-20010528-freebsd43-snap.tgz and some critical problem after the snap was out were fixed. There are many many changes since last KAME merge. TODO: - The definitions of SADB_* in sys/net/pfkeyv2.h are still different from RFC2407/IANA assignment because of binary compatibility issue. It should be fixed under 5-CURRENT. - ip6po_m member of struct ip6_pktopts is no longer used. But, it is still there because of binary compatibility issue. It should be removed under 5-CURRENT. Reviewed by: itojun Obtained from: KAME MFC after: 3 weeks
2001-06-11 12:39:29 +00:00
.Fn ipsec_strerror
The .Fn function. Spelling.
2003-02-06 11:29:40 +00:00
function first appeared in WIDE/KAME IPv6 protocol stack kit.
synchronize with latest kame tree. behavior change: policy syntax was changed. you may need to update your setkey(8) configuration files.
2000-07-04 16:22:05 +00:00
.\"
Sync with recent KAME. This work was based on kame-20010528-freebsd43-snap.tgz and some critical problem after the snap was out were fixed. There are many many changes since last KAME merge. TODO: - The definitions of SADB_* in sys/net/pfkeyv2.h are still different from RFC2407/IANA assignment because of binary compatibility issue. It should be fixed under 5-CURRENT. - ip6po_m member of struct ip6_pktopts is no longer used. But, it is still there because of binary compatibility issue. It should be removed under 5-CURRENT. Reviewed by: itojun Obtained from: KAME MFC after: 3 weeks
2001-06-11 12:39:29 +00:00
.Sh BUGS
The .Fn function. Spelling.
2003-02-06 11:29:40 +00:00
The
Sync with recent KAME. This work was based on kame-20010528-freebsd43-snap.tgz and some critical problem after the snap was out were fixed. There are many many changes since last KAME merge. TODO: - The definitions of SADB_* in sys/net/pfkeyv2.h are still different from RFC2407/IANA assignment because of binary compatibility issue. It should be fixed under 5-CURRENT. - ip6po_m member of struct ip6_pktopts is no longer used. But, it is still there because of binary compatibility issue. It should be removed under 5-CURRENT. Reviewed by: itojun Obtained from: KAME MFC after: 3 weeks
2001-06-11 12:39:29 +00:00
.Fn ipsec_strerror
The .Fn function. Spelling.
2003-02-06 11:29:40 +00:00
function will return its result which may be overwritten by subsequent calls.
just merged cosmetic changes from KAME to ease sync between KAME and FreeBSD. (based on freebsd4-snap-20020128) Reviewed by: ume MFC after: 1 week
2002-04-19 04:46:24 +00:00
.Pp
.Va ipsec_errcode
is not thread safe.
Reference in New Issue Copy Permalink