home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / RUE_200.ZIP / RUE.DOC < prev    next >
Text File  |  1992-07-28  |  23KB  |  623 lines
  1.  
  2.  
  3.  
  4.              ▄▄▄▄  ▄  ▄  ▄▄▄▄
  5.              ▀  █  █  █  █
  6.              █  ▄  ▀  █  █        SuperBBS Remote User Editor
  7.              █▀█▀  █  ▄  ▀▀▀
  8.              █  █  █▄▄█  █▄▄▄
  9.  
  10.                version 2.00
  11.  
  12.  
  13.  
  14.     DOCUMENTS ════════════════ (C) Copyright 1992 by Pasi Talliniemi
  15.  
  16.  
  17.  
  18.     ■ Preface
  19.  
  20.     RUE - SuperBBS Remote User Editor - is at its release date the
  21.     most versatile user editor for SuperBBS. It is completely menu
  22.     configurable and includes almost everything that you have ever
  23.     dreamed of.  It has been designed  mainly  for remote use  but
  24.     since there is no potential rivals at this moment  I guess it
  25.     will be a lot used locally, too.  There is, however, one thing
  26.     for which RUE cannot compete  with local editors - speed.  You
  27.     just have to live with it till I am able to release Sue.
  28.  
  29.  
  30.  
  31.     ■ Legal stuff
  32.  
  33.     This software  is copyrighted 1992  by Pasi Talliniemi.  You are
  34.     not allowed to charge for this software, modify the files in any
  35.     way,  or add files  to the original  distribution archive.  This
  36.     program is only guaranteed to take up disk space,  nothing else.
  37.     Use at your own risk.
  38.  
  39.     RUE - SuperBBS Remote User Editor v 2.00 - is released under the
  40.     Shareware concept. This means that you can test the software for
  41.     30 days, before you either have to register or to stop using it.
  42.     Otherwise you are violating the Shareware concept.  Registration
  43.     entitles you to use any version of this software!
  44.  
  45.     Please support the Shareware concept. Through this concept it is
  46.     possible to test the software before paying for it.
  47.  
  48.     How to register?  Please check out file HOWTOREG.TXT for further
  49.     information.
  50.  
  51.  
  52.  
  53.     ■ Some features:
  54.  
  55.     - Edit user
  56.     - Search user(s)
  57.     - Global edit
  58.     - Validate new users
  59.     - View questionnaire file answers
  60.     - Delete user from .ASW
  61.     - View log files
  62.     - Add user to / Remove user from .CTL-files
  63.     - Select combined boards
  64.     - View security level limits
  65.     - Go to user
  66.     - Completely menu configurable; menu editor included
  67.     - Hot keys in menus
  68.     - Templates
  69.  
  70.  
  71.  
  72.     ■ How to setup?
  73.  
  74.       ∙ Quick Setup
  75.  
  76.         Check out the file named START.TXT!
  77.  
  78.       ∙ Configuration file
  79.  
  80.         You should modify  RUE.CFG  to fit your system  with a plain
  81.         ASCII text editor. The file is pretty well commented so I do
  82.         not repeat everything here.
  83.  
  84.         Note:  All the  configuration commands  in  RUE.CFG  between
  85.         "KEYWORD" and "END" are used only  if you define -K<keyword>
  86.         on the command line. "ELSE" is also supported.
  87.  
  88.         For example,  I needed an own configuration  to set only the
  89.         combined boards  so I put  that configuration  under keyword
  90.         "COMBINED".  To use it  I specify -KCOMBINED  on the command
  91.         line. If I do not do so that configuration will not be used.
  92.         Very handy  -  you do not have to have several configuration
  93.         files.
  94.  
  95.       ∙ Parameters
  96.  
  97.         RUE.EXE -C<configfile> [-K<keyword>] [-L] *E
  98.  
  99.         -C<configfile>    This MUST be specified on the command line
  100.                           - otherwise RUE will not even start.
  101.         -K<keyword>       Specifies  special configuration  keyword;
  102.                           Configuration specified under this keyword
  103.                           will be used.
  104.         -L                Forces to the local mode.
  105.         *E                Must  be included  on the command line  if
  106.                           run  from  SuperBBS  (as usual).  (Enables
  107.                           editing of user him/herself.)
  108.  
  109.       ∙ Included Menus
  110.  
  111.         There are currently four different menus to RUE. And each of
  112.         them are taken to use just by changing parameter -K:s value.
  113.  
  114.         -KNORMALMENUS     These are very fast menus, contain all the
  115.                           abilities that RUE has!
  116.  
  117.         -KSUEMENUS        These are SUE (SuperBBS User Editor) alike
  118.                           menus, not very fast but still quite nice.
  119.  
  120.         -KMEGAEDITMENUS   MegaEdit is  (C) by MegaGroup/Raimo Virta.
  121.                           Raimo  gave me  his written permission  to
  122.                           use these nice ANSIs in RUE. Thanks.
  123.  
  124.         -KCOMBINED        Combined  boards  selection  to  your BBS.
  125.                           Just disable  SuperBBS's internal combined
  126.                           boards selection and run this both in your
  127.                           NEWUSER.Q-A  and in menus  (wherever it is
  128.                           possible to select combined boards).
  129.  
  130.         If you are able to make any new menus or ansis,  please send
  131.         them to me, too. I would really appreciate that.
  132.  
  133.  
  134.  
  135.     ■ Edit user
  136.  
  137.       ∙ Keys available while editing:
  138.  
  139.       ASCII 32 - ASCII 255 : Normal input (#32..#255)
  140.       Ctrl-P               : Wait for special char;
  141.                              next char can be also #0..#31
  142.       Delete               : Delete current char
  143.       Backspace            : Delete previous char
  144.       Ctrl-Backspace       : Delete previous word
  145.       Ctrl-E               : Delete chars to the end of the string
  146.       Ctrl-T               : Delete next word
  147.       Ctrl-Y               : Delete current string
  148.       Ctrl-V, Insert       : Toggle insert mode
  149.       Home                 : Go to the start of the string
  150.       End                  : Go to the end of the string
  151.       Ctrl-S, Cursor Left  : Go to previous char
  152.       Ctrl-D, Cursor Right : Go to next char
  153.       Ctrl-A, Ctrl-Left    : Go to the start of the previous word
  154.       Ctrl-F, Ctrl-Right   : Go to the end of the next word
  155.       Enter                : Quit edit, accept changes
  156.  
  157.       ∙ Note:
  158.  
  159.       1) First letters of alias may be capitalized.
  160.          - Magic config word: CAPITALIAS ON/OFF.
  161.          - Example: "the city manager of el paso" ->
  162.                     "The City Manager Of El Paso".
  163.  
  164.       2) First letters of city may be capitalized.
  165.          - Magic config word: CAPITCITY ON/OFF.
  166.          - Example: "eL pASO, fINLAND" ->
  167.                     "El Paso, Finland".
  168.  
  169.       3) User  may not edit  other users'  passwords  unless his/her
  170.          name is 'Sysop'.
  171.          - Magic config word: EDITPASSWORD ON/OFF.
  172.  
  173.       4) User may not put too high a security level.
  174.          - Magic config word: MAXSECTOPUT <SECLVL>.
  175.          - Example:  User is trying to change his/her security level
  176.            to 32000 but  does not  succeed in it  because  "maximum"
  177.            security level is lower than 32000.
  178.          - Note:  If edited user  has already  higher security level
  179.            than this maximum one  and the security level  is changed
  180.            it cannot be restored with RUE!
  181.  
  182.       5) User cannot edit users with "too" high a security level.
  183.          - Magic config word: MAXSECTOEDIT <SECLVL>.
  184.          - Example: User is trying to edit Sysop with security level
  185.            32000  but  does  not  succeed  in it  because  "maximum"
  186.            security level is lower than 32000.
  187.          - Note:  Even that user has higher security level than this
  188.            maximum one he/she cannot edit users with higher security
  189.            level - not even him/herself!
  190.  
  191.       6) All changes in user information will be saved in RUE.LOG.
  192.          - Magic config word: FULLLOGS ON/OFF.
  193.          - Examples: RUE.LOG:
  194.            Edited #0: Security level 32000 -> 0
  195.            Edited #130: Deleted Yes -> No
  196.  
  197.       7) Flags can also be edited invidually when they are just like
  198.          attributes. (See menutype "Flags, Invidual".)
  199.  
  200.  
  201.  
  202.     ■ Search user(s)
  203.  
  204.       ∙ Note:
  205.  
  206.       I beg your pardon  that RUE is quite slow  while searching  or
  207.       editing globally but I wanted to  include all user options and
  208.       I did not want to take any compability risks!
  209.  
  210.       1) What to search?
  211.  
  212.       A) String:
  213.          - Enter search string.
  214.          - Case will be ignored  and the search string can be just a
  215.            part of a word or so.
  216.          - Example:
  217.            Search cities by "El" :
  218.            Found users from cities: "EL PASO", "Gargamel's Place"...
  219.  
  220.       B) Number, Date, Time:
  221.          - Enter <method> and <number/date/time> to search.
  222.          - Methods are:
  223.            · "=" ie. SAME AS <searchstr>. Equation sign is default.
  224.            · "<" ie. LESS THAN or BEFORE <searchstr>.
  225.            · ">" ie. MORE THAN or AFTER <searchstr>.
  226.          - Examples:
  227.            · Search security levels by ">100" :
  228.              Found users with sec.lvls 100 or more.
  229.            · Search last login dates by "=12-31-91" (mm-dd-yy) :
  230.              Found users who have last logged in New Year's Eve.
  231.            · Search first login times by "<00:30" (hh:mm) :
  232.              Found users who logged in before 00:30 am at their
  233.              first call.
  234.          - Note: NO spaces are allowed in search strings!
  235.  
  236.       C) Flag, Attribute:
  237.          - Enter <method> and <flag(s)/attribute(s)> to search.
  238.          - More than one flag to search can be entered.
  239.          - Methods are:
  240.            · "+" ie. flag/attribute is ON. Plus sign is default.
  241.            · "-" ie. flag/attribute is OFF.
  242.          - Examples:
  243.            · Flags, Search users by "A1+ B1+" :
  244.              Found users who have flags A1 and B1 ON.
  245.            · Attributes, Search users by "A0+ B3-" :
  246.              (attributes are shown on the screen so it is "a little"
  247.              easier to remember correct letters and numbers.)
  248.              Found all DELETED MALE users.
  249.  
  250.       2) After confirm the search begins. You may stop the search by
  251.          pressing <Ctrl-C>. After search, RUE sorts found users.
  252.  
  253.          (TP and C programmers,  I need FAST double linked list sort
  254.          routine!)
  255.  
  256.       3) Selecting users. Found users are shown on the screen.
  257.          - <Cursor Up> and <Cursor Down> moves cursor.
  258.          - <Plus sign> or <Page Up> changes to previous page.
  259.          - <Minus> or <Page Down> changes to next page.
  260.          - <Space> chooses that user ie. quits select mode and jumps
  261.            to that user.
  262.          - <"S"> chooses  user by number  (there are numbers  on the
  263.            left side  of the screen,  entering  that number  selects
  264.            that user).
  265.  
  266.       4) Searching again.
  267.          - RUE will ask you if you want to search again with "found"
  268.            users or to clear the find user list.
  269.            · Clearing  the list  means  that  RUE will search wanted
  270.              things from the whole user base again.
  271.            · Without  clearing  the list  you can  search  users  by
  272.              SEVERAL different options.
  273.          - Example: User wants to find all users who have both flags
  274.            A1 and B1 set ON  and whose security level is over 50 and
  275.            who live in New York.  First he/she could search by those
  276.            flags. Then he/she WON'T clear the find user list because
  277.            he/she is going  to search again,  this time by  security
  278.            level.  At last,  he/she searchs  by city.  Those who are
  279.            left match the search items.
  280.  
  281.  
  282.  
  283.     ■ New user validation
  284.  
  285.     New user validation is based on  the search by new user security
  286.     level. In addition, it is possible to view new user answers, set
  287.     new security level and templates directly in  the "select users"
  288.     screen.
  289.  
  290.     I recommend warmly using this menutype - it is very handy and it
  291.     really speeds things up!
  292.  
  293.  
  294.  
  295.     ■ Global edit
  296.  
  297.       ∙ How to edit globally?
  298.  
  299.       A) String, date, time:
  300.          - Enter string to be replaced. Case will be ignored.
  301.          - Enter string to replace with. Case will not be ignored.
  302.          - If "string to be replaced" is left empty  the whole field
  303.            is replaced with "string to replace with".
  304.          - If "string to  replace  with"  is  left empty  "string to
  305.            be replaced" will be deleted.
  306.          - Examples:
  307.            · User wants to replace all  "Sf" or "SF" or "sf" strings
  308.              with "Finland" in city fields.
  309.              Replace, city:
  310.              1) String to be replaced:  "Sf"
  311.              2) String to replace with: "Finland"
  312.            · User wants to  delete all  "Not yet commented." strings
  313.              in comment fields.
  314.              Replace, comment:
  315.              1) String to be replaced: "Not yet commented."
  316.              2) String to replace with: "" (empty)
  317.            · User  wants to  change  all comments  back to  "Not yet
  318.              commented." in comment fields.
  319.              Replace, comment:
  320.              1) String to be replaced: "" (empty)
  321.              2) String to replace with: "Not yet commented."
  322.  
  323.       B) Number:
  324.          - Enter "method" and "number".
  325.          - Methods:
  326.            · "+" ie. ADD <number> to field's old value.
  327.            · "-" ie. SUBTRACT <number> from field's old value.
  328.            · "=" ie. REPLACE field's old value with <number>.
  329.              Equalisation sign is default.
  330.          - Example: User wants to increase security levels by 10.
  331.            Replace, sec.lvl: "+10"
  332.          - Note: NO spaces are allowed.
  333.  
  334.       C) Flag, Attribute:
  335.          - Enter "flag/attribute" and "method".
  336.          - Several flags/attributes may be entered.
  337.          - Methods:
  338.            · "+" ie. turn flag or attribute ON. Equalisation sign is
  339.              default.
  340.            · "-" ie. turn flag or attribute OFF.
  341.          - Examples:
  342.            · User wants to mark users as deleted.
  343.              Replace, attribute: "A0+"
  344.            · User wants to set flags D1 ON and D3 OFF.
  345.              Replace, flag: "D1+ D3-"
  346.  
  347.       ∙ How to select users to be edited globally?
  348.  
  349.       RUE will replace only "found" users. Normally, it would be all
  350.       users, but it can be limited by normal search functions.
  351.  
  352.       Examples:
  353.       - User wants to mark flag A1 ON on all users who have security
  354.         level 10 or below.
  355.         1) Search, sec.lvl: "<11"
  356.         2) Replace, flags: "A1+"
  357.       - User wants to reduce maximum time in time bank  (By the way,
  358.         who needs one when  Unlimited Door Bank  can be used) to 180
  359.         minutes.
  360.         1) Search, time bank: ">180"
  361.         2) Replace, time bank: "=180"
  362.       - User wants to increase all users' netmail credit and pending
  363.         by 10.
  364.         1) Clear "find user" list (if necessary)
  365.         2) Replace, credit: "+10"
  366.         3) Replace, pending: "+10"
  367.  
  368.  
  369.  
  370.     ■ SysOp keys available from console
  371.  
  372.     - Alt-C     Line chat. The user or SysOp can change his/her text
  373.                 color while in chat  by pressing Ctrl-P and a number
  374.                 between 0 and 7.
  375.     - Alt-H     Hangup user.
  376.     - Alt-J     Swap to disk or EMS and shell to OS.
  377.     - Ctrl-PgUp Increase user's time left.
  378.     - Ctrl-PgDn Decrease user's time left.
  379.  
  380.  
  381.  
  382.     ■ Password protection
  383.  
  384.     You may define  one to three passwords  that are asked  from the
  385.     user at the beginning.  If passwords do not match, user will not
  386.     be let in the editor.
  387.  
  388.  
  389.  
  390.     ■ Questionnaire answers
  391.  
  392.     You are able to  view user's questionnaire answers in RUE -  not
  393.     just the new user answers  but the others,  too.  If needed, you
  394.     may define  the string  that separates users  (as default  it is
  395.     "** <username> answered on <date> at <time>"). RUE will show all
  396.     user's answers if answered more than once.
  397.  
  398.     If you want, you may delete user's all,  older or newer answers.
  399.     For example,  if the user has given three times his/her new user
  400.     answers,  you may delete them all from NEWUSER.ASW  or save only
  401.     the oldest/newest answers.
  402.  
  403.  
  404.  
  405.     ■ Logs
  406.  
  407.     You should be able to  view any log file in RUE  though the only
  408.     log files "officially" supported are  SBBSUP.LOG,  SBBSDOWN.LOG,
  409.     SYSTEM.LOG,  CHAT.LOG and  RUE.LOG.  You can view all the user's
  410.     activity or all the activity today in log.
  411.  
  412.     RUE keeps its own log,  RUE.LOG.  It is a plain  ASCII file that
  413.     contains  all activities in RUE.  And if you have set "FULLLOGS"
  414.     on  (log also changes  in user base),  it is even easier  to see
  415.     what user has done in RUE.
  416.  
  417.  
  418.  
  419.     ■ .CTL-files
  420.  
  421.     RUE can show you in which .CTL-files the edited user exists. For
  422.     example, if the user is in VIP.CTL and NOBCHECK.CTL,  it will be
  423.     shown on the screen.
  424.  
  425.     You are able to add the user to  a .CTL-file or  correspondingly
  426.     remove the user from the .CTL-file.
  427.  
  428.  
  429.  
  430.     ■ Combined board settings
  431.  
  432.     Combined boards may be set with RUE,  too.    Boards may be set on
  433.     and off  using cursor keys.  Screens can be  scrolled  back- and
  434.     forward with plus and minus signs. In addition, at the bottom of
  435.     the screen is  an edit line  on which  you may specify following
  436.     options:
  437.  
  438.     A) <num>[..<num>][:ON/OFF]
  439.  
  440.     Board <num> or boards from <num> to <num> can be set on or off.
  441.  
  442.     Examples:    1..100:ON    Boards from 1 to 100 are turned on.
  443.         1:OFF         Board 1 is turned off.
  444.         1         If board 1 is on, it is turned off and
  445.                  vice versa.
  446.  
  447.     B) [*]<str>[*][:ON/OFF]
  448.  
  449.     Boards whose name start with <str> or contain <str> or is <str>
  450.     can be set on or off.
  451.  
  452.     Examples:    SF.*:ON    All "SF." starting boards are turned on.
  453.         *:OFF       All boards are turned off.
  454.         JOKES:ON   Board "JOKES" is turned on.
  455.         *SYSOP:ON  All    boards    whose  name  contains  word
  456.                "SYSOP" are turned on.
  457.  
  458.     C) LOCAL/NET/ECHO[:ON/OFF]
  459.  
  460.     Local, net mail and echo mail boards can be set on or off.
  461.  
  462.     Examples:    LOCAL:ON   Local boards are turned on.
  463.         ECHO:OFF   Echo mail boards are turned off.
  464.  
  465.  
  466.  
  467.     ■ Import file to message base
  468.  
  469.     The user may send a text file as a message. RUE asks the name of
  470.     the text file,  receiver's name  ("All"  or  "*Everyone*" if for
  471.     everyone), subject, message board and  if the message is private
  472.     or public.
  473.  
  474.  
  475.  
  476.     ■ Templates
  477.  
  478.     It is possible to create templates    which can be assigned to the
  479.     user or the group of users.  Template contains:  security level,
  480.     flags A to D and file name.
  481.  
  482.     User's security level  will be changed  only if  (s)he has lower
  483.     security level than in template unless "force" flag is on.
  484.  
  485.     And the same with the flags: User's flags will not be turned off
  486.     unless "force" flag is on.
  487.  
  488.     If file name is specified, that file will be imported to message
  489.     base to that user.
  490.  
  491.     These templates are very handy when updating users and  I really
  492.     recommend using them, at least when you are using many flags.
  493.  
  494.  
  495.  
  496.     ■ Move User, Swap two users
  497.  
  498.     You are able to move a user in the user base to another location
  499.     there. Moving is still very slow operation but works properly so
  500.     do not worry if your hard drive is having hard time.
  501.  
  502.     You may also swap locations of two users in the user base.  This
  503.     is fast and preferable to 'move user'  when, for example, moving
  504.     the system operator back to  him/her place  (in the beginning of
  505.     the user files).
  506.                     
  507.  
  508.  
  509.     ■ Other menutypes
  510.  
  511.       - Show About:
  512.         "SuperBBS Remote User Editor v2.00..."
  513.  
  514.       - Show User Name:
  515.         "Record #<num>: <name>, <alias> [(new user)] [(deleted)]".
  516.  
  517.       - Your Command:  Shows the string defined in  the config file.
  518.         The cursor will always be placed after that string.
  519.  
  520.       - Show Time Left: Shows string "Time: " and user's time left.
  521.  
  522.       - View Limits: Shows security level limits found in LIMITS.BBS
  523.  
  524.  
  525.  
  526.     ■ Information about creating menus
  527.  
  528.       - First menu can be defined in config file ("TOPMENUFILE").
  529.  
  530.       - Default menu  can be defined in  config file ("DEFMENUFILE")
  531.         (same as INCLUDE1.MNU in SuperBBS).  "Move'n'edit" functions
  532.         are not available in this menu.
  533.  
  534.       - Every menu command  can be secured  with security level  and
  535.         flags (as in SuperBBS).
  536.  
  537.       - Fields:
  538.  
  539.         Type - Edit/File/Find/Global/Other
  540.         Key  - Key needed to process this menutype (see below)
  541.         Info - File menutypes:  Filename
  542.                Other menutypes: X and Y coordinates, colour
  543.                Edit menutype:   also "Ed"  which tells  if this edit
  544.                                 field cannot be edited (just shown)
  545.         Func - Menutype's name
  546.  
  547.       - Special keys in menutypes:
  548.  
  549.         ^S - Left, ^D - Right, ^E - Up, ^X - Down,
  550.         ^W - Home, ^Z - End
  551.  
  552.         ^A - Execute this menutype automatically  (for example, show
  553.              ansi file at the beginning of the menu)
  554.         ^B - "Move'n'edit" function (only with EDIT menutypes)
  555.  
  556.       - Move'n'edit:     User may "walk" through edit menutypes with
  557.         cursor keys and edit  by pressing Enter.  All other keys are
  558.         processed normally.
  559.  
  560.       - Keys available in menu editor (while not editing):
  561.  
  562.             Alt-H, F1 - Show help
  563.                    F2 - Show 'load automatically' Ansi screens
  564.               Ctrl-F2 - Disable selecting cursor positions from Ansi
  565.                         screen
  566.             Alt-S, F5 - Secure menutype: set sec.lvl and flags
  567.         F9, Shift-F10 - Load menu or New menu
  568.                   F10 - Save menu
  569.                 Alt-J - Swap to disk or EMS and shell to OS
  570.                 Alt-M - Move line
  571.                 Alt-C - Copy line to undelete buffer
  572.                 Alt-U - Undelete line
  573.                   Ins - Insert line
  574.                   Del - Delete line
  575.                 Enter - Edit menu type
  576.                   Esc - Exit
  577.  
  578.  
  579.  
  580.     ■ Bugs - do they exist? And what about the future?
  581.  
  582.     Well, I have tested this software far and carefully  and in this
  583.     release version  there should NOT be any bugs.  If you still can
  584.     find one, please report to me!
  585.  
  586.     I will continue  developing this software  if people  show their
  587.     interest to this software by registrating their copies!  I need,
  588.     however,  a lot of new ideas and improving suggestions,  and YOU
  589.     are the one who may help me.
  590.  
  591.     What do you think about these documents?  Could you write better
  592.     ones?  I have almost no time for writing documents  and all help
  593.     would be appreciated.
  594.  
  595.     You may contact me  by writing netmail or snailmail to me  or by
  596.     calling directly to my BBS.
  597.  
  598.     ∙ Fidonet 2:220/297
  599.       Vnet 46:8616/80
  600.       Supernet 42:1200/311
  601.       Delightnet 105:13581/310
  602.  
  603.     ∙ Pasi Talliniemi
  604.       Tiilitie 3
  605.       SF-05200 Rajamäki
  606.       Finland
  607.  
  608.     ∙ EL PASO, +358-0-2903463 (Diana), 24H, v.32bis v.42bis
  609.  
  610.  
  611.  
  612.     ■ Thanks!
  613.  
  614.     Yeah, to all registered users!
  615.  
  616.     Special thanks go to Simo Tirri and Vesa Pajula for beta-testing
  617.     and giving a lot of ideas!
  618.  
  619.  
  620.  
  621.     With best regards,
  622.     Pasi Talliniemi
  623.