fs_usage.tproj/fs_usage.1

   1
   2 .\" Copyright (c) 2000, Apple Computer, Inc.  All rights reserved.
   3 .\"
   4 .Dd March 28, 2000
   5 .Dt FS_USAGE 1
   6 .Os "Mac OS X"
   7 .Sh NAME
   8 .Nm fs_usage
   9 .Nd reports system calls and page faults related to filesystem activity
  10 in real-time.
  11 .Sh SYNOPSIS
  12 .Nm fs_usage [-e] [-w] [ pid|cmd [pid|cmd] ...]
  13 .Sh DESCRIPTION
  14 .Nm fs_usage
  15 presents an ongoing display of system call usage
  16 information pertaining to filesystem activity.  By default
  17 this includes all system processes.  The information, however,
  18 may  be limited to include or exclude a specified list
  19 of processes.
  20 .Pp
  21 The output presented by
  22 .Nm fs_usage
  23 is formatted according to the size of your window.
  24 A narrow window will display fewer columns of data.
  25 Use a wide window for maximum data display.  You may
  26 override the window formatting restrictions by
  27 forcing a wide display with the
  28 .Fl w
  29 option.  In this case, the data displayed will wrap
  30 when the window is not wide enough.
  31 .Pp
  32 The options are as follows:
  33 .Bl -tag -width Ds
  34 .It Fl e
  35 Specifying the
  36 .Fl e
  37 option generates output that excludes sampling
  38 of the running fs_usage tool. If a list of
  39 process ids or commands is also given, then
  40 those processes are also excluded from the sampled
  41 output.
  42 .It Fl w
  43 Specifying the
  44 .Fl w
  45 option forces a wider, more detailed output,
  46 regardless of the window size.
  47 .It  pid | cmd
  48 The sampled data can be limited to a list of process
  49 ids or commands.  When a command name is given, all
  50 processes with that name will be sampled.  Using the
  51 .Fl e
  52 option has the opposite effect, excluding sampled data
  53 relating to the given list of process ids or commands.
  54 .El
  55 .Pp
  56 If "/tmp/FileTracing" is present when a Carbon Application
  57 is launched, then the high level Carbon FileManager
  58 calls will be displayed bracketing the system calls that they
  59 are built on.
  60 .Pp
  61 The data columns displayed are as follows:
  62 .Bl -tag -width TIME_INTERVALWWWW -compact
  63 .Pp
  64 .It TIMESTAMP
  65 TOD when call occurred. Wide mode will
  66 have millesecond granularity.
  67 .It CALL
  68 the name of the filesystem call or page-in.
  69 .It FILE DESCRIPTOR
  70 Of the form F=x, x is a file descriptor. Depending
  71 on the type of system call, this will be either
  72 an input value or a return value.
  73 .It BYTE COUNT
  74 Of the form B=x, x is the number of bytes requested by the call.
  75 .It [ERRNO]
  76 On error, the errno is displayed in brackets.
  77 .It PATHNAME
  78 Pathname of the file accessed (up to the last 28 bytes).
  79 .It FAULT ADDRESS
  80 Of the form A=0xnnnnnnnn, where 0xnnnnnnnn is the
  81 address being faulted.
  82 .It TIME INTERVAL(W)
  83 The elapsed time spent in the system call.
  84 A 'W' after the elapsed time indicates
  85 the process was scheduled out during
  86 this file activity.  In this case, the elapsed
  87 time includes the wait time.
  88 .It PROCESS NAME
  89 The process that made the system call.
  90 .El
  91 .Pp
  92 .Sh SAMPLE USAGE
  93 .Pp
  94 fs_usage -w telnetd
  95 .Pp
  96 .Nm fs_usage
  97 will report file system usage data for all
  98 instances of processes named telnetd.  Maximum
  99 data output will be displayed in the window.
 100 .Sh SEE ALSO
 101 .Xr top 1
 102 .Xr sc_usage 1
 103 .Xr latency 1