debian/manpages/update-exim4.conf.template.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 UPDATE-EXIM4.CONF.TEMPLATE 8 "Feb 27, 2005" EXIM4
   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 update\-exim4.conf.template \- Regenerate exim4 configuration file template.
  22 .SH SYNOPSIS
  23 .B update\-exim4.conf.template [\-h|\-\-help] [\-n|\-\-nobackup] [\-o|\-\-output file] [\-r|\-\-run]
  24
  25 .SH OPTIONS
  26 .TP
  27 .I \-h|\-\-help
  28 Show short help message and exit
  29 .TP
  30 .I \-n|\-\-nobackup
  31 Overwrite existing file, instead of keeping it as
  32 /etc/exim4/exim4.conf.template.bak.random-number
  33 .TP
  34 .I \-o|\-\-output file
  35 Write output to file instead of /etc/exim4/exim4.conf.template.
  36 .TP
  37 .I \-r|\-\-run
  38 Actually do something. If this option is not specified
  39 .B update\-exim4.conf.template
  40 will exit immediately. This option was introduced because
  41 .B update\-exim4.conf.template
  42 overwrites configuration files.
  43
  44 .SH DESCRIPTION
  45 The script
  46 .B update\-exim4.conf.template
  47 regenerates the main configuration file template
  48 .I /etc/exim4/exim4.conf.template
  49 from the configuration snippets in the
  50 .I /etc/exim4/conf.d
  51 directory tree.
  52 .PP
  53 This process will overwrite all local changes in
  54 .I /etc/exim4/exim4.conf.template
  55 and might be useful if there are local changes in the
  56 .I /etc/exim4/conf.d
  57 directory tree, for example by a new mail related package dropping its
  58 own configuration snippets in there.
  59
  60 .B update\-exim4.conf.template
  61 ignores all files in the conf.d directory that have a filename which
  62 does not consist only of letters, numbers, underscores and hyphens
  63 ([:alnum:]_\-), similar to
  64 .B run\-parts(8).
  65 For easy interaction with packages extending Exim additionally
  66 /etc/exim4/conf.d/foo/bar.rul is used instead of
  67 /etc/exim4/conf.d/foo/bar if it exists!
  68
  69 .SH ENVIRONMENT
  70 If
  71 .B CONFDIR
  72 is set
  73 .B update\-exim4.conf.template
  74 will search for the input files below $CONFDIR/conf.d instead of
  75 /etc/exim4/conf.d/ and will write the output to $CONFDIR/exim4.conf.template
  76 instead of to /etc/exim4/exim4.conf.template (unless overridden with \-o or
  77 \-\-output).
  78
  79
  80 .SH BUGS
  81 This manual page needs a major re-work. If somebody knows better groff
  82 than us and has more experience in writing manual pages, any patches
  83 would be greatly appreciated.
  84
  85 .SH SEE ALSO
  86 .BR exim4 (8),
  87 /usr/share/doc/exim4\-base/ and for general notes and details about interaction
  88 with debconf
  89 /usr/share/doc/exim4\-base/README.Debian.gz
  90
  91 .SH AUTHOR
  92 Marc Haber <mh+debian\-packages@zugschlus.de>