generic-library/libbsd
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libbsd/libbsd.git synced 2025-04-22 10:13:10 +02:00
Code Issues Projects Releases Wiki Activity

man: Update libbsd(7) man page with updates in 0.11.0

Browse Source
This commit is contained in:
Guillem Jover 2021-02-07 10:56:51 +01:00
parent 4ab11c7f48
commit 18ebabf223
1 changed files with 43 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
man/libbsd.7
View File

@ -94,11 +94,13 @@ be prefixed with
.It In bitstring.h .It In bitstring.h
.It In err.h .It In err.h
.It In getopt.h .It In getopt.h
.It In grp.h
.It In inttypes.h .It In inttypes.h
.It In libutil.h .It In libutil.h
.It In md5.h .It In md5.h
.It In netinet/ip_icmp.h .It In netinet/ip_icmp.h
.It In nlist.h .It In nlist.h
.It In pwd.h
.It In readpassphrase.h .It In readpassphrase.h
.It In stdio.h .It In stdio.h
.It In stdlib.h .It In stdlib.h
@ -107,6 +109,7 @@ be prefixed with
.It In sys/bitstring.h .It In sys/bitstring.h
.It In sys/cdefs.h .It In sys/cdefs.h
.It In sys/endian.h .It In sys/endian.h
.It In sys/param.h
.It In sys/poll.h .It In sys/poll.h
.It In sys/queue.h .It In sys/queue.h
.It In sys/time.h .It In sys/time.h
@ -125,6 +128,45 @@ It only works in non-overlay mode.
.Bl -tag -width 4m -compact .Bl -tag -width 4m -compact
.It In bsd/bsd.h .It In bsd/bsd.h
.El .El
.Sh ALTERNATIVES
Some functions have different prototypes depending on the BSD where they
originated from, and these various implementations provided are selectable
at build-time.
.Pp
This is the list of functions that provide multiple implementations:
.Bl -tag -width 4m
.It Fn strnvis 3
.It Fn strnunvis 3
.Nx
added
.Fn strnvis 3
and
.Fn strnunvis 3
but unfortunately made it incompatible with the existing one in
.Ox
and Freedesktop's libbsd (the former having existed for over ten years).
Despite this incompatibility being reported during development (see
http://gnats.netbsd.org/44977) they still shipped it.
Even more unfortunately
.Fx
and later MacOS picked up this incompatible implementation.
.Pp
Provide both implementations and default for now to the historical one to
avoid breakage, but we will switch to the
.Nx
one in a later release, which is internally consistent with the other
.Xr vis 3
functions and is now more widespread.
Define
.Dv LIBBSD_NETBSD_VIS
to switch to the
.Nx one now.
Define
.Dv LIBBSD_OPENBSD_VIS
to keep using the
.Ox
one.
.El
.Sh DEPRECATED .Sh DEPRECATED
Some functions have been deprecated, they will emit warnings at compile time Some functions have been deprecated, they will emit warnings at compile time
and possibly while being linked at run-time. and possibly while being linked at run-time.
@ -216,6 +258,7 @@ This function is provided by
.Xr md5 3bsd , .Xr md5 3bsd ,
.Xr nlist 3bsd , .Xr nlist 3bsd ,
.Xr pidfile 3bsd , .Xr pidfile 3bsd ,
.Xr pwcache 3bsd ,
.Xr queue 3bsd , .Xr queue 3bsd ,
.Xr radixsort 3bsd , .Xr radixsort 3bsd ,
.Xr readpassphrase 3bsd , .Xr readpassphrase 3bsd ,