sadc.tproj/sadc.8

   1 .\"Portions Copyright (c) 1999-2003 Apple Computer, Inc. All Rights
   2 .\"Reserved.
   3 .\"
   4 .\"This file contains Original Code and/or Modifications of Original Code
   5 .\"as defined in and that are subject to the Apple Public Source License
   6 .\"Version 2.0 (the 'License'). You may not use this file except in
   7 .\"compliance with the License. Please obtain a copy of the License at
   8 .\"http://www.opensource.apple.com/apsl/ and read it before using this
   9 .\"file.
  10 .\"
  11 .\"The Original Code and all software distributed under the License are
  12 .\"distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  13 .\"EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  14 .\"INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  15 .\"FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  16 .\"Please see the License for the specific language governing rights and
  17 .\"limitations under the License.
  18 .\"
  19 .\"     @(#)sadc.8
  20 .Dd Jul 25 2003               \" DATE
  21 .Dt sadc 8      \" Program name and manual section number
  22 .Os "Mac OS X"
  23 .Sh NAME                 \" Section Header - required - don't modify
  24 .Nm sadc
  25 .Nd system activity data collector
  26 .Sh SYNOPSIS             \" Section Header - required - don't modify
  27 .Nm /usr/lib/sa/sadc
  28 .Op Fl m Ar mode        \" [-m mode]
  29 .Op Ar t n              \" [t n]
  30 .Op Ar ofile           \" [ofile]
  31 .Sh DESCRIPTION          \" Section Header - required - don't modify
  32 The
  33 .Nm sadc
  34 tool is used to collect cumulative system activity data.
  35 The sample system data is collected at intervals
  36 .Ar t
  37 seconds apart, in a loop
  38 .Ar n
  39 times.
  40 The binary sample data is written to
  41 .Ar ofile
  42 if specified.
  43 Otherwise, the binary data is written to stdout.
  44 If the
  45 .Ar ofile
  46 file does not exist, it is created, otherwise it is truncated.
  47 .Pp                      \" Inserts a space
  48 .Nm sadc
  49 is intended to be used as the engine behind the
  50 .Nm sar(1)
  51 command, and is not typically invoked on the command line.
  52 Two shell scripts,
  53 .Nm sa1
  54 and
  55 .Nm sa2 ,
  56 are provided to drive the typical sampling, saving, and
  57 reporting process.
  58 .Pp
  59 .Sh OPTIONS
  60 The following options modify the way data is collected by
  61 .Nm sadc .
  62 .Bl -tag -width -indent  \" Begins a tagged list
  63 .It Fl m Ar mode
  64 Modify the collection of system statistics as specified by
  65 .Ar mode .
  66 Currently only one mode is supported.
  67 .Bl -tag -width -indent  \" Begins a tagged list
  68 .It PPP
  69 By default, the collection of ppp network interface statistics
  70 is turned off.
  71 This is because the number of ppp connections can be very high,
  72 causing the raw data file to grow unexpectedly large,
  73 especially  when samples are collected at short intervals.
  74 Use the
  75 .Ar PPP
  76 mode to turn the collection back on.
  77 .El
  78 .El
  79 .Pp
  80 .Sh EXAMPLES
  81 /usr/lib/sa/sadc 15 20 /tmp/sample.out
  82 .Pp
  83 This call collects 20 samples at 15 second intervals.
  84 The binary data is written to the /tmp/sample.out file
  85 .Sh FILES                \" File used or created by the topic of the man page
  86 .Bl -tag -width "/var/log/sa/sadd" -compact
  87 .It Pa /var/log/sa/sadd
  88 Default daily activity file that holds the binary sampling data.
  89 .Ar dd
  90 are digits that represent the day of the month.
  91 .It Pa /usr/lib/sa/sa1
  92 Shell script used to drive the
  93 .Nm sar
  94 data collection.
  95 .It Pa /usr/lib/sa/sa2
  96 Shell script used to drive the
  97 .Nm sar
  98 data reporting.
  99 .El
 100 .Sh SEE ALSO
 101 .\" List links in ascending order by section, alphabetically within a section.
 102 .Xr fs_usage 1 ,
 103 .Xr netstat 1 ,
 104 .Xr sar 1 ,
 105 .Xr sc_usage 1 ,
 106 .Xr top 1 ,
 107 .Xr vm_stat 1 ,
 108 .Xr iostat 8 ,
 109 .Xr sa1 8 ,
 110 .Xr sa2 8