home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / USRED12.ZIP / USERED.DOC < prev    next >
Encoding:
Text File  |  1992-10-19  |  13.9 KB  |  343 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.               ┌─┐ ┌─┐ ┌─────┐ ┌─────┐ ┌──────┐ ┌─────┐ ┌──────┐
  11.               │ │ │ │ │ ┌───┘ │ ┌───┘ │ ┌──┐ │ │ ┌───┘ └┐ ┌─┐ │
  12.               │ │ │ │ │ └───┐ │ └─┐   │ └──┘ │ │ └─┐    │ │ │ │
  13.               │ │ │ │ └───┐ │ │ ┌─┘   │ ┌─┐ ┌┘ │ ┌─┘    │ │ │ │
  14.               │ └─┘ │ ┌───┘ │ │ └───┐ │ │ │ └┐ │ └───┐ ┌┘ └─┘ │
  15.               └─────┘ └─────┘ └─────┘ └─┘ └──┘ └─────┘ └──────┘
  16.  
  17.                                version 1.2
  18.  
  19.                        (C) 1992 by Mikko Palomäki
  20.                               2:222/930.2
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.     Contents:
  29.     ---------
  30.  
  31.     Contents............................ What's in this document
  32.     Warranty............................ Legal stuff
  33.     ShareWare........................... The meaning of ShareWare
  34.     What USERED needs to run?........... Requirements to run USERED
  35.     How is it run?...................... Parameters for USERED
  36.     Operating information............... What it actually does when run
  37.     Function keys and other keys........ What are the keys used
  38.     Special function keys............... Detailed info about the function keys
  39.     DOSErrors........................... Error codes Shell might return
  40.     History............................. What's new and what has changed
  41.     Files in archive.................... What files should you have
  42.     Last note........................... Where to contact the author
  43.  
  44.  
  45.  
  46.    Warranty
  47.    --------
  48.  
  49.     USERED is provided AS IS without any warranty, expressed or implied.
  50.     This includes without limitation the fitfulnes to a particular purpose
  51.     or application and any warranties of merchantability.
  52.  
  53.     I shall not be liable for any damages, whether direct, indirect, special,
  54.     or consequantial arising from a failure of this program or accompanying
  55.     files to operate in a manner desired by the user. I shall not be liable
  56.     for any damage to data or property which may by caused directly or
  57.     indirectly by use of this program.
  58.  
  59.     In no event will I be liable to you for any damages, including any lost
  60.     of profits, lost of savings or other incidental or consequential damages
  61.     arising out of your use or inability to use the program, or for any
  62.     claim by any other party.
  63.  
  64.  
  65.  
  66.    ShareWare
  67.    ---------
  68.  
  69.     Because I have used a lot of my time to do this I would like to
  70.     have a small donation for that. I would say 20 FIMK ($5 US) is
  71.     enough...From this version USERED is fully working even if
  72.     unregistered. Only a short delay and a registration remainder
  73.     is displayed when not registered. When you register the delay
  74.     and the registration screen are removed.
  75.  
  76.     20 FIMK is not so much, please give me some credit and pay the fee
  77.     if you like this program...I have done a lot of work to produce
  78.     this...Future versions might depend on registration or lack of
  79.     them.
  80.  
  81.  
  82.  
  83.    What USERED needs to run?
  84.    -------------------------
  85.  
  86.     USERED needs DOS 3.xx or greater and a BBBSUSR.DAT and BBBSCFG.x files
  87.     from BBBS v0.28 or v0.29 to run. It has tested with 0.29 userfiles and
  88.     it seems to work :)
  89.  
  90.  
  91.  
  92.    How is it run?
  93.    --------------
  94.  
  95.     USERED needs one command line parameter: the name of one of the BBBS
  96.     config files (BBBSCFG.x where x is the node number). USERED reads from
  97.     this config file the maindir and other usefull information.
  98.  
  99.  
  100.  
  101.    Operating information
  102.    ---------------------
  103.  
  104.     When USERED is first started it will automatically create a backup
  105.     file of BBBSUSR.DAT in the same directory it is located. Its name
  106.     will be BBBSUSR.$$$, place it in safe place in case of usersfile
  107.     corruption. I have tested this program many times but I cannot be
  108.     100% sure something won't go wrong. For safer operation you can
  109.     make additional backup of your BBBSUSR.DAT file if you like, remember
  110.     to put all the backup files somewhere else.
  111.  
  112.     The config file BBBSCFG.x file won't be changed it is only read nothing
  113.     is written back to it. BBBSUSR.DAT is only affected if you press the
  114.     F2 function key, USERED won't write anything back to the file unless
  115.     you want it to.
  116.  
  117.     When USERED is first started it asks you a password. It is the same
  118.     the SysOp has in BBBS, if you do not enter a password or it is
  119.     different than SysOps pass in BBBS you still are allowed in USERED,
  120.     you just cannot edit nor see any of the users passwords and you cannot
  121.     edit or see SysOps information. If the user has the SysOp pass and
  122.     he/she wishes to give the right to edit and see every users password
  123.     to the CoSysops (except SysOp's, only SysOp can edit or see his/her
  124.     own information) the SysOp can press F7 and change the status of
  125.     the CoSysOps. Press enter to change and save the current status, press
  126.     ESC to abort and exit. The status is saved in USERED.CFG file where
  127.     the colors are also saved.
  128.  
  129.     DO NOT use USERED when someone is at the same time in BBBS, it may
  130.     crash either of the program and usersfile may come corrupted.
  131.  
  132.  
  133.  
  134.    Function and other keys to operate USERED
  135.    -----------------------------------------
  136.  
  137.       F1         - Brings up a help screen
  138.       F2         - Saves up the current users information
  139.       F3         - Find a user by a name or part of a name
  140.       F4         - Dump users to an ASCII file, only string type information
  141.                    is saved in the file.
  142.       F5         - Change some of the colors used in USERED
  143.       F6         - Blanks the screen...press any key to restore.
  144.      *F7         - Change the status of CoSysops level in USERED.
  145.       Up/Down    - Moves the selection bar up and down
  146.       Left/Right - Increases/decreases/changes the values (with CTRL ± 1000)
  147.       PgDn       - Moves to next user  (Does not write anything to file)
  148.       PgUp       - Moves to previous user (Does not write anything to file)
  149.       Home       - Moves to first user (usually the SysOp)
  150.       End        - Moves to last user
  151.       Enter      - Edits string type information: address, phone etc...
  152.       ALT-J      - Jump to DOS shell, type exit to return back
  153.       ALT-X/ESC  - Exits the program and returns back to DOS
  154.  
  155.       *) Only for SysOp, it is the first name in usersfile.
  156.  
  157.  
  158.  
  159.    Special operations and keys
  160.    ---------------------------
  161.  
  162.       F3 - Find a user by name or part of the name
  163.  
  164.       When you press F3 the program puts a input line in the lower right
  165.       part of the sreen. Enter there the name or part of the name and
  166.       press ENTER, the program finds all the names that has that string
  167.       in its name. If it finds a name it asks if you want to (C)ontinue
  168.       or (S)top, if you continue it searches the next name with the
  169.       findstring. When no more names are found it stops automatically and
  170.       shows you the current users information.
  171.  
  172.       NOTE: Nothing is saved in the usersfile when the search is started.
  173.       You must save all the changed information before you use the search
  174.       function.
  175.  
  176.  
  177.       F4 - Dump some of all users information in an ASCII file you specify.
  178.  
  179.       When you press F4 the program asks you the filename where the
  180.       information is then saved. The file is created in the current directory
  181.       so you can specify only its name not path. If any file with the same
  182.       name exists in the current directory the program will ask you if
  183.       you want to overwrite it (all the previous information is destroyed)
  184.       or if you want to append the data (all the previous information is
  185.       preserved and the new information is appended after the old). If an
  186.       error occurs during saving it will be informed without crashing...
  187.  
  188.       Only the following information is saved in the ASCII file in the
  189.       following order:
  190.  
  191.         * Users name
  192.         * Users address
  193.         * Users city
  194.         * Users phone number
  195.         * Users birth date
  196.  
  197.  
  198.       F5 - Change some of the colors used in USERED
  199.  
  200.       When you press this function key a screen with a selection bar appears
  201.       and you can browse the selections by up and down keys. Pressing enter
  202.       and the arrow keys are used here. Select the color with Enter, any
  203.       other key has no meaning. If you are not happy with the colors press
  204.       ESC in the first menu, F10 saves the information in USERED.CFG in
  205.       current directory. It is then read when USERED is started and the
  206.       colors in it will be used. If you want the original colors delete
  207.       the *.CFG file. Note: The CoSysOps status is also saved in the same
  208.       file, you must change that if you delete the *.CFG file.
  209.  
  210.  
  211.       F6 - Blanks the screen.
  212.  
  213.       With this you can blank the screen, press any key to restore back
  214.       to normal.
  215.  
  216.  
  217.       F7 - Change the status of the CoSysOps
  218.  
  219.       Press ENTER to change the status. Information is saved in USERED.CFG
  220.       file and read at startup. ESC aborts and exits. Default is No,
  221.       meaning that the CoSysOps has no right to see or edit users password.
  222.  
  223.  
  224.  
  225.    DOSErrors
  226.    ---------
  227.  
  228.       List of the DOSErrors Shell-function (ALT-J) might return in case of
  229.       an error:
  230.  
  231.         2   - File not found
  232.         3   - Path not found
  233.         5   - Access denied
  234.         6   - Invalid handle
  235.         8   - Not enough memory
  236.         10  - Invalid environment
  237.         11  - Invalid format
  238.         18  - No more files
  239.  
  240.       ALT-J executes the file located in COMSPEC in environment, it is
  241.       usually the "command interpreter".
  242.  
  243.  
  244.  
  245.    History
  246.    -------
  247.  
  248.      0.1ß  - First working copy. Not all info displayd (lasttime-on date not
  249.              displayd...don't know how to get it out of the file :). This
  250.              is the BETA version and it is not intended to be public...not now
  251.              anyway. Maybe from version 1.0 its made available to all...
  252.              or maybe sooner.
  253.  
  254.  
  255.      1.0   - First public version. Changed a lot internal functions and added
  256.              the ability to edit also name, address, password, phonenumber,
  257.              city and birthdates. When selection bar is on one of those press
  258.              ENTER and you can edit them. Note: Even if you change something
  259.              it is not written back to file unless you press F2 first!
  260.  
  261.  
  262.      1.1   - Fixed   : Users password converted to uppercase when written back
  263.                        to usersfile.
  264.              Added   : Password is not visible when browsing names, password
  265.                        made visible only when it is edited.
  266.              Added   : ESC exits the program too...
  267.              Added   : DOS shell (data files closed when shelling).
  268.              Added   : Lasttime on - date showed.
  269.              Changed : Moved left side of the screen one colomn right.
  270.              Changed : From CippleWare to fully working ShareWare program :)
  271.              Changed : User name is not editable because BBBSUSR.IDX is not
  272.                        updated...may change in future versions.
  273.              Changed : Document file updated...some irregular information
  274.                        removed :)
  275.              Changed : Renamed XModem XRC to XModem CRC
  276.  
  277.  
  278.       1.2  - Fixed   : Pressing ENTER on the right side of screen input
  279.                        line does not appear on the left side :)
  280.              Fixed   : Sometimes when exiting DOS shell selection bar was
  281.                        not shown when returned.
  282.              Fixed   : When editing some value whole screen doesn't flicker,
  283.                        it was really severe when running DesqView.
  284.              Fixed   : At the program logo there was some wrong information,
  285.                        version 1.0 was tested with v0.29 userfiles and it
  286.                        seem to work well, logo said it wasn't tested.
  287.              Changed : Archive name to USRED*.*, I can make bugfix versions
  288.                        without changing allways version numbers. Now bugfixes
  289.                        are marked as letters, from A to Z.
  290.              Added   : Selection bar made visible when first entering the
  291.                        program.
  292.              Fixed   : Misspelling in editscreen.
  293.              Changed : USERED.KEY file format changed. An old keyfile
  294.                        won't work with versions 1.1 or lower. A new keyfile
  295.                        is given to registered users when asked.
  296.              Added   : Find and move to a user specified. Very fast find
  297.                        and search...
  298.              Added   : Dump of all users some information to an ASCII file.
  299.              Added   : The ability to change some of the colors used in
  300.                        USERED. Colors saved in USERED.CFG, it is always read
  301.                        at the startup if it is found in current directory.
  302.              Added   : With F6 you can blank the screen temporaly.
  303.              Added   : SysOp can edit everybody, including him/her self.
  304.                        CoSysOps cannot edit or view users password and
  305.                        cannot edit or see at all SysOps information.
  306.              Added   : The SysOp can change CoSysOp's status in USERED. (F7)
  307.  
  308.  
  309.  
  310.    Files in archive
  311.    ----------------
  312.  
  313.         USRED12.*:
  314.  
  315.            USERED.EXE     - Main program
  316.            USERED.DOC     - Yet another example of recursion...:)
  317.            USERED.INF     - Short information about the program, for BBS's
  318.            REGISTER.FRM   - Registration form
  319.            REGISTER.INF   - Detailed registration information
  320.  
  321.  
  322.  
  323.    Last note
  324.    ---------
  325.  
  326.     Note: This program has some minor bugs I know of but don't know yet
  327.     how to correct them. They are only visual bugs...not very important.
  328.  
  329.     If you have anything to say or have anything to add/improve this
  330.     program let me know...or if you find any bugs! You can contact
  331.     me at:
  332.  
  333.      Deaf Leopard BBS
  334.      (Diana) 961-478 3245  (+358-61-4783245)
  335.      24H
  336.      V.32bis (16800bps/V42BIS/MNP5)
  337.      Fido 2:222/930
  338.  
  339.      Username: Mikko Palomaki ( by NetMail to 2:222/930.2)
  340.  
  341.  
  342.                                 <<< EOF >>>
  343.