home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Unix / file / ofiles.README < prev    next >
Encoding:
Text File  |  1994-01-07  |  6.4 KB  |  181 lines
  1. NAME
  2.      ofiles - identify open files
  3.  
  4. SYNOPSIS
  5.      ofiles [ -h ] [ -n ] [ -N ] [ -p ] [ -P _n ] [ -u ] [ -U _n ]
  6.      _n_a_m_e_s
  7.  
  8. DESCRIPTION
  9.      _O_f_i_l_e_s displays the command, process ID (PID), user ID
  10.      (UID), file descriptor (FD), type, device, inode and some
  11.      information about the name of files opened by NeXTStep 1.0a
  12.      and 2.0 processes.
  13.  
  14.      An open file may be a regular file, a directory, a character
  15.      special file, or a network file (Internet socket, NFS file
  16.      or Unix domain socket.) A specific file may be selected by
  17.      its path _n_a_m_e.
  18.  
  19. OPTIONS
  20.      In the absence of any options, _o_f_i_l_e_s displays all open
  21.      files belonging to all active processes.
  22.  
  23.      If any display request option is specified, all other
  24.      displays must be specifically requested - e. g., if -n is
  25.      specified for the display of Internet network files, NFS
  26.      files won't be displayed unless -N is also specified.
  27.  
  28.      -h       This option selects a brief usage (help) output
  29.               display.
  30.  
  31.      -n       This option selects the display of Internet network
  32.               files.
  33.  
  34.      -N       This option selects the display of NFS files.
  35.  
  36.      -p       This option specifies that _o_f_i_l_e_s should print pro-
  37.               cess identifiers only - e. g., so that the output
  38.               may be piped to _k_i_l_l(1).
  39.  
  40.      -P _n     This option selects the display of files for the
  41.               process whose ID is `n'.
  42.  
  43.      -u       This option selects the display of Unix domain
  44.               socket files.
  45.  
  46.      -U _n     This option selects the display of files for the
  47.               user whose user ID (UID) is `n'.
  48.  
  49.      _n_a_m_e_s    These are the path names of specific files to
  50.               display.
  51.  
  52.  
  53. OUTPUT
  54.      _O_f_i_l_e_s displays for each open file:
  55.  
  56.      COMMAND                 contains the first seven characters
  57.                              of the name of the Unix command
  58.                              associated with the process.
  59.  
  60.      PID                     is the process identification (PID)
  61.                              number of the process.
  62.  
  63.      UID                     is the user identification (UID)
  64.                              number of the user to whom the pro-
  65.                              cess belongs.
  66.  
  67.      FD                      is the file descriptor (FD) number
  68.                              of the file or ``cd' if it is the
  69.                              current working directory of the
  70.                              process.  FD is followed by an
  71.                              asterisk if the vnode of the file
  72.                              has non-zero shared or exclusive
  73.                              lock counts.
  74.  
  75.      TYPE                    is the type of the vnode associated
  76.                              with the file (see <sys/vnode.h>).
  77.  
  78.                              ``unix'' is the type for a Unix
  79.                              domain socket that is not associated
  80.                              with a vnode.
  81.  
  82.      DEVICE                  contains the major and minor device
  83.                              numbers for a character special,
  84.                              block special, regular or directory
  85.                              file;
  86.  
  87.                              or the protocol type of an Internet
  88.                              network file;
  89.  
  90.                              or the client major and minor device
  91.                              number of a remote, NSF file (under
  92.                              NeXTStep 1.0a);
  93.  
  94.                              or the network major and minor dev-
  95.                              ice number of a remote, NSF file
  96.                              (under NeXTStep 2.0);
  97.  
  98.                              or the hexadecimal socket address of
  99.                              a Unix domain file.
  100.  
  101.      INODE                   is the inode number of a local file
  102.                              or the inode number of an NFS file
  103.                              in the server host.
  104.  
  105.      NAME/[LOCAL][REMOTE]    is the name of the mount point and
  106.                              file system on which the file
  107.                              resides;
  108.  
  109.                              or the name of a file specified in
  110.                              the _n_a_m_e_s option;
  111.  
  112.                              or the name of a character special
  113.                              or block special device;
  114.  
  115.                              or the local and remote Internet
  116.                              addresses of a network file;
  117.  
  118.                              or the address of a Unix domain
  119.                              socket;
  120.  
  121.                              or the local and remote mount point
  122.                              names of an NFS file.  (A NeXTStep
  123.                              1.0a local mount point name will be
  124.                              reduced to the last component of the
  125.                              path.)
  126.  
  127. DIAGNOSTICS
  128.      Errors are identified with messages on the standard error
  129.      file.
  130.  
  131.      _O_f_i_l_e_s returns a one (1) if any error was detected, includ-
  132.      ing the failure to locate any _n_a_m_e_s.  It returns a zero (0)
  133.      if no errors were detected and if it was able to display
  134.      information about all the specified _n_a_m_e_s.
  135.  
  136. EXAMPLES
  137.      To display all open files, use:
  138.  
  139.           ofiles
  140.  
  141.      To display all open Internet and Unix domain files, use:
  142.  
  143.           ofiles -n -u
  144.  
  145.      To display all open files on device /dev/sd0a, use:
  146.  
  147.           ofiles /dev/sd0a
  148.  
  149.      To find the process that has /Homes/abe/foo open, use:
  150.  
  151.           ofiles /Homes/abe/foo
  152.  
  153.      To send a SIGHUP to the process that has /Homes/abe/bar
  154.      open, use:
  155.  
  156.           kill -HUP `ofiles -p /Homes/abe/bar`
  157.  
  158. BUGS
  159.      Since _o_f_i_l_e_s reads kernel memory in its search for open
  160.      files, rapid changes in kernel memory may produce unpredict-
  161.      able results.
  162.  
  163.      For reasons unknown, _o_f_i_l_e_s startup, while it is acquiring
  164.      the major and minor device numbers of the files in /dev, is
  165.      slow.
  166.  
  167.      _O_f_i_l_e_s has only been tested under NeXTStep versions 1.0a and
  168.      2.0.
  169.  
  170. AUTHORS
  171.      The NeXTStep version of _o_f_i_l_e_s was written by Victor A.
  172.      Abell of the Purdue University Computing Center.  He ack-
  173.      nowledges his debt to the work of Dan Bernstein, Michael
  174.      ``Ford'' Ditto, Tom Dunigan, Alexander Dupuy, Vik Lall, Ray
  175.      Moody, C. Spencer and Michael Spitzer, who contributed to
  176.      versions of _o_f_i_l_e_s and its offspring.
  177.  
  178. SEE ALSO
  179.      fs(5).
  180.  
  181.