home *** CD-ROM | disk | FTP | other *** search
/ The Pier Shareware 6 / The_Pier_Shareware_Number_6_(The_Pier_Exchange)_(1995).iso / 035 / lsetdesc.zip / LSETDESC.DOC < prev    next >
Text File  |  1994-10-24  |  11KB  |  245 lines
  1.  
  2.         ──────────────────────────────────────────────────────────────────
  3.         ▒▒▒ LSetDesc ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Version 1.00 ▒▒▒▒
  4.         ──────────────────────────────────────────────────────────────────
  5.  
  6.          (c)1994 Simon Ewins
  7.  
  8.          FidoNet....: 1:250/664
  9.          InterNet...: simon@axaxa.tor250.org
  10.  
  11.         The latest version of LSetDesc is always available at 1:250/664 by
  12.         requesting the 'magic name' LSETDESC.
  13.  
  14.  
  15.  
  16.         ──────────────────────────────────────────────────────────────────
  17.         ▒▒ Disclaimer & License ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  18.         ──────────────────────────────────────────────────────────────────
  19.  
  20.         LSetDesc is FreeWare *NOT* Public Domain.
  21.  
  22.         The documentation and accompanying program are copyrighted
  23.         material designed, produced and tested by the author of the
  24.         software.
  25.  
  26.         Although every care and attention has been taken to write and test
  27.         the program to make sure that it does what this documentation
  28.         states, the program is provided as it is, without warranty or
  29.         guarantee of any kind, either expressed or implied, as to the
  30.         quality or performance of this program, except that it will occupy
  31.         disk space.
  32.  
  33.         The author shall not be held liable to you or anyone else for any
  34.         direct, indirect, incidental or consequential damages, including
  35.         any lost profits, lost savings, lost business, which may result
  36.         from the use or inability to use this program.
  37.  
  38.         Your use of this program constitutes your agreement to this
  39.         disclaimer and your release of the author from any form of
  40.         liability or litigation.
  41.  
  42.         You are actively encouraged to copy and distribute it in an
  43.         unmodified way as much as you want, as long as you still abide to
  44.         the conditions mentioned here and that no money or monies or any
  45.         other form of compensation is asked for or accepted.
  46.  
  47.  
  48.         ──────────────────────────────────────────────────────────────────
  49.         ▒▒▒ LSetDesc ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Version 1.00 ▒▒▒▒
  50.         ──────────────────────────────────────────────────────────────────
  51.  
  52.         LSetDesc started out as a small program to read the SysMsg.Dat
  53.         file used by LORA-BBS and try to resolve the description field for
  54.         each echo area from a FidoNet.NA file or any file that contains
  55.         the echo area tag name followed by one or more spaces and then a
  56.         description of the area.
  57.  
  58.         Like this:
  59.  
  60.         MONKEY_BUSINESS     All about monkeys
  61.         HOPE_CHEST          Hope Chest discussion forum.
  62.  
  63.         That worked fine so I added more fields that could be dealt with
  64.         globally as well as providing a 'one shot' method that didn't
  65.         require a descriptions file like FidoNet.NA or similar.
  66.  
  67.         LSetDesc can get a bit complicated but, after a brief discussion
  68.         of the command line options available, I hope that some examples
  69.         will clear things up for you.
  70.  
  71.  
  72.         ──────────────────────────────────────────────────────────────────
  73.         ▒▒▒ LSetDesc ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Version 1.00 ▒▒▒▒
  74.         ──────────────────────────────────────────────────────────────────
  75.  
  76.               Usage: LSetDesc [options]
  77.  
  78.               Options:  -d<descriptions_file_name>
  79.                         -c<config_file_path_name>
  80.                         -r<read_access_level>..... T,L,N,P etc.
  81.                         -w<write_access_level>.... T,L,N,P etc.
  82.                   -x<maximum messages> .....
  83.                   -e<maximum age> ..........
  84.                         -a<tag> .................. search for & only apply to tag
  85.                         -q ....................... apply QWK tag
  86.                         -f ....................... forced write
  87.                   -s ....................... write Squish.Cfg
  88.                         -g ....................... flag P(or)V (and) A,G
  89.                         "-udescription to use" ... use supplied description
  90.                         "-odefault origin line" .. must be in double quotes
  91.  
  92.         NOTE: To allow spaces in the -u and -o arguments the ENTIRE string
  93.               (including the -o or -u) MUST be enclosed in double
  94.               quotation marks.
  95.  
  96.         -d ... The descriptions file name (and path if required). This
  97.                                  file must be in the format demonstrated on the previous
  98.                page. The number of spaces between the area name and the
  99.                description doesn't matter but must be at least one.
  100.  
  101.         -c ... The config file name is the only argument that must be
  102.                present regardless of any other options. This is the name
  103.                (and path if required) of the LORA SysMsgat file.
  104.  
  105.         -r ... Sets the read access level to Twit, Disgrace and so on up
  106.                to Hidden. The r must be followed by the first letter of
  107.                the access level to set.
  108.  
  109.         -w ... Sets the write access level to Twit, Disgrace and so on
  110.                up to Hidden. The w must be followed by the first letter
  111.                of the access level to set.
  112.  
  113.         -a ... This specifies an area tag that is to be searched for and
  114.                                     any changes (-r, -w, -q etc.) will be applied ONLY to that
  115.                area. -d can be used with -a but the only description taken
  116.                from the descriptions file will be the one for the tag
  117.                specified with the -a argument.
  118.  
  119.         -q ... This will take the first 12 letters (or less if there
  120.                aren't 12) from the echo tag listed for the area and place
  121.                them in the QWK name field. For some reason the SysMsg.Idx
  122.                file update, when this option is used, doesn't take. If
  123.                this happens to you an update can be forced by entering the
  124.                messages areas configuration of LSETUP and altering any QWK
  125.                name and then saving the record. After the database is
  126.                updated you can then change it back again. This is the only
  127.                bug that I have found and it is far from critical.
  128.  
  129.  
  130.         ──────────────────────────────────────────────────────────────────
  131.         ▒▒▒ LSetDesc ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Version 1.00 ▒▒▒▒
  132.         ──────────────────────────────────────────────────────────────────
  133.  
  134.         -a ... This specifies an area tag that is to be searched for and
  135.                                     any changes (-r, -w, -q etc.) will be applied ONLY to that
  136.                area. -d can be used with -a but the only description taken
  137.                from the descriptions file will be the one for the tag
  138.                specified with the -a argument.
  139.  
  140.         -f ... Normally LSetDesc will only update a field if it is empty
  141.                or of NIL value. Using the -f option will force the data
  142.                provided by you or gleaned from the descriptions file to be
  143.                written over existing data.
  144.  
  145.         -g ... This will apply the flags for an area as V (private only)
  146.                or P (public only), as well as the A (use alias) and G
  147.                (group restriction) flags. If -g is used with no additional
  148.                arguments then all flags will be set to 'No'. This means
  149.                that those that are provided will be set to 'Yes' and those
  150.                that aren't will be set to 'No'. -gPG would set the Public
  151.                and Group flags to 'Yes' and set the Private and Alias
  152.                flags to 'No'.
  153.  
  154.         -o ... This will write the origin line into the record(s) being
  155.                updated. If there are any spaces in your origin line
  156.                (usually there would be) then you must enclose the -o
  157.                argument INCLUDING the -o itself in double quotes...
  158.                "-oThis is my origin line" is correct but -o"My origin" is
  159.                not.
  160.  
  161.         -u ... In a 'one shot' run of LSetDesc you can supply a
  162.                description yourself rather than having LSetDesc search a
  163.                descriptions file. As with the -o option you must surround
  164.                the -u in double quotes if there are any spaces in the
  165.                string. Specifying -u with a -d will result in an error as
  166.                will specifying a -u without a -a.
  167.  
  168.         -s ... If used with the name of a Squish.Cfg file this will write
  169.                the same for you. This will only be of use to those who use
  170.                a reader like FleetStreet that requires this in order to
  171.                know what echo areas you have on your system.
  172.  
  173.         -x ... The maximum number of messages in the area.
  174.  
  175.         -e ... The maximum age (in days) for the area.
  176.  
  177.  
  178.         ──────────────────────────────────────────────────────────────────
  179.         ▒▒▒ LSetDesc ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Version 1.00 ▒▒▒▒
  180.         ──────────────────────────────────────────────────────────────────
  181.  
  182.  
  183.               Examples:
  184.  
  185.  LSetDesc -cSYSMSG.DAT -dD:\NET\FIDONET.NA -rN -wS -q "-oA_X_A_X_A :: Toronto"
  186.  
  187.   - Uses D:\NET\FIDONET.NA
  188.     Writes to SYSMSG.DAT in the current directory
  189.     Sets read access to Normal
  190.     Sets write access to Sysop
  191.     Fills QWK tag with echoarea tag
  192.     Fills any empty origin fields with: A_X_A_X_A :: Toronto
  193.  
  194.  LSetDesc -cSYSMSG.DAT -dFIDONET.NA -aHOLYSMOKE -x1000 -e14 -ssquish.cfg
  195.  
  196.   - Uses SYSMSG.DAT in the current directory
  197.     Searches FIDONET.NA (in the current directory)
  198.     For the tag HOLYSMOKE and applies the description (if) found
  199.     Sets maximum messages to 1000
  200.     Sets maximum age to 14 days
  201.     Writes areas to a Squish.Cfg file
  202.  
  203.  LSetDesc -cSYSMSG.DAT "-uMonkey Business" -aMONKEY_BUSINESS -q -f
  204.  
  205.   - Uses SYSMSG.DAT in the current directory
  206.     Applies the description "Monkey Business"
  207.     To the area MONKEY_BUSINESS
  208.     Fills the QWK tag with MONKEY_BUSIN
  209.     Forces a write to the field even if it isn't empty
  210.  
  211.  LSetDesc -cSYSMSG.DAT "-oNew Origin Line"
  212.  
  213.   - Replaces all areas' origin lines in SYSMSG.DAT with the origin line
  214.     "New Origin Line" if they are empty
  215.  
  216.  LSetDesc -cSYSMSG.DAT "-oNew Origin Line" -f -gPG
  217.  
  218.   - Replaces all areas' origin lines in SYSMSG.DAT with the origin line
  219.     "New Origin Line" even if they aren't empty
  220.     Also sets the Group and Public flags for all areas
  221.  
  222.  
  223.         ──────────────────────────────────────────────────────────────────
  224.         ▒▒▒ LSetDesc ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Version 1.00 ▒▒▒▒
  225.         ──────────────────────────────────────────────────────────────────
  226.  
  227.         Future versions of this program will involve adding more fields
  228.         that can be manipulated (like the access flags and areafix levels
  229.         for each area). Who knows, it may even turn into a full blown
  230.         message area editor with global search and replace... hmmmmm.
  231.  
  232.         Although this program is FreeWare I would mention that donations
  233.         to my beer fund are always welcome. If you feel that you'd like to
  234.         buy me a beer (and maybe even my wife) for providing you with this
  235.         program (and my wife for putting up with me while I worked on it)
  236.         please feel free to send a donation to the beer fund at:
  237.  
  238.         Simon Ewins
  239.         102 Cleveland Street,
  240.         Toronto, Ontario
  241.         CANADA  M4S 2W5
  242.  
  243.         Enjoy...
  244.  
  245.