summaryrefslogtreecommitdiff
path: root/lib/libc/string/strlcpy.3
diff options
context:
space:
mode:
authorTodd C. Miller <millert@cvs.openbsd.org>2000-06-01 04:02:06 +0000
committerTodd C. Miller <millert@cvs.openbsd.org>2000-06-01 04:02:06 +0000
commitbb671d21362b92b6fc2b517b9cd14df5bded7ab1 (patch)
treede2d98f2950454e21df0b408f2ebf91754ede023 /lib/libc/string/strlcpy.3
parent244601823b152e336afa1af795ddf7a3c73c201b (diff)
State explicitly that strlc{py,at} only work on real C strings.
Clarify point about always NUL-terminating.
Diffstat (limited to 'lib/libc/string/strlcpy.3')
-rw-r--r--lib/libc/string/strlcpy.325
1 files changed, 22 insertions, 3 deletions
diff --git a/lib/libc/string/strlcpy.3 b/lib/libc/string/strlcpy.3
index 03a80e6c792..5acbcce148f 100644
--- a/lib/libc/string/strlcpy.3
+++ b/lib/libc/string/strlcpy.3
@@ -1,6 +1,6 @@
-.\" $OpenBSD: strlcpy.3,v 1.7 2000/04/21 15:24:20 aaron Exp $
+.\" $OpenBSD: strlcpy.3,v 1.8 2000/06/01 04:02:05 millert Exp $
.\"
-.\" Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com>
+.\" Copyright (c) 1998, 2000 Todd C. Miller <Todd.Miller@courtesan.com>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -56,9 +56,28 @@ and
take the full size of the buffer (not just the length) and guarantee to
NUL-terminate the result (as long as
.Fa size
-is larger than 0).
+is larger than 0 or, in the case of
+.Fn strlcat ,
+as long as there is at least one byte free in
+.Fa dst ) .
Note that you should include a byte for the NUL in
.Fa size .
+Also note that
+.Fn strlcpy
+and
+.Fn strlcat
+only operate on true
+.Dq C
+strings. This means that for
+.Fn strlcpy
+.Fa src
+must be NUL-terminated and for
+.Fn strlcat
+both
+.Fa src
+and
+.Fa dst
+must be NUL-terminated.
.Pp
The
.Fn strlcpy