sadc.tproj/sa2.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 .\"     @(#)sa2.8
  20 .Dd Jul 25 2003               \" DATE
  21 .Dt sa2 8      \" Program name and manual section number
  22 .Os "Mac OS X"
  23 .Sh NAME                 \" Section Header - required - don't modify
  24 .Nm sa2
  25 .Nd Generate a system activity daily report file.
  26 .Sh SYNOPSIS             \" Section Header - required - don't modify
  27 .Nm /usr/lib/sa/sa2
  28 .Op Fl dgpu              \" [-dgpu]
  29 .Op Fl n Ar mode         \" [-n mode ]
  30 .Op Fl e Ar time         \" [-e time]
  31 .Op Fl f Ar filename     \" [-f filename]
  32 .Op Fl i Ar seconds      \" [-i seconds]
  33 .Op Fl s Ar time         \" [-s time]
  34 .Sh DESCRIPTION          \" Section Header - required - don't modify
  35 The
  36 .Nm sa2
  37 command is a shell script used to invoke the system
  38 activity reporter
  39 .Nm sar
  40 for purposes of generating the standard default
  41 daily report file.
  42 The report file generated is,
  43 .Ar /var/log/sa/sardd
  44 where the
  45 .Ar dd
  46 represents the current day of the month.
  47 The
  48 .Nm sa2
  49 options are the same as those documented in
  50 .Nm sar(1) .
  51 .Pp                      \" Inserts a space
  52 When
  53 .Nm sa2
  54 runs, it will also remove data and report files,
  55 found in /var/log/sa, that are more than one week old.
  56 .Pp
  57 The
  58 .Nm sa2
  59 command is intended to be started by cron.
  60 .Pp
  61 .Sh EXAMPLE CRON ENTRY
  62 .Pp
  63 .Bd -literal
  64 # Starting at 8am collect system activity records
  65 # every 20 minutes for 12 hours
  66 # 20 minutes = 1200 seconds
  67 # 12 hours with 3 samples each hour = 36 loops
  68
  69 0 8 * * 1-5 /usr/lib/sa/sa1 1200 36
  70
  71 # After the 12 hour period,
  72 # collect a system activity report
  73
  74 30 20 * * 1-5 /usr/lib/sa/sa2 -A
  75
  76 .Ed
  77 .Pp
  78 .Sh FILES                \" File used or created by the topic of the man page
  79 .Bl -tag -width "/var/log/sa/sardd" -compact
  80 .It Pa /var/log/sa/sardd
  81 Default daily report file.
  82 .It Pa /var/log/sa/sadd
  83 Default daily data file.
  84 .Pp
  85 .Ar dd
  86 are digits that represent the day of the month.
  87 .El
  88 .Sh SEE ALSO
  89 .\" List links in ascending order by section, alphabetically within a section.
  90 .Xr crontab 1 ,
  91 .Xr fs_usage 1 ,
  92 .Xr netstat 1 ,
  93 .Xr sar 1 ,
  94 .Xr sc_usage 1 ,
  95 .Xr top 1 ,
  96 .Xr vm_stat 1 ,
  97 .Xr crontab 5 ,
  98 .Xr iostat 8 ,
  99 .Xr sa1 8 ,
 100 .Xr sadc 8