debian/manpages/exicyclog.8

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH EXICYCLOG 8 "March 26, 2003"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .\" \(oqthis text is enclosed in single quotes\(cq
  19 .\" \(lqthis text is enclosed in double quotes\(rq
  20 .SH NAME
  21 exicyclog \- Cycle exim's logfiles
  22 .SH SYNOPSIS
  23 .B eximcyclog
  24 .SH DESCRIPTION
  25 The
  26 .B exicyclog
  27 script can be used to cycle (rotate)
  28 .I mainlog
  29 and
  30 .I rejectlog
  31 files.
  32 This is not necessary if only syslog is being used.
  33 Some operating systems have their own standard mechanisms for log cycling,
  34 and these can be used instead of
  35 .B exicyclog
  36 if preferred.
  37
  38 Each time
  39 .B exicyclog
  40 is run the file names get \(oqshuffled down\(cq by one.
  41 If the main log file name is mainlog (the default) then when
  42 .B exicyclog
  43 is run mainlog becomes mainlog.01, the previous mainlog.01 becomes mainlog.02
  44 and so on, up to a limit which is set in the script, and which defaults to 10.
  45 Reject logs are handled similarly.
  46
  47 If no mainlog file exists, the script does nothing.
  48 Files that \(oqdrop off\(cq the end are deleted.
  49 All files with numbers greater than 01 are compressed, using a compression
  50 command which is configured by the COMPRESS_COMMAND setting in
  51 Local/Makefile.
  52 It is usual to run \(lqexicyclog\(rq daily from a root \(lqcrontab\(rq entry
  53 of the form
  54
  55   1 0 * * * su exim \-c /usr/exim/bin/exicyclog
  56
  57 assuming you have used the name \(oqexim\(cq for the Exim user.
  58 You can run
  59 .B exicyclog
  60 as root if you wish, but there is no need.
  61
  62
  63 .SH BUGS
  64 This manual page needs a major re-work. If somebody knows better groff
  65 than us and has more experience in writing manual pages, any patches
  66 would be greatly appreciated.
  67
  68 .SH SEE ALSO
  69 .BR exim (8),
  70 /usr/share/doc/exim4\-base/
  71
  72 .SH AUTHOR
  73 This manual page was stitched together from spec.txt by
  74 Andreas Metzler <ametzler at downhill.at.eu.org>,
  75 for the Debian GNU/Linux system (but may be used by others).