sadc.tproj/sa2.8

   1 .\" Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
   2 .\"
   3 .\" The contents of this file constitute Original Code as defined in and
   4 .\" are subject to the Apple Public Source License Version 1.1 (the
   5 .\" "License").  You may not use this file except in compliance with the
   6 .\" License.  Please obtain a copy of the License at
   7 .\" http://www.apple.com/publicsource and read it before using this file.
   8 .\"
   9 .\" This Original Code and all software distributed under the License are
  10 .\" distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  11 .\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  12 .\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  13 .\" FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  14 .\" License for the specific language governing rights and limitations
  15 .\" under the License.
  16 .\"
  17 .\"     @(#)sadc.8
  18 .Dd Jul 25 2003               \" DATE
  19 .Dt sa2 8      \" Program name and manual section number
  20 .Os "Mac OS X"
  21 .Sh NAME                 \" Section Header - required - don't modify
  22 .Nm sa2
  23 .Nd Generate a system activity daily report file.
  24 .Sh SYNOPSIS             \" Section Header - required - don't modify
  25 .Nm /usr/lib/sa/sa2
  26 .Op Fl dgpu              \" [-dgpu]
  27 .Op Fl n Ar mode         \" [-n mode ]
  28 .Op Fl e Ar time         \" [-e time]
  29 .Op Fl f Ar filename     \" [-f filename]
  30 .Op Fl i Ar seconds      \" [-i seconds]
  31 .Op Fl s Ar time         \" [-s time]
  32 .Sh DESCRIPTION          \" Section Header - required - don't modify
  33 The
  34 .Nm
  35 command is a shell script used to invoke the system
  36 activity reporter
  37 .Nm sar
  38 for purposes of generating the standard default
  39 daily report file.
  40 The report file generated is,
  41 .Ar /var/log/sa/sardd
  42 where the
  43 .Ar dd
  44 represents the current day of the month.
  45 The
  46 .Nm
  47 options are the same as those documented in
  48 .Nm sar(1) .
  49 .Pp                      \" Inserts a space
  50 When
  51 .Nm
  52 runs, it will also remove data and report files,
  53 found in /var/log/sa, that are more than one week old.
  54 .Pp
  55 The
  56 .Nm
  57 command is intended to be started by cron.
  58 .Pp
  59 .Sh EXAMPLE CRON ENTRY
  60 .Pp
  61 .Bd -literal
  62 # Starting at 8am collect system activity records
  63 # every 20 minutes for 12 hours
  64 # 20 minutes = 1200 seconds
  65 # 12 hours with 3 samples each hour = 36 loops
  66
  67 0 8 * * 1-5 /usr/lib/sa/sa1 1200 36
  68
  69 # After the 12 hour period,
  70 # collect a system activity report
  71
  72 30 20 * * 1-5 /usr/lib/sa/sa2 -A
  73
  74 .Ed
  75 .Pp
  76 .Sh FILES                \" File used or created by the topic of the man page
  77 .Bl -tag -width "/var/log/sa/sardd" -compact
  78 .It Pa /var/log/sa/sardd
  79 Default daily report file.
  80 .It Pa /var/log/sa/sadd
  81 Default daily data file.
  82 .Pp
  83 .Ar dd
  84 are digits that represent the day of the month.
  85 .El
  86 .Sh SEE ALSO
  87 .\" List links in ascending order by section, alphabetically within a section.
  88 .Xr sa1 8 ,
  89 .Xr sadc 8 ,
  90 .Xr sar 1 ,
  91 .Xr iostat 8 ,
  92 .Xr vm_stat 1 ,
  93 .Xr netstat 1 ,
  94 .Xr top 1 ,
  95 .Xr sc_usage 1 ,
  96 .Xr fs_usage 1 ,
  97 .Xr crontab 1 ,
  98 .Xr crontab 5