aslmanager.tproj/aslmanager.8

   1 .\"Copyright (c) 2004-2009 Apple Inc. All rights reserved.
   2 .\"
   3 .\"@APPLE_LICENSE_HEADER_START@
   4 .\"
   5 .\"This file contains Original Code and/or Modifications of Original Code
   6 .\"as defined in and that are subject to the Apple Public Source License
   7 .\"Version 2.0 (the 'License'). You may not use this file except in
   8 .\"compliance with the License. Please obtain a copy of the License at
   9 .\"http://www.opensource.apple.com/apsl/ and read it before using this
  10 .\"file.
  11 .\"
  12 .\"The Original Code and all software distributed under the License are
  13 .\"distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14 .\"EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15 .\"INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16 .\"FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  17 .\"Please see the License for the specific language governing rights and
  18 .\"limitations under the License.
  19 .\"
  20 .\"@APPLE_LICENSE_HEADER_END@
  21 .\"
  22 .Dd December 7, 2007
  23 .Dt ASLMANAGER 8
  24 .Os "Mac OS X"
  25 .Sh NAME
  26 .Nm aslmanager
  27 .Nd Apple System Log data store file manager
  28 .Sh SYNOPSIS
  29 .Nm
  30 .Op Fl s Ar store_dir
  31 .Op Fl a Op Ar archive_dir
  32 .Op Fl ttl Ar days
  33 .Op Fl size Ar max_size
  34 .Sh DESCRIPTION
  35 .Nm
  36 manages files in the ASL data store written by the
  37 .Nm syslogd
  38 server.
  39 .Pp
  40 .Nm
  41 is started automatically at various times.
  42 It runs shortly after the
  43 .Nm syslogd
  44 server starts, upon receipt of the first message after midnight (local time),
  45 and any time a file in the ASL data store directory (/var/log/asl) reaches a maximum size limit as specified to the
  46 .Nm syslogd
  47 server.
  48 .Pp
  49 Command-line options may be specified in the aslmanager launch plist file.
  50 However,
  51 .Nm
  52 reads the /etc/asl.conf file which may also contain parameter settings.
  53 Settings in the asl.conf file will override those given on the command line.
  54 .Pp
  55 .Nm
  56 scans through the files in the ASL data store directory /var/log/asl, or some other directory specified following the
  57 .Fl s
  58 flag, or by the setting of the store_path parameter in asl.conf.
  59 Data files that are older than the default 7 day time-to-live are either archived or removed.
  60 Files that contain messages with explicit expire times are removed or archived monthly after all thier contents expire.
  61 The default 7 day time-to-live value may be overridden by supplying a value following the
  62 .Fl ttl
  63 flag, or by the setting of the store_ttl parameter in asl.conf.
  64 A value of zero allows files to remain in the store with no time limit.
  65 .Pp
  66 A maximum size for the entire data store may be provided as a value following the
  67 .Fl size
  68 flag, or by the setting of the max_store_size parameter in asl.conf.
  69 This will cause
  70 .Nm
  71 to archive (if enabled) and remove files until the total size of the data store is
  72 .Ar max_size
  73 bytes or less.
  74 The default value is 150000000 bytes.
  75 A value of zero means the size is unlimited.
  76 An unlimited size specification should be used with great caution,
  77 since a runaway process could quickly fill all available disk space.
  78 Files are removed in order starting from oldest to newest.
  79 Files with the same date are removed in standard lexigraphic sort order by file name.
  80 .Pp
  81 Files are either removed entirely or copied to an archive directory.
  82 If the
  83 .Fl a
  84 flag is specified with no argument, files are copied to the /var/log/asl.archive directory.
  85 An alternate directory path may be specified following the
  86 .Fl a
  87 flag.
  88 The archive parameter setting in asl.conf enables or disables archiving.
  89 The archive parameter requires a value of "1" to enable archiving, or a value of "0" to disable it.
  90 An option archive directory path may follow the "0" or "1".
  91 .Sh SEE ALSO
  92 .Xr syslogd 8 ,
  93 .Xr syslog 1 ,
  94 .Xr asl 3 ,
  95 .Xr asl.conf 5 ,
  96 .Xr syslog 3 .
  97 .Sh HISTORY
  98 The
  99 .Nm
 100 utility appeared in Mac OS X 10.6.