Hi, I've written a man page for scandirat(3) that is new to glibc 2.15. The man page is based on the text used in mkfifoat(3) which was very similar. I am happy for this man page to be distributed under the terms of the GNU General Public License version 3 or later. The information in the man page was checked against the source code for glibc 2.15. I include the patch inline below, and also as an attachment. Best regards, Mark Bannister. .\" Hey Emacs! This file is -*- nroff -*- source. .\" .\" Copyright (c) 2011, Mark R. Bannister <cambridge@xxxxxxxxxxxxxxxxxxxxx> .\" based on text in mkfifoat.3 Copyright (c) 2006, Michael Kerrisk .\" .\" This is free documentation; you can redistribute it and/or .\" modify it under the terms of the GNU General Public License as .\" published by the Free Software Foundation; either version 3 of .\" the License, or (at your option) any later version. .\" .\" The GNU General Public License's references to "object code" .\" and "executables" are to be interpreted as the output of any .\" document formatting or typesetting system, including .\" intermediate and printed output. .\" .\" This manual is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public .\" License along with this manual; if not, write to the Free .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, .\" USA. .\" .TH SCANDIRAT 3 2011-11-15 "Linux" "Linux Programmer's Manual" .SH NAME scandirat \- scan a directory relative to a directory file descriptor .SH SYNOPSIS .nf .B #include <fcntl.h> /* Definition of AT_* constants */ .B #include <dirent.h> .sp .fi .BI "int scandir(int " dirfd ", const char *" dirp "," .BI "struct dirent ***" namelist , .nf .RS .BI "int (*" filter ")(const struct dirent *)," .BI "int (*" compar ")(const struct dirent **, const struct dirent **));" .RE .fi .SH DESCRIPTION The .BR scandirat () system call operates in exactly the same way as .BR scandir (3), except for the differences described in this manual page. If the pathname given in .I dirp is relative, then it is interpreted relative to the directory referred to by the file descriptor .I dirfd (rather than relative to the current working directory of the calling process, as is done by .BR scandir (3) for a relative pathname). If .I dirp is relative and .I dirfd is the special value .BR AT_FDCWD , then .I dirp is interpreted relative to the current working directory of the calling process (like .BR scandir (3)). If .I dirp is absolute, then .I dirfd is ignored. .SH "RETURN VALUE" On success, .BR scandirat () returns the number of directory entries selected. On error, \-1 is returned and .I errno is set to indicate the error. .SH ERRORS The same errors that occur for .BR scandir (3) can also occur for .BR scandirat (). The following additional errors can occur for .BR scandirat (): .TP .B EBADF .I dirfd is not a valid file descriptor. .TP .B ENOTDIR .I dirp is a relative path and .I dirfd is a file descriptor referring to a file other than a directory. .SH VERSIONS .BR scandirat () was added to glibc in version 2.15. .SH "CONFORMING TO" This system call is non-standard but is proposed for inclusion in a future revision of POSIX.1. .SH NOTES See .BR openat (2) for an explanation of the need for .BR scandirat (). .SH "SEE ALSO" .BR openat (2), .BR scandir (3), .BR path_resolution (7).
Attachment:
scandirat.3
Description: Binary data
