Aminet 18

home *** CD-ROM | disk | FTP | other *** search

/ Aminet 18 / aminetcdnumber181997.iso / Aminet / comm / news / DWdecode.lha / dwdecode / DWdecode.Defaults.Doc < prev next >

Wrap

Text File | 1997-01-02 | 43KB | 542 lines

################################################################################ # # # DWDecode # # # # Defaults Documentation File # # # # Copyright ©1996 by Dick Whiting # # # #------------------------------------------------------------------------------# # This file documents all of the options and their internal defaults. Any of # # these may be overridden either on the command line or in the runtime prefs # # file. This file is NOT useable as a preferences file. It is only used to # # document what the options are and what they are used for. # # # # Command line options override the prefs file and the prefs file options will # # override the internal defaults. # # # # All commands can be specified using the ALIAS or the fullname. # # # # # # Commands have a 'TYPE' indicated. # # 'B' is Boolean (YES/NO, TRUE/FALSE, ON/OFF, 1/0) # # 'N' is Numeric (any positive integer) # # 'F' is a file. The program checks for its existence # # 'S' is a character string. Any alphanumeric string is accepted # # # # # # All options with a type of 'B' may be turned ON by specifying just the # # command or its alias. # # # #------------------------------------------------------------------------------# # # # FORMAT of this file: (options are grouped according to function) # # # #Command-Option Alias Type Default-Value # # # #------------------------------------------------------------------------------# # # # A complete alphabetical listing can be gotten by envoking DWDecode as: # # # # DWDecode -h OR DWDecode ? OR DWDecode HELP # # # #------------------------------------------------------------------------------# # TABLE OF CONTENTS OF THIS FILE # # # # DECODERS AND THEIR FAILURE CODES # # Base64Cmd # # B64cmdFail # # UUcmd # # UUcmdFail # # # # FILES USED FOR DETERMINING DECODING INFORMATION # # Base64TypesFile # # BinTypesFile # # EncTypesFile # # SectionTypesFile # # # # VARIABLES USED FOR DETERMINING DECODING INFORMATION # # MaxHeader # # MinEncoded # # # # FILES USED FOR SETTING RUNTIME OPTIONS # # PrefsFile # # # # DIRECTORIES AND INPUT AND OUTPUT # # Source # # Recursive # # Dest # # FileNote # # Replace # # # # FILTERING OF INPUT FILES # # KeepDays # # MarkOld # # SkipFrom # # SkipFromFile # # SkipSubject # # SkipSubjectFile # # # # REPORT CONTROL OPTIONS # # ShowDecode # # ShowDirs # # ShowFiles # # ShowParts # # ShowStats # # DumpOpts # # # # DELETE OPTIONS # # DeleteAfter # # DeleteDups # # DeleteFrom # # DeleteOld # # DeleteSubject # # DeleteText # # XDELETE # # # # DEBUGGING OPTIONS # # Debug # # Dump64Files # # DumpBase64Types # # DumpBinTypes # # DumpDates # # DumpEncTypes # # DumpFiles # # DumpFroms # # DumpMisc # # DumpOpts # # DumpPhase2 # # DumpSectionTypes # # DumpSkipFroms # # DumpSkipSubjects # # DumpSubjects # # # # TrapAllBegs # # TrapAllEncs # # TrapAllSecs # # # # LOGGING OPTIONS # # Log # # LogFile # # # # MISCELLANEOUS RUNTIME OPTIONS # # DWassignIN # # DWtemp # # Quiet # # RunBack # # ScanOnly # # ScanProg # # # # MAKING DWDECODE SMARTER # # TrapNewEncs # # TrapNewEncsFile # # TrapNewSecs # # TrapNewSecsFile # # # #------------------------------------------------------------------------------# # # # Dick Whiting <dwhiting@europa.com> # # 01 December 1996 # # # ################################################################################ ################################################################################ # DECODERS AND THEIR FAILURE CODES # #------------------------------------------------------------------------------# # # #Base64Cmd BC F Base64Decode %SF %DF USEMINLEN > nil: # #B64cmdFail BF N 20 # # # #UUcmd UC F UUout %SF BUFSIZE=150 IGNORETERMINATION USEBASENAME > nil: # #UUcmdFail UF N 10 # # # #------------------------------------------------------------------------------# # These options control which decoders are used and what is considered a # # FATAL error such as 'Disk Full'. If you use different decoders you will # # have to construct your own command line string for them. They accept the # # following substitution variables: # # # # %SF is replaced with the complete name (including path) of the input file # # %DF is replaced with the complete name (including path) of the output file # # %SD is replaced with the name of the input directory # # %DD is replaced with the name of the output directory # # # # Likewise, you will HAVE to determine the appropriate xxxcmdFail value. # # The easiest way is just to direct decoding to a floppy disk and see what # # value is returned when the disk fills up and you select CANCEL on the # # requestor. # # # # I do a change directory to the output prior to envoking the decoders, so # # if yours does not require an output filename AND used the current directory # # you will not need to specify it. # # # # # # If you do NOT place them in the same directory as DWDecode, they you must # # specify the path information also. Such as: # # # # Base64Cmd='AmiTCP:bin/Base64Decode %SF %DF USEMINLEN > nil:' # # # ################################################################################ ################################################################################ # FILES USED FOR DETERMINING DECODING INFORMATION # #------------------------------------------------------------------------------# # # #Base64TypesFile B64F F DWdecode.Base64.Types # #BinTypesFile BTF F DWdecode.Binary.Types # #EncTypesFile ETF F DWdecode.Encode.Types # #SectionTypesFile STF F DWdecode.Section.Types # # # #------------------------------------------------------------------------------# # These FILES contain information for determining how a file is encoded, # # where parts begin and end, and what words in a subject line MIGHT be a # # valid part name. See the individual file for further documentation. These # # files are required and are part of the DWDecode distribution. # # # ################################################################################ ################################################################################ # VARIABLES USED FOR DETERMINING DECODING INFORMATION # #------------------------------------------------------------------------------# # # #MaxHeader MH N 25 # #MinEncoded ME N 4 # # # #------------------------------------------------------------------------------# # After the output of the SCAN program has been checked, what are usually # # text files are searched looking for lines that might be UUencoded or B64 # # encoded. Usually, any found will be part xx/yy of files. # # The MAXHEADER values says to only read nn lines looking for encoded lines. # # The MINENCODED value says that there MUST be at least nn lines that seem # # to be the SAME kind of encoding and that no other lines may appear within # # this group of nn lines. The default values seem to work well. If you see # # encoded files being indicated as text files, you can modify these values. # # # ################################################################################ ################################################################################ # FILES USED FOR SETTING RUNTIME OPTIONS # #------------------------------------------------------------------------------# # # #PrefsFile P F DWdecode.Prefs # # # #------------------------------------------------------------------------------# # This file is used to set your personal preferences. You can have as many # # different preference files as you wish. Just specify: # # # # DWDecode P='pref-file-this-time' # # # # to use a file with a different name. This is the VERY FIRST option that is # # checked from the command line and is used (if present) to load the current # # runs options. # # # ################################################################################ ################################################################################ # DIRECTORIES AND INPUT AND OUTPUT # #------------------------------------------------------------------------------# # # #Source S F (NO default value) # #Recursive REC B YES # # # #Dest D F (NO default value) # #FileNote FN S %LLQ2 : %SUBJECT # #Replace REP B NO # # # #------------------------------------------------------------------------------# # SOURCE= and DEST= are used as the input for the USENET news files and as # # the output directory for decoded files. The RECURSIVE option controls # # whether SOURCE= is treated as a single directory or if it is considered # # as the highest level of a directory tree. RECURSIVE=YES will result in # # decoding ALL of the files in SOURCE= plus ALL of the files in ALL of the # # subdirectories of SOURCE= # # # # FILENOTE= controls the format of the filenote attached to decoded output # # files. Any character string is valid. However, substitution variables MUST # # be separated from other characters by at least 1 blank. # # # # The string may contain the following substitution variables: # # # # For the following examples assume input file is from directory: # # INTERNET:UUNEWS/alt/binaries/pictures/animals/cute/fuzzy # # # # %LLQn is replaced by the last n levels of the INPUT directory name. # # if n is NOT specified the default is n=1 # # # # i.e. specifying FN='%LLQ2 : keep' would result in filenotes of # # 'cute fuzzy : keep' # # # # %HLQn is replaced by the first n levels of the INPUT directory name. # # if n is NOT specified the default is the top level only (n=1) # # # # i.e. specifying FN='%HLQ2 : keep' would result in filenotes of # # 'INTERNET UUNEWS : keep' # # # # %QUALxy is replaced with a portion of the INPUT directory name starting # # with the xth level for y levels. If xy are not specified then # # the COMPLETE directory name is used. If y is missing, then all # # levels starting with the xth are used. # # # # i.e. specifying FN='%QUAL53 : keep' would result in # # 'pictures animals cute : keep' # # # # %DATE is replaced with the date from the Date: HEADER in the input file. # # # # %FROM is replaced with the value from the From: HEADER in the input file. # # # # %SUBJECT is replaced with the Subject: HEADER in the input file. # # # # %SOURCE is replaced with the FULL source directory name. If RECURSIVE=YES # # this will be the actual subdirectory name. # # # # REPLACE=YES says to replace existing files in the output directory with # # new ones from the input directory. This may result in the same file being # # created multiple times each time overlaying the previously created one. # # With all of the cross posting that occurs, this can be a considerable # # nuisance. However, there ARE times that you may wish to turn this on. # # # ################################################################################ ################################################################################ # FILTERING OF INPUT FILES # #------------------------------------------------------------------------------# # # #KeepDays KD N 30 # #MarkOld MO B YES # # # #SkipFrom SF B YES # #SkipFromFile SFF F DWdecode.Skip.Froms # # # #SkipSubject SS B YES # #SkipSubjectFile SSF F DWdecode.Skip.Subjects # # # #------------------------------------------------------------------------------# # # # SKIPFROM=YES uses the values in the SKIPFROMFILE to bypass processing of # # certain input files. Files matching a SKIPFROMFILE value will have an 'F' # # in their filenote comment string. Use Dopus or another directory to check # # these. # # # # If DELETEFROM=YES then these files will be deleted PRIOR to any decoding. # # # # The SKIPSUBJECT=YES and SKIPSUBJECTFILE= options also work together in the # # same way. The input files that match will have an 'S' in their comment. # # # # These will disappear without ever being seen if DELETESUBJECT=YES. # # # # KEEPDAYS=nn specifies how many days (based on the Date: header) to keep an # # input file. If MARKOLD=YES then these files will go through the normal # # decoding logic and then have 'O' (old) placed in their filenote comments. # # # # If DELETEOLD=YES, then they will be deleted instead of being marked. # # # ################################################################################ ################################################################################ # REPORT CONTROL OPTIONS # #------------------------------------------------------------------------------# # # #ShowDecode SHDE B YES # #ShowDirs SHDI B YES # #ShowFiles SHF B YES # #ShowParts SHP B YES # #ShowStats SHS B YES # # # #DumpOpts DO B NO # # # #------------------------------------------------------------------------------# # # # These options control which reports appear on the console or log (see LOG=) # # # # SHOWDIRS switches on/off the complete list of ALL directories processed # # SHOWFILES switches on/off the reporting by file # # SHOWPARTS switches on/off the reporting by partname # # SHOWDECODE switches on/off the reporting of the decoding process # # SHOWSTATS switches on/off the reporting of various stats for each directory # # # # DUMPOPTS switches on/off the reporting of the runtime options # # # ################################################################################ ################################################################################ # DELETE OPTIONS # #------------------------------------------------------------------------------# # SUGGESTION: Don't turn these options on until you are REALLY secure with my # # program. Test SKIP options thoroughly BEFORE making them into DELETEs. # #------------------------------------------------------------------------------# # # #DeleteAfter DELA B NO # #DeleteDups DELD B NO # #DeleteFrom DELF B NO # #DeleteOld DELO B NO # #DeleteSubject DELS B NO # #DeleteText DELT B NO # #XDELETE XD B NO # # # #------------------------------------------------------------------------------# # # # These options control which (if any) input files are deleted after decoding # # and/or filtering. # # # # DELETEAFTER=YES deletes all files used in a 'successful' decode. # # DELETEDUPS=YES works in combination with REPLACE= # # If REPLACE=NO then DELETEDUPS will delete files that specify # # an output file that ALREADY exists. # # If REPLACE=YES then DELETEDUPS will delete files that name # # SAME output file as one decoded in the current run. # # # # DELETETEXT=YES deletes any files that DWDecode 'thinks' are just text. # # # # DELETEFROM=YES deletes any files identified during the SKIPFROM logic. # # # # DELETESUBJECT=YES deletes files identified by SKIPSUBJECT logic. # # # # DELETEOLD=YES deletes any files identified as older than keepdays, but this # # is done AFTER attempting to decode them. # # # # XDELETE=YES turns ON ALL DELETE options. Very dangerous, but it's there. # # # ################################################################################ ################################################################################ # DEBUGGING OPTIONS # #------------------------------------------------------------------------------# # These are probably useless to most of you, but since I left them in, I # # thought I should document them--a very little;) # #------------------------------------------------------------------------------# # # #Debug DB B NO # #Dump64Files D64F B NO # #DumpBase64Types D64T B NO # #DumpBinTypes DBT B NO # #DumpDates DD B NO # #DumpEncTypes DET B NO # #DumpFiles DF B NO # #DumpFroms DFR B NO # #DumpMisc DM B NO # #DumpOpts DO B NO # #DumpPhase2 DP2 B NO # #DumpSectionTypes DST B NO # #DumpSkipFroms DSF B NO # #DumpSkipSubjects DSS B NO # #DumpSubjects DS B NO # # # #TrapAllBegs TAB B NO # #TrapAllEncs TAE B NO # #TrapAllSecs TAS B NO # # # #------------------------------------------------------------------------------# # # # Debug - turns on ALL debugging options # # Dump64Files - not used -- removed as unnecessary during coding # # DumpBase64Types - writes the Base64TypesFile to the console/log # # DumpBinTypes - writes the BinTypesFile to the console/log # # DumpDates - writes ALL Date: header lines to the console/log # # DumpEncTypes - writes the EncTypesFile to the console/log # # DumpFiles - writes the Files. array to the console/log # # DumpFroms - writes ALL From: header lines to the console/log # # DumpMisc - writes the MiscInfo. array to the console/log # # DumpOpts - writes all of the runtime options to the console/log # # DumpPhase2 - writes various arrays to the console/log # # DumpSectionTypes - writes the SectionTypesFile to the console/log # # DumpSkipFroms - writes the SkipFromFile to the console/log # # DumpSkipSubjects - writes the SkipSubjectsFile to the console/log # # DumpSubjects - writes ALL Subject: header lines to the console/log # # # # TrapAllBegs - writes ALL lines containing 'begin' to the console/log # # TrapAllEncs - writes ALL 'Content-Transfer-Encoding:' lines # # TrapAllSecs - writes ALL lines containing 'section' to console/log # # # ################################################################################ ################################################################################ # LOGGING OPTIONS # #------------------------------------------------------------------------------# # # #Log L B YES # #LogFile LF S DWdecode.Log # # # #------------------------------------------------------------------------------# # # # LOG=YES says to write reports to a file instead of the console # # LOGFILE is used to specify the name of the log file. # # # ################################################################################ ################################################################################ # MISCELLANEOUS RUNTIME OPTIONS # #------------------------------------------------------------------------------# # # #DWassignIN DWI S DW: # #DWtemp DWT F T: # #Quiet Q B NO # #RunBack RB S run > nil: # #ScanOnly SO B NO # #ScanProg SP F FlashFind # # # #------------------------------------------------------------------------------# # # # DWassignIN - within the program I use this assign for the input directory. # # you would only need to change it if there was a conflict with # # an existing assign - it is removed at the end of program. # # # # DWtemp - this is used as the target of temporary files. Might need to # # changed if T: can't handle the amount of bytes necessary? # # # # QUIET - if set to YES will suppress almost all console messages. I # # recommend leaving it set to NO so that you have something to # # watch as the decode process progresses. # # # # # # RunBack - this runs QuickSort. You could change it to use c:asyncrun or # # some other program -- why I'm not really sure. # # # # ScanOnly - if set to YES will have the program do everything EXCEPT the # # actual decoding and deleting of files. If you are nervous about # # running this or just curious about the output - try this. It # # was mostly useful when I was doing the coding. # # # # ScanProg - originally I had intended allowing for different Scan/search # # programs, but the AmigaDos Search command was tooooo slow, # # and others wrote strange characters. FlashFind was fast AND it # # was easy to parse the output. So this option MUST be FlashFind # # with its path (if you put in a different directory) # # # # # ################################################################################ ################################################################################ # MAKING DWDECODE SMARTER # #------------------------------------------------------------------------------# # # #TrapNewEncs TNE B YES # #TrapNewEncsFile TNEF S DWdecode.Trap.Encodes # #TrapNewSecs TNS B YES # #TrapNewSecsFile TNSF S DWdecode.Trap.Sections # # # #------------------------------------------------------------------------------# # # # TrapNewEncs - enables trapping of NEW 'Content-Transfer-Encoding:' lines. # # This enables you to add them as you discover them. # # # # TrapNewEncsFile is the file where the NEW encoding lines are logged. # # # # TrapNewSecs - enables trapping of NEW section lines. These are lines that # # start with the word section and do not match ones in the STF # # # # TrapNewSecsFile is the file where the NEW section lines are logged # # # # # # SUGGESTION: Check these files occassionally and add the necessary info to # # the corresponding file. Also, I would appreciate it if you would send any # # new section lines or encoding lines to me (email) and I will add them for # # future updates. # # # # # ################################################################################ # END OF DEFAULTS DOCUMENTATION FILE # ################################################################################