libbsd (7)

Leading comments

libbsd man page

Copyright © 2017 Gullem Jover <guillem@hadrons.org>

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
   documentat...

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-config3 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 In 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-config3 library named libbsd The includes in this case should be namespaced with bsd/ such as In 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 Fn setproctitle function gets invoked automatically at startup time. This can be done with the pkg-config3 library named libbsd-ctor

HEADERS

In bitstring.h

In err.h

In getopt.h

In libutil.h

In md5.h

In netinet/ip_icmp.h

In nlist.h

In readpassphrase.h

In stdio.h

In stdlib.h

In string.h

In stringlist.h

In sys/bitstring.h

In sys/cdefs.h

In sys/endian.h

In sys/poll.h

In sys/queue.h

In sys/time.h

In sys/tree.h

In timeconv.h

In unistd.h

In vis.h

In wchar.h

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

In bsd/bsd.h

DEPRECATED

This is the list of currently deprecated macros and functions:

Fn 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 Fn getline 3 instead, which is available in many systems and required by St -p1003.1-2008 .

Fn funopen

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

In addition, the MD5 set of digest funtions are now provided by the libmd companion library, so it is advised to use that instead, as the ones provided in libbsd might disappear on the next SONAME bump.

SEE ALSO

HISTORY

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