cryb.to/cryb-to
1
0
Fork 0
mirror of https://github.com/cryb-to/cryb-to.git synced 2024-11-21 21:25:50 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve man pages for strlcat() and strlcpy().

Browse source
This commit is contained in:
Dag-Erling Smørgrav 2017-05-02 12:52:19 +02:00
parent e99877752f
commit 7d22bec7bc
2 changed files with 23 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
lib/core/cryb_strlcat.3
View file

@ -1,6 +1,6 @@
.\"- .\"-
.\" Copyright (c) 2015 The University of Oslo .\" Copyright (c) 2015 The University of Oslo
.\" Copyright (c) 2016 Dag-Erling Smørgrav .\" Copyright (c) 2016-2017 Dag-Erling Smørgrav
.\" All rights reserved. .\" All rights reserved.
.\" .\"
.\" Redistribution and use in source and binary forms, with or without .\" Redistribution and use in source and binary forms, with or without
@ -27,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd Septmber 17, 2016 .Dd May 2, 2017
.Dt cryb_strlcat 3 .Dt cryb_strlcat 3
.Os .Os
.Sh NAME .Sh NAME
@ -54,14 +54,25 @@ occupied by the existing string and space for the terminating NUL
character. character.
If the sum of the lengths of both strings exceeds the available space, If the sum of the lengths of both strings exceeds the available space,
the result is truncated. the result is truncated.
In all cases, the destination buffer is properly NUL-terminated. In either case, the destination buffer is properly NUL-terminated.
.Pp
If the buffer pointed to by
.Va dst
does not contain a NUL character within the first
.Va size
bytes,
.Nm
behaves as if the length of
.Va dst
is
.Va size .
.Sh RETURN VALUES .Sh RETURN VALUES
The The
.Fn cryb_strlcat .Fn cryb_strlcat
function returns the sum of the lengths of the original strings. function returns the sum of the lengths of the original strings.
If this number is equal to or greater than the value of the If this number is equal to or greater than the value of
.Va size .Va size ,
argument, the string was too long to fit in the buffer. the string was too long to fit in the buffer.
.Sh IMPLEMENTATION NOTES .Sh IMPLEMENTATION NOTES
If the If the
.Dv HAVE_STRLCAT .Dv HAVE_STRLCAT

12
lib/core/cryb_strlcpy.3
View file

@ -1,6 +1,6 @@
.\"- .\"-
.\" Copyright (c) 2015 The University of Oslo .\" Copyright (c) 2015 The University of Oslo
.\" Copyright (c) 2016 Dag-Erling Smørgrav .\" Copyright (c) 2016-2017 Dag-Erling Smørgrav
.\" All rights reserved. .\" All rights reserved.
.\" .\"
.\" Redistribution and use in source and binary forms, with or without .\" Redistribution and use in source and binary forms, with or without
@ -27,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd September 17, 2016 .Dd May 2, 2017
.Dt cryb_strlcpy 3 .Dt cryb_strlcpy 3
.Os .Os
.Sh NAME .Sh NAME
@ -53,14 +53,14 @@ argument specifies the total size of the buffer, including the space
required for the terminating NUL character. required for the terminating NUL character.
If the length of the string exceeds the available space, the result is If the length of the string exceeds the available space, the result is
truncated. truncated.
In all cases, the destination buffer is properly NUL-terminated. In either case, the destination buffer is properly NUL-terminated.
.Sh RETURN VALUES .Sh RETURN VALUES
The The
.Fn cryb_strlcpy .Fn cryb_strlcpy
function returns the length of the original string. function returns the length of the original string.
If this number is equal to or greater than the value of the If this number is equal to or greater than the value of
.Va size .Va size ,
argument, the string was too long to fit in the buffer. the string was too long to fit in the buffer.
.Sh IMPLEMENTATION NOTES .Sh IMPLEMENTATION NOTES
If the If the
.Dv HAVE_STRLCPY .Dv HAVE_STRLCPY