generic-library/libbsd
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libbsd/libbsd.git synced 2025-01-08 11:02:24 +01:00
Code Issues Projects Releases Wiki Activity

man: Fix manual page references

Browse Source 
When referring to another manual page and their section number, we need
to use Xr instead of Fn, otherwise the section number is interpreted as
a function argument. For functions provided by libbsd itself we should
be using the 3bsd section instead of 3.
This commit is contained in:
Guillem Jover 2024-01-08 23:40:31 +01:00
parent 9275d134e5
commit e87ae3be19
1 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
man/libbsd.7
View File

@ -76,7 +76,7 @@ The package also provides a
.Nm libbsd-ctor .Nm libbsd-ctor
static library that can be used to inject automatic constructors into a static library that can be used to inject automatic constructors into a
program so that the program so that the
.Xr setproctitle_init 3 .Xr setproctitle_init 3bsd
function gets invoked automatically at startup time. function gets invoked automatically at startup time.
This can be done with the This can be done with the
.Xr pkgconf 1 .Xr pkgconf 1
@ -136,13 +136,13 @@ at build-time.
This is the list of functions that provide multiple implementations: This is the list of functions that provide multiple implementations:
.Pp .Pp
.Bl -tag -width 4m -compact .Bl -tag -width 4m -compact
.It Fn strnvis 3 .It Xr strnvis 3bsd
.It Fn strnunvis 3 .It Xr strnunvis 3bsd
.Nx .Nx
added added
.Xr strnvis 3 .Xr strnvis 3bsd
and and
.Xr strnunvis 3 .Xr strnunvis 3bsd
but unfortunately made it incompatible with the existing one in but unfortunately made it incompatible with the existing one in
.Ox .Ox
and Freedesktop's libbsd (the former having existed for over ten years). and Freedesktop's libbsd (the former having existed for over ten years).
@ -156,7 +156,7 @@ Provide both implementations and default for now to the historical one to
avoid breakage, but we will switch to the avoid breakage, but we will switch to the
.Nx .Nx
one in a later release, which is internally consistent with the other one in a later release, which is internally consistent with the other
.Xr vis 3 .Xr vis 3bsd
functions and is now more widespread. functions and is now more widespread.
Define Define
.Dv LIBBSD_NETBSD_VIS .Dv LIBBSD_NETBSD_VIS
@ -178,7 +178,7 @@ or non-buggy way; or because there are better more portable replacements now.
.Pp .Pp
This is the list of currently deprecated macros and functions: This is the list of currently deprecated macros and functions:
.Bl -tag -width 4m .Bl -tag -width 4m
.It Fn fgetln 3 .It Xr fgetln 3bsd
Unportable, requires assistance from the stdio layer. Unportable, requires assistance from the stdio layer.
An implementation has to choose between leaking buffers or being reentrant An implementation has to choose between leaking buffers or being reentrant
for a limited amount of streams (this implementation chose the latter with for a limited amount of streams (this implementation chose the latter with
@ -187,7 +187,7 @@ Use
.Xr getline 3 .Xr getline 3
instead, which is available in many systems and required by instead, which is available in many systems and required by
.St -p1003.1-2008 . .St -p1003.1-2008 .
.It Fn fgetwln 3 .It Xr fgetwln 3bsd
Unportable, requires assistance from the stdio layer. Unportable, requires assistance from the stdio layer.
An implementation has to choose between leaking buffers or being reentrant An implementation has to choose between leaking buffers or being reentrant
for a limited amount of streams (this implementation chose the latter with for a limited amount of streams (this implementation chose the latter with
@ -198,7 +198,7 @@ instead, which is available in many systems and required by
.St -isoC-99 .St -isoC-99
and and
.St -p1003.1-2001 . .St -p1003.1-2001 .
.It Fn funopen 3 .It Xr funopen 3bsd
Unportable, requires assistance from the stdio layer or some hook framework. Unportable, requires assistance from the stdio layer or some hook framework.
On GNU systems the On GNU systems the
.Xr fopencookie 3 .Xr fopencookie 3
@ -215,26 +215,26 @@ are present in all major
for example. for example.
.Pp .Pp
.Bl -tag -width 4m -compact .Bl -tag -width 4m -compact
.It Fn MD5Init 3 .It Xr MD5Init 3
.It Fn MD5Update 3 .It Xr MD5Update 3
.It Fn MD5Pad 3 .It Xr MD5Pad 3
.It Fn MD5Final 3 .It Xr MD5Final 3
.It Fn MD5Transform 3 .It Xr MD5Transform 3
.It Fn MD5End 3 .It Xr MD5End 3
.It Fn MD5File 3 .It Xr MD5File 3
.It Fn MD5FileChunk 3 .It Xr MD5FileChunk 3
.It Fn MD5Data 3 .It Xr MD5Data 3
The set of MD5 digest functions are now proxies for the implementations The set of MD5 digest functions are now proxies for the implementations
provided by the provided by the
.Nm libmd .Nm libmd
companion library, so it is advised to switch to use that directly instead. companion library, so it is advised to switch to use that directly instead.
.It Fn explicit_bzero 3 .It Xr explicit_bzero 3bsd
This function is provided by This function is provided by
.Nm glibc .Nm glibc
2.25, and 2.25, and
.Nm musl .Nm musl
1.1.20. 1.1.20.
.It Fn reallocarray 3 .It Xr reallocarray 3bsd
This function is provided by This function is provided by
.Nm glibc .Nm glibc
2.26, and 2.26, and
@ -244,16 +244,16 @@ This function is provided by
This function is provided by This function is provided by
.Nm glibc .Nm glibc
2.34. 2.34.
.It Xr arc4random 3 .It Xr arc4random 3bsd
.It Xr arc4random_buf 3 .It Xr arc4random_buf 3bsd
.It Xr arc4random_uniform 3 .It Xr arc4random_uniform 3bsd
These functions are provided by These functions are provided by
.Nm glibc .Nm glibc
2.36. 2.36.
Note that it does not provide the Note that it does not provide the
.Xr arc4random_stir 3 .Xr arc4random_stir 3bsd
and and
.Xr arc4random_addrandom 3 .Xr arc4random_addrandom 3bsd
functions. functions.
.It Xr strlcpy 3bsd .It Xr strlcpy 3bsd
.It Xr strlcat 3bsd .It Xr strlcat 3bsd