# Modtool configuration file
# (C) Christian Alice Scarborough 1996
# Redistributable under the terms of the Gnu Public License (GPL)
# See the file COPYING for details

#
# Configuration parameters - change these to suit your local setup
# =======================
#
# In the text below, variables are sometimes referred to as $variable.
# This is to distinguish them from the surrounding text.  You should
# not include the $ sign when defining variables.
#

#
# Location of data files
# ----------------------
#

# Name of file containing submissions (UNIX spool format)
#
datafile="/aber/ccs95/Mail/cot"

# Directory for saving posts to
#
# If not defined, modtool assumes the current directory
#
savedir=/aber/ccs95/Mail/saved

# Name of file for saved submissions 
#
# If $savedir is defined, this file will be considered to be in that
# directory, unless it begins with a /, in which case you should 
# specify the complete path to the file.
#
savefile="cot.saved"

# Working directory - the rejections file + sig file live here
# You must have write access to this directory or the program will fail.
#
wd="/aber/ccs95/modtool/"

# Signature filename - in the working directory
#
sigfile=mod.sig

# Rejections filename - in the working directory
#
rejfile=rejections

#
# External programs
# -----------------
#

# Name of pager program on your system
#
pager="/usr/bin/more"

# Your favourite text editor
#
editor="/aber/ccs95/bin/pico"

# Date command - must be in the proper Usenet News format.
# Something like "Tue, 01 Feb 1995 15:55:33 GMT"
# Try a 'man date' on your system if the default doesn't work for you
#
# This one works on Digital UNIX
datecmd=date +"%a, %d %b %Y %H:%M:%S %Z"
#
# This one works on SunOS (and possibly Solaris) - note the use of -u
# to give GMT, since the Sun date command doesn't appear to support
# displaying the timezone.
# datecmd=date -u +"%a, %d %h %y %H:%M:%S GMT"

# PGP Moose support
#
# This is the path to the PGP Moose article approval program.  If this
# is defined, modtool will pass the article to PGP Moose before posting.
# PGP Moose is a program which authenticates news articles to prevent
# forgeries entering the group.  It is available from
# http://www/landfield.com/moderators
#
# THE CODE TO DO THIS IS UNTESTED, BUT SHOULD WORK AS IT IS FAIRLY
# TRIVIAL - USE WITH CAUTION THOUGH
#
#pgpmoose=pmapp

# 
# News transport
# --------------
#

# Outbound mail address for approved posts
#
# If $outaddr is defined, modtool will not use either NNTP or inews to
# post news, but will instead mail the article to the address given.  It
# then becomes the responsibility of a filter installed at the mail
# address specified to post the news.  This feature could also be
# used to run a moderated mailing list. 
#
#outaddr=<email address>

# Mailing list
# If this variable is defined, modtool assumes that it is being used to 
# moderate a mailing list rather than a newsgroup.  The list address to
# send out approved posts to should also be placed in $outaddr.  If
# $maillist is defined, then the Approved: and Newsgroup: headers will
# not be included in the outgoing messages.  Defining $maillist 
# automatically defines $nomodcheck (see below).
#
#maillist=1

# Check for moderated groups
#
# If $nomodcheck is set, then modtool will not attempt to check the names
# of moderated groups using NNTP when it first starts up.  This means that
# modtool will start quicker, but it will also be unable to tell if there
# are other moderated groups in the Newsgroups: line.  For most purposes,
# this variable should not be set.
#
#nomodcheck=1

# News poster
#
# If this variable is defined, modtool pipes the article to the posting
# program.  If not defined, modtool uses direct NNTP transfer with
# an IHAVE or POST command.  NNTP is the preferred posting method. (ie
# don't define $poster unless the other way doesn't work.)
#
#poster="/aber/innews/inews -h"

# News host
#
# This variable must be defined, even if you are using $poster, unless
# you also define $nomodcheck. It is used to retrieve a list of moderated
# newsgroups via NNTP each time modtool starts.  It should be the fastest 
# server you have read (or read/write) access to.  In most cases, this
# will be your local news server
# 
news_host="news.aber.ac.uk"

# Posting host 
#
# For most setups, this will not need to be defined, but
# for those with picky news servers (like me) a different news server must
# be used for posting.  If it is not defined, modtool uses the host in
# $news_host for posting to
#
#post_host = "news.uu.net"

# When using NNTP posting, two methods are possible, POST or IHAVE.  You
# should use the one that your server supports.  POST is enabled by 
# default unless $ihave is defined.  If you are using news.uu.net, then
# you must use IHAVE.
#
#ihave=1

# Name of moderated newsgroup (will appear in newsgroups line if poster 
# has not supplied one)
#
modgroup=<your group here>
#modgroup="misc.test"
#modgroup="aber.test"

# Approved line for netnews postings
#
approved=comp.org.team-os2@teamos2.org

# From: kludge.  If you have a picky news server that insists that 
# articles are posted under the name of a local user, uncomment this line
# and put a valid local email address in it.  Note: this is a rubbish
# way to moderate a newsgroup, since all articles appear to come from you.
# The real sender is listed in an X-Really-From: line.
#
# Note that it shouldn't ever be necessary to do this now, since the
# article can be posted from news.uu.net, it's left in for historical
# reasons.
#
#from_kludge="ccs95@aber.ac.uk (Christian Alice Scarborough)"

# $extraheaders adds extra headers to the bottom of each posting.  This
# is provided in case you have standard headers you wish to appear on all
# messages posted.  You must include a \n at the end of each line to 
# indicate that the end of the line has been reached
#
# One possible use is as a disclaimer
#
#extraheaders = "X-Disclaimer: Views are those of the poster, not the \
#moderator\n"

#
# Mail transport
# --------------
#

# Mail delivery program (must accept mail with all headers from stdin)
# If this line is commented out, modtool will send mail using SMTP 
# instead.  SMTP is the preferred method of mail transfer.
#
#mailer="/usr/lib/sendmail"

# SMTP server - used only if $mailer is not set
#
mail_host="mailhost.aber.ac.uk"

# Host name - used for creating Message-IDs and also when using SMTP
# mailing.  If you do not define this, then modtool will attempt to work out
# your hostname on its own.  You may need to define this if you get
# error messages about "hostname: command not found".  If you get this
# wrong, SMTP mail transfers probably won't work.
#
#hostname=osfa.aber.ac.uk

# From: field to appear in outgoing mail (email addresses need to be in 
# single quotes)
from=<mail address>

# Reply-To: field to appear in outgoing mail
# (Comment out if you don't want a Reply-To: field
replyto=<mail address>

# domain to mail postings to other moderated groups to
# (it's probably safest to leave this one alone)
modgroupdomain="uunet.uu.net"

#Subject line for rejection notes
rejsub="Your submission has been rejected"

#
# Miscellaneous
# -------------
#

# Uncomment this if you have a BSD style stty program
#BSD_STYLE=1

#
# Digests / Archiving
# -------------------
#

# Digest name
#
# if $digest is defined, modtool will archive all accepted posts in the
# form of a RFC 1153 compliant digest message.  This variable should 
# contain the name of the digest as it is to appear in the Subject:
# line of the digest message.
#
#digest=Welsh dancing

# Digest From: field
#
# The address to put in the From: field of the digest, if none is
# supplied, modtool assumes that the address is the same as in $from
#
#digfrom=<your address>

# Digest To: field
# 
# If this is set, then when a digest is completed and a new digest 
# started the old digest will be mailed to the address given, using 
# the mail transport specified earlier in this file.
#
#digto=<address to mail it to>

# Digest Reply-To:
#
# Sets the Reply-To: field on the digest.  You must include this if you
# want a Reply-To: field, even if $replyto is already defined above
# 
#digreplyto=<address>

# Digest config file
#
# Name of a file in the working directory where modtool stores internal
# information about the digest.  If undefined, modtool uses .modtooldigest
#
#digcfg=.mtdig

# Digest prefix
#
# This is used at the beginning of the digest filenames themselves.
# If not defined, it defaults to the value of $digest
#
#digprefix=digest

# Digest directory
#
# Name of the directory where digest files are stored.  If not specified,
# the modtoool working directory is used
#
#digdir=/aber/ccs95/modtool/digest

# Digest header file
#
# If specified, modtool will read the contents of this file from the 
# working directory and place them in the header file of each digest.
# This file is the place to put mailing list unsubscription information,
# and other info you may wish to distribute with each digest.
#
#dighdrfile=dighdr

# Digest interval
#
# This is the default interval at which digests are completed and a new
# digest created.  It is done by means of the date command, and is 
# perhaps explained best by example.  One of the example below should
# suit you, but if you have particularly esoteric requirements, you can
# always write a shell script that gives unique codes to each interval
# you are interested in.
#
# Daily - most people will want this one (it's also the default if 
# $digthreshhold is undefined (see below)
#diginterval=date +"%d%m%y"
#
# Weekly
#diginterval=date +"%W%y"
#
# Monthly
#diginterval=date +"%m%y"
#
# Yearly (no-one could ever want this, surely)
#diginterval=date +"%y"

# Digest size threshold
#
# If this is set, modtool will create a new digest automatically whenever 
# the old digest reaches a size in bytes larger than this number, 
# whether the current time period (as specified by $diginterval above) has
# expired or not.  This stops digests getting too large if there is 
# heavy traffic in an interval.  If $digthreshold is set, and $diginterval
# isn't, then a new digest will be started only when the old one has
# reached this size.  15000 bytes is the recommended size for a digest.
#
#digthreshold=15000

# Digest only
#
# If this keyword is defined, then accepting an article will not cause it 
# to be sent or posted to news, but it will just be added to the Digest.
# In this way, you can make modtool produce digests of accepted posts
# without any other output occurring
#
#digonly=1

# No automatic digest creation
#
# If this is defined, modtool will not create digest automatically as 
# articles are approved.  You should define this if you intend to use 
# modtool with the -d option.  When modtool is invoked with the -d 
# option, it searches the newsgroup $modgroup for new articles using
# NNTP, so the digest is created from articles that actually appear
# in the newsgroup.  This is a Good Thing if there are multiple 
# group moderators, since it means that posts approved by the other
# moderators will be included in the digest when they arrive at your
# site.
#
#dignoauto=1

#
# auto-replying to mail 
# ---------------------
#

# From: header
#
# Modtool has the ability to automatically generate a reply when a piece
# of mail is piped to it (usually by a mail filter program) and it is 
# invoked with the -r parameter.  This variable contains the address to 
# appear in the From: field of such posts.  If undefined, modtool uses the
# address in $from
#
#arepfrom=<your address>

# Reply-To: header
#
# Again, modtool will use $replyto if this is not defined.  If neither are
# defined, no Reply-To: header is generated for these messages
#
#arepreplyto=<address>

# Subject: header
#
# The default is "Your mail has been received."  You can use %subject% 
# for which modtool will substitute the contents of the Subject: header
# in the received mail.
#
#arepsub=Re: %subject%
#
#arepsub=[AUTO-REPLY] Your post has been received

# Reply text file
#
# Name of the file (in the working directory) containing the text of the
# reply. You can use %subject% within this file too.  The default is 
# "autoreply".  If you include valid mail headers at the top of this file,
# they will be incorporated into the header when the mail is sent out.
#
#arepfile=.reply

# Config file
#
# modtool stores the addresses of recently replied to mail and will not
# reply to them twice in the same day.  This is to avoid creating mail 
# loops.  You can specify the name of the file where these are stored 
# here.  This means that you can have different files if you are running
# more than one group.  Usually the default (.mtrecent) is best.  The
# file lives, you guessed it, in the working directory
#
#arepcfg=recent-replies

# Include signature
#
# If this variable is defined, modtool includes the signature file, as
# specified by $sigfile above
#
#arepincsig=1

# Include original mail
# 
# Modtool appends the original message to the end of the reply.
#
#arepincmail=1
