home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / gnu / man / cat2 / stat.0 < prev    next >
Text File  |  1993-12-07  |  7KB  |  199 lines
  1.  
  2. STAT(2)                    UNIX Programmer's Manual                    STAT(2)
  3.  
  4. NNAAMMEE
  5.      ssttaatt, llssttaatt, ffssttaatt - get file status
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<ssyyss//ttyyppeess..hh>>
  9.      ##iinncclluuddee <<ssyyss//ssttaatt..hh>>
  10.  
  11.      _i_n_t
  12.      ssttaatt(_c_o_n_s_t _c_h_a_r _*_p_a_t_h, _s_t_r_u_c_t _s_t_a_t _*_b_u_f)
  13.  
  14.      _i_n_t
  15.      llssttaatt(_c_o_n_s_t _c_h_a_r _*_p_a_t_h, _s_t_r_u_c_t _s_t_a_t _*_b_u_f)
  16.  
  17.      _i_n_t
  18.      ffssttaatt(_i_n_t _f_d, _s_t_r_u_c_t _s_t_a_t _*_b_u_f)
  19.  
  20. DDEESSCCRRIIPPTTIIOONN
  21.      The ssttaatt() function obtains information about the file pointed to by
  22.      _p_a_t_h. Read, write or execute permission of the named file is not re­
  23.      quired, but all directories listed in the path name leading to the file
  24.      must be seachable.
  25.  
  26.      LLssttaatt() is like ssttaatt() except in the case where the named file is a sym­
  27.      bolic link, in which case llssttaatt() returns information about the link,
  28.      while ssttaatt() returns information about the file the link references.
  29.  
  30.      The ffssttaatt() obtains the same information about an open file known by the
  31.      file descriptor _f_d, such as would be obtained by an open call.
  32.  
  33.      _B_u_f is a pointer to a ssttaatt() structure as defined by <_s_y_s_/_s_t_a_t_._h> (shown
  34.      below) and into which information is placed concerning the file.
  35.  
  36.      struct stat {
  37.          dev_t    st_dev;    /* device inode resides on */
  38.          ino_t    st_ino;    /* inode's number */
  39.          mode_t   st_mode;   /* inode protection mode */
  40.          nlink_t  st_nlink;  /* number or hard links to the file */
  41.          uid_t    st_uid;    /* user­id of owner */
  42.          gid_t    st_gid;    /* group­id of owner */
  43.          dev_t    st_rdev;   /* device type, for special file inode */
  44.          off_t    st_size;   /* file size, in bytes */
  45.          time_t   st_atime;  /* time of last access */
  46.          long     st_spare1;
  47.          time_t   st_mtime;  /* time of last data modification */
  48.          long     st_spare2;
  49.          time_t   st_ctime;  /* time of last file status change */
  50.          long     st_spare3;
  51.          long     st_blksize;/* optimal file sys I/O ops blocksize */
  52.          long     st_blocks; /* blocks allocated for file */
  53.          u_long   st_flags;  /* user defined flags for file */
  54.          u_long   st_gen;    /* file generation number */
  55.      };
  56.  
  57.      The time­related fields of _s_t_r_u_c_t _s_t_a_t are as follows:
  58.  
  59.      st_atime   Time when file data last accessed.  Changed by the following
  60.                 system calls: mknod(2),  utimes(2),  and read(2).
  61.  
  62.      st_mtime   Time when file data last modified.  Changed by the following
  63.                 system calls: mknod(2),  utimes(2),  write(2).
  64.  
  65.      st_ctime   Time when file status was last changed (inode data modifica­
  66.                 tion).  Changed by the following system calls: chmod(2)
  67.                 chown(2),  link(2),  mknod(2),  rename(2),  unlink(2),
  68.                 utimes(2),  write(2).
  69.  
  70.      st_blocks  The actual number of blocks allocated for the file in 512­byte
  71.                 units.
  72.  
  73.      The status information word _s_t___m_o_d_e has bits:
  74.  
  75.      #define S_IFMT 0170000           /* type of file */
  76.      #define        S_IFIFO  0010000  /* named pipe (fifo) */
  77.      #define        S_IFCHR  0020000  /* character special */
  78.      #define        S_IFDIR  0040000  /* directory */
  79.      #define        S_IFBLK  0060000  /* block special */
  80.      #define        S_IFREG  0100000  /* regular */
  81.      #define        S_IFLNK  0120000  /* symbolic link */
  82.      #define        S_IFSOCK 0140000  /* socket */
  83.      #define S_ISUID 0004000  /* set user id on execution */
  84.      #define S_ISGID 0002000  /* set group id on execution */
  85.      #define S_ISVTX 0001000  /* save swapped text even after use */
  86.      #define S_IRUSR 0000400  /* read permission, owner */
  87.      #define S_IWUSR 0000200  /* write permission, owner */
  88.      #define S_IXUSR 0000100  /* execute/search permission, owner */
  89.  
  90.      For a list of access modes, see <_s_y_s_/_s_t_a_t_._h>, access(2) and chmod(2).
  91.  
  92. RREETTUURRNN VVAALLUUEESS
  93.      Upon successful completion a value of 0 is returned.  Otherwise, a value
  94.      of ­1 is returned and _e_r_r_n_o is set to indicate the error.
  95.  
  96. EERRRROORRSS
  97.      SSttaatt() and llssttaatt() will fail if:
  98.  
  99.      [ENOTDIR]       A component of the path prefix is not a directory.
  100.  
  101.      [EINVAL]        The pathname contains a character with the high­order bit
  102.                      set.
  103.  
  104.      [ENAMETOOLONG]  A component of a pathname exceeded 255 characters, or an
  105.                      entire path name exceeded 1023 characters.
  106.  
  107.      [ENOENT]        The named file does not exist.
  108.  
  109.      [EACCES]        Search permission is denied for a component of the path
  110.                      prefix.
  111.  
  112.      [ELOOP]         Too many symbolic links were encountered in translating
  113.                      the pathname.
  114.  
  115.      [EFAULT]        _B_u_f or _n_a_m_e points to an invalid address.
  116.  
  117.      [EIO]           An I/O error occurred while reading from or writing to
  118.                      the file system.
  119.  
  120.      FFssttaatt() will fail if:
  121.  
  122.      [EBADF]   _f_d is not a valid open file descriptor.
  123.  
  124.      [EFAULT]  _B_u_f points to an invalid address.
  125.  
  126.      [EIO]     An I/O error occurred while reading from or writing to the file
  127.                system.
  128.  
  129. CCAAVVEEAATT
  130.      The fields in the stat structure currently marked _s_t___s_p_a_r_e_1, _s_t___s_p_a_r_e_2,
  131.      and _s_t___s_p_a_r_e_3 are present in preparation for inode time stamps expanding
  132.      to 64 bits.  This, however, can break certain programs that depend on the
  133.      time stamps being contiguous (in calls to utimes(2)).
  134.  
  135. SSEEEE AALLSSOO
  136.      chmod(2),  chown(2),  utimes(2)
  137.  
  138. BBUUGGSS
  139.      Applying fstat to a socket (and thus to a pipe) returns a zero'd buffer,
  140.      except for the blocksize field, and a unique device and inode number.
  141.  
  142. SSTTAANNDDAARRDDSS
  143.      The ssttaatt() and ffssttaatt() function calls are expected to conform to IEEE Std
  144.      1003.1­1988 (``POSIX'').
  145.  
  146. HHIISSTTOORRYY
  147.      A llssttaatt function call appeared in 4.2BSD.
  148.  
  149. 4th Berkeley Distribution       March 10, 1991                               3
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.