BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / gen / scandir.3

diff --git a/usr/src/lib/libc/gen/scandir.3 b/usr/src/lib/libc/gen/scandir.3
index 87519a5..c4da247 100644 (file)
--- a/usr/src/lib/libc/gen/scandir.3
+++ b/usr/src/lib/libc/gen/scandir.3
@@ -1,71 +1,106 @@
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1991 Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)scandir.3   6.1 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.TH SCANDIR 3  ""
-.UC 5
-.SH NAME
-scandir \- scan a directory
-.SH SYNOPSIS
-.nf
-.B #include <sys/types.h>
-.B #include <sys/dir.h>
-.PP
-.B scandir(dirname, namelist, select, compar)
-.B char *dirname;
-.B struct direct *(*namelist[]);
-.B int (*select)();
-.B int (*compar)();
-.PP
-.B alphasort(d1, d2)
-.B struct direct **d1, **d2;
-.fi
-.SH DESCRIPTION
-.I Scandir
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)scandir.3  6.8 (Berkeley) 4/19/91
+.\"
+.Dd April 19, 1991
+.Dt SCANDIR 3
+.Os BSD 4.2
+.Sh NAME
+.Nm scandir ,
+.Nm alphasort
+.Nd scan a directory
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <dirent.h>
+.Ft int
+.Fn scandir "const char *dirname" "struct dirent ***namelist" "int \\*(lp*select\\*(rp\\*(lpstruct dirent *\\*(rp" "int \\*(lp*compar\\*(rp\\*(lpconst void *, const void *\\*(rp"
+.Ft int
+.Fn alphasort "const void *d1" "const void *d2"
+.Sh DESCRIPTION
+The
+.Fn scandir
+function

 reads the directory
 reads the directory

-.I dirname
+.Fa dirname

 and builds an array of pointers to directory
 entries using
 and builds an array of pointers to directory
 entries using

-.IR malloc (3).
-It returns the number of entries in the array and a pointer to the
-array through
-.IR namelist .
-.PP
+.Xr malloc 3 .
+It returns the number of entries in the array.
+A pointer to the array of directory entries is stored in the location
+referenced by
+.Fa namelist .
+.Pp

 The
 The

-.I select
+.Fa select

 parameter is a pointer to a user supplied subroutine which is called by
 parameter is a pointer to a user supplied subroutine which is called by

-.I scandir
+.Fn scandir

 to select which entries are to be included in the array.
 The select routine is passed a
 pointer to a directory entry and should return a non-zero
 value if the directory entry is to be included in the array.
 If
 to select which entries are to be included in the array.
 The select routine is passed a
 pointer to a directory entry and should return a non-zero
 value if the directory entry is to be included in the array.
 If

-.I select
+.Fa select

 is null, then all the directory entries will be included.
 is null, then all the directory entries will be included.

-.PP
+.Pp

 The
 The

-.I compar
+.Fa compar

 parameter is a pointer to a user supplied subroutine which is passed to
 parameter is a pointer to a user supplied subroutine which is passed to

-.IR qsort (3)
-to sort the completed array. If this pointer is null, the array is not sorted.
-.I Alphasort
+.Xr qsort 3
+to sort the completed array.
+If this pointer is null, the array is not sorted.
+.Pp
+The
+.Fn alphasort
+function

 is a routine which can be used for the
 is a routine which can be used for the

-.I compar
+.Fa compar

 parameter to sort the array alphabetically.
 parameter to sort the array alphabetically.

-.PP
+.Pp

 The memory allocated for the array can be deallocated with
 The memory allocated for the array can be deallocated with

-.I free
-(see
-.IR malloc (3))
-by freeing each pointer in the array and the array itself.
-.SH "SEE ALSO"
-directory(3),
-malloc(3),
-qsort(3),
-dir(5)
-.SH DIAGNOSTICS
+.Xr free 3 ,
+by freeing each pointer in the array and then the array itself.
+.Sh DIAGNOSTICS

 Returns \-1 if the directory cannot be opened for reading or if
 Returns \-1 if the directory cannot be opened for reading or if

-.IR malloc (3)
+.Xr malloc 3

 cannot allocate enough memory to hold all the data structures.
 cannot allocate enough memory to hold all the data structures.

+.Sh SEE ALSO
+.Xr directory 3 ,
+.Xr malloc 3 ,
+.Xr qsort 3 ,
+.Xr dir 5
+.Sh HISTORY
+The
+.Fn scandir
+and
+.Fn alphasort
+functions appeared in 
+.Bx 4.2 .