(split) Apply minor changes from v3.32 to v3.35 in the upstream.

[linuxjm/LDP_man-pages.git] / release / man3 / scandir.3

.\" Copyright (C) 1993 David Metcalfe (david@prism.demon.co.uk)
.\"
.\" 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.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" References consulted:
.\"     Linux libc source code
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
.\"     386BSD man pages
.\" Modified Sat Jul 24 18:26:16 1993 by Rik Faith (faith@cs.unc.edu)
.\" Modified Thu Apr 11 17:11:33 1996 by Andries Brouwer (aeb@cwi.nl):
.\"     Corrected type of compar routines, as suggested by
.\"     Miguel Barreiro (enano@avalon.yaix.es).  Added example.
.\" Modified Sun Sep 24 20:15:46 2000 by aeb, following Petter Reinholdtsen.
.\" Modified 2001-12-26 by aeb, following Joey. Added versionsort.
.\"
.\" FIXME glibc 2.15 adds scandirat()
.\"
.\" Japanese Version Copyright (c) 1998 Hiroaki Nagoya all rights reserved.
.\" Translated Thu May 28 1998 by Hiroaki Nagoya <nagoya@is.titech.ac.jp>
.\" Updated & Modified Sat Jan 19 18:22:21 JST 2002
.\"         by Yuichi SATO <ysato@h4.dion.ne.jp>
.\" Updated & Modified Sun Jan 16 08:12:04 JST 2005
.\"         by Yuichi SATO <ysato444@yahoo.co.jp>
.\"
.TH SCANDIR 3  2011-09-08 "GNU" "Linux Programmer's Manual"
.SH ̾Á°
scandir, alphasort, versionsort \- ¥Ç¥£¥ì¥¯¥È¥ê¤òÁöºº¤¹¤ë
.SH ½ñ¼°
.nf
.B #include <dirent.h>
.sp
.BI "int scandir(const char *" dirp ", struct dirent ***" namelist ,
.RS
.BI "int (*" filter ")(const struct dirent *),"
.BI "int (*" compar ")(const struct dirent **, const struct dirent **));"
.RE
.sp
.BI "int alphasort(const void *" a ", const void *" b );
.sp
.BI "int versionsort(const void *" a ", const void *" b );
.fi
.sp
.in -4n
glibc ¸þ¤±¤Îµ¡Ç½¸¡ºº¥Þ¥¯¥í¤ÎÍ×·ï
.RB ( feature_test_macros (7)
»²¾È):
.in
.sp
.BR scandir (),
.BR alphasort ():
_BSD_SOURCE || _SVID_SOURCE
.br
.BR versionsort ():
_GNU_SOURCE
.SH ÀâÌÀ
´Ø¿ô
.BR scandir ()
¤Ï¥Ç¥£¥ì¥¯¥È¥ê \fIdirp\fP ¤òÁöºº¤·¡¢
¥Ç¥£¥ì¥¯¥È¥ê¤Î³Æ¥¨¥ó¥È¥ê¤ò°ú¤­¿ô¤È¤·¤Æ
.BR filter ()
¤ò¸Æ¤Ó½Ð¤¹¡£
.BR filter ()
¤¬ 0 °Ê³°¤ÎÃͤòÊÖ¤¹¥¨¥ó¥È¥ê¤Ï
.BR malloc (3)
¤Ë¤è¤Ã¤Æ
³ÎÊݤµ¤ì¤¿Ê¸»úÎó¤ËÊݸ¤µ¤ì¡¢Èæ³Ó´Ø¿ô
.BR compar ()
¤òÍѤ¤¤Æ
.BR qsort (3)
¤Ë¤è¤ê¥½¡¼¥È¤µ¤ì¡¢
.BR malloc (3)
¤Ë¤è¤ê³ÎÊݤµ¤ì¤¿ÇÛÎó
\fInamelist\fP ¤Ë¤Þ¤È¤á¤é¤ì¤ë¡£
\fIfilter\fP ¤¬ NULL ¤Ê¤é¤Ð¡¢¤¹¤Ù¤Æ¤Î¥¨¥ó¥È¥ê¤¬ÁªÂò¤µ¤ì¤ë¡£
.LP
Èæ³Ó´Ø¿ô
.IR compar ()
¤Ë¤Ï
.BR alphasort ()
´Ø¿ô¤È
.BR versionsort ()
´Ø¿ô¤ò»È¤¦¤³¤È¤¬¤Ç¤­¤ë¡£
.BR alphasort ()
¤Ï
.BR strcoll (3)
¤òÍѤ¤¤Æ¥Ç¥£¥ì¥¯¥È¥ê¥¨¥ó¥È¥ê¤ò¥½¡¼¥È¤·¡¢
.BR versionsort ()
¤Ïʸ»úÎó \fI(*a)\->d_name\fP ¤È \fI(*b)\->d_name\fP ¤ËÂФ·¤Æ
.BR strverscmp (3)
¤òÍѤ¤¤ë¡£
.SH ÊÖ¤êÃÍ
´Ø¿ô
.BR scandir ()
¤ÏÁªÂò¤µ¤ì¤¿¥¨¥ó¥È¥ê¤Î¿ô¤«¡¢
(¥¨¥é¡¼¤¬È¯À¸¤·¤¿¾ì¹ç) \-1 ¤òÊÖ¤¹¡£
.PP
´Ø¿ô
.BR alphasort ()
¤È
.BR versionsort ()
¤Ï 1 ÈÖÌܤΰú¤­¿ô¤¬ 2 ÈÖÌܤΰú¤­¿ô¤ËÂФ·¤Æ¡¢
[¾®¤µ¤¤/Åù¤·¤¤/Â礭¤¤] ¤«¤Ë±þ¤¸¤Æ¡¢0 ¤è¤ê [¾®¤µ¤¤/Åù¤·¤¤/Â礭¤¤] ÃͤòÊÖ¤¹¡£
.SH ¥¨¥é¡¼
.TP
.B ENOENT
\fIdirp\fR ¤Ç»ØÄꤵ¤ì¤¿¥Ñ¥¹¤¬Â¸ºß¤·¤Ê¤¤¡£
.TP
.B ENOMEM
Æ°ºî¤ò´°¿ë¤¹¤ë¤Ë¤Ï¥á¥â¥ê¤¬Â­¤ê¤Ê¤¤¡£
.TP
.B ENOTDIR
\fIdirp\fR ¤Ç»ØÄꤵ¤ì¤¿¥Ñ¥¹¤¬¥Ç¥£¥ì¥¯¥È¥ê¤Ç¤Ï¤Ê¤¤¡£
.SH ¥Ð¡¼¥¸¥ç¥ó
.BR versionsort ()
¤Ï¡¢glibc ¥Ð¡¼¥¸¥ç¥ó 2.1 ¤ÇÄɲ䵤줿¡£
.SH ½àµò
.BR alphasort ()
¤È
.BR scandir ()
¤Ï POSIX.1-2008 ¤Çµ¬Äꤵ¤ì¤Æ¤ª¤ê¡¢¹­¤¯ÍøÍѲÄǽ¤Ç¤¢¤ë¡£
.BR versionsort ()
¤Ï GNU ³ÈÄ¥¤Ç¤¢¤ë¡£
.LP
´Ø¿ô
.BR scandir ()
¤È
.BR alphasort ()
¤Ï 4.3BSD ¤«¤é¼è¤êÆþ¤ì¤é¤ì¡¢Linux ¤Ç¤Ï libc4 ¤«¤é»ÈÍѲÄǽ¤Ë¤Ê¤Ã¤¿¡£
libc4 ¤È libc5 ¤Ç¤Ï°Ê²¼¤Î¤è¤¦¤Ê¤â¤Ã¤È¾ÜºÙ¤Ê¥×¥í¥È¥¿¥¤¥×¤ò»È¤Ã¤Æ¤¤¤ë¡£
.sp
.nf
    int alphasort(const struct dirent ** a,
                  const struct dirent **b);
.fi
.sp
¤·¤«¤· glibc 2.0 ¤Ç¤ÏÉÔÀµ³Î¤Ê BSD ¤Î¥×¥í¥È¥¿¥¤¥×¤ËÌá¤Ã¤¿¡£
.LP
´Ø¿ô
.BR versionsort ()
¤Ï GNU ¤Î³ÈÄ¥¤Ç¤¢¤ê¡¢glibc 2.1 °Ê¹ß¤Ç»ÈÍѲÄǽ¤Ç¤¢¤ë¡£
.LP
glibc 2.1 °Ê¹ß¤Ç¤Ï
.BR alphasort ()
¤Ï
.BR strcoll (3)
¤ò¸Æ¤Ó½Ð¤¹¡£
.BR alphasort ()
¤Ï°ÊÁ°¤Ï
.BR strcmp (3)
¤ò»È¤Ã¤Æ¤¤¤¿¡£
.SH Îã
.nf
#define _SVID_SOURCE
/* ¥«¥ì¥ó¥È¥Ç¥£¥ì¥¯¥È¥ê¤Î¥Õ¥¡¥¤¥ë¤òµÕ½ç¤Ë½ÐÎϤ¹¤ë */
#include <dirent.h>

int
main(void)
{
    struct dirent **namelist;
    int n;

    n = scandir(".", &namelist, 0, alphasort);
    if (n < 0)
        perror("scandir");
    else {
        while (n\-\-) {
            printf("%s\en", namelist[n]\->d_name);
            free(namelist[n]);
        }
        free(namelist);
    }
}
.fi
.SH ´ØÏ¢¹àÌÜ
.BR closedir (3),
.BR fnmatch (3),
.BR opendir (3),
.BR readdir (3),
.BR rewinddir (3),
.BR seekdir (3),
.BR strcmp (3),
.BR strcoll (3),
.BR strverscmp (3),
.BR telldir (3)