diff options
author | Chad Loder <cloder@cvs.openbsd.org> | 2005-02-25 03:12:45 +0000 |
---|---|---|
committer | Chad Loder <cloder@cvs.openbsd.org> | 2005-02-25 03:12:45 +0000 |
commit | 8e555d953d4a7e8702ccb2d29b39ad91d179ce95 (patch) | |
tree | 6c0a9ec621640942bf2aabca87382a65abb1cd77 /lib/libc/gen | |
parent | 8dcf2d1387109e43cabbf8b12a6bf3dd3ed2613d (diff) |
Be correct in our man pages when talking about NUL termination (that is,
termination with '\0') vs. null termination.
Input from krw@, jaredy@, jmc@. OK deraadt@
Diffstat (limited to 'lib/libc/gen')
-rw-r--r-- | lib/libc/gen/authenticate.3 | 6 | ||||
-rw-r--r-- | lib/libc/gen/confstr.3 | 4 | ||||
-rw-r--r-- | lib/libc/gen/exec.3 | 8 | ||||
-rw-r--r-- | lib/libc/gen/fts.3 | 6 | ||||
-rw-r--r-- | lib/libc/gen/getbsize.3 | 6 | ||||
-rw-r--r-- | lib/libc/gen/getcap.3 | 4 | ||||
-rw-r--r-- | lib/libc/gen/getdomainname.3 | 4 | ||||
-rw-r--r-- | lib/libc/gen/gethostname.3 | 4 | ||||
-rw-r--r-- | lib/libc/gen/getpass.3 | 4 | ||||
-rw-r--r-- | lib/libc/gen/popen.3 | 6 | ||||
-rw-r--r-- | lib/libc/gen/readpassphrase.3 | 4 | ||||
-rw-r--r-- | lib/libc/gen/ttyname.3 | 6 | ||||
-rw-r--r-- | lib/libc/gen/uname.3 | 4 | ||||
-rw-r--r-- | lib/libc/gen/vis.3 | 4 |
14 files changed, 35 insertions, 35 deletions
diff --git a/lib/libc/gen/authenticate.3 b/lib/libc/gen/authenticate.3 index f690610b66a..1b564df4028 100644 --- a/lib/libc/gen/authenticate.3 +++ b/lib/libc/gen/authenticate.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: authenticate.3,v 1.7 2003/05/30 14:00:32 jmc Exp $ +.\" $OpenBSD: authenticate.3,v 1.8 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1997 Berkeley Software Design, Inc. All rights reserved. .\" @@ -269,9 +269,9 @@ should be used to determine the outcome of the authentication request. .Pp The .Fn auth_mkvalue -function takes a null terminated string pointed to by +function takes a NUL-terminated string pointed to by .Ar value -and returns a null terminated string suitable for passing +and returns a NUL-terminated string suitable for passing back to a calling program on the back channel. This function is for use by the login scripts themselves. The string returned should be freed by diff --git a/lib/libc/gen/confstr.3 b/lib/libc/gen/confstr.3 index 1ebcd7c41e6..260cfe7b445 100644 --- a/lib/libc/gen/confstr.3 +++ b/lib/libc/gen/confstr.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: confstr.3,v 1.13 2004/04/16 10:48:39 jmc Exp $ +.\" $OpenBSD: confstr.3,v 1.14 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1993 .\" The Regents of the University of California. All rights reserved. @@ -68,7 +68,7 @@ has a value; up to .Fa len \- 1 bytes of the value are copied into the buffer .Fa buf . -The copied value is always null terminated. +The copied value is always NUL terminated. .Pp The available values are as follows: .Bl -tag -width "123456" diff --git a/lib/libc/gen/exec.3 b/lib/libc/gen/exec.3 index 8c53eac70fa..febeed692b0 100644 --- a/lib/libc/gen/exec.3 +++ b/lib/libc/gen/exec.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: exec.3,v 1.16 2003/06/02 20:18:34 millert Exp $ +.\" $OpenBSD: exec.3,v 1.17 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -77,7 +77,7 @@ functions can be thought of as \&..., .Fa argn . Together they describe a list of one or more pointers to -null-terminated +NUL-terminated strings that represent the argument list available to the executed program. The first argument, by convention, should point to the file name associated with the file being executed. @@ -90,7 +90,7 @@ The and .Fn execvp functions provide an array of pointers to -null-terminated strings that +NUL-terminated strings that represent the argument list available to the new program. The first argument, by convention, should point to the file name associated with the file being executed. @@ -106,7 +106,7 @@ pointer that terminates the list of arguments in the parameter list or the pointer to the .Va argv array with an additional parameter. -This additional parameter is an array of pointers to null-terminated +This additional parameter is an array of pointers to NUL-terminated strings and .Em must be terminated by a null pointer itself. diff --git a/lib/libc/gen/fts.3 b/lib/libc/gen/fts.3 index 46b14e9e610..e4c0e8ab8e7 100644 --- a/lib/libc/gen/fts.3 +++ b/lib/libc/gen/fts.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fts.3,v 1.19 2003/06/02 20:18:34 millert Exp $ +.\" $OpenBSD: fts.3,v 1.20 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1989, 1991, 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -319,7 +319,7 @@ Therefore, the .Fa fts_path and .Fa fts_accpath -fields are guaranteed to be null terminated +fields are guaranteed to be NUL terminated .Em only for the file most recently returned by .Fn fts_read . @@ -336,7 +336,7 @@ Any such modifications should be undone before further calls to are attempted. The .Fa fts_name -field is always null terminated. +field is always NUL terminated. .Ss FTS_OPEN The .Fn fts_open diff --git a/lib/libc/gen/getbsize.3 b/lib/libc/gen/getbsize.3 index 876b1b53df2..0d8857128f7 100644 --- a/lib/libc/gen/getbsize.3 +++ b/lib/libc/gen/getbsize.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getbsize.3,v 1.7 2003/06/02 20:18:34 millert Exp $ +.\" $OpenBSD: getbsize.3,v 1.8 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1993 .\" The Regents of the University of California. All rights reserved. @@ -48,14 +48,14 @@ for details on its use and format. .Pp The .Fn getbsize -function returns a pointer to a null-terminated +function returns a pointer to a NUL-terminated string describing the block size, something like .Qq 1K-blocks . The memory referenced by .Fa headerlenp is filled in with the length of the string (not including the -terminating null byte). +terminating NUL byte). The memory referenced by .Fa blocksizep is filled in with the block size, in bytes. diff --git a/lib/libc/gen/getcap.3 b/lib/libc/gen/getcap.3 index fa6429a3f46..188b9c01783 100644 --- a/lib/libc/gen/getcap.3 +++ b/lib/libc/gen/getcap.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getcap.3,v 1.27 2004/04/16 10:48:39 jmc Exp $ +.\" $OpenBSD: getcap.3,v 1.28 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1992, 1993 .\" The Regents of the University of California. All rights reserved. @@ -197,7 +197,7 @@ retrieves the value of the string capability .Fa cap from the capability record pointed to by .Fa buf . -A pointer to a decoded, null-terminated, +A pointer to a decoded, NUL-terminated, .Xr malloc Ns \&'d copy of the string is returned in the .Ft char * diff --git a/lib/libc/gen/getdomainname.3 b/lib/libc/gen/getdomainname.3 index b07bb0679de..b3e0831e4d1 100644 --- a/lib/libc/gen/getdomainname.3 +++ b/lib/libc/gen/getdomainname.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getdomainname.3,v 1.20 2003/06/02 20:18:34 millert Exp $ +.\" $OpenBSD: getdomainname.3,v 1.21 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -52,7 +52,7 @@ specifies the size of the .Fa name array. If insufficient space is provided, the returned name is truncated. -The returned name is always null terminated. +The returned name is always NUL terminated. .Pp .Fn setdomainname sets the domain name of the host machine to be diff --git a/lib/libc/gen/gethostname.3 b/lib/libc/gen/gethostname.3 index e5bd6609280..5db7efcb0fc 100644 --- a/lib/libc/gen/gethostname.3 +++ b/lib/libc/gen/gethostname.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: gethostname.3,v 1.19 2003/06/02 20:18:34 millert Exp $ +.\" $OpenBSD: gethostname.3,v 1.20 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -52,7 +52,7 @@ specifies the size of the .Fa name array. If insufficient space is provided, the returned name is truncated. -The returned name is always null terminated. +The returned name is always NUL terminated. .Pp .Fn sethostname sets the name of the host machine to be diff --git a/lib/libc/gen/getpass.3 b/lib/libc/gen/getpass.3 index 31a586b4960..6ae08359ee3 100644 --- a/lib/libc/gen/getpass.3 +++ b/lib/libc/gen/getpass.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getpass.3,v 1.11 2003/06/02 20:18:34 millert Exp $ +.\" $OpenBSD: getpass.3,v 1.12 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -66,7 +66,7 @@ space. .Sh RETURN VALUES Upon successful completion, .Fn getpass -returns a pointer to a null-terminated string of at most +returns a pointer to a NUL-terminated string of at most .Dv _PASSWORD_LEN characters. If an error is encountered, the terminal state is restored and diff --git a/lib/libc/gen/popen.3 b/lib/libc/gen/popen.3 index 0300d711144..1215be9d0c1 100644 --- a/lib/libc/gen/popen.3 +++ b/lib/libc/gen/popen.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: popen.3,v 1.12 2003/06/02 20:18:34 millert Exp $ +.\" $OpenBSD: popen.3,v 1.13 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -54,7 +54,7 @@ the resulting stream is correspondingly read-only or write-only. .Pp The .Fa command -argument is a pointer to a null-terminated +argument is a pointer to a NUL-terminated string containing a shell command line. This command is passed to .Pa /bin/sh @@ -63,7 +63,7 @@ using the flag; interpretation, if any, is performed by the shell. The .Fa type -argument is a pointer to a null-terminated +argument is a pointer to a NUL-terminated string which must be either .Qq r for reading diff --git a/lib/libc/gen/readpassphrase.3 b/lib/libc/gen/readpassphrase.3 index 029fa07fa86..f078d0abdfb 100644 --- a/lib/libc/gen/readpassphrase.3 +++ b/lib/libc/gen/readpassphrase.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: readpassphrase.3,v 1.14 2004/04/16 10:48:39 jmc Exp $ +.\" $OpenBSD: readpassphrase.3,v 1.15 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 2000, 2002 Todd C. Miller <Todd.Miller@courtesan.com> .\" @@ -68,7 +68,7 @@ space. .Sh RETURN VALUES Upon successful completion, .Fn readpassphrase -returns a pointer to the null-terminated passphrase. +returns a pointer to the NUL-terminated passphrase. If an error is encountered, the terminal state is restored and a null pointer is returned. .Sh FILES diff --git a/lib/libc/gen/ttyname.3 b/lib/libc/gen/ttyname.3 index 96b0ae10db6..ff459273c22 100644 --- a/lib/libc/gen/ttyname.3 +++ b/lib/libc/gen/ttyname.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ttyname.3,v 1.14 2003/06/02 20:18:35 millert Exp $ +.\" $OpenBSD: ttyname.3,v 1.15 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -78,7 +78,7 @@ functions get the related device name of a file descriptor for which is true. The .Fn ttyname_r -function stores the null-terminated +function stores the NUL-terminated pathname of the terminal associated with the file descriptor .Fa fd @@ -101,7 +101,7 @@ The .Fn ttyname and .Fn ttyname_r -functions return the null-terminated name if the device is found and +functions return the NUL-terminated name if the device is found and .Fn isatty is true; otherwise a null pointer is returned and diff --git a/lib/libc/gen/uname.3 b/lib/libc/gen/uname.3 index fc196d1b7c7..c069b753f3c 100644 --- a/lib/libc/gen/uname.3 +++ b/lib/libc/gen/uname.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: uname.3,v 1.10 2003/06/02 20:18:35 millert Exp $ +.\" $OpenBSD: uname.3,v 1.11 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1994 .\" The Regents of the University of California. All rights reserved. @@ -40,7 +40,7 @@ .Sh DESCRIPTION The .Fn uname -function stores null-terminated strings of information identifying +function stores NUL-terminated strings of information identifying the current system into the structure referenced by .Fa name . .Pp diff --git a/lib/libc/gen/vis.3 b/lib/libc/gen/vis.3 index 67fa8b55ef2..54ed818d507 100644 --- a/lib/libc/gen/vis.3 +++ b/lib/libc/gen/vis.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: vis.3,v 1.19 2003/06/02 20:18:35 millert Exp $ +.\" $OpenBSD: vis.3,v 1.20 2005/02/25 03:12:43 cloder Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -57,7 +57,7 @@ a string which represents the character If .Fa c needs no encoding, it is copied in unaltered. -The string is null terminated and a pointer to the end of the string is +The string is NUL terminated and a pointer to the end of the string is returned. The maximum length of any encoding is four characters (not including the trailing NUL); |