ftp.update.uu.se

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

/ ftp.update.uu.se / ftp.update.uu.se.2014.03.zip / ftp.update.uu.se / pub / rainbow / msdos / misc / wdir12.lzh / WDIR.DOC < prev

Wrap

Text File | 1986-01-31 | 36KB | 1,057 lines

# # # #### ###### # # # # # # # # # # ####### # # # # # # # # # # #### ###### AV Software Designs, Ltd. _________________________________________________________________ 646-1 University Avenue, Rochester, NY, 14607-1232 (716)-461-2446 1.0 - PACKAGE INFORMATION AT A GLANCE Package - DEC Rainbow Archive Package #14 Program - WDir - W(indow)Dir(ectory) Version - 1.2PD Author - Alan I. Vymetalik for AV Software Designs, Ltd. Date - January 31, 1986 System - DEC Rainbow 100/A/B/+/190 MS-DOS Version 2.05 or above Memory - 128K minimum Other versions are available Language - TurboPascal Version 3.01A All documentation, sources, and programs - Copyright (c) 1985, 1986 by AV Software Designs, Ltd. 2.0 - WDIR VERSION 1.2PD USER'S MANUAL 2.1 - WDir Features WDir Version 1.2PD uses high-speed video, advanced keyboard scanning, efficient memory management, and scrolling and pop-up window-style displays to manage and display a sorted directory of the path specified on the command line or of selected directories chosen while in WDir. WDir was developed due to frustration of the lack of a proper DIR command and the slow speed and cumbersome efforts under MS-DOS to get a sorted directory listing. You had to twiddle with column parameters until you were sorting on the correct columns; counting and poking at the screen. This was all very time-consuming, a general pain and didn't LOOK good. All that was wanted was a look at a directory or sub-directory of a disk but everything on the screen just got scrolled away! WDir contains a number of sophisticated sorting and display capabilities and allows recursive searching of the disk's directory structure. You can sort the directory listing on any of the directory fields and you get total file counts and file space counts. In addition, you get information about the disk's storage and remaining space. Also, you can use WDir to get repeated directory listings of disks without returning to MS-DOS. Simply swap in as many disks as desired and press the DO and PRINT SCREEN keys. Page 1 2.2 - Program Details, Requirements, and Set-Up Instructions WDir V1.2PD contains enhancements and fixes to bugs that were discovered after the release of prior versions of WDir. These enhancements include a more uniform user-interface, corrected printer status checking, and code optimization. 2.2.1 - Required Hardware and Hardware Incompatibility WDir requires the use of a standard DEC Rainbow 100A, 100B, or 190 system. A standard system includes the system unit, LK201 keyboard, VR201 or VR241 monitor, any combination of floppy disks, hard-disks, and RAM disks, and any DEC-approved printers. The color monitor may be used in conjunction with WDir as long as it being used in text mode. WDir does not handle graphics mode (at this time) and, while it will work, nothing will be dis- played on the screen if graphics mode is on. The main reason for this is the use of the advanced, high-speed video features available in VT102-mode that aren't available in graphics mode. 2.2.2 - Directory Limits The directory can contain up to 512 files taking up to 99 megabytes of disk space for the disk in whole or the directory in particular. In practice, of course, MS-DOS handles much less disk space per partition and directories over 256 files are generally unwieldly. 2.2.3 - Memory Requirements WDir requires at least 128K of RAM to run due to the need of having a fairly large sort work area, the code of WDir and the operating system in memory at the same time. Other versions may be available by writing to the above address and describing your application. 2.2.4 - Distribution and ARChiving Method WDir.COM and the companion WDir.DOC (and any addendum files) are distributed in an 'archived' file called WDIR.ARC which was created using ARC V4.5 from System Enhancement Associates. If you are viewing this file using ARC, make sure you have at least version 4.5 to de-archive the files. If you received WDir in archived format, follow the intructions on how to use ARC from ARC.DOC. If you received them as normal files then ignore the above. 2.2.5 - Set-Up and Helpful Hints Copy WDir's files from the public-domain distribution disk to your working MS-DOS master disk or your utility directory that is being referenced by the MS-DOS command PATH or the public domain PATH-like SEARCH. Remember to always backup your programs and make sure the master disks have write-protect tabs. While all attempts have been made to make WDir as fast as possible, following the above suggestions along with placing WDir on a hard-disk or RAMDisk (if either is available) will sig- nificantly speed up operation over that of a floppy disk. Page 2 2.2.6 - Incompatibility With Other Software WDir should not be running while interrupt-sensitive back- ground processes, like printer-spoolers, are running. WDir takes over some interrupts during its operation and should you be running such a process, issue another Active Command (see below), and MS-DOS will catch up on its I/O requests. Memory-Resident programs, like SEARCH, should have no effect on WDir's operations. DPath, on the other hand, may cause problems when you're printing a file containing the view of the current directory. It may go to the path specified by DPath and not necessarily where you wanted it to. If the user discovers any software compatibility problems, please notify AVSD, Ltd. at the above address 2.2.7 - Recursive Scanning of Directory Structures WDir allows you to recursively select up to 10 different levels of directory information. You must leave your original disk in while scanning the directory structure or risk being forced out of WDir. This and the recursive limit are implemented to maintain memory security, efficiency and headaches on your part while still offering flexibility. You may, of course, switch disks when you reach the 'root' level of the disk. When you select a new directory (via the FIND function key), you may give WDir a new filename mask (e.g. *.COM) so that WDir only looks for those particular files when it scans the new directory. You'll enter the new directory and find it sorted on the sort field as the previous level. If you want to change the sorting, invoke the Sort Options command with the SELECT function key. Upon returning to the previous level, all previous sorting and listing options have been remembered. 2.3 - Command-Line Arguments WDir supports a variety of sorting options and pathname/ filename combinations. The switches and pathnames are order- independent. 2.3.1 - Invoking WDir Via the MS-DOS Command Line To invoke WDir, enter on the command line: E> WDIR [/a[adshr]defhsty] [drv:][path][fn(s)?*] where the following sort switches are: /a - by file attribute setting using the following sub-switches: a - by archive attribute d - by directory attribute s - by system attribute h - by hidden attribute r - by read-only attribute /d - by date /e - by extension /f - by filename (default) /h - command-line help information /s - by file size Page 3 /t - by time /y - by day of the week and the other parameters are: [drv:] - optional drive letter (A-I) and the colon (actually, the last available drive that MS-DOS sees will be the upper limit) [path] - optional path up to 64 characters. Items that can be included are the backslash and specific pathnames like '.' and '..' [fn(s)(*?)] - optional filename or filenames with embedded asterisk '*' and question mark '?' wildcards permitted. 2.3.2 - Optional Parameters and Parameter Syntax Each of the following parameters are optional: drive, leading path, and filename(s). If none are selected, the current directory is viewed. Wildcard characters (* and ?) are pemitted in the filename. If no sort switches are used, WDir sorts on the the 11 character file name. Also, note that the switch and pathname can be in any orde on the command line and the switches can be in upper and/or lower case. But, if the sort switch follows the pathname, please in- clude at least one space between them. 2.3.3 - Sorting Conventions WDir sorts directories on pre-assigned fields. Please note that these conventions are employed at the Command-Line and Active-Command interfaces. The following secondary sorting schemes are currently implemented: Sorting on the filename Extension will use the first 8 characters of the filename. Sorting on the Day-of-the-Week field will use the date field as the secondary sorting parameter. Sorting on the Date field will use the Time field as its secondary sorting field. All other sorting fields use the full 11 characters of the filename as the secondary sorting field. Please note that only a maximum of two levels of sorting are done. This may produce, at times, strange looking sorted direc- tory listings. Please refer to the above rules to orient your- self. 2.3.4 - Command-Line Parameter Examples Note that the symbol 'E>' represents the MS-DOS Command prompt. Do not enter this with the WDir command. (1) E> wdir f: Page 4 This is the default version of WDir which sorts the current directory on drive F: by the 11 character filename (12 characters if you consider the period). (2) E> wdir/E This will sort the current directory by the extension of the filename. The secondary field for sorting is the first 8 characters of the filename. (3) E> WDIR f:\foobar\bigfoo /d This will sort the directory \foobar\bigfoo on drive F:. The directory will be sorted by the date field. (4) E> wdir/y b:*.com This will sort only the .COM files in the currently activated directory on drive B: by the day of the week field. The secondary field will be the date field. (5) E> wdir c:\ /aD This will sort the root directory on drive C: by the directory attribute. All directories will appear at the end of the listing. 2.3.5 - Command-Line Mode Error Communication If an incorrect switch or illegal path or filename is specified on the command-line, a help window will appear with information to aid you in re-entering the command correctly. This window will also appear in response to the '/h' switch. 2.4 - Active Commands WDir supports two methods of command control, one as mention- ed above under Command-Line Arguments, and another using the special function keys of the Rainbow. The two sets of commands are exclusive and cannot be used interchangeably. The Active Commands are available only after WDir has been executed and the directory display is on the screen. 2.4.1 - Active Command Descriptions Once WDir is up and has displayed the current directory, the following function keys are available for use: 2.4.1.1 - Function Key: HELP Displays a pop-up help window to remind the user of the available Active Commands. Commands marked with an asterisk, '*', denote that those function keys also can be used in combination with the SHIFT and CONTROL-SHIFT keys to perform additional functions. Press any key to put away the help window. 2.4.1.2 - Function Key: UP ARROW Use the UP ARROW key to scan upwards through the directory listing a line at a time. The console bell will sound when you Page 5 attempt to go beyond the top. The UP ARROW key is also used in conjunction with the FIND function key (select new sub-directory command). Repeating the UP ARROW key will allow you to scan through the displayed directories in a cyclic fashion. 2.4.1.3 - Function Key: DOWN ARROW Press the DOWN ARROW key to scan down through the directory listing a line at a time. The console bell will sound when you attempt to go beyond the bottom. The DOWN ARROW key is also used in conjunction with the FIND function key (select new sub-directory command). Repeating the DOWN ARROW key will allow you to scan through the displayed directories in a cyclic fashion. 2.4.1.4 - Function Key: NEXT SCREEN SHIFT-NEXT SCREEN The NEXT SCREEN will scan down through the directory listing a page at a time. A page consists of 12 lines. When moving down to a new page, the bottom line of the previous page is now the top line of the current page. Using the SHIFT key in conjunction with the NEXT SCREEN key will move the window to the last page of the directory listing. 2.4.1.5 - Function Key: PREV SCREEN SHIFT-PREV SCREEN The PREV SCREEN will scan up through the directory listing a page at a time. A page consists of 12 lines. When moving up to a new page, the top line of the previous page is now the bottom line of the current page. Using the SHIFT key in conjunction with the PREV SCREEN key will move the window to the first page of the directory listing. 2.4.1.6 - Function Key: SELECT The SELECT function key serves a dual-purpose. Normally, the SELECT key invokes the new sorting option of WDir. A particular column of the screen, reflecting the current sorting field, will be switched into reverse video. Using the LEFT and RIGHT ARROW function keys, select the particular sorting field desired. The SELECT function key is then pressed a second time to perform the new sorting selection. The SELECT function remembers the last sorting column that was used. The SELECT function key is also used following the invoking of the FIND function key for selecting sub-directories. See the description in section 2.4.1.7 on the FIND function key. Once a directory has been chosen with the FIND key, pressing the SELECT key will set-up WDir for the new directory. WDir prompts for a filename mask though the use of a small window. Entering a filename followed by a RETURN or the SELECT key (or simply hitting the RETURN or SELECT key) will cause WDir to change to the new directory. Use the CANCEL key (see section 2.4.1.9) to abort the changing of directories. 2.4.1.7 - Function key: FIND Page 6 The FIND function key is used to select a particular sub- directory to become the current directory. The FIND key high- lights the first directory in the window. Use the UP and DOWN arrow keys to select the new sub-directory. A highlighted field appears over those directory entries which are sub-directories. Pressing the SELECT key (see above) sets the particula sub-directory as the current directory. Note: To select a sub-directory, it must be in the current viewing window. If not, use the UP and DOWN ARROWS (outside of the Select Sub-Directory Mode) or the PREV and NEXT SCREEN keys to move the window to the area of the sub-directory desired. 2.4.1.8 - Function keys: LEFT ARROW, RIGHT ARROW The LEFT and RIGHT arrow keys are used to select the new sorting option by changing the highlighted column displayed on the window. These keys can only be used after pressing the SELECT function key (see above). 2.4.1.9 - Function key: CANCEL Use the CANCEL key to abort a previously issued command such as sorting, selecting a new sub-directory, or before printing a directory listing to a file or the printer. 2.4.1.10 - Function key: PRINT SCREEN The PRINT SCREEN key is used to print out a full listing of the current directory to either the attached printer or to a specified disk file. A small window with two single-letter options appears and the user must choose between either option 'F' or option 'P'. If option 'F' is selected, WDir responds by asking for a filename. The filename, at maximum, can be of the form: drive:\filename.ext This should be more than sufficient to handle wherever the user wants to place the listing file. If the drive or a 'simple' path are not explicitly stated, the file will appear in the directory the user was in before he invoked WDir. If the user specifies a leading path, such as '..', '.', '\', or '..\', the resultant file will appear in a disk directory relative to the directory the user was in before starting WDir. The 'P' option immediately dumps the directory listing to an attached printer. WDir returns to the display of the current directory upon completion of the the print task. Any errors, such as a bad filename, will display an error message before returning to the listing. If the printer is turned off or is off-line, WDir will report a 'Printer Not Ready' message before returning to the main menu. There must be sufficient space on the disk to store the file and WDir checks this before creating the listing file. If there is no room, WDir responds with a small error window message. 2.4.1.11 - Function key: DO Page 7 The DO function key allows the user to select and view the root directories of new floppy disks. This function has been made generic so it is possible to reselect a hard disk or RAM disk. But this is will not produce any new information (unless file dumps of the disk were placed in the root directory). This key may also be activated any time the user ha selected the root directory through the FIND function key. The user must be in the root directory for this function to work properly. The current sort option will be applied to the directory of the new disk. This function is included to allow the user to cycle through any number of disks and produce directory listings without having to leave WDir and return to MS-DOS and back again each time a new disk directory listing is desired. A typical sequence is to invoke WDir via "WDir A:\". This will select drive A: as the new viewing drive and you can now insert as many disks as desired. Simply press the DO key after inserting the new disk and a new directory will be produced. Press the PRINT SCREEN and either print option and a listing will be generated. If you specifiy a path such as B:\*.pas and wish to use the DO function key, WDir remembers the filename specified and will look for only those specified files on each of the new disks. For a overall view, use the path B:\. 2.4.1.12 - Function key: EXIT SHIFT-EXIT CONTROL-EXIT SHIFT-CONTROL EXIT The EXIT function key is used to exit WDir and return to MS-DOS if you are at the same directory level and recursive order in which you entered WDir. The EXIT key also serves the purpose of leaving a currently selected sub-directory and returning to the previous recursive level. If using EXIT brings you back to MS-DOS, the screen will be restored to its original status before WDir was invoked. The SHIFT-EXIT function key combination is used to leave WDir but will not erase the directory listing from the screen. To use this function key combination, you must be at the level in which you entered WDir. At times, it will not be convenient to use the EXIT key to leave currently selected sub-directories as a method of leaving WDir. Finding yourself six levels down in searching directories, the CONTROL-EXIT combination will immediately exit WDir and return you to MS-DOS at any point. Use the SHIFT-CONTROL-EXIT combination to exit at any point and leave the directory listing on the screen. 2.5 - Active Mode Error Communication WDir communicates errors to the user through small pop-up error windows or by the use of the console bell. The error windows should be self-explanatory. The bells, on the other hand, may occur for any of the following reasons: The directory is empty. WDir has no work to do and Page 8 thus any command function keys except for HELP, DO, and EXIT are meaningless, The portion of the directory listing being currently displayed is at either end of the full listing; the user is not allowed to scan beyond the limits of the di- rectory listing, An illegal key was pressed or a key was used that was not appropriate for the current mode of WDir. Examples: trying to use the LEFT ARROW key when scanning the directory or typing the letter 'X' which is meaningless to WDir. If you forget the function key meanings, press the HELP key. Swapping disks before exiting WDir, especially when you are recursively returning up the directory structure, is generally not a good idea. WDir will beep and force an exit rather than attempting to read wrong information from the disk. If you swap disks, WDir will leave you in the root directory. Disk swapping and the use of the DO function key is permitted only at the root directory. If you remove the disk from which WDir was called, a beep may sound notifying you that a disk swap occured and thus WDir was temporarily confused. The suggestion here is that while you can swap disks at the root levels, you must place the original disk back in the drive before using the EXIT key. 2.6 - WDir Display and Printing Formats 2.6.1 - Window Display Formats When WDir becomes active, a window overlays the user's current display and contains up to 13 lines of the sorted di- rectory listing. In addition, the top and bottom borders of the display window contain additional information about the selected disk and the files on the disk. The top border contains the volume label (if any) and the date and time the volume was created. The next line contains the directory currently being scanned by WDir. If the directory pathname is longer than 40 characters, it is truncated to the current directory. An ellipsis field (\...\) is placed between the drive specifier and the current directory name. The bottom border contains information on the total volume space and the total amount of free space remaining. Both values are in terms of bytes. The border above that contains a count of the number of directories and files in the current directory along with the total amount of space taken up by the files. The directory is displayed between the two sets of borders up to a maximum of 13 files at any one time. The window is adjusted proportionally if there are fewer than 13 files in the directory. The file and disk sizes are displayed with comma notation. 2.6.2 - Printer and Print File Formats The format used for printing to an attached printer or a disk file are identical. The format follows the described method in section 3.6.1 with the single difference that the borders are not centered but are rather left-justified. WDir has no knowledge of the forms-setup of the printer and therefore will print a con- tinuous listing. At the end of each listing, though, the printer will be re-aligned to 'top-of-form'. Page 9 2.6.3 - Directory Information Format The display of the directory entry (file) information will in what is known as a 'full-format'. The following fields of file information will be displayed: - main filename - filename extension - file size - file creation information - day of the week - date - time - an attribute field displaying any number of values depending on the status of setting of the file. Valid attributes are: (A)rchived file, (D)irectory, (S)ystem file, (H)idden file, (R)ead/Only file. 2.6.4 - Sub-Directory Entry Format Sub-directory entries will be indented 1 character position to offset them from regular files. This aids in easier viewing of files and sub-directories. Though directory entries do have a size, their file size field will contain the tag identifier 'Dir'. 3.0 - FUTURE IDEAS As time and money permit, WDir V1.3 will contain the ability to allow the user to choose an arbitrary secondary field for sorting (and possibly a third). A recursive print command to list the entire directory structure is planned. And maybe some other neat things such as switching the disk drive specification. We are trying to keep WDir as simple as possible. Also, at this time an unavailable or not-ready drive will cause MS-DOS to prompt that wonderful "Abort-Retry-Ignore" message. The next version of WDir should, hopefully, take care of that problem. Any ideas or comments will be appreciated. 4.0 - COPYRIGHT NOTICE, DISCLAIMERS, AND WARRANTY 4.1 - Package Distribution Rights Any material included in this package may be used for whatever application desired. However, no documentation, sources, or programs created AV Software Designs, Ltd. maybe sold or otherwise included, in whole or part, in other software being sold. Licensing arrangements can by made through the above address. This package contains a "PD" suffix to the version number which specifies that this program is in the "Public Domain". Packages released after November 30, 1985 that do not contain this suffix are to be considered pre-release, beta-test versions and, therefore, are not convered by any warranty stated or implied from AVSD, Ltd. Page 10 4.2 - Special Exceptions Special exception is made for any sources that this package contains. The source routines may be used in any manner the user wishes. The user is encouraged to include the routines in his software to better the quality of the software and thereby the quality in public domain circulation. Appropriate references are appreciated. 4.3 - FreeWare Concept Since these materials are being released under the FreeWare concept, any user of this software may freely donate money, useful ideas, or comparable routines in return for using this software if the user has felt he has benefitted or learned something from this software. Funds and ideas will go a long way in helping the author develop new software and to maintain this and other packages. Address all inquires and communications to the above address. 4.4 - Package Specific Warranties and Guarantees Though these programs have been tested as thoroughly as possible, neither the author nor AVSD, Ltd. assumes nor is responsible for any damage occuring to any hardware or software of the user nor for any typographical or logic errors that may occur. 4.5 - Program Specific Warranties and Guarantees This software conforms to the specification outlined above and does not attempt harmful operations to the user's system or software. This software is expected to operate at or exceed the stated guide lines. If the software fails to work according to specification, please notify AVSD, Ltd. and a corrected version will be issued. Please document all errors found and the circumstances in which they occurred. This will help us in tracking down the error. Using this software on other systems or under other operating systems not specifically stated voids this guarantee. This package and its contents are subject to modification without prior notice and no commitment of any kind is stated or to be inferred. 5.0 - ACKNOWLEDGMENTS Digital, DEC, Rainbow 100, 100B, 190, 100+, VT-102 are trademarks of Digital Equipment Corporation. MS-DOS is a trademark of Microsoft Corporation. TurboPascal is a trademark of Borland, International. ARC and the method in which this package was stored were developed by System Enhancement Associates. SEARCH was developed by Arborsoft Systems, Inc. AVSD, the AVSD logo, and WDir are pending trademarks and developed software of AVSD, Ltd. Page 11 DEC Rainbow Archive Package #14 WDir Version 1.2PD Copyright (c) 1985, 1986 by AV Software Designs, Ltd. Page 12 »