Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / UEDIT204.ZIP / UEDIT.DOC < prev next >

Wrap

Text File | 1993-01-25 | 21.6 KB | 502 lines

█████ █████ ██████████ ████████ ███████ ███████████ ███░░ ███░░ ███░░░░██░ ███░░░████ ░███░░░ ░░░███░░░░░ ███░ ███░ ███░ ░░ ███░ ░███ ███░ ███░ ███░ ███░ ██████ ███░ ██░ ███░ ███░ ███░ ███░ ███░░░░ ███░ ███░ ███░ ███░ ████ ████░░ ███ ██ ███░ ████░░ ███░ ███░ ░██████░░░ ██████████░ ████████░░░ ███████ ███░ ░░░░░░ ░░░░░░░░░░ ░░░░░░░░ ░░░░░░░ ░░░ UEDIT v2.04 for WWIV version 4.22 or greater Copyright (C) 1990-1992 by Jon R. Rickher All Rights Reserved ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ Table of Contents ═-═-═-═-═-═-═-═-═ 1) What UEDIT Does . . . . . . . . . . . . . . 2) Files Included with UEDIT . . . . . . . . . 3) System Requirements . . . . . . . . . . . . 4) Setting Up UEDIT. . . . . . . . . . . . . . 5) Starting UEDIT. . . . . . . . . . . . . . . 6) Commandline Parameters. . . . . . . . . . . 7) Using UEDIT from within WWIV. . . . . . . . 8) Modifying WWIV to Run UEDIT Easily. . . . . 9) Using UEDIT . . . . . . . . . . . . . . . . 10) Registration. . . . . . . . . . . . . . . . 11) Dedication. . . . . . . . . . . . . . . . . 12) Suggestions?. . . . . . . . . . . . . . . . 13) Last Word . . . . . . . . . . . . . . . . . ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 1) What UEDIT Does ══════════════════ UEDIT is a standalone executable file for WWIV that makes some tasks related to the maintenance of the USER.LST file easier, more efficient, and more pleasant. There are four primary uses for it: viewing, searching, printing, and editing. It will work with any WWIV, version 4.21A or greater. It is possible to completely strip out the built-in user editor and replace that capability with UEDIT.EXE and save considerable code space, if you do not have remote sysops. Even if you do have remote sysops, using UEDIT is definitely worthwhile, as it offers ease-of-use and features far beyond the internal user editor. For those who multitask their systems, UEDIT is even more useful as you can edit user entries while someone is online, without them being able to see a thing. Not to mention being able to search for that suddenly-needed phone number, etc. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 2) Files Included with UEDIT ════════════════════════════ There are at present five files included with this package, as follows: UEDIT .DOC : This documentation file. UEDIT .EXE : The executable editor itself DU .C : Source for small program you compile with your VARDEC.H if you have the FROM modification installed DU32 .EXE : Use if you have stock 4.21A userrec with 32 msg bases DU64 .EXE : Use if you have stock 4.21A userrec with 64 msg bases ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 3) System Requirements ══════════════════════ To run UEDIT you need the same basic system requirements as you do to run WWIV, but a color monitor is highly desirable. 640k is necessary to run it without shrink from the main menu prompt or from the WFC screen, with the appropriate source code modifications installed of course. In DOS, UEDIT requires about 300K. UEDIT supports a mouse if you have one, but is just as easy to use without one. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 4) Setting Up UEDIT ═══════════════════ Place UEDIT.EXE in your main WWIV directory (it needs to find and read the WWIV file CONFIG.DAT). In addition, place DU.EXE there as well. This will either be a DU.EXE that you compiled yourself using the DU.C source file or the DU.EXE that comes with UEDIT. I suggest that you do compile DU.C into DU.EXE yourself, using your own VARDEC.H, especially if you have done many modifications. If you compile DU.C to DU.EXE yourself, you should use the large memory model. You may get a warning. Ignore it; it isn't a problem or anything to worry about. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 5) Starting UEDIT ═════════════════ Execute the program by going to the directory containing UEDIT.EXE and type UEDIT followed by an [Enter]. If UEDIT determines that your userrec structure is supported then it will load properly, else it will abort and tell you that it isn't a supported userrec. The size of your userrec is located in the file CONFIG.DAT. This is how UEDIT determines which structure to use. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 6) Commandline Parameters ═════════════════════════ UEDIT supports the following optional commandline parameters: /A<int> Where <int> is a number from 0 to 255. This will be used as the attribute for the backgrond character. Default is 57. /C<int> Where <int> is a number from 0 to 255. This is the ordinal value of the background character you wish to use. (3 is a heart, 32 is a space, 177 is a medium shaded block, etc). Default is 177. /D<int> Where <int> is a number from 0 to 65535. This value determines the cutoff point in days since last called, for users that will be shown in subdued cyan (rather than red for deleted users, or bright cyan for "normal" users). Default is 90 days. /E<char> Where <char> is a letter from A to P, representing an AR that exempts callers from being purged, no matter how long it's been since they called. /S Sound effects for exploding windows. Default is no sound effects. /U<usernum> Start UEDIT with user # <usernum> loaded. Default is user #1. /V##-## Where ##-## is a range of security levels to purge (this parameter is intended for use with the /Z parameter, obviously). /X Enable exploding windows. Default is no exploding windows. /Z Purge userlist based on the number of days since they called (either 90 days or the value defined with the /D option), and will not exempt users with the AR specified with the /R option (if any). This feature only works in the registered version. If using the unregistered version, then UEDIT will load completely, as normal. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 7) Using UEDIT from within WWIV ═══════════════════════════════ While UEDIT may run fine from 'F' at WFC, or SHift-F10, or //DOS, it is primarily designed to run from WWIV's shrink or as a standalone utility. If you wish to use it remotely you will need to use a utility such as DOORWAY or PC Anywhere, that allows intercepting direct screen writes. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 8) Modifying WWIV to Run UEDIT Easily ═════════════════════════════════════ If you have a registered copy of the WWIV source code, you may install the following modifications (or modifications of THESE modifications) to run UEDIT from WFC. Search for the following lines in BBS.C (with ^Q^F using the TC editor): case 'Z': if (ok_local()) { zlog(); nl(); getkey(); } break; Add the following lines after the above lines: case '=': if (ok_local()) { holdphone(1); shrink_out("UE",0,0,0,1); } If you are using the Borland C++/Turbo C++ Integrated Environment, then you can now hit F2 (to save your BBS.C file) and F9 (to recompile a new BBS.EXE file). After this is accomplished, you will be able to run UEDIT.EXE from the WFC screen by hitting the '=' key. To add it to the main menu prompt, do the following modification: Find the following lines in BBS.C: if (strcmp(s,"CLS")==0) outstr("\x0c"); Add the following lines after the above: if ((strcmp(s,"UE")==0) && (so())) { shrink_out("UE",0,0,0,1); } Hit F2 to save and F9 to recompile and you will be in business. Once this small modification, you will need to create a UE.BAT file (this is what both of the above shrink calls will execute). Inside this file, do something like this: @Echo Off C: Cd\WWIV UEDIT /X /S /A56 /C176 /D120 /U%1 ^Z The above example would use exploding windows which "squeak" when opened or closed, would use a "heavy" block character as the background character, the background character would be shown in green on cyan, all callers who haven't called in over 120 days would be shown in muted cyan, and the user entered on the commandline would be loaded. (For instance UE 3 would start on user #3, etc.) Of course, you can remove any of the commandline parameters if you do wish to use the default features. This batch file will allow you to type in "UE usernumber" at any DOS prompt to start and load that user number's account (or default to the #1 account if there is no parameter). This file should be placed somewhere in your PATH. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 9) Using UEDIT ══════════════ Immediately after executing UEDIT.EXE, you will be shown a screen that contains two windows. On the left window will be a series of user handles and account numbers. These may be different colors, depending on that user's account. The colors mean the following: BRIGHT CYAN on BLUE = Normal account. DULL CYAN on BLUE = Has not called in over 90 days (or the number specified by the /D (or -D) commandline parameter. YELLOW on BLUE = Security Level of 100 or greater. BRIGHT RED on BLUE = Deleted account. On the right side of the window will be a window showing you some of the more vital statistics about the user on which the scroll bar is located. At the bottom is a copyright notice and an indicator that F1 gets you help. Most of the commands are fairly self-explanatory, but I will detail them. IMPORTANT! One thing you NEED to remember is that Control-ENTER saves edit changes, ESC aborts them. Options with an asterisk next to them are only available with the registered version. BROWSE MODE Commands: F1 : Help screen showing commands available at this level. ESC : Quit (with prompt). ENTER : Go into EDIT MODE. * Alt- : Search downwards for any account that fits the current search specification. * Alt= : Search upwards looking for any account that fits the current search specification. Alt1 : Go straight to the #1 account and go into EDIT MODE. * AltA : Add a specified number of new user accounts. AltB : Brings in (imports) saved Search Spec. Of course, this will produce an error message if you have not previously saved one with the AltW command. This is handy, allowing you to save your most commonly used search specification. * AltC : Redefine colors for all users who match the current search specification so that they match the colors of the #1 account. AltD : Delete the current account. Note: DU.EXE *must* be in the main WWIV directory for this to allow the mail and voting records to also be deleted. * AltE : Exchange the current account with another one you select. AltF : Fix (restore) a deleted user account. AltG : Go directly to a specified user account number. * AltM : Calculate number of users that match current search specification. AltO : Shell to the operating system, leaving only a small kernel in memory (about 7-10K). * AltP : Print some information about all users who match the current search specification, to a file called UINFO.TXT, which will be in the main WWIV directory (or the directory where you first executed UEDIT.EXE, actually). You may specify long or short information; long (obviously) has more detailed information. Short info contains minimal information, primarily for use in validations. If you have the FROM modification installed, then you may also specify [M] for mailing list - this will print out the mailing address infor- mation for the users who match the search spec. AltR : Perform the equivalent of WWIV's //RESETF function. Rebuild the file NAMES.LST based on the current status of the USER.LST file. Because of the in-memory sorting technique used, this function boosts memory requirements somewhat (but if you've shrunk out to UEDIT, it doesn't much matter). AltS : Define a search specification. This is *quite* a powerful tool, and quite fast as well. The default search specification will find *everyone*. AltW : Write out (export, save) the current search specification. This is saved to a file called UEDIT.SCH, and will be located in the dir from which UEDIT was originally executed (generally the main WWIV directory). AltX : Quick exit, no prompt. * AltZ : Zap (purge) user accounts (registered version only). This function goes through the entire user file, deleting anyone who matches the currently defined search specification. If you have a mouse then you may click on the scroll bars to move through the user list. Double-clicking on a handle in the right window will put you into EDIT MODE with that user's account. The right mouse button serves as an ESC key, and pressing the right mouse button twice will quit you out of UEDIT. EDIT MODE Commands: F1 : Help screen showing available EDIT MODE commands. * Alt- : As above, but you remain in EDIT MODE. * Alt= : As above, but you remain in EDIT MODE. * AltA : As above, but you remain in EDIT MODE. AltB : As above, but you remain in EDIT MODE. * AltC : As above, but you remain in EDIT MODE. AltD : As above, but you remain in EDIT MODE. * AltE : As above, but you remain in EDIT MODE. AltF : As above, but you remain in EDIT MODE. AltG : As above, but you remain in EDIT MODE. * AltM : As above, but you remain in EDIT MODE. AltO : As above, but you remain in EDIT MODE. * AltP : As above, but you remain in EDIT MODE. AltR : As above, but you remain in EDIT MODE. AltS : As above, but you remain in EDIT MODE. AltW : As above, but you remain in EDIT MODE. AltX : As above - quits you out with no prompting. * AltZ : As above, but you remain in EDIT MODE. TAB : Move to the next field. ENTER : Move to the next field. ^HOME : Move to the first field (user handle). ^END : Move to the last field. ^LeftCursor : Move down one user, remain in EDIT MODE. ^RightCursor : Move up one user, remain in EDIT MODE. The last two commands listed above allow you to use EDIT MODE itself as a form of user list browser, if you're more comfortable staying in EDIT MODE. In EDIT MODE you may click on any field to edit. There are so many fields to edit that may not fit on the entry screen at one time. But that's okay, since it scrolls for you automatically, as needed. You may use the cursor keys to move around the various fields as well. In 50-line mode, using an unmodified 32- or 64-msg base userrec, all editable fields *do* fit on the screen simultaneously. In general, trailing and beginning spaces are trimmed from each field. The exceptions are the handle, real name, password, callsign, macro fields: with these fields, the trailing spaces are trimmed, but leading spaces are not. However, when using macros it is preferable to use TABs (^P^I will embed a TAB) to do spacing. One field, age, is protected. You may not edit this field directly. It is altered by changing the user's birthday; when you edit the birthday, the age field is automatically updated for you. When editing any of the string fields (macros, whatever), you may use the standard ^P sequence to get keys that you couldn't normally type (such as ^P itself, TAB, ENTER, ESC, etc.). The bottom of the screen when in EDIT MODE shows you a short description of the field the cursor is currently on. The bottom if the edit window shows you the handle of the current user and how many days it's been since he/she was last on the BBS. When editing colors, the space bar or + key will cycle the color up by a value of 1. Using the - (minus) key will cycle the background colors. The sex and status (deleted, inactive, normal) are toggled with the space bar. Note: while UEDIT's AltR command does indeed rewrite NAMES.LST for you (which is what WWIV's own //RESETF command does), WWIV will not have updated information when returning from a shrink since it does not reread NAMES.LST, so it is best to do WWIV's own //RESETF if you have A) deleted anyone, B) changed anyone's handle or C) exchanged one or more user accounts. Also, while UEDIT will handle up to 65,535 user accounts, I suggest you not exceed 10,000. (And this really should not be a problem - I don't know of *any* WWIV board with even a third that many user accounts, and many boards have been up for several years.) I also don't think WWIV itself would deal with more than 10,000 user accounts very adequately. If this ever becomes a problem for anyone, let me know, and I will expand a bit. SEARCH SPEC DEFINITION This is the area where you define the search specification you wish to use. Other than the obvious data entry commands for defining the search spec, ESC to abort the search specification edit, and CONTROL-ENTER to save it, two other commands are available at this level: AltB : Retrieve (bring in) a saved search specification. This will get you an error beep if you haven't saved one to disk with... ALTW : Save (write) the current search specification to disk. This is so that if you use a specific search specification a great deal of the time you don't have to redefine it each time. The search spec is written to disk as UEDIT.SCH in the directory that you first started UEDIT from. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 10) Registration ════════════════ This program is ShareWare. Use beyond a two-week trial period requires that you register it - hey, it's taken me literally YEARS to get it this way; my time is surely worth a little something and it pays to support ShareWare authors. If no one ever registers, then why should I release upgrades and improvements? Show me that it's worthwhile to do so. Besides, considering the amount of time I have invested here, the cost is pretty minimal. What does registration get you? It gets you my undying gratitude - okay, $20 worth of undying gratitude anyway <grin>. And, of course, it gets rid of the irritating reminder beeps and enables all disabled features, several of which are pretty nice things to have. AND you can brag to your friends about how you actually registered something (but don't give 'em a heart attack or anything). And, as if all that weren't enough, it'll keep me writing and releasing other quality WWIV utilities. To register, send $20 to the following address: Jon R. Rickher c/o The Fellowship 7035 Ethel St. Louis, MO 63117 If you wish UEDIT to be mailed to you, specify what format (360k or 720k), and include an addition $5 US ($10 US if you're not in the United States). This also applies to upgrades. In other words, it is my strong preference that you get an account on The Fellowship (314-644-5777 USR Dual Standard) and get your updates whenever it's convenient for you. This will be easier on me and cheaper for you. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 11) Dedication ══════════════ This program is dedicated to £ady Sƒ, for her many good suggestions, and her help in running our board. I never could've done half this without her help, patience, and devotion. She believed in me before I believed in myself. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 12) Suggestions? ════════════════ Any questions, or suggestions for enhancements may be directed to WWIVNet address 1@3456. I'd be quite happy to hear from you - no kidding! I've added many things at peoples' request. I don't add things that are only applicable to a small minority of people, but additions that are useful to most people, or even many people, are generally added. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 13) Last Word ═════════════ My thanks to the many, many people who have made WWIVNet an enjoyable experi- ence for us here. Let us continue to make this a fun thing to do! Tolkien, 1@3456, January 15, 1993 ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■