home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / bued120.zip / BUED.DOC < prev    next >
Text File  |  1996-09-09  |  20KB  |  598 lines
  1.  
  2.  
  3.  
  4. ** = ONLY AVAILABLE IN THE REGISTERED VERSION
  5.                     
  6.                     
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                     SLOVAS Productions
  13.                          presents
  14.  
  15.  
  16.                         BUEd/2  v1.20
  17.                  BBBS User Editor for OS/2
  18.  
  19.  
  20.  
  21.                      Documentation
  22. -------------------------------------------------------------
  23.  
  24.       
  25.    What is BUEd?.......................................1.0
  26.    System requirements for BUEd........................2.0
  27.    Installing and setting up BUEd......................3.0
  28.       The BUED.CFG file................................3.1
  29.       The BUED.BZ file.................................3.2
  30.    Using BUEd..........................................4.0
  31.       The interface....................................4.1
  32.       Using the keyboard...............................4.2
  33.       Using the mouse..................................4.3
  34.       The keys.........................................4.4
  35.       Changing values..................................4.5
  36.          Entering numeric or string values.............4.5.1
  37.          Selecting values from a pick list.............4.5.2
  38.          Toggling values...............................4.5.3
  39.       The MD5 checksums................................4.6
  40.    Known bugs..........................................5.0
  41.    Registering and contacting the author...............6.0 
  42.    Credits.............................................7.0
  43.       
  44.  
  45. -------------------------------------------------------------------------
  46.  
  47.                      Standard disclaimer:
  48.  
  49.         LIMITED WARRANTY AND DISCLAIMER OF WARRANTY 
  50.  
  51.         THIS SOFTWARE AND ACCOMPANYING WRITTEN MATERIALS (INCLUDING 
  52. INSTRUCTIONS FOR USE) ARE PROVIDES "AS IS" WITHOUT WARRANTY OF ANY 
  53. KIND. FURTHER, THE AUTHOR DOES NOT WARRANT, GUARANTEE, OR MAKE ANY 
  54. REPRESENTATIONS REGARDING THE USE, OR THE RESULTS OF USE, OF THE 
  55. SOFTWARE OR WRITTEN MATERIALS IN TERMS OF CORRECTNESS, ACCURACY, RELIA-
  56. BILITY, CURRENTNESS, OR OTHERWISE. THE ENTIRE RISK AS TO THE RESULTS 
  57. AND PERFORMANCE OF THE SOFTWARE IS ASSUMED BY YOU. IF THE SOFTWARE OR 
  58. WRITTEN MATERIALS ARE DEFECTIVE YOU, AND NOT THE AUTHOR, ASSUME THE 
  59. ENTIRE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
  60.  
  61.         THE ABOVE IS THE ONLY WARRANTY OF ANY KIND, EITHER EXPRESS 
  62. OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF 
  63. MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, THAT IS MADE BY 
  64. THE AUTHOR, ON THIS PRODUCT. NO ORAL OR WRITTEN INFORMATION OR ADVICE 
  65. GIVEN BY THE AUTHOR, DISTRIBUTORS OR AGENTS SHALL CREATE A WARRANTY OR 
  66. IN ANY WAY INCREASE THE SCOPE OF THIS WARRANTY AND YOU MAY NOT RELY ON 
  67. ANY SUCH INFORMATION OR ADVICE. 
  68.  
  69.         NEITHER THE AUTHOR NOR ANYONE ELSE WHO HAS BEEN INVOLVED IN THE 
  70. CREATION, PRODUCTION OR DELIVERY OF THIS PRODUCT SHALL BE LIABLE FOR ANY 
  71. DIRECT, INDIRECT, CONSEQUENTIAL OR INCIDENTAL DAMAGES (INCLUDING DAMAGES 
  72. FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS 
  73. INFORMATION, AND THE LIKE) ARISING OUT OF THE USE OR INABILITY TO USE 
  74. SUCH PRODUCT EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF 
  75. SUCH DAMAGES.
  76.  
  77. <pfjuh>
  78.  
  79.  
  80.                     Copyright notice:
  81.  
  82.       BUEd is COPYRIGHT (c) 1996 by  Snorre Lovas.  You
  83.       may distribute it freely, as long as no charge is
  84.       made  for  it.  You may not in any way change the
  85.       program.  BUEd is E-Mail/NetMailware, which means 
  86.       you  have to  send the  registration  form to the 
  87.       author to register the program, and get your reg-
  88.       istration key.
  89.  
  90.  
  91.  
  92.  
  93. -------------------------------------------------------------------------
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  1.0     What is BUEd?
  102. =======================
  103.   
  104.   As a BBBS sysop you will have noticed that you often have to change 
  105. the profile of your users. This can be difficult to do within BBBS due
  106. to the program's limited search facilities and ease of use.
  107.   
  108.   BUEd is designed to help the Sysop to ease this task of maintaining 
  109. his user record. It provides search facilities, a powerful bulk (multi user) 
  110. processing and a mouse and keyboard driven interface, while maintaining 
  111. the BBBS look.  
  112.  
  113.   BUEd also incooperates a database where you can enter notes 
  114. about your users for additional information. Ideal if you have a new-user
  115. form that the users have to fill out.
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  2.0    System requirements for BUEd
  127. ======================================
  128.  
  129.   BUEd's requirements:
  130.    * PC 386
  131.    * Minimum 350k free conventional memory. 
  132.    * BBBS 3.14.95 ->
  133.    * OS/2 Warp
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  3.0    Installing and setting up BUEd    
  145. =======================================
  146.  
  147.   Installing BUEd is quite straight forward. Just unpack the archive
  148. in a directory (e.g. C:\BUED) and edit the configuration file BUED.CFG.
  149.  
  150.  
  151.  
  152.  
  153.  3.1    The BUED.CFG file. 
  154. ---------------------------
  155.  
  156.   BUEd needs some input values to function properly. The first is your
  157. BBBS directory pointing to the BBBSTXT. and the EXTERNAL.BBB file.
  158. (Don't worry.... BUEd only reads values from these files!)
  159.   
  160.   The second input value is your BBBS MAIN directory where the BBBSUSR.DAT
  161. resides.
  162.  
  163.   Third it needs to know the location of your favourite ASCII editor, such
  164. as EDIT or Q. The %f indicates where the program should place the filename. 
  165. (Use %f, not %F)
  166.  
  167.   
  168.   To compute the right checksum for the userprofile BUEd needs the 
  169. registratinnumber of your BBBS. Enter the number belowe the header
  170. [BBBSRegistrationNumber]
  171.   
  172.   
  173.   
  174.   BUEd can release time slices to the operating system when doing heavy/
  175. lengthy processing or is waiting for input from the user. This option 
  176. slows BUEd insignificantly down, and makes the program cooperate better
  177. with multitasking OSes. Therefore if you're using DOS set the value below  
  178. the header [ReleaseTimeSlice] to NO. If you're using OS/2, WinNT, DV etc. 
  179. you can set the value to YES if you want BUEd to release time slices to the
  180. OS.
  181.  
  182. A sample BUED.CFG may look like this:
  183. --------CUT ON----------
  184.  
  185. [BBBSDIR]
  186. c:\bbs
  187.  
  188. [BBBSMAINDIR]
  189. c:\bbs\main
  190.  
  191. [EDITOR]
  192. c:\dos\edit %f
  193.  
  194. [BBBSRegistrationNumber]
  195. 0
  196.  
  197. [ReleaseTimeSlice]
  198. Yes
  199.  
  200. --------CUT OFF---------
  201.  
  202. Do not use trailing backslashes... (NOT c:\bbs\) 
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  3.2    The BUED.BZ file.
  209. --------------------------
  210.  
  211.   If you want to run BUEd from within your BBBS you can edit this file,
  212. place it in your BBBS directory and compile it.
  213.  
  214.   The only line in BUED.BZ that needs editing is the system-command. 
  215. Edit this to reflect where BUED.EXE resides.
  216.  
  217.   After compiling you can use the 'RUN BUED' command within BBBS to use the
  218. editor. You may also edit ERROR.BZ (refer to the BBBS documentation)
  219.  
  220.  
  221.   
  222.   IMPORTANT!!!!!!!!!!!!!
  223.  
  224. You CAN NOT edit a user that is currently on-line!
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  4.0    Using BUEd
  236. ===================
  237.  
  238.   Many people don't like reading documentation (me included), so start
  239. the program and try figuring it out. It should mostly be self explanatory, 
  240. but after messing around a bit please read on.
  241.  
  242.  
  243.  
  244.  
  245.  4.1    The interface.
  246. -----------------------
  247.  
  248.   I have used the BBBS userprofile interface in this program, since it is a interface
  249. most BBBS sysops are familiar with. But in addition I have included two 
  250. menu lines and a second screen.
  251.  
  252.   The menu lines at the top and bottom show the available keys and actions, 
  253. and the second screen adds a few options that BBBS utility menu don't have.
  254. (use RIGHT ARROW to look at the second screen)
  255.  
  256.  
  257.  
  258.  
  259.  4.2    Using the keyboard.
  260. ----------------------------
  261.  
  262.   The available keys are displayed on the menu lines, but in order to change
  263. any values you have to use the UP and DOWN arrow to move the marker 
  264. (the yellow diamond) to highlight the option you want to change. Press ENTER
  265. to change the value. 
  266.  
  267.   For an explanation on every available key and how to change the values, 
  268. refer to section 4.4 and 4.5.
  269.  
  270.  
  271.  
  272.  
  273.  4.3    Using the mouse. === NOT AVAILABLE IN BUEd v1.20 FOR OS/2!
  274. -------------------------------------------------------------------
  275.  
  276.   Point and single click :)  You can click on the menu lines and on the 
  277. option VALUES (not the option names).
  278.  
  279.  
  280.  
  281.  
  282.  4.4    The keys.
  283. -------------------
  284.  
  285.   Here comes an explanation on every key that is used in the program
  286.  
  287.   Function keys: 
  288.    
  289.    F1 - HELP      :  Displays a help screen with an overview of 
  290.                      the available keys.
  291.  
  292.    
  293.    F2 - USERLIST  :  Displays a list of all the users on your BBBS. Use
  294.                      the UP and DOWN arrow or the mouse to highlight the 
  295.                      one you want to display/change and press ENTER
  296.                      /LeftMouseButton.
  297.  
  298.    
  299.    F3 - SEARCH    :  Use this function to search for a user. Enter the 
  300.                      search string and the program will search the fields 
  301.                      NAME, ADDRESS, POSTAL CODE/CITY, PHONE NUMBER and 
  302.                      BIRTH for matches. Then it will display the matching 
  303.                      users in a list similar to the USERLIST function.  
  304.                      
  305.                      You can use boolean operators in the search string:
  306.                      ie: 'kattem and (thomas or kristian)' will display
  307.                      users that have the word 'kattem' and either 'thomas'
  308.                      or 'kristian' in their record.
  309.  
  310.                      If the search string is to complicated the program will
  311.                      beep and return to the previous screen.
  312.                      
  313.    
  314.    F4 - EXPORT    :  This function exports the userrecords to a ASCII text 
  315.                      file. Just enter a valid filename.
  316.  
  317.    
  318.    F5 - BULK PROC :  This is a very powerfull feature. Here you can select
  319.                      an unlimited number of users and then change a value
  320.                      in their userrecord. 
  321.                      
  322.                      There are several ways to initiate which users that 
  323.                      are selected:
  324.                      
  325.                      1. Select from list
  326.                         Select the users from the userlist by marking them 
  327.                         using the SPACE button.
  328.  
  329.     **               2. Select all
  330.                         Selects all the users in the userlist. You can 
  331.                         deselect some by toggling them with the SPACE button.
  332.  
  333.     **               3. Select by search.
  334.                         Selects all users that match the search string. Same 
  335.                         search method as F3-Search (see that section for
  336.                         details). You can select/deselect additional users
  337.                         by using the SPACE button
  338.                         
  339.                         
  340.                      When you have selected the desired users press ENTER 
  341.                      to move on to the option list. Select the option you 
  342.                      want to change, and then select the appropiate value.
  343.                      WARNING: This is a powerful feature and use it with 
  344.                      care. There is nothing stopping the program from killing
  345.                      every user on the BBS if you tell it to. 
  346.  
  347.    
  348.    F6 - DUPE CHECK:  This function makes a report containing users that
  349.                      look similar. That is - they have some of the same 
  350.                      information in their name/address/city/phone/birthday 
  351.                      fields. This may indicate that one of the compared  
  352.                      users are fake or a duplicate that isn't used.
  353.                      First you choose the level of the report, by choosing
  354.                      how high the possibility has to be before the  
  355.                      users are logged. Setting this number to 1 will log
  356.                      users with one similar value as the same first name.  
  357.                      The possibility is calculated as illustrated in the  
  358.                      table below.                                      
  359.                      Second you choose the filename to which the report will
  360.                      be written.
  361.  
  362.                      Similar first name    -> Possibility increase by one.
  363.                      Similar second name   -> Possibility increase by one.
  364.                      Similar word in
  365.                      address               -> Possibility increase by one.
  366.                      Same phone number     -> Possibility increase by two.
  367.                      Same birthday         -> Possibility increase by two.
  368.  
  369. ** I              :  Show the note on the current user.
  370.                      BUEd has an internal database where you can store
  371.                      notes about your users. Ie. their membership type,
  372.                      references, your new-user question form and so on. 
  373.                      The maximum size of the note is 2048 bytes.
  374.  
  375.  
  376. ** ALT-I          :  Edit the note on the current user.
  377.                      Here you can edit a note or make a new one.
  378.                      
  379.                      1. Edit user note: Use your favorite editor to make
  380.                         or edit the note on the current user.
  381.  
  382.                      2. Import user note: Import a user note from a ASCII
  383.                         TXT file.
  384.  
  385.                      3. Delete user note: Delete the note on the current
  386.                         user.
  387.  
  388.                      4. Clean up BUED.DAT: Use this function to erase notes
  389.                         on users that no longer are in the BBBSUSR.DAT. 
  390.                         (Killed users that are in the userrecord will
  391.                         still have their notes intact until they are removed
  392.                         from the userrecord with BBBS BPUS)
  393.  
  394.  
  395.  
  396.   Movement keys:
  397.  
  398.    PgDn           :  Displays the next user.
  399.  
  400.    PgUp           :  Displays the previous user.  
  401.    
  402.    Home           :  Displays the first user. (Probably you)
  403.  
  404.    End            :  Displays the last user.
  405.  
  406.    RightArrow/     
  407.    RButton        :  Displays the second option screen.
  408.  
  409.    LeftArraw/      
  410.    RButton        :  Displays the first option screen.
  411.  
  412.    DownArrow      :  Moves the option marker one step down.
  413.  
  414.    UpArrow        :  Moves the option marker one step up.
  415.  
  416.  
  417.  
  418.   Action keys:
  419.    
  420.    Enter/LButton  :  Allows you to change the value of the marked option
  421.  
  422.    Space/RButton  :  This is only used in the sysop access option and the
  423.                      bulk processing. It toggles the highlighted value 
  424.                      in the list on/off.
  425.  
  426.    Delete         :  Sets the current user's status to KILLED. 
  427.    
  428.    Insert         :  Sets the current user's status to ACTIVE.
  429.  
  430.    ESC            :  1. In the second option screen -> Return to the first 
  431.                         option screen 
  432.                      2. In the first option screen  -> Exit program    
  433.                      3. In changing a value         -> Abort change
  434.  
  435.  
  436.  
  437.  
  438.  4.5    Changing values
  439. -------------------------
  440.  
  441.   There are three ways of altering values in BUEd:
  442.   1. Entering a string or a number directly.
  443.   2. Selecting a value from a pick list.
  444.   3. Toggling values.
  445.  
  446.  
  447.  
  448.  4.5.1  Entering numeric or string values.
  449. --------------------------------------------
  450.  
  451.   To change values as address and lines in screen just select the
  452. option and enter the value. The program will not allow you to enter
  453. an illegal value.
  454.   To avoid the change press ESC
  455.  
  456.  
  457.  
  458.  4.5.2  Selecting values from a pick list.
  459. -------------------------------------------
  460.  
  461.   To change values like grabfile format and terminal emulation you 
  462. select the option and you will be presented with a pick list with the 
  463. current value highlighted. 
  464.  
  465.   Use the arrows or the mouse to select the new value and press enter 
  466. to select it. If you don't want to change the value press ESC.
  467.  
  468.   In most pick list you can only select one value, but in some you can 
  469. choose several using the SPACE button. These two are the sysop access
  470. option and the bulk processing. (For an explanation on how to use the 
  471. bulk processing refer to section 4.4 - F5. )
  472.  
  473.  
  474.  4.5.2.1 The sysop access value.
  475. -----------------------------------
  476.  
  477.   When you select the sysop access option, you will be presented with 
  478. a pick list with 8 options. Here you can grant and revoke sysop rights to
  479. users by toggling the options with the SPACE key, or the right mouse 
  480. button. The appropriate value will be calculated when you end the selection
  481. with ENTER or the left mouse button.
  482.  
  483.   At the time of release there are two undefined sysop access levels.
  484.  
  485.  
  486.  
  487.  4.5.3  Toggling values.
  488. --------------------------
  489.  
  490.   In options as conference status at login and menu level there are only
  491. two possible values, and you can toggle between them by selecting the 
  492. option and press ENTER or use the mouse to click on the option value. 
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  4.6    The MD5 checksums
  499. -----------------------------
  500.  
  501.   As a security routine BBBS has an internal test of the userrecords.
  502. This MD5 routine check the userprofile against a checksum and if the 
  503. profile doesn't match the checksum BBBS revoke the user's sysop   
  504. priveleges. 
  505.  
  506.   The problem has been apparent in every BBBS usereditor I have tried, 
  507. and results in nasty messages as this one:
  508. ******** WARNING: TAMPERED USERREC WITH SYSOP ACCESS (xxxx xxxxxxx)*******
  509. There is no danger in this message if it is YOU who have altered the
  510. profile, but if not.....
  511.  
  512.   
  513.   
  514.   THESE FALSE WARNING  MESSAGES DOES NOT LONGER APPEAR IN BUEd IF YOU 
  515. HAVE SET THE SYSTEM UP PROPERLY AND HAVE A REGISTRERD VERSION OF BUEd!!!
  516.                                            ----------
  517.   
  518.   My thanks to the author of BBBS, Kim Heino, for allowing me to use BBBS'
  519. MD5 routine.
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  5.0    Known bugs.
  530. =====================
  531.  
  532.  There are some known bugs in the program that can't easily resolved:
  533.  
  534.    * You can not edit a user that is currently on-line.
  535.  
  536.  If you find any other bugs, or have comments/suggestions to improvements
  537. please contact the author at the addresses below.
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  6.0    Registering and contacting the author. 
  549. ================================================
  550.  
  551.   BUEd is E-Mail/NetMailware and is free of charge. The reason I want
  552. you to register, is that I then will have an idea if my program is 
  553. being used by anyone. If people register I'm more likely to be 
  554. encouraged to improve the program and provide you with updates.
  555.  
  556.   Registered users will get updates sent to them by E-Mail.
  557.  
  558.   So if you want to get rid of the silly delay just fill out the 
  559. registration form and send it to:
  560.  
  561.   E-Mail    :   slovas@sn.no
  562.                 snorre@skribenten.bbs.no
  563.   FidoNet   :   Snorre L¢vås 2:212/24
  564.  
  565.   
  566.   Remember to include a return address so I may send you the registration
  567. key.
  568.   
  569.   Use the same addresses if you have comments/suggestions/bug reports, or 
  570. just want to get in touch with me :)
  571.   (Will be greatly appreciated)
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  7.0    Credits.
  583. ==================
  584.  
  585.   I wish to thank the following people:
  586.  
  587.   My beta-testers, Kristoffer Resellmo and ¥yvind Hallsteinsen.
  588.  
  589.   Morten Vold for helping me... 
  590.  
  591.   Thomas Johnsen for helping me with implementing the MD5 checksums,
  592.   and for porting BUEd to OS/2.
  593.   
  594.   Kim Heino for making the BBBS system, and revealing to me the dark
  595.   secret of BBBS MD5 routine. 
  596.  
  597.   -- end of document --
  598.