Print this page
Ensured various XPG7 stuff are declared properly in sys/stat.h (and cleanup)
New documentation for wcslen, wcsnlen, wcscasecmp (and friends), wcsdup.
Various other tweaks and markup improvements.
opendir, dirfd are in XPG7
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man3c/opendir.3c
+++ new/usr/src/man/man3c/opendir.3c
1 -'\" te
1 +.\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
2 2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
3 3 .\" Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
4 4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
5 5 .\" http://www.opengroup.org/bookstore/.
6 6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
7 7 .\" This notice shall appear on any product containing this material.
8 8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
9 9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
10 10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
11 -.TH OPENDIR 3C "Jun 26, 2007"
12 -.SH NAME
13 -opendir, fdopendir \- open directory
14 -.SH SYNOPSIS
15 -.LP
16 -.nf
17 -#include <sys/types.h>
18 -#include <dirent.h>
19 -
20 -\fBDIR *\fR\fBopendir\fR(\fBconst char *\fR\fIdirname\fR);
21 -.fi
22 -
23 -.LP
24 -.nf
25 -\fBDIR *\fR\fBfdopendir\fR(\fBint\fR \fIfildes\fR);
26 -.fi
27 -
28 -.SH DESCRIPTION
29 -.sp
30 -.LP
31 -The \fBopendir()\fR function opens a directory stream corresponding to the
32 -directory named by the \fIdirname\fR argument.
33 -.sp
34 -.LP
35 -The \fBfdopendir()\fR function opens a directory stream for the directory file
36 -descriptor \fIfildes\fR. The directory file descriptor should not be used or
11 +.Dd "Jul 22, 2014"
12 +.Dt OPENDIR 3C
13 +.Os
14 +.Sh NAME
15 +.Nm opendir ,
16 +.Nm fdopendir
17 +.Nd open directory
18 +.Sh SYNOPSIS
19 +.In dirent.h
20 +.
21 +.Ft "DIR *"
22 +.Fn opendir "const char *dirname"
23 +.
24 +.Ft "DIR *"
25 +.Fn fdopendir "int fildes"
26 +.
27 +.Sh DESCRIPTION
28 +The
29 +.Fn opendir
30 +function opens a directory stream corresponding to the
31 +directory named by the
32 +.Fa dirname
33 +argument.
34 +.Lp
35 +The
36 +.Fn fdopendir
37 +function opens a directory stream for the directory file
38 +descriptor
39 +.Fa fildes .
40 +The directory file descriptor should not be used or
37 41 closed following a successful function call, as this might cause undefined
38 42 results from future operations on the directory stream obtained from the call.
39 -Use \fBclosedir\fR(3C) to close a directory stream.
40 -.sp
41 -.LP
42 -The directory stream is positioned at the first entry. If the type \fBDIR\fR is
43 +Use
44 +.Xr closedir 3C
45 +to close a directory stream.
46 +.Lp
47 +The directory stream is positioned at the first entry. If the type
48 +.Ft DIR
49 +is
43 50 implemented using a file descriptor, applications will only be able to open up
44 -to a total of {\fBOPEN_MAX\fR} files and directories. A successful call to any
45 -of the \fBexec\fR functions will close any directory streams that are open in
46 -the calling process. See \fBexec\fR(2).
47 -.SH RETURN VALUES
48 -.sp
49 -.LP
50 -Upon successful completion, \fBopendir()\fR and \fBfdopendir()\fR return a
51 -pointer to an object of type \fBDIR\fR. Otherwise, a null pointer is returned
52 -and \fBerrno\fR is set to indicate the error.
53 -.SH ERRORS
54 -.sp
55 -.LP
56 -The \fBopendir()\fR function will fail if:
57 -.sp
58 -.ne 2
59 -.na
60 -\fB\fBEACCES\fR\fR
61 -.ad
62 -.RS 16n
51 +to a total of
52 +.Bq OPEN_MAX
53 +files and directories. A successful call to any
54 +of the
55 +.Xr exec 2
56 +functions will close any directory streams that are open in
57 +the calling process.
58 +.Sh RETURN VALUES
59 +Upon successful completion,
60 +.Fn opendir
61 +and
62 +.Fn fdopendir
63 +return a
64 +pointer to an object of type
65 +.Ft DIR .
66 +Otherwise, a null pointer is returned
67 +and
68 +.Va errno
69 +is set to indicate the error.
70 +.Sh ERRORS
71 +The
72 +.Fn opendir
73 +function will fail if:
74 +.Bl -tag -width Er
75 +.It Er EACCES
63 76 Search permission is denied for the component of the path prefix of
64 -\fIdirname\fR or read permission is denied for \fIdirname\fR.
65 -.RE
66 -
67 -.sp
68 -.ne 2
69 -.na
70 -\fB\fBELOOP\fR\fR
71 -.ad
72 -.RS 16n
73 -Too many symbolic links were encountered in resolving \fIpath\fR.
74 -.RE
75 -
76 -.sp
77 -.ne 2
78 -.na
79 -\fB\fBENAMETOOLONG\fR\fR
80 -.ad
81 -.RS 16n
82 -The length of the \fIdirname\fR argument exceeds {\fBPATH_MAX\fR}, or a path
83 -name component is longer than {\fBNAME_MAX\fR} while {\fB_POSIX_NO_TRUNC\fR} is
77 +.Fa dirname
78 +or read permission is denied for
79 +.Fa dirname .
80 +.It Er ELOOP
81 +Too many symbolic links were encountered in resolving
82 +.Fa path .
83 +.It Er ENAMETOOLONG
84 +The length of the
85 +.Fa dirname
86 +argument exceeds
87 +.Brq PATH_MAX ,
88 +or a path name component is longer than
89 +.Brq NAME_MAX
90 +while
91 +.Brq _POSIX_NO_TRUNC
92 +is
84 93 in effect.
85 -.RE
86 -
87 -.sp
88 -.ne 2
89 -.na
90 -\fB\fBENOENT\fR\fR
91 -.ad
92 -.RS 16n
93 -A component of \fIdirname\fR does not name an existing directory or
94 -\fIdirname\fR is an empty string.
95 -.RE
96 -
97 -.sp
98 -.ne 2
99 -.na
100 -\fB\fBENOTDIR\fR\fR
101 -.ad
102 -.RS 16n
103 -A component of \fIdirname\fR is not a directory.
104 -.RE
105 -
106 -.sp
107 -.LP
108 -The \fBfdopendir()\fR function will fail if:
109 -.sp
110 -.ne 2
111 -.na
112 -\fB\fBENOTDIR\fR\fR
113 -.ad
114 -.RS 11n
115 -The file descriptor \fIfildes\fR does not reference a directory.
116 -.RE
117 -
118 -.sp
119 -.LP
120 -The \fBopendir()\fR function may fail if:
121 -.sp
122 -.ne 2
123 -.na
124 -\fB\fBEMFILE\fR\fR
125 -.ad
126 -.RS 16n
127 -There are {\fBOPEN_MAX\fR} file descriptors currently open in the calling
128 -process.
129 -.RE
130 -
131 -.sp
132 -.ne 2
133 -.na
134 -\fB\fBENAMETOOLONG\fR\fR
135 -.ad
136 -.RS 16n
94 +.It Er ENOENT
95 +A component of
96 +.Fa dirname
97 +does not name an existing directory or
98 +.Fa dirname
99 +is an empty string.
100 +.It Er ENOTDIR
101 +A component of
102 +.Fa dirname
103 +is not a directory.
104 +.El
105 +.Lp
106 +The
107 +.Fn fdopendir
108 +function will fail if:
109 +.Bl -tag -width Er
110 +.It Er ENOTDIR
111 +The file descriptor
112 +.Fa fildes
113 +does not reference a directory.
114 +.El
115 +.Lp
116 +The
117 +.Fn opendir
118 +function may fail if:
119 +.Bl -tag -width Er
120 +.It Er EMFILE
121 +There are
122 +.Brq OPEN_MAX
123 +file descriptors currently open in the calling process.
124 +.It Er ENAMETOOLONG
137 125 Pathname resolution of a symbolic link produced an intermediate result whose
138 -length exceeds \fBPATH_MAX\fR.
139 -.RE
140 -
141 -.sp
142 -.ne 2
143 -.na
144 -\fB\fBENFILE\fR\fR
145 -.ad
146 -.RS 16n
126 +length exceeds
127 +.Brq PATH_MAX .
128 +.It Er ENFILE
147 129 Too many files are currently open on the system.
148 -.RE
149 -
150 -.SH USAGE
151 -.sp
152 -.LP
153 -The \fBopendir()\fR and \fBfdopendir()\fR functions should be used in
154 -conjunction with \fBreaddir\fR(3C), \fBclosedir\fR(3C) and \fBrewinddir\fR(3C)
155 -to examine the contents of the directory (see the \fBEXAMPLES\fR section in
156 -\fBreaddir\fR(3C)). This method is recommended for portability.
157 -.SH ATTRIBUTES
158 -.sp
159 -.LP
160 -See \fBattributes\fR(5) for descriptions of the following attributes:
161 -.sp
162 -
163 -.sp
164 -.TS
165 -box;
166 -c | c
167 -l | l .
168 -ATTRIBUTE TYPE ATTRIBUTE VALUE
169 -_
170 -Interface Stability T{
171 -\fBopendir()\fR is Standard; \fBfdopendir()\fR is Evolving
172 -T}
173 -_
174 -MT-Level Safe
175 -.TE
176 -
177 -.SH SEE ALSO
178 -.sp
179 -.LP
180 -\fBlstat\fR(2), \fBsymlink\fR(2), \fBclosedir\fR(3C), \fBreaddir\fR(3C),
181 -\fBrewinddir\fR(3C), \fBscandir\fR(3C), \fBattributes\fR(5)
130 +.El
131 +.Sh USAGE
132 +The
133 +.Fn opendir
134 +and
135 +.Fn fdopendir
136 +functions should be used in conjunction with
137 +.Xr readdir 3C ,
138 +.Xr closedir 3C
139 +and
140 +.Xr rewinddir 3C
141 +to examine the contents of the directory
142 +.Po see the
143 +.Sx EXAMPLES
144 +section in
145 +.Xr readdir 3C Pc .
146 +This method is recommended for portability.
147 +.Sh INTERFACE STABILITY
148 +.Sy Standard .
149 +.Sh MT-LEVEL
150 +.Sy Safe .
151 +.Sh SEE ALSO
152 +.Xr exec 2 ,
153 +.Xr lstat 2 ,
154 +.Xr symlink 2 ,
155 +.Xr closedir 3C ,
156 +.Xr readdir 3C ,
157 +.Xr rewinddir 3C ,
158 +.Xr scandir 3C ,
159 +.Xr standards 5
160 +.Sh STANDARDS
161 +The
162 +.Fn opendir
163 +function was introduced in
164 +.Bx 4.2 .
165 +and standardized in
166 +.St -p1003.1 .
167 +The
168 +.Fn fdopendir
169 +function was introduced in
170 +.St -p1003.1-2008 .
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX