home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / comms / bbs / dfile07.lha / DiaFile.doc < prev    next >
Text File  |  1990-10-24  |  12KB  |  295 lines
  1.  
  2. /*********************************************************
  3.  
  4. DiaFile.LZH short filenote:
  5. 123456789_123456789_123456789_123456789_123456
  6. Dialog File Utility/Module Lister/Editor v0.5
  7.  
  8. DiaFile.LZH long filenote:
  9. Lists/edits/deletes DialogBBS files via CLI options or online as
  10. module.  Search any/all fields for matching files.  Any
  11. combination AND'ed or OR'ed together.  Individual values or ranges
  12. allowed.  Search by:  file area, filename, file number, uploader
  13. name, upload date, new files since last call, # of times
  14. downloaded, file size, attributes, days since upload, file
  15. description, etc.
  16.  
  17. *********************************************************/
  18.  
  19.   SysOps:
  20.      Please delete all prior versions of this prg after putting
  21.      this current version online.
  22.  
  23.   Updates/bug fixes and listed in reverse chronological order
  24.   at the end of this file.
  25.  
  26.   All the latest releases of my DialogBBS modules/utilities are
  27.   available by download to members of:
  28.     The Amiga ShareWare HeadQuarters BBS
  29.     Bill Beogelein
  30.     Box 52441
  31.     Livonia, MI 48152
  32.     313-473-2020 (BBS); 1:120/207 (Fido)
  33.  
  34.   An "all work in progress" disk (95-99% full) is available
  35.   by US mail for $15.   It guarantees you all the latest updates to all
  36.   my utilities/doors as well as other's related Dialog/BBS/
  37.   Telecommunication shareware.
  38.   > Specify "DIALOG UTILITIES/MODULE DISK #1".
  39.  
  40.   Please create file t:DiaFile.log and include it when reporting bugs.
  41.   If you suspect a bug has been located, specific debugging can be
  42.   turned on with the "-Z 00000000" option.  The parameter is a 8-bit
  43.   binary number.  Each bit represents the ON/OFF setting of the
  44.   following debugging info:
  45.                        8- Changes made with +options.        
  46.                      / 7- Expansion of ^values.
  47.                     // 6- Ranges interpreted/used.
  48.                    /// 5- File names loaded/used.
  49.                   //// 4- Area names loaded/used.
  50.                  ///// 3- Open/Closing of all files.
  51.                 ////// 2- Alloc/freeing of all memory used.
  52.                /////// 1- CLI or menu passed -options.
  53.               //////// 
  54.              ||||||||  
  55.   DiaFile -Z 11111111   (Turn on all debugging)
  56.   Any of 256 combinations are valid.   Bits not shown are considered OFF.
  57.   "-Z 00000111" is equivalent to "-Z 111"  turning on -option, memory
  58.   allocation, and file handling debugging.
  59.   
  60.   Keep a backup copy of your FILE:*.fd files available.
  61.  
  62.   Only the 1st char of each option is checked.
  63.   -name is equal to -n, etc...
  64.  
  65. KEYWORDS: -(nscdDAtTcC...)
  66.   Must appear immediately before their companion values.
  67.   You can optional replace the required value with "-?string_strings"
  68.   which will prompt the user for this missing value.
  69.    DiaFile -AREA 1 -name *.arc        ; Search for these files
  70.    DiaFile -AREA 1 -name -?Filename:  ; Prompt user for filename
  71.    DiaFile -AREA 2 -days 0-7          ; Search for all files uploaded this week
  72.    DiaFile -AREA 2 -days -?Days:      ; Prompt user for this value
  73.   An internal/default prompt string is used by specifying "-option
  74.   -?" without trailing prompt string.
  75.  
  76. SWITCHES: -(oqQkKmMh)
  77.   Can appear anywhere on cmd line and DON'T need companion values
  78.   following.
  79.  
  80.   All switches and keywords ARE case sensitive.
  81.   Each option can only be used once.
  82.   All values are 'AND'ed together unless '-or' option is used.
  83.  
  84.   1> DiaFile -help >prt:      ;;; Will output help screen to printer ;;;
  85.  
  86.   Auto validate/delete files via nightly midnight.sh.
  87.  
  88.   All the altering options (+option) that are followed by a numerical
  89.   value can specific a +value, -value, or absolute value.
  90.  
  91.    ; It is highly recommended that you use script files and/or alias cmds
  92.    ; for commonly used  DiaFile functions:
  93.    alias touch    DiaFile -name [] +
  94.    alias purge    DiaFile -TIMES_DL 0   -size 50000-    -days_ul 120-
  95.    alias find     DiaFile -name []
  96.    alias ULer     DiaFile -uploader []
  97.    alias never    DiaFile -T 0
  98.    alias rare     DiaFile -T 0-2
  99.    alias popular  DiaFile -T 10-
  100.    alias big      DiaFile -s 80000-
  101.    alias small    DiaFile -s -3000
  102.    alias text     DiaFile -t []
  103.    alias new      DiaFile -d 0-2
  104.    alias old      DiaFile -d 120-
  105.    alias recent   DiaFile -D 0-2
  106.    alias today    DiaFile -days_ul 0
  107.    alias yester   DiaFile -days_ul 1
  108.    alias recent   DiaFile -days_ul 0-2
  109.    alias weekly   DiaFile -days_ul 0-7
  110.    alias inactive DiaFile -days_ul 99- -TIMES_DL 0
  111.    alias early    DiaFile -file# 1-3
  112.    alias kill     DiaFile -name []   +KILL
  113.    alias arced    DiaFile -n *.arc
  114.  
  115.   Log Generation:
  116.   t:DiaFile.LOG exists-           Append to end file.
  117.   t:DiaFile.LOG doesn't exist-    No log output generated.
  118.  
  119.   All options ARE case-sensitive.
  120.   All options are significant only by 1st character.
  121.   Others are ignored.  ("-time" == "-t")  ("-TiMeThIs" == "-T")
  122.  
  123.   The -x -X +x +X (i/o input/output) options allow output to be formatted
  124.   and output to a file of your choice.
  125.  
  126.   The filename specified with -x must contain one of eight characters
  127.   at the start of every line.  See DiaFile.cfg for more information.
  128.  
  129.   All ^values can also be passed directly from CLI with the -X by
  130.   replacing the filename with body string desired.
  131.     1>  DiaFile -s 50000-90000 -X _^n_^s_^d
  132.  
  133.   The following TCS (text control sequences) values are allowed
  134.   within the specified "-x filename" formatting file.
  135.    (8 reserved chars are \ ( ) , + - . ; % Do Not Use)
  136.    ^a Attributes shown as 0-32768
  137.    ^e Attributes shown as 16 bits string "YYY__YY__YYY___Y"
  138.    ^A Current area #
  139.    ^B User's baud rate
  140.    ^f File's number
  141.    ^E All area #s to be searched
  142.    ^m # of mins to D/L file as 00:00:00 (Currently only for 2400baud callers)
  143.    ^s Size of file in bytes
  144.    ^S Size of file in K bytes
  145.    ^T # of times file has been D/Led
  146.    ^U Upload date as 01Jan90
  147.    ^R Upload date as "Sat 08 Sep 90 19:34"
  148.    ^n Filename
  149.    ^t 1st 70-80 chars of filenote
  150.    ^u Uploader's name
  151.    ^d # of days since uploaded
  152.    ^x DiaFile.cfg name passed via CLI with -x option
  153.    ^X cfg string passed via CLI with -X option
  154.  
  155.    ^| ttl_num_missing      Total # of missing files in all areas.
  156.    ^= ttl_num_matched      Total # of files matching search criteria.
  157.    ^' ttl_num_changed      Total # of files changed.
  158.    ^` ttl_num_not_changed  Total # of files not changed.
  159.    ^~ num_est         Estimated # of files in area (hi_pointer-lo_pointer+1).
  160.    ^> ttl_num_est     Estimated # of files ttl (hi_pointer-lo_pointer+1).
  161.    ^< __DATE__        DiaFile's compile dat.
  162.    ^@ num_matched     Number of files in 1 area matching search criteria.
  163.    ^! num_changed     Number of files total matching search criteria.
  164.    ^$ num_act         Number of actual files in 1 area.
  165.    ^^ "^"             Single ^ char.
  166.    ^* num_not_changed Total # of files changed.
  167.    ^{ DAY             Current day of week.
  168.    ^} DATE            Current date as 01Jan90.
  169.    ^] ttl_num_del     Total # of files deleted in all areas.
  170.    ^[ ttl_num_act     Total # of files online.
  171.    ^_ LDATE           Current date as 900101 (for sorting).
  172.    ^= TIME            Current time as 00:00:00.
  173.    ^? VERSION         DiaFile's name/version#.
  174.    ^: num_del         # of files deleted in 1 area.
  175.    ^& num_missing     # of files missing in 1 area.
  176.   Each will output the corresponding value.  These ^TCSs are identical
  177.   to the -options used on the CLI cmd line.
  178.  
  179.   Special TCSs:
  180.    ^;                 Remainder of line is comment.
  181.    ^.                 Suppress automatic linefeed at end of line.
  182.  
  183.  All values can LEFT or RIGHT justify with width-value immediately
  184.  following each '^' char.
  185.   ^10n  Right  justify
  186.   ^-10n Left   justify
  187.   ^+10n Center justify
  188.   ^05n  Right  justify, padded with 0s
  189.   ^,10n Right  justify, filling w/commas
  190.  
  191.  [^-40n] gives [DiaFile.LZH                         ] left-jusify in 40cols
  192.  [^+40n] gives [            DiaFile.LZH             ] center in 40cols
  193.  [^40n]  gives [                         DiaFile.LZH] right-justify in 40cols
  194.  
  195.  [^09s]  gives [000123456] right-justify in 9cols, w/zero padding
  196.  [^,9s]  gives [  123,456] right-justify in 9cols, w/comma expansion
  197.  
  198. Also expanded within ^format-file or ^values passed from CLI:
  199.    \\    (ANSI)   Single backslash  (dec- 92)
  200.    \a    (ANSI)   Alert user        (dec-  7)  (Amiga screen flash/beep)
  201.    \b    (ANSI)   Backspace         (dec-  8)
  202.    \f    (ANSI)   Form feed         (dec- 12)
  203.    \n    (ANSI)   Linefeed          (dec- 10)
  204.    \r    (ANSI)   Carriage return   (dec- 13)
  205.    \t    (ANSI)   Tab               (dec-  9)
  206.    \v    (ANSI)   Vertical tab      (dec- 11)
  207.    \e             Escape char       (dec- 27)
  208.    \E             CSI               (dec-155)
  209.    \%             Percent sign      (dec- 37)
  210.  
  211. Revision history:
  212.    The following update info is for internal reference only.
  213.    Please excuse its "shorthand" nature.
  214.  
  215. Bugs/future updates:
  216.    check() needs to return/use success/range value to y/n/q, not just abort
  217.    Need to speed up ^value expansion
  218.    Unbuffered I/O for y/n/q w/o [RETURN]
  219.    Needs -option to save line to executable file
  220.    Needs ^option to output current execution argv
  221.    Bug if any user strings contain illegal chars ^ % etc
  222.    Save "changes" also to separate file
  223. *  Search/set [n]ew file date field   (FILE:###/USER.FILE)
  224. *  Need info for each of 16 attribute bits
  225.    Full .CFG '|' support
  226. *  Which files can callers not view or D/L due to low access level
  227.    Needs to set -priority level
  228.    Needs to set -buffer size of FileNote
  229.    Needs to get user's baud from t:tr?.user instead of -BAUD option
  230. *  Given FILE:*.fd then find corresponding FILE.LZH.
  231. *  Given FILE.LZH  then find corresponding FILE:*.fd.
  232.    Check -attributes with 16 bits Yy1 or Nn0_-
  233.    ^value to halt screen output
  234.    ^value for total bytes in area, total bytes online
  235.    
  236. * Tom/James/Mike I need more info before I can do anything
  237.   with these items.  (Fido 1:120/207, 313-473-2020)
  238.  
  239. xxx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx
  240.  
  241.    v0.6  Tuesday 23-Oct-90 17:25:52
  242.       Removed dummy struct  File_Areas from .h
  243.       Replaced with correct File_Area structs
  244.       Now compatable ONLY with Dialog update dated 17Oct90
  245.       "Should" exit safely with "Error in FILE:AREA.BBS" if an attempt is 
  246.          made to use DiaFile with older, non-compatable FILE:Area.bbs format.
  247.       
  248.    v0.5  Wednesday 26-Sep-90 08:19:40 (31520)
  249.       -!debug option is now a KEYWORD instead of a SWITCH (see above)
  250.       -!debug rename -zdebug and -ZDEBUG
  251.  
  252.    v0.4  Tuesday 25-Sep-90 08:17:03 (30280)
  253.       If no -AREAS specified, use all actual areas, not 1-999
  254.       Don't close stdout if used for output as fp[1]
  255.       More info if -!debug used
  256.       Fixed file area name ^value ?? bug if (area #) > (# of areas)
  257.       Tweaked baud/cps for 00:00:00 D/L times ^values
  258.       Moved "cps to baud look-up" out of size2time() (Slightly faster)
  259.       Added ^B to show user's baud rate
  260.       Change File_Areas struct from 37/SHORT/13 to 38/SHORT/14 still 54
  261.  
  262.    v0.3  Monday 24-Sep-90 16:10:39  (30076)
  263.       Clear 1st char in all opt_s, not last
  264.       Added missing -opt to usage2 string
  265.       MAXLEN shortened from 300 chars to 200
  266.       Cleared all head/body/tail once before use_format() and load_format()
  267.       ^< shows compile date
  268.       Check for -? removed from makerange() (already in get_input())
  269.       Added file's (size) to .doc
  270.       Removed intuition.h from pre-compile
  271.       Faster/smarter/smaller showbits() loop
  272.       Char count of global footer not being cleared before run (fixed)
  273.       Correct 00:00:00 D/L time at all bauds if passed with new "-BAUD n"
  274.       Fixed non-working "-x -?" "-X -?"
  275.       Fixed non-working "+x -?" "+X -?" (Allows file overwrites.  Caution)
  276.       Sloppy fix if "holes" in FILE:Area.BBS (!!!I need structs.h!!!)
  277.  
  278.    v0.2  Saturday 22-Sep-90 19:36:46   (29648)
  279.       Added -attribute search support (Unable to find out what each bit means)
  280.       Removed a:zzzBBSad from .LZH, using version_0.? instead
  281.       ^# changed to ^file# to match -file# option
  282.       Changed .CFG '-' char from PRIVATE to NO FILES FOUND
  283.       Added   .CFG '|' char meaning PRIVATE files (Still not supported)
  284.       Changed cps @ 2400 baud from 200cps to 218cps (Partial support)
  285.       Added ^S file size in K bytes
  286.       Added ^G for string file area names
  287.       Added ^# for total # of file areas
  288.  
  289.    v0.1  Saturday 22-Sep-90 03:59:33
  290.       1st release, list only, no edit/change +options
  291.  
  292.  xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx
  293.  
  294. ***  EOF DiaFile.doc ***
  295.