diff options
Diffstat (limited to 'share/man/man5/dir.5')
| -rw-r--r-- | share/man/man5/dir.5 | 86 |
1 files changed, 47 insertions, 39 deletions
diff --git a/share/man/man5/dir.5 b/share/man/man5/dir.5 index f97c35f38e0..0445cb012c3 100644 --- a/share/man/man5/dir.5 +++ b/share/man/man5/dir.5 @@ -1,5 +1,4 @@ -.\" $OpenBSD: dir.5,v 1.9 2003/06/02 23:30:14 millert Exp $ -.\" $NetBSD: dir.5,v 1.5 1995/03/28 17:30:20 jtc Exp $ +.\" $OpenBSD: dir.5,v 1.10 2003/07/04 23:06:01 millert Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -28,9 +27,9 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" @(#)dir.5 8.3 (Berkeley) 4/19/94 +.\" @(#)dir.5 8.4 (Berkeley) 5/3/95 .\" -.Dd April 19, 1994 +.Dd May 3, 1995 .Dt DIR 5 .Os .Sh NAME @@ -39,7 +38,7 @@ .Nd directory file format .Sh SYNOPSIS .Fd #include <sys/types.h> -.Fd #include <sys/dir.h> +.Fd #include <dirent.h> .Sh DESCRIPTION Directories provide a convenient hierarchical method of grouping files while obscuring the underlying details of the storage medium. @@ -73,30 +72,42 @@ partitioned area of such a disk (see The directory entry format is defined in the file .Aq Pa dirent.h : .Bd -literal -#ifndef _DIRENT_H_ -#define _DIRENT_H_ - /* -* A directory entry has a struct dirent at the front of it, containing its -* inode number, the length of the entry, and the length of the name -* contained in the entry. These are followed by the name padded to a 4 -* byte boundary with null bytes. All names are guaranteed null terminated. -* The maximum length of a name in a directory is MAXNAMLEN. -*/ + * A directory entry has a struct dirent at the front of it, containing + * its inode number, the length of the entry, and the length of the name + * contained in the entry. These are followed by the name padded to a 4 + * byte boundary with null bytes. All names are guaranteed NUL terminated. + * The maximum length of a name in a directory is MAXNAMLEN. + */ struct dirent { - u_long d_fileno; /* file number of entry */ - u_short d_reclen; /* length of this record */ - u_short d_namlen; /* length of string in d_name */ -#ifdef _POSIX_SOURCE - char d_name[MAXNAMLEN + 1]; /* maximum name length */ -#else + u_int32_t d_fileno; /* file number of entry */ + u_int16_t d_reclen; /* length of this record */ + u_int8_t d_type; /* file type, see below */ + u_int8_t d_namlen; /* length of string in d_name */ #define MAXNAMLEN 255 char d_name[MAXNAMLEN + 1]; /* maximum name length */ -#endif - }; +/* + * File types + */ +#define DT_UNKNOWN 0 +#define DT_FIFO 1 +#define DT_CHR 2 +#define DT_DIR 4 +#define DT_BLK 6 +#define DT_REG 8 +#define DT_LNK 10 +#define DT_SOCK 12 +#define DT_WHT 14 + +/* + * Convert between stat structure types and directory types. + */ +#define IFTODT(mode) (((mode) & 0170000) >> 12) +#define DTTOIF(dirtype) ((dirtype) << 12) + #ifdef _POSIX_SOURCE typedef void * DIR; #else @@ -108,31 +119,28 @@ typedef void * DIR; /* structure describing an open directory. */ typedef struct _dirdesc { - int dd_fd; /* file descriptor associated with directory */ - long dd_loc; /* offset in current buffer */ - long dd_size; /* amount of data returned by getdirentries */ - char *dd_buf; /* data buffer */ - int dd_len; /* size of data buffer */ - long dd_seek; /* magic cookie returned by getdirentries */ + int dd_fd; /* file descriptor associated with directory */ + long dd_loc; /* offset in current buffer */ + long dd_size; /* amount of data returned by getdirentries */ + char *dd_buf; /* data buffer */ + int dd_len; /* size of data buffer */ + long dd_seek; /* magic cookie returned by getdirentries */ + long dd_rewind; /* magic cookie for rewinding */ + int dd_flags; /* flags for readdir */ } DIR; #define dirfd(dirp) ((dirp)->dd_fd) -#ifndef NULL -#define NULL 0 -#endif +/* flags for opendir2 */ +#define DTF_HIDEW 0x0001 /* hide whiteout entries */ +#define DTF_NODUP 0x0002 /* don't return duplicate names */ +#define DTF_REWIND 0x0004 /* rewind after reading union stack */ +#define __DTF_READALL 0x0008 /* everything has been read */ #endif /* _POSIX_SOURCE */ - -#ifndef _KERNEL - -#include <sys/cdefs.h> - -#endif /* !_KERNEL */ - -#endif /* !_DIRENT_H_ */ .Ed .Sh SEE ALSO +.Xr getdirentries 2 , .Xr fs 5 , .Xr inode 5 .Sh HISTORY |