share/man/man5/dir.5

   1 .\"     $NetBSD: dir.5,v 1.20 2007/06/22 15:03:40 rumble Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)dir.5       8.3 (Berkeley) 4/19/94
  31 .\"
  32 .Dd October 31, 2008
  33 .Dt DIRENT 5
  34 .Os
  35 .Sh NAME
  36 .Nm dirent
  37 .Nd directory format
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In sys/dirent.h
  41 .Sh DESCRIPTION
  42 Directories provide a convenient hierarchical method of grouping
  43 files while obscuring the underlying details of the storage medium.
  44 A directory file is differentiated from a plain file
  45 by a flag in its
  46 .Xr inode 5
  47 entry.
  48 It consists of records (directory entries) each of which contains
  49 information about a file and a pointer to the file itself.
  50 Directory entries may contain other directories
  51 as well as plain files; such nested directories are referred to as
  52 subdirectories.
  53 A hierarchy of directories and files is formed in this manner
  54 and is called a file system (or referred to as a file system tree).
  55 .\" An entry in this tree,
  56 .\" nested or not nested,
  57 .\" is a pathname.
  58 .Pp
  59 Each directory file contains two special directory entries; one is a pointer
  60 to the directory itself
  61 called dot
  62 .Ql \&.
  63 and the other a pointer to its parent directory called dot-dot
  64 .Ql \&.. .
  65 Dot and dot-dot
  66 are valid pathnames, however,
  67 the system root directory
  68 .Ql / ,
  69 has no parent and dot-dot points to itself like dot.
  70 .Pp
  71 File system nodes are ordinary directory files on which has
  72 been grafted a file system object, such as a physical disk or a
  73 partitioned area of such a disk.
  74 (See
  75 .Xr mount 8 . )
  76 .Pp
  77 The directory entry format is defined in the file
  78 .Aq Pa sys/dirent.h :
  79 .Bd -literal
  80 /*
  81  * A directory entry has a struct dirent at the front of it, containing
  82  * its inode number, the length of the entry, and the length of the name
  83  * contained in the entry.  These are followed by the name padded to an
  84  * 8 byte boundary with null bytes.  All names are guaranteed null
  85  * terminated.  The maximum length of a name in a directory is MAXNAMLEN.
  86  */
  87
  88 struct dirent {
  89         ino_t    d_fileno;      /* file number of entry */
  90         uint16_t d_reclen;      /* length of this record */
  91         uint16_t d_namlen;      /* length of string in d_name */
  92         uint8_t  d_type;        /* file type, see below */
  93 #define MAXNAMLEN       511
  94         char d_name[MAXNAMLEN + 1]; /* name must be no longer than this */
  95 };
  96
  97 /*
  98  * File types
  99  */
 100 #define DT_UNKNOWN      0
 101 #define DT_FIFO         1
 102 #define DT_CHR          2
 103 #define DT_DIR          4
 104 #define DT_BLK          6
 105 #define DT_REG          8
 106 #define DT_LNK          10
 107 #define DT_SOCK         12
 108 #define DT_WHT          14
 109 .Ed
 110 .Sh SEE ALSO
 111 .Xr getdents 2 ,
 112 .Xr fs 5 ,
 113 .Xr inode 5
 114 .Sh HISTORY
 115 A
 116 dir structure appeared in
 117 .At v7 .
 118 The
 119 .Nm
 120 structure appeared in
 121 .Nx 1.3 .