========================================== ulist v1.00 -- DLG(tm) User List Generator Documentation - June 26, 1993 - ========================================== Copyright (c) 1993 by Sam Yee. All Rights Reserved. ====================================================================== COPYRIGHT ========= The program, ulist and its documentation are written and copyrighted by Sam Yee. ulist may be distributed freely providing the following restrictions are satisfied: o Distributors may not charge more than the cost of a diskette used in the distribution of this program. o Distributors may only distribute the unmodified copy of the original program, along with its documentation, and copyright notices intact. o Commercial distribution is only possible with written permission from the author. ====================================================================== DISCLAIMER ========== This program and its documentation are provided "as is". No warranties are made with respect to the accuracy, reliability, performance or operation of this software and information. You are using this program at your own risk. The author is not liable for any damages that may have been caused by using this software. ====================================================================== INTRODUCTION ============ ulist is a user list generator for DLG(tm). It operates much like the AmigaDOS command "list", but with users instead. ulist searches through DLG's USER: directory looking for the users you named. You can list more than one user per execution of the program. User names may contain AmigaDOS wildcards. For the user listing, you can optionally sort it in ascending or descending order. The output format can be be fully configured. ====================================================================== REQUIREMENTS ============ This program runs on any Amiga(tm) with version 2.04 of the OS. Also, TelePro's DLG(tm) BBS software is required. This program has been tested with DLG v.995, but it should work with any version. ====================================================================== INSTALLATION ============ You must put ulist and its accompanying files into the assigned directory called DOORS:ASI. DOORS: is the proposed directory for doors (or BBS utilities) used by many system operators and door programmers. ASI is a directory where you should put the BBS or telecommunication utilities written by me. You should also create several directories within DOORS:ASI. However, when you "un-LHA" the archive it will create some of these directories for you. The directories are: DOORS:ASI/bin/ -- Where all executable files go. DOORS:ASI/config/ -- Where all configuration files go. DOORS:ASI/data/ -- Where all the data files go. DOORS:ASI/doc/ -- Where all the documents go. DOORS:ASI/help/ -- Where all the help files go. DOORS:ASI/key/ -- Where all the key files go. DOORS:ASI/script/ -- Where all the scripts go. DOORS:ASI/text/ -- Where all other text files go. DOORS:ASI/user/ -- Where all the data for users go. The files pertaining to ulist are as follows: bin/ulist -- ulist exectuable program doc/ulist.doc -- what you are reading now ====================================================================== USAGE ===== ulist uses a standard AmigaDOS command template. The template is "USER/M,SORT/S,REVERSE=DOWN/S,NOHEAD/S,LFORMAT/K". "ulist ?" will display the template, and then you'll be able to enter the arguments at the prompt. Each argument are described as: USER/M This keyword specifies the list of user names to look up. The presence of the keyword is optional, and is implied. Example: "ulist john#? smith#? joe_sixpack" will list all users with first name John, or last name Smith, or Joe Sixpack. SORT/S If this keyword is present, the output listing is sorted, with default ascending order. Sorting is currently only done on the first field of the output. Example: "ulist john#? sort". REVERSE=DOWN/S If the SORT is specified and either REVERSE or DOWN keywords is specified, the output will be sorted in descending order. Example: "ulist (john|joe)#? sort reverse". NOHEAD/S This keyword determines if the header and footer should be output. The header is 'Directory "USER:" on ", and the footer is " users". Example: "ulist ~(joe#?) nohead". LFORMAT/K This keyword allows you to specify the output format of the user listing. The flags are discussed below. The default list format is "%15NAME %10ALIAS %-3LEVEL %-14PHONE %LASTCALL %-3CALLS". Example: 'ulist lformat "%NAME %ALIAS %PHONE"' will display the users' real names, aliases, and phone numbers. ====================================================================== OUTPUT FLAGS ============ Flags (or switches) may contain formatting codes. The formatting codes and flag are defined as "%[-|0|.][]". The '-' stands for left-justification, '0' pads 0s before a numerical flag (e.g., "%CALLS"), and "." to truncate the flag to characters, and is of course the width of the flag. Examples: Suppose %CALLS reports 123, and %NAME reports Sam Yee. Example 1: %NAME => "Sam Yee" %2NAME => "Sam Yee" %10NAME => "Sam Yee " Example 1: %-NAME => "Sam Yee" %-10NAME => " Sam Yee" Example 2: %0CALLS => "123" %05CALLS => "00123" Example 3: %.NAME => "Sam Yee" %.4NAME => "Sam " Supported DLG Flags ------------------- %NAME Full name %FIRST First name %LAST Last name %UNAME Underscored name %ADDRESS Address %CITY City %PROVINCE Province %COUNTRY Country %POSTAL Postal Code %PHONE Phone number %BYEAR Birth year %BMONTH Birth month %BDAY Birth day %AGE Age %JOINED Date Joined %LASTCALL Date of last call %CALLS Number of calls %ALIAS Alias %PASSWORD Passwd %COMPUTER Comp type %LEVEL Usr Level %SCLEGNTH Screen legnth %SCWIDTH Screen width %HELPLVL Help level %PROTOCOL DL protocol %SYSPAGES Sysop pages %DAYLIMIT daily limit %SESLIMIT session limit %DIRLIMIT size of users allowed private dir %MSGENTER messages written %MSGREAD messages read %BYTESUP bytes uploaded %BYTESDN bytes downloaded %FILESUP number of files uploaded %FILESDN number of files downloaded %RATIO Up/Down ratio limit %LASTMSG last message area visited %LASTFILE last file area visited %PORT port %BAUD baudrate %CREDIT netmail credits %NETPRIV netmail privaledges %UUCP uucp status %ANSI ansi status, (color or mono) %DATE current date and time This list is copied right out of PortManager.doc, so some flags (e.g., "%PORT") don't make sense. ====================================================================== PRODUCTS RELEASED AND UNDER DEVELOPMENT ======================================= Released: - ECopy v1.00 (Hard/floppy drive utility with space "optimization"). Can be used for making backups. A must-have for pictures/mods/utilities collectors! Freeware. - TeleWho v1.00 (DLG(tm) BBS utility) Freeware. - TelePage v1.00 (DLG(tm) BBS utility) Freeware. - RawIN.lib v1.10 (Input handling library for BBS door programmers) Freeware. - Multi-Talk v0.93 (Multi-user teleconference system) Shareware. - TeleReg v1.00 (User registry (and others) database allowing concurrent users)  Shareware. - IfAge v1.00 (DLG(tm) Age Checker) Freeware. - GateTerm v1.00 (CLI Terminal/Outdialer) Shareware. - TeleVal v1.00 (DLG(tm) Call Back Verifier/Validator) Shareware. - NovPack v1.00 (Package of novelty programs) Freeware. - PortManager v1.00 (DLG(tm) Port Management) Shareware. - ulist v1.00 (DLG(tm) User Listing Generator) Freeware. Under Development: - TeleBank (DLG(tm) BBS utility, a time/credit accounting system) - *top secret* projects :-) ====================================================================== TRADEMARKS ========== Amiga, and AmigaDOS are trademarks of Commodore-Amiga. DLG is a trademark of TelePro Technologies. ====================================================================== CONTACT ======= Questions, ideas, comments, bug reports, etc. should go to: Home Address: Sam Yee 4595 Nanaimo St. Vancouver, B.C. Canada V5N-5J5 Internet: samy@sfu.ca FidoNet: 1:153/765 (Terra Firma BBS 1-604-434-3665)