All pages: Replace the 4th argument to .TH by "Linux man-pages (unreleased)"

[thirdparty/man-pages.git] / man3 / getdirentries.3

diff --git a/man3/getdirentries.3 b/man3/getdirentries.3
index 49ac828239f6704076399a439af1c09e52d128de..0a903b9f50840a1b43b55aa47d2961fcd1a3cb4e 100644 (file)
--- a/man3/getdirentries.3
+++ b/man3/getdirentries.3
@@ -1,45 +1,35 @@
-.\" Hey Emacs! This file is -*- nroff -*- source.
-.\"
 .\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu)
 .\" Portions extracted from /usr/include/dirent.h are:
 .\"                    Copyright 1991, 1992 Free Software Foundation
 .\"
-.\" Permission is granted to make and distribute verbatim copies of this
-.\" manual provided the copyright notice and this permission notice are
-.\" preserved on all copies.
-.\"
-.\" Permission is granted to copy and distribute modified versions of this
-.\" manual under the conditions for verbatim copying, provided that the
-.\" entire resulting derived work is distributed under the terms of a
-.\" permission notice identical to this one.
-.\"
-.\" Since the Linux kernel and libraries are constantly changing, this
-.\" manual page may be incorrect or out-of-date.  The author(s) assume no
-.\" responsibility for errors or omissions, or for damages resulting from
-.\" the use of the information contained herein.  The author(s) may not
-.\" have taken the same level of care in the production of this manual,
-.\" which is licensed free of charge, as they might when working
-.\" professionally.
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
 .\"
-.\" Formatted or processed versions of this manual, if unaccompanied by
-.\" the source, must acknowledge the copyright and authors of this work.
-.\"
-.TH GETDIRENTRIES 3 2007-07-26 "GNU" "Linux Programmer's Manual"
+.TH GETDIRENTRIES 3 2021-03-22 "Linux man-pages (unreleased)" "Linux Programmer's Manual"
 .SH NAME
-getdirentries \- get directory entries in a file system-independent format
+getdirentries \- get directory entries in a filesystem-independent format
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
 .SH SYNOPSIS
+.nf
 .B #include <dirent.h>
-.sp
-.BI "ssize_t getdirentries(int " fd ", char *" buf ", size_t " nbytes
-.BI ", off_t *" basep );
-.sp
-.in -4n
+.PP
+.BI "ssize_t getdirentries(int " fd ", char *restrict " buf ", size_t " nbytes ,
+.BI "                      off_t *restrict " basep );
+.fi
+.PP
+.RS -4
 Feature Test Macro Requirements for glibc (see
 .BR feature_test_macros (7)):
-.in
-.sp
+.RE
+.PP
 .BR getdirentries ():
-_BSD_SOURCE || _SVID_SOURCE
+.nf
+    Since glibc 2.19:
+        _DEFAULT_SOURCE
+    Glibc 2.19 and earlier:
+        _BSD_SOURCE || _SVID_SOURCE
+.fi
 .SH DESCRIPTION
 Read directory entries from the directory specified by
 .I fd
@@ -58,11 +48,28 @@ is updated with the new position after reading.
 returns the number of bytes read or zero when at the end of the directory.
 If an error occurs, \-1 is returned, and
 .I errno
-is set appropriately.
+is set to indicate the error.
 .SH ERRORS
 See the Linux library source code for details.
-.SH CONFORMING TO
-Not in POSIX.1-2001.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.ad l
+.nh
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface      Attribute       Value
+T{
+.BR getdirentries ()
+T}     Thread safety   MT-Safe
+.TE
+.hy
+.ad
+.sp 1
+.SH STANDARDS
+Not in POSIX.1.
 Present on the BSDs, and a few other systems.
 Use
 .BR opendir (3)