mysticbbs/mystic/mutil.ini

371 lines
11 KiB
INI

; MUTIL configuration file
; -------------------------------------------------------------------------
;
; MUTIL is an automated maintainance and utility program driven by
; configuration files used to perform various tasks upon execution.
;
; The syntax to execute MUTIL is: MUTIL <configuration file>. If no
; configuration file is supplied, then the program will look for mutil.ini
; in the same directory. A second parameter -NOSCREEN can be used to turn
; off screen updates but the configuration file parameter MUST be supplied
; ex: mutil mutil.ini -NOSCREEN
;
; Many different configuration files can exist to perform any series of
; tasks supported by MUTIL, or a single configuration can be maintained that
; does everything. The minimum requirement is the General header with a
; task enabled, and then the specific header for that task.
;
; Current abilities (enabled/disabled in the General header below):
;
; - Import Message Bases (by datafile analysis)
; - Import FIDONET.NA into Message bases
; - Import FILEBONE.NA into File bases
; - Mass upload files to all file bases (with FILE_ID.DIZ import)
; - Generate Top 1 up to 99 Callers, Posters, Downloaders, Uploaders, PCR
; Completely configurable output by using template files
; - Import FILES.BBS into file bases
; - Generate all files listing
; - Purge Message bases (by age and max messages)
; - Pack and renumber message bases
; - Post text files to message bases
;
; ==========================================================================
; ==========================================================================
; ==========================================================================
[General]
; Uncomment this and set it to the full path and filename to
; MYSTIC.DAT if you want to run mutil from a directory other than
; the root Mystic directory. Otherwise, leave this commented and
; MUTIL will look in the current directory.
; mystic_directory=c:\mystic\mystic.dat
; Logging option. If no directory is specified in the logfile
; name, mUtil will attempt to use the configured LOGS directory from
; in Mystic's configuration. To disable logging, leave the logfile
; option commented out or set to a blank value.
logfile=mutil.log
; Level 1 = basic
; Level 2 = verbose
loglevel=2
; list of functions to perform on startup
Import_FIDONET.NA = false
Import_MessageBase = false
Import_FILEBONE.NA = false
Import_FILES.BBS = false
MassUpload = false
GenerateTopLists = false
GenerateAllFiles = false
PurgeMessageBases = false
PostTextFiles = false
PackMessageBases = false
ExportEchoMail = true
; ==========================================================================
; ==========================================================================
; ==========================================================================
[Import_FIDONET.NA]
; filename to import
filename = fidonet.na
; convert tags to lower case for message base filename 1=yes
lowercase_filename = 1
; The following options define the "default" values used when creating
; any new message bases. netaddress must match an exiting network
; address configured within Mystic BBS. default values are also
; taken from the system configuration for origin line, colors, etc.
netaddress = 1:1/1
acs_list =
acs_read =
acs_post =
acs_news =
acs_sysop = s255
header = msghead
read_template = ansimrd
index_template = ansimlst
max_msgs = 500
max_msgs_age = 365
; true/false type values 0=false 1=true (newscan 2=forced)
use_autosig = 1
use_realname = 0
kill_kludge = 1
private_base = 0
new_scan = 1
qwk_scan = 1
; value is either 0 for JAM or 1 for Squish
base_format = 0
; ==========================================================================
; ==========================================================================
; ==========================================================================
[Import_FILEBONE.NA]
; filename of filebone.na
filename = filebone.na
; root directory to create file paths under. when a new filebone echo
; is found, mUtil will create a file using "root_dir" + areatag. So
; for example if root is "c:\mystic\filebase\" and the areatag is
; MYSTICBBS it will create "c:\mystic\filebase\MYSTICBBS". This root
; directory MUST exist.
root_dir = c:\mystic\files\
; convert tags to lower case for filebase base filename/dir 1=yes
lowercase_filename = 1
; Default values when creating a new file base
dispfile =
template = ansiflst
acs_list =
acs_ftp =
acs_download =
acs_upload =
acs_comment =
acs_sysop = s255
; true/false type values 0=false 1=true (newscan 2=forced)
free_files = 0
show_uploader = 1
new_scan = 1
; ==========================================================================
; ==========================================================================
; ==========================================================================
[Import_FILES.BBS]
; This function searches the filebase directories for existance of a
; FILES.BBS file. If the file is found, MUTIL will process all files
; within it and upload any new files into the BBS using the description
; from the FILES.BBS. The files must physically exist in the same
; directory as the FILES.BBS in order for them to be uploaded to the BBS
uploader_name = Mystic BBS
; for custom files.bbs importing. desc_char is the character that denotes
; extended description (blank = space). desc_charpos is the position in
; which the character exists. desc_start is the position where the
; description actually starts.
desc_char =
desc_charpos = 1
desc_start = 14
; erase files.bbs after processing? 0=no, 1=yes
delete_after = 0
; ==========================================================================
; ==========================================================================
; ==========================================================================
[MassUpload]
; this function searches all configured file directories for new
; files and will upload them into the BBS. It will attempt to
; import FILE_ID.DIZ using the configured archivers if the option
; is enabled.
; Name to save has the uploader
uploader_name = Mystic BBS
; Import FILE_ID.DIZ? 1=yes
import_fileid = 1
; No description string used when no FILE_ID.DIZ is imported.
no_description = No Description
; ==========================================================================
; ==========================================================================
; ==========================================================================
[GenerateTopLists]
; Top list generator can generate up to top 99 for various different
; statistics. Each individual top file can be enabled or disabled and
; can each have their own template files that are totally configurable.
;
; 1=enable for top_call, top_post, etc.
;
; The number of items in each list is determined by the template. It
; could be any number between 1 and 99.
;
; In the templates use @NA01-99 for name and @DA01-99 for numerical data
; @DE returns the value set as _desc in the configuration. You can look
; at the provided template as an example.
;
; namelen and datalen define the width the MCI code is padded to
;
; exclude list is one name per line text file listing names which should
; not be included in the generated output. lines that begin with a ;
; are considered comments.
exclude_list = mutil.toplist.exclude.txt
; User name for "no one" when for example you have 3 users and make a
; top 10 list
no_user = No one
; Sort order. You can use this to calculate top or bottom 99. 1=top
sort_top=1
; configuration for top callers generator
; @NA=name @DA=calls
top_call = 1
top_call_template = mutil.toplist.template.txt
top_call_output = topcallers.asc
top_call_desc = Callers
top_call_namelen = 30
top_call_datalen = 10
; configuration for top downloads
; @NA=name @DA=downloads
top_dl = 1
top_dl_template = mutil.toplist.template.txt
top_dl_output = topdownload.asc
top_dl_desc = Downloaders
top_dl_namelen = 30
top_dl_datalen = 10
top_ul = 1
top_ul_template = mutil.toplist.template.txt
top_ul_output = topupload.asc
top_ul_desc = Uploaders
top_ul_namelen = 30
top_ul_datalen = 10
top_post = 1
top_post_template = mutil.toplist.template.txt
top_post_output = topposts.asc
top_post_desc = Posters
top_post_namelen = 30
top_post_datalen = 10
top_pcr = 1
top_pcr_template = mutil.toplist.template.txt
top_pcr_output = toppcr.asc
top_pcr_desc = Posts Per Call
top_pcr_namelen = 30
top_pcr_datalen = 10
[GenerateAllFiles]
; Generate all files list
; Path / filename of output filename. If the path is not included then the
; file will be created in whatever the current working directory is.
filename = allfiles.txt
; ideas/features for the future?
; header, footer, baseheader, basefooter, exclude bases, uploader optional
; uploader line, format list line 1st,2nd line, space between files?
[PurgeMessageBases]
; No options for this function
[PackMessageBases]
; No options for this function
[PostTextFiles]
; Total number of text files to be posted. For each file there needs to
; be a file definition as show below.
totalfiles = 2
; This defines one file which will be posted to the message base. Each
; file should be prefixed with file# where # is a number from 1 to
; totalfiles.
;
; The delfile option (if true) will remove the filename after the message
; is posted. The baseidx is the permanent index of the message base to
; post the message into (shown as Index at the top of the message base
; editor in Mystic's configuration. Address is the echomail destination
; address
file1_name = myfile.txt
file1_baseidx = 2
file1_from = Sysop
file1_to = All
file1_subj = My subject
file1_addr = 0:0/0
file1_delfile = false
file2_name = myfile.txt
file2_baseidx = 2
file2_from = Sysop
file2_to = All
file2_subj = My subject
file2_addr = 0:0/0
file2_delfile = false
[Import_MessageBase]
; This option scans the message base directory, and creates any messages
; bases inside of Mystic that have data files in the directory.
; The following options define the "default" values used when creating
; new message bases. netaddress must match an exiting network
; address configured within Mystic BBS. default values are also
; taken from the system configuration for origin line, colors, etc.
netaddress = 1:1/1
acs_list =
acs_read =
acs_post =
acs_news =
acs_sysop = s255
header = msghead
read_template = ansimrd
index_template = ansimlst
max_msgs = 500
max_msgs_age = 365
; network type (0=local, 1=echomail, 2=newsgroup 3=netmail)
net_type = 1
; true/false type values 0=false 1=true (newscan 2=forced)
use_autosig = 1
use_realname = 0
kill_kludge = 1
private_base = 0
new_scan = 1
qwk_scan = 1
[ExportEchoMail]