]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man3/getdirentries.3
All pages: Replace the 4th argument to .TH by "Linux man-pages (unreleased)"
[thirdparty/man-pages.git] / man3 / getdirentries.3
index da3344d88de694554a3b1825a4d772915d5d2f17..0a903b9f50840a1b43b55aa47d2961fcd1a3cb4e 100644 (file)
@@ -2,47 +2,34 @@
 .\" Portions extracted from /usr/include/dirent.h are:
 .\"                    Copyright 1991, 1992 Free Software Foundation
 .\"
-.\" %%%LICENSE_START(VERBATIM)
-.\" 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.
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
 .\"
-.\" 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.
-.\"
-.\" Formatted or processed versions of this manual, if unaccompanied by
-.\" the source, must acknowledge the copyright and authors of this work.
-.\" %%%LICENSE_END
-.\"
-.TH GETDIRENTRIES 3 2016-03-15 "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 filesystem-independent format
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
 .SH SYNOPSIS
+.nf
 .B #include <dirent.h>
 .PP
-.BI "ssize_t getdirentries(int " fd ", char *" buf ", size_t " nbytes
-.BI ", off_t *" basep );
+.BI "ssize_t getdirentries(int " fd ", char *restrict " buf ", size_t " nbytes ,
+.BI "                      off_t *restrict " basep );
+.fi
 .PP
-.in -4n
+.RS -4
 Feature Test Macro Requirements for glibc (see
 .BR feature_test_macros (7)):
-.in
+.RE
 .PP
 .BR getdirentries ():
+.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
@@ -61,22 +48,27 @@ 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 ATTRIBUTES
 For an explanation of the terms used in this section, see
 .BR attributes (7).
+.ad l
+.nh
 .TS
 allbox;
-lb lb lb
+lbx lb lb
 l l l.
 Interface      Attribute       Value
 T{
 .BR getdirentries ()
 T}     Thread safety   MT-Safe
 .TE
-.SH CONFORMING TO
+.hy
+.ad
+.sp 1
+.SH STANDARDS
 Not in POSIX.1.
 Present on the BSDs, and a few other systems.
 Use