NAME¶

DESCRIPTION¶

The library can be used in an overlay mode, which is the preferred way, so that the code is portable and requires no modification to the original BSD code. This can be done easily with the pkg-config(3) library named libbsd-overlay. Or by adding the system-specific include directory with the bsd/ suffix to the list of system include paths. With gcc this could be -isystem ${includedir}/bsd. In addition the LIBBSD_OVERLAY pre-processor variable needs to be defined. The includes in this case should be the usual system ones, such as <unistd.h>.

The other way to use the library is to use the namespaced headers, this is less portable as it makes using libbsd mandatory and it will not work on BSD-based systems, and requires modifying original BSD code. This can be done with the pkg-config(3) library named libbsd. The includes in this case should be namespaced with bsd/, such as <bsd/unistd.h>.

The package also provides a bsd-ctor static library that can be used to inject automatic constructors into a program so that the setproctitle() function gets invoked automatically at startup time. This can be done with the pkg-config(3) library named libbsd-ctor.

HEADERS¶

<bitstring.h>

 

<err.h>

 

<getopt.h>

 

<inttypes.h>

 

<libutil.h>

 

<md5.h>

 

<netinet/ip_icmp.h>

 

<nlist.h>

 

<readpassphrase.h>

 

<stdio.h>

 

<stdlib.h>

 

<string.h>

 

<stringlist.h>

 

<sys/bitstring.h>

 

<sys/cdefs.h>

 

<sys/endian.h>

 

<sys/poll.h>

 

<sys/queue.h>

 

<sys/time.h>

 

<sys/tree.h>

 

<timeconv.h>

 

<unistd.h>

 

<vis.h>

 

<wchar.h>

 

The following is a libbsd specific convenience header, that includes some of the extended headers. It only works in non-overlay mode.

<bsd/bsd.h>

 

DEPRECATED¶

This is the list of currently deprecated macros and functions:

fgetln()

Unportable, requires assistance from the stdio layer. An implementation has to choose between leaking buffers or being reentrant for a limited amount of streams (this implementation chose the latter with a limit of 32). Use getline(3) instead, which is available in many systems and required by IEEE Std 1003.1-2008 (“POSIX.1”).

fgetwln()

Unportable, requires assistance from the stdio layer. An implementation has to choose between leaking buffers or being reentrant for a limited amount of streams (this implementation chose the latter with a limit of 32). Use fgetwc(3) instead, which is available in many systems and required by ISO/IEC 9899:1999 (“ISO C99”) and IEEE Std 1003.1-2001 (“POSIX.1”).

funopen()

Unportable, requires assistance from the stdio layer or some hook framework. On GNU systems the fopencookie() function can be used. Otherwise the code needs to be prepared for neither of these functions being available.

SUPERSEDED¶

MD5Init()

 

MD5Update()

 

MD5Pad()

 

MD5Final()

 

MD5Transform()

 

MD5End()

 

MD5File()

 

MD5FileChunk()

 

MD5Data()

The set of MD5 digest functions are now provided by the libmd companion library, so it is advised to use that instead.

explicit_bzero()

This function is provided by glibc 2.25.

reallocarray()

This function is provided by glibc 2.26.

SEE ALSO¶

HISTORY¶

It is now distributed as part of most non-BSD distributions.