libbsd(7)

1LIBBSD(7)            BSD Miscellaneous Information Manual            LIBBSD(7)
2

NAME

4     libbsd — utility functions from BSD systems
5

DESCRIPTION

7     The libbsd library provides a set of compatibility macros and functions
8     commonly found on BSD-based systems.  Its purpose is to make those avail‐
9     able on non-BSD based systems to ease portability.
10
11     The library can be used in an overlay mode, which is the preferred way,
12     so that the code is portable and requires no modification to the original
13     BSD code.  This can be done easily with the pkg-config(3) library named
14     libbsd-overlay.  Or by adding the system-specific include directory with
15     the bsd/ suffix to the list of system include paths.  With gcc this could
16     be -isystem ${includedir}/bsd.  In addition the LIBBSD_OVERLAY pre-pro‐
17     cessor variable needs to be defined.  The includes in this case should be
18     the usual system ones, such as <unistd.h>.
19
20     The other way to use the library is to use the namespaced headers, this
21     is less portable as it makes using libbsd mandatory and it will not work
22     on BSD-based systems, and requires modifying original BSD code.  This can
23     be done with the pkg-config(3) library named libbsd.  The includes in
24     this case should be namespaced with bsd/, such as <bsd/unistd.h>.
25
26     The package also provides a bsd-ctor static library that can be used to
27     inject automatic constructors into a program so that the
28     setproctitle_init(3) function gets invoked automatically at startup time.
29     This can be done with the pkg-config(3) library named libbsd-ctor.
30

HEADERS

32     The following are the headers provided by libbsd, that extend the stan‐
33     dard system headers.  They can work in normal or overlay modes, for the
34     former they need to be prefixed with bsd/.
35
36     <bitstring.h>
37     <err.h>
38     <getopt.h>
39     <inttypes.h>
40     <libutil.h>
41     <md5.h>
42     <netinet/ip_icmp.h>
43     <nlist.h>
44     <readpassphrase.h>
45     <stdio.h>
46     <stdlib.h>
47     <string.h>
48     <stringlist.h>
49     <sys/bitstring.h>
50     <sys/cdefs.h>
51     <sys/endian.h>
52     <sys/poll.h>
53     <sys/queue.h>
54     <sys/time.h>
55     <sys/tree.h>
56     <timeconv.h>
57     <unistd.h>
58     <vis.h>
59     <wchar.h>
60
61     The following is a libbsd specific convenience header, that includes some
62     of the extended headers.  It only works in non-overlay mode.
63
64     <bsd/bsd.h>
65

DEPRECATED

67     Some functions have been deprecated, they will emit warnings at compile
68     time and possibly while being linked at run-time.  This might be due to
69     the functions not being portable at all to other systems, making the
70     package not buildable there; not portable in a correct or non-buggy way;
71     or because there are better more portable replacements now.
72
73     This is the list of currently deprecated macros and functions:
74
75     fgetln(3)
76           Unportable, requires assistance from the stdio layer.  An implemen‐
77           tation has to choose between leaking buffers or being reentrant for
78           a limited amount of streams (this implementation chose the latter
79           with a limit of 32).  Use getline(3) instead, which is available in
80           many systems and required by IEEE Std 1003.1-2008 (“POSIX.1”).
81
82     fgetwln(3)
83           Unportable, requires assistance from the stdio layer.  An implemen‐
84           tation has to choose between leaking buffers or being reentrant for
85           a limited amount of streams (this implementation chose the latter
86           with a limit of 32).  Use fgetwc(3) instead, which is available in
87           many systems and required by ISO/IEC 9899:1999 (“ISO C99”) and IEEE
88           Std 1003.1-2001 (“POSIX.1”).
89
90     funopen(3)
91           Unportable, requires assistance from the stdio layer or some hook
92           framework.  On GNU systems the fopencookie(3) function can be used.
93           Otherwise the code needs to be prepared for neither of these func‐
94           tions being available.
95

SUPERSEDED

97     Some functions have been superseded by implementations in other system
98     libraries, and might disappear on the next SONAME bump, assuming those
99     other implementation have widespread deployment, or the implementations
100     are present in all major libc for example.
101
102     MD5Init(3)
103     MD5Update(3)
104     MD5Pad(3)
105     MD5Final(3)
106     MD5Transform(3)
107     MD5End(3)
108     MD5File(3)
109     MD5FileChunk(3)
110     MD5Data(3)
111           The set of MD5 digest functions are now provided by the libmd com‐
112           panion library, so it is advised to use that instead.
113     explicit_bzero(3)
114           This function is provided by glibc 2.25.
115     reallocarray(3)
116           This function is provided by glibc 2.26.
117

HISTORY

132     The libbsd project started in the Debian GNU/kFreeBSD port as a way to
133     ease porting code from FreeBSD to the GNU-based system.  Pretty early on
134     it was generalized and a project created on FreeDesktop.org for other
135     distributions and projects to use.
136
137     It is now distributed as part of most non-BSD distributions.
138
139BSD                              May 21, 2018                              BSD

NAME

DESCRIPTION

HEADERS

DEPRECATED

SUPERSEDED

SEE ALSO

HISTORY