home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / sysutl / xlist232.arc / XLIST.DOC < prev    next >
Text File  |  1989-12-18  |  38KB  |  1,205 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                         XLIST (tm)
  17.  
  18.                         DISK MANAGER
  19.  
  20.                         USERS GUIDE
  21.  
  22.                         for the
  23.  
  24.                         IBM PC/AT
  25.  
  26.  
  27.  
  28.  
  29.                         by
  30.  
  31.                         GARY W. WOOD
  32.  
  33.  
  34.         *** READ CAREFULLY BEFORE USING XLIST ***
  35.             PROGRAM LICENSE AGREEMENT
  36.  
  37. XLIST (tm) is NOT "Public Domain" and it is NOT "Freeware".  XLIST is a
  38. copyrighted software product developed and owned by Gary W. Wood.  XLIST (tm) is
  39. distributed under the shareware concept.  You are free to copy and use the
  40. software for personal use.  If you are a corporation or institution a license
  41. fee in required.  But, if you are using the software for personal use, your
  42. encouraged to make a gift ($25 suggested) and become a XLIST supporter.  XLIST
  43. supports will receive the next major release free of charge and be keep informed
  44. of major developments for one (1) year.  A license is required for use of XLIST
  45. by corporations and institutions, and for its commercial distribution.    You may
  46. obtain a license for the use of XLIST by writing to me.  The license is for
  47. perpetual, non-exclusive use of any version.  Purchase orders and invoicing are
  48. acceptable.  If you have special requirements, such as licensing for an unlimited
  49. number of copies, local area networks, site licenses, or customization, please
  50. feel free to submit them in writing.  You may request a license for:
  51.  
  52. o  an unlimited number of end user copies at a single site;
  53. o  customization of messages and documentation,  an additional
  54.    fee may be required depending on the extent of changes;
  55. o  permission to distribute within your organization;
  56. o  permission to include with your company's commercial products;
  57. o  or other needs.
  58.  
  59. The fee for a license depends on the estimated number of copies of the program
  60. that you will use.  If you wish to distribute XLIST with your own programs or
  61. hardware, write for a "Marketing License".  To use the discount schedule below,
  62. estimate the total number of copies that you may eventually use.
  63.  
  64.       Number of users(copies)    Price per copy
  65.           1 to 9            $ 25.00
  66.           10 to 25              18.00
  67.           26 up              (call)
  68.  
  69. Regardless of the quantity, only one set of materials will be sent to you.  You
  70. may then make as many copies of it that are licensed.  Maintenance is free.
  71. Upgrades will be made available upon request.  Technical support is available
  72. via mail, or through the Compuserve or GENIE bulletin board systems (76156,317
  73. & G.WOOD4 respectively), at no charge.
  74.  
  75.           Copyright (C) 1985-1990 Gary W. Wood
  76.  
  77.  
  78.  
  79.  
  80. If you find XLIST easy and convenient to use, a contribution of $25 or more will
  81. register you to receive a current version of XLIST.  Please state the current
  82. version of XLIST that you have.  Send contributions to:
  83.  
  84.       Gary Wood
  85.       5401 Lakeview Road
  86.       North Little Rock, Arkansas  72116
  87.  
  88. All rights reserved.  Printed in the United States of America.    No part of this
  89. publication may be reproduced, stored in a retrieval system, or transmitted in
  90. any form or by any means, electronic, mechanical, photocopying, recording, or
  91. otherwise without the prior written permission from Gary W. Wood, 5401 Lakeview
  92. Road, North Little Rock, Arkansas, 72116.
  93.  
  94.  
  95.  
  96.  
  97.                DISCLAIMER
  98.  
  99. The author has taken due care in the preparation of this document and the
  100. associated program.  Insofar as specific mention of program features, the author
  101. believes the information to be true.  No warranty is made regarding the
  102. suitability of the program to be compatible with your computer.  Incidental and
  103. consequential damages caused by malfunction, defect, or otherwise are not the
  104. responsibility of Gary W. Wood, and to the extent permitted by law, and hereby
  105. excluded both for the property and, to the extent not unconscionable, for
  106. personal injury damage. (Some states or jurisdictions do not allow the exclusion
  107. or limitation of incidental or consequential damages, so the above limitation
  108. or exclusion may not apply to you.)  Gary W. Wood also reserves the right to make
  109. amendments to the contents of this document from time to time, to reflect changes
  110. made to the specification of the XLIST system or for any other reason.
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124. XLIST is a Trademark of Gary W. Wood.  IBM, IBM-PC, PC-XT, PC-AT, DOS, and PC-DOS
  125. are Trademarks of International Business Machines Corp.
  126.  
  127.  
  128. CHAPTERS
  129.  
  130.  
  131.  
  132. 1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . . .  5
  133.  
  134. 2.  Getting Started   . . . . . . . . . . . . . . . . . . . . . . .  6
  135.  
  136. 3.  Invoking the XLIST Command    . . . . . . . . . . . . . . . . . .  8
  137.  
  138. 4.  Using the Keyboard    . . . . . . . . . . . . . . . . . . . . . .  9
  139.  
  140. 5.  Using the XLIST.CNF File  . . . . . . . . . . . . . . . . . . . 10
  141.  
  142. 6.  Using the XLIST.PRO Profile . . . . . . . . . . . . . . . . . . 11
  143.  
  144. 7.  Sample XLIST.PRO File . . . . . . . . . . . . . . . . . . . . . 20
  145.  
  146. 8.  Command Line Commands . . . . . . . . . . . . . . . . . . . . . 23
  147.  
  148.  
  149.  
  150.  
  151. INTRODUCTION
  152.  
  153.  
  154.  
  155. WELCOME TO THE WORLD OF DISK MANAGEMENT USING
  156. XLIST - DISK UTILITY
  157.  
  158. If you are new to PC-DOS, you have realized that commands provided by PC-DOS
  159. are designed to be short and sweet.  This program is designed as a tool to
  160. effectively provide the user a friendly way to view files contained in sub-
  161. directories and be able to execute programs and PC-DOS commands.
  162.  
  163.  
  164. GETTING STARTED
  165.  
  166.  
  167.  
  168. WHAT KIND OF HARDWARE DO I NEED
  169.  
  170.  
  171. To use XLIST you need the following:
  172.  
  173. An IBM PC with hard disk, PC XT, PC AT, or a very closely compatible
  174. microcomputer.
  175.  
  176. A color/graphics adapter, monochrome adapter, or VGA adapter
  177.  
  178. 256K of RAM memory for best results.  The program requires at least 120K of
  179. memory.
  180.  
  181. One diskette drive
  182.  
  183. DOS 2.1 or greater
  184.  
  185.  
  186.  
  187. WHAT DO I DO NOW
  188.  
  189.  
  190. Installing XLIST to operate on your system is a simple process.You should
  191. start by copying the distribution diskette and putting the original away in a
  192. safe place.
  193.  
  194. Now, copy the files on the diskette to a directory on your hard disk searched
  195. by the DOS path.  The PC-DOS "PATH" command specifies a directory search order
  196. for commands and/or batch files that are not in the current directory.
  197.  
  198. For best performance of XLIST, set the following environment parameters.
  199.  
  200.      SET OVERLAY=D:\     <--- Point to work area or RAM disk.
  201.      SET XLIST=LIST     <--- The name of a browser or editor.
  202.  
  203. You are now ready!
  204.  
  205.  
  206. INVOKING THE XLIST COMMAND
  207.  
  208.  
  209. WHAT ARE THE INVOKING PARAMETERS
  210.  
  211.  
  212. First, no parameters are mandatory, but under some conditions you may want to
  213. specify them to limit or expand the directory entries displayed.
  214.  
  215. To invoke the program enter:
  216.  
  217.        XLIST [[d:][path][filename[.ext]] /Mnn /A /L
  218.  
  219. The optional parameters have the following definitions:
  220.  
  221.   [[d:][path][filename[.ext]] to specify the file and/or files
  222.        that will be initially be displayed by the XLIST screen.
  223.  
  224.   [/Mnn] is used to specify a directory attribute that will override the
  225.        attribute that could be specified in the profile with the *DIRATTR
  226.        parameter.
  227.  
  228.   [/A] is used to tell XLIST to load every file on the default
  229.        drive into XLIST.
  230.  
  231.   [/L] is used to tell XLIST to display license information.
  232.  
  233.  
  234. Example:
  235.  
  236. Execute XLIST loading the directory from the default drive directory and the root
  237. directory of the C: drive.
  238.  
  239. XLIST *.* c:\*.*
  240.  
  241.  
  242.  
  243. USING THE KEYBOARD
  244.  
  245.  
  246. WHAT KEYS ON THE KEYBOARD DOES XLIST USE
  247.  
  248.  
  249. XLIST uses the keyboard for communications.  The keyboard is used to enter
  250. commands, scroll the display, and to invoke user-defined function keys.  These
  251. are the single keystroke commands used by XLIST.  You may change command keys
  252. by using the "Alt-k" key.  Defaults are defined as follows:
  253.  
  254.      Key Stroke            Definition
  255.  
  256.        Home       Position the cursor to the first character.
  257.  
  258.        End     Position the cursor to the last character.
  259.  
  260.        Ctrl End     Erase data in the command line from the
  261.             cursor to the end-of-line.
  262.  
  263.        Alt a     Change file attributes.
  264.  
  265.        Alt c     Change screen colors.
  266.  
  267.        Alt e     Toggle to EGA 43-line screen.
  268.  
  269.        Alt f     Toggle to set XLIST to stop processing
  270.             when an error is encountered.
  271.  
  272.        Alt k     Change keyboard definitions.
  273.  
  274.        Alt s     Toggle between displaying filesize in K's
  275.             or in total number of bytes.
  276.  
  277.        Alt t     Tag multiple files.
  278.  
  279.        Alt x     Exclude entry.
  280.  
  281.        Esc      Exit.
  282.  
  283.        Enter        Pass control to XLIST to process the
  284.             command lines.
  285.  
  286.        Ctrl PgUp    Goto top of directory.
  287.  
  288.        Ctrl PgDn    Goto bottom of directory.
  289.  
  290.        `      Tag single entry (toggle)
  291.  
  292.  
  293. USING THE XLIST.CNF CONFIGURATION
  294.  
  295.  
  296. WHAT PARAMETERS ARE IN THE CONFIGURATION FILE
  297.  
  298.  
  299. The 'XLIST.CNF' file contains the initial keyboard and color settings.  You may
  300. modify these using the "Alt-c" for color changes and the "Alt-k" for keyboard
  301. changes.  If by some chance this file is corrupted, erase the file and XLIST will
  302. recreate it to the default values.
  303.  
  304. After changing the screen colors or the keyboard, XLIST will prompt you to
  305. permanently save the new setting to the configuration file.
  306.  
  307.  
  308. USING THE XLIST.PRO PROFILE
  309.  
  310.  
  311. WHAT PARAMETERS ARE IN THE PROFILE
  312.  
  313.  
  314. The 'XLIST.PRO' file is used to communicate the monitor type, directory limits,
  315. and definitions of the function keys.  The profile is found by XLIST by first
  316. searching the current directory then searching for the profile by following the
  317. paths set by the PC-DOS "PATH" command.  All XLIST options are identified by
  318. preceding keywords that start with a asterisk "*".  When the first character is
  319. not an asterisk the command line is treated as a comment.
  320.  
  321.  
  322. *ALLATTR   ON | OFF | DISABLE
  323.  
  324. The *ALLATTR is used in conjunction with changing the attributes of a DOS file
  325. within a sub-directory.  When the "/A" command will function:
  326.  
  327.       ON --- All files under the sub-directory will be changed.
  328.      OFF --- Only files under the specific directory will be changed.
  329.      DISABLE --- Will not function on sub-directories.
  330.  
  331.  
  332.  
  333. *BUFFER    32767 | nnnnn
  334.  
  335. Use the *BUFFER command to assign the size reserved for "XLIST" to use as a
  336. "COPY" Input / Output buffer.  The buffer is allocated the first time the "COPY"
  337. command is used.  The size may be decreased down to 512 characters.  By
  338. decreasing the buffer size, performance of the "COPY" command will be impaired.
  339.  
  340.  
  341.  
  342. *DIRATTR     49 | nn
  343.  
  344. The *DIRATTR command is used to define what attribute is used to search the DOS
  345. directory.  This is used to setup a mask used during the search of the directory
  346. to select what entries are included when displaying directory entries on the
  347. XLIST screen.
  348.  
  349. The attribute byte is mapped as follows:
  350.  
  351.  
  352. Bit Mask   Hex     Dec.               Description
  353. .......1  X'01'   +1   Read-only file.
  354. ......1.  X'02'   +2   Hidden file.
  355. .....1..  X'04'   +4   System file.
  356. ....1...  X'08'   +8   Volume label.
  357. ...1....  X'10'  +16   Sub-directory.
  358. ..1.....  X'20'  +32   Archival file.  A file is flagged as
  359.                archival whenever the file has been
  360.             written to and closed.
  361.  
  362. If all the bits are turned on the decimal number would be a decimal +63.  The
  363. default is set to a decimal +49 which would have the bit mask of "..11...1" that
  364. has the meaning of having the sub-directory, archival, and read-only bits on.
  365. You get the attribute by adding together 32 + 16 + 1 to get +49.
  366.  
  367.  
  368. *DISABLE  [command]
  369.  
  370. XLIST will intercept some PC-DOS commands,  this gives greater control to XLIST
  371. when monitoring the directory and keeps PC-DOS from writing over XLIST's screen.
  372. The PC-DOS "Copy" & "Rename" command executed by XLIST are not fully like the
  373. PC-DOS "Copy" & "Rename" in that XLIST won't allow wild cards in the source
  374. parameter.  Also, note that XLIST will get a up to a 32K buffer, this will
  375. increase the size of XLIST and this space won't be given back.  If you wish to
  376. use wild cards, either disable the command or use the "DOS" command to use
  377. PC-DOS.
  378.  
  379. Profile parameter "*DISABLE command" is used to disable PC-DOS commands that
  380. XLIST will intercept for it to have better control.  The following commands are
  381. able to be disabled:
  382.  
  383.     *DISABLE COPY
  384.     *DISABLE DEL
  385.     *DISABLE ERASE
  386.     *DISABLE RENAME
  387.     *DISABLE REN
  388.     *DISABLE CHDIR
  389.     *DISABLE CD
  390.     *DISABLE MKDIR
  391.     *DISABLE MD
  392.     *DISABLE RMDIR
  393.     *DISABLE RD
  394.     *DISABLE MOVE
  395.  
  396. It is to your advantage to not disable the above commands unless they fail to
  397. perform to your expectations.  By allowing XLIST to intercept these commands,
  398. it is better able to keep the command line up to date as changes are made to the
  399. current sub-directory.
  400.  
  401.  
  402.  
  403. *DIRCLEAR  ON | OFF
  404.  
  405. The *DIRCLEAR command is used in conjunction with the append directory command
  406. ("\AD").  When changing directories from one place to another, XLIST will reset
  407. what directories to load to "*.*" when this option is set ON.  When set OFF,
  408. XLIST will use the currently set list of wildcards set by the "\RD" & "\AD"
  409. commands.
  410.  
  411.  
  412. *DIRSAVE  ON | OFF
  413.  
  414. The *DIRSAVE command is used to enable a feature to save the contents of the
  415. directory in XLIST when leaving that particular directory.  This is in
  416. anticipation of returning to the directory and seeing the directory as it was
  417. left.  The contents of the directory is saved in a file in the directory it
  418. represents with the name XLIST.$$$.  After using the file to reload XLIST the
  419. file is erased.
  420.  
  421.  
  422.  
  423. *DOS  ON | OFF
  424.  
  425. The *DOS command controls how XLIST passes control to programs invoked under
  426. XLIST.    When this option is "ON", XLIST will load the secondary PC-DOS command
  427. processor (COMMAND.COM) to execute the program or command directly.  When the
  428. option is "OFF", XLIST will search the environment "PATH" searching for the
  429. proper command to execute.  If found, it will load the program directly,
  430. bypassing PC-DOS.This will save some memory space.  If the command is found to
  431. be a ".BAT" file or isn't found, XLIST will load the secondary command processor
  432. to attempt to execute the command.  The secondary PC-DOS command processor is
  433. always used when the OVERLAY option is set "ON".
  434.  
  435.  
  436.  
  437. *EGA43    ON | OFF
  438.  
  439. The *EGA43 command is used to have XLIST come up using the EGA 43 line mode.
  440. This will allow displaying of 43 lines of text instead of the default of 25.
  441. The "alt-e" keystroke will toggle into and out of this mode when using a EGA
  442. adapter.
  443.  
  444.  
  445.  
  446. *ENTRIES  200 | nnnn
  447.  
  448. The *ENTRIES command is used to provide a method for the user to specify how much
  449. memory is used by XLIST to hold directory entry information.  Each directory is
  450. held in memory by XLIST to be displayed on the screen.    The maximum number of
  451. entries XLIST can load is 1300.
  452.  
  453. Whenever there are more entries than set by the *ENTRIES command, the excess
  454. entries are bypassed.
  455.  
  456.  
  457.  
  458. *EXECUTE   [pattern] [commands......]
  459.  
  460. The *EXECUTE command is used to associate a series of commands to be entered when
  461. the ENTER key is pressed.  This can be used to invoke a browser, editor, Lotus
  462. 1-2-3, DBASEIII, or any other series of commands.
  463.  
  464. You can set up multiple *EXECUTE commands within the XLIST.PRO profile.   They
  465. are scanned sequential each time the ENTER key is pressed to see if any commands
  466. should be entered if the pattern matches the name of the file.
  467.  
  468.  
  469. Example:
  470.  
  471. To have a program called "LIST" invoked whenever the ENTER key is pressed for
  472. all files that start with either an A, B, or C and the extension is "DOC".
  473.  
  474.      *EXECUTE [ABC]*.DOC LIST
  475.  
  476.  
  477.  
  478. *FINDFILE  [d:][path][filename]
  479.  
  480. The *FINDFILE parameter specifies the name of a file to save a file containing
  481. all the filename's located during a "\FIND" command.  This can be used to create
  482. batch files for executing global commands against the files located by the
  483. "\FIND" command.
  484.  
  485.  
  486.  
  487. *HEIGHT    nnn
  488.  
  489. The *HEIGHT command is used to disable the EGA adapter interface in determining
  490. the number of rows on the screen.  This will set the number of rows on the screen
  491. to the value specified in the parameter.  This value must be between 25 and
  492. 60.  This will disable the EGA 43-line toggle.
  493.  
  494. NOTE: Not a normally used parameter.
  495.  
  496.  
  497.  
  498. *LINEEND   ~ | c
  499.  
  500. The LINEEND command is used to define the logical line end character.  For
  501. entering multiple commands on the same line for execution.  The default character
  502. is the '~'.  This character may be put on the command line or used within the
  503. *PFKEYS or *EXECUTE profile commands.
  504.  
  505.  
  506.  
  507. *LOGO  ON | OFF
  508.  
  509. The LOGO command is used to disable the presentation of the initial copyright
  510. screen.  This presentation delays XLIST execution for 3 seconds.
  511.  
  512.  
  513.  
  514. *MEMORY   0 | nnn
  515.  
  516. The MEMORY command is used in conjunction with the OVERLAY command to reserve
  517. the minimum amount of memory that should be available for commands invoked from
  518. within XLIST.  This value contains the amount of memory in K that you want to
  519. free up.  Specify zero (0) or a number greater than available memory to free up
  520. all the memory possible.
  521.  
  522.  
  523.  
  524. *OVERLAY   ON | OFF
  525.  
  526. The OVERLAY command is used in conjunction with the MEMORY command to reserve
  527. the minimum amount of memory that should be available for commands invoked from
  528. within XLIST.  XLIST reduces the resident portion of XLIST while another command
  529. is executed by temporarily storing the XLIST program to disk.  After the invoked
  530. command is finished, XLIST is read back in memory and execution resumes.  This
  531. will effectively reduce the memory requirements of XLIST down to only 16K!  The
  532. feature can be toggled on and off by using the "/s" option on the command line.
  533. XLIST will free memory to a temporary work file.  This file can be up to 128K,
  534. and takes a long time to page out when the file isn't on a RAM drive.  I would
  535. suggest setting up a RAM drive in extended memory using the VDISK.SYS device
  536. driver provided by PC-DOS.
  537.  
  538. Example:
  539.  
  540. Change CONFIG.SYS to include the following:
  541.  
  542.      DEVICE=C:VDISK.SYS /e 196 512 64
  543.  
  544. Change AUTOEXEC.BAT to include the following:
  545.  
  546.      SET OVERLAY=D:\
  547.  
  548. The above changes would set up a 196K RAM drive using the next available drive,
  549. ie. D:.  XLIST would save the memory file to the location specified by the
  550. "OVERLAY" environment variable.
  551.  
  552.  
  553.  
  554. *PATHSZ    200 | nnn
  555.  
  556. The PATHSZ command is used to define the amount of memory reserved for saving
  557. the DOS paths that have been previously been displayed during a XLIST session.
  558. This memory is automatically managed in conjunction with use of the /BD command.
  559.  
  560.  
  561.  
  562. *PFKEYS       Xnn (btd) function
  563. *PFKEYS-ARC   Xnn (btd) function
  564. *PFKEYS-ZIP   Xnn (btd) function
  565.  
  566. This command provides the user with a method of defining the function keys F1-F10
  567. in order to execute commands using the function keys rather than entering the
  568. command.  The function may be more than one command each separated by the logical
  569. line end character (i.e. ~).
  570.  
  571. When viewing a .ARC or .ZIP directory structure by utilizing the /EXP, /ZIP, or
  572. /ARC commands, XLIST has the ability to load another set of function key
  573. definitions.  These are specified by appending "-ZIP" or "-ARC" upon the *PFKEYS
  574. keyword.
  575.  
  576. The format for the command is as follows:
  577.  
  578. *PFKEYS Xnn (btd) function
  579.  
  580.        X = Shift key indicator.
  581.         blank = unshifted.
  582.         S = right or left shift pressed.
  583.         C = CTRL pressed.
  584.         A = ALT pressed.
  585.       nn = Function key number (1 thru 10).
  586.      btd = Abbreviation for display (optional).
  587. function = Text inserted into XLIST command line.
  588.  
  589. Example:
  590.  
  591. Set function key (F1) to compile a program using the Lattice C compiler.
  592.  
  593. *PFKEYS 1 (lcs) lc -ms /c
  594.  
  595. Set function key (F2) to link-edit a program and cancel execution of XLIST.
  596.  
  597. *PFKEYS 2 (lnk) link @xlistlk.lnk /o/c~/can
  598.  
  599.  
  600. Set function key (F3) to compile and link-edit a program.
  601.  
  602. *PFKEYS 3 (all) /F1~/F2
  603.  
  604. Set function key (F3) to un-zip file to the drive/directory specified by the TEMP
  605. environment variable using PKUNZIP; execute a program called "LIST" passing the
  606. name of the file as the first parameter; erase the un-zipped file after execution
  607. of LIST.
  608.  
  609. *PFKEYS-ZIP 3 (LIS) /cPKUNZIP -o $A %TEMP% $~LIST %TEMP%$~ERASE %TEMP%$
  610.  
  611.  
  612.  
  613. *PFREF    ON | OFF
  614.  
  615. The PFREF command is used to tell XLIST to refresh the function key definitions
  616. from the XLIST.PRO profile found in the current directory.  When XLIST senses
  617. that a drive or sub-directory change has occurred a search is made in the current
  618. directory for the XLIST.PRO profile.  This file is used to refresh the function
  619. key definitions.
  620.  
  621.  
  622. *RETRACE  ON | OFF
  623.  
  624. Profile parameter *RETRACE is used for IBM Personal Computers with IBM
  625. Color/Graphics Monitor Adapters.  They require special programming to prevent
  626. "snow" from appearing on the screen when a program changes the contents of the
  627. screen buffer.    The required programming will slow down screen updating and is
  628. not necessary for many other display adapters.
  629.  
  630.     *RETRACE  ON
  631.  
  632. will make XLIST run slower on these systems.
  633.  
  634. Setting *RETRACE OFF on an IBM PC with an IBM color adapter will cause "snow"
  635. on the screen in some instantaneous.
  636.  
  637.  
  638. *SORT     [A|S|B|N|D|E|T] [-]
  639.  
  640. Profile parameter *SORT will cause XLIST to sort the directory before it is
  641. displayed.  This will allow you to specify the order the entries are arranged.
  642.  
  643. The parameter definitions are:
  644.  
  645.      A     - by attribute
  646.      S     - by size
  647.      B     - by blocksize (same as S)
  648.      N     - by name
  649.      D     - by date
  650.      E     - by extension
  651.      T     - by type (same as E, except sub-directories
  652.            go to the top)
  653.  
  654.      -     - descending order
  655.  
  656.  
  657.  
  658. *TOPVIEW  ON | OFF
  659.  
  660. The *TOPVIEW command is used to disable the access of the TOPVIEW buffer address.
  661. Some video adapters have conflicts with the interrupts used to access the TOPVIEW
  662. video buffer.  Setting this to the OFF setting will make for faster screen
  663. access.
  664.  
  665.  
  666. *TREE      ON | OFF
  667.  
  668. The *TREE command went set to "ON" will automatically load the directory tree
  669. during startup of the XLIST program.  This will cause the startup to take longer.
  670. The default is to have the option "OFF".
  671.  
  672.  
  673.  
  674. *WIDTH      nnn
  675.  
  676. The *WIDTH command is used to disable the EGA adapter interface in determining
  677. the number of columns on the screen.  This will set the number of columns on the
  678. screen to the value specified in the parameter.  This value must be between 80
  679. and 132.  This will disable the EGA 43-line toggle.
  680.  
  681. NOTE: Not a normally used parameter.
  682.  
  683.  
  684.  
  685. SAMPLE XLIST PROFILE
  686.  
  687.  
  688. *ALLATTR   DISABLE
  689. *BUFSIZE   32767
  690. *DIRCLEAR  ON
  691. *DIRSAVE   OFF
  692. *DISABLE   RMDIR
  693. *DISABLE   MKDIR
  694. *DISABLE   CHDIR
  695. *DISABLE   DEL
  696. *DOS       ON
  697. *ENTRIES   300
  698. *FINDFILE  C:\XLBAT.BAT
  699. *LINEEND   ~
  700. *LOGO       OFF
  701. *MEMORY    0
  702. *OVERLAY   OFF
  703. *PATHSZ    200
  704. *PFREF       ON
  705. *RETRACE   OFF
  706. *SORT       T
  707. *TOPVIEW   OFF
  708. *TREE       OFF
  709. *EGA43       OFF
  710. +
  711. *EXECUTE *.ZIP        /ZIP
  712. *EXECUTE *.ARC        /ARC
  713. *EXECUTE *.BAT        /EXE
  714. *EXECUTE *.EXE        /EXE
  715. *EXECUTE *.COM        /EXE
  716. *EXECUTE [abc]*.C   X $F
  717. *EXECUTE *        LIST $F
  718. *EXECUTE *.*        LIST $F
  719. +
  720. *EXECUTE-ZIP *.BAT    /cPKUNZIP -o $A %TEMP% $~%TEMP%$~ERASE %TEMP%$
  721. *EXECUTE-ZIP *.EXE    /cPKUNZIP -o $A %TEMP% $~%TEMP%$~ERASE %TEMP%$
  722. *EXECUTE-ZIP *.COM    /cPKUNZIP -o $A %TEMP% $~%TEMP%$~ERASE %TEMP%$
  723. *EXECUTE-ZIP *        /cPKUNZIP -o $A %TEMP% $~LIST %TEMP%$~ERASE %TEMP%$
  724. *EXECUTE-ZIP *.*    /cPKUNZIP -o $A %TEMP% $~LIST %TEMP%$~ERASE %TEMP%$
  725. +
  726. *EXECUTE-ARC *.BAT    /cPKXARC -r $A %TEMP% $~%TEMP%$~ERASE %TEMP%$
  727. *EXECUTE-ARC *.EXE    /cPKXARC -r $A %TEMP% $~%TEMP%$~ERASE %TEMP%$
  728. *EXECUTE-ARC *.COM    /cPKXARC -r $A %TEMP% $~%TEMP%$~ERASE %TEMP%$
  729. *EXECUTE-ARC *        /cPKXARC -r $A %TEMP% $~LIST %TEMP%$~ERASE %TEMP%$
  730. *EXECUTE-ARC *.*    /cPKXARC -r $A %TEMP% $~LIST %TEMP%$~ERASE %TEMP%$
  731.  
  732.  
  733. SAMPLE XLIST PROFILE (Continued)
  734.  
  735.  
  736. *PFKEYS  1 (HEL) XHELP -TXLIST -HXLIST.HLP XLIST /O
  737. *PFKEYS  2 (KED) X $F
  738. *PFKEYS  3 (LIS) LIST $F
  739. *PFKEYS  4 (NCD) NCD /O
  740. *PFKEYS  5 (ARC) /EXP
  741. *PFKEYS  6 (DSP) /DSPF
  742. *PFKEYS  7 (/BD) /BD
  743. *PFKEYS  8 (/AP) /c/pTSRMAP
  744. *PFKEYS  9 (TRE) /TREE
  745. *PFKEYS  10 (CAN) /CAN
  746. +
  747. *PFKEYS S1 (TST) /c/oECHO SHIFT FUNCTION KEYS~pause
  748. *PFKEYS S2 (KED) X $F
  749. *PFKEYS S3 (LIS) LIST $F
  750. *PFKEYS S4 (NCD) NCD /O
  751. *PFKEYS S5 (ARC) /EXP
  752. *PFKEYS S6 (DSP) /DSPF
  753. *PFKEYS S7 (/BD) /BD
  754. *PFKEYS S8 (/AP) /c/pTSRMAP
  755. *PFKEYS S9 (TRE) /TREE
  756. *PFKEYS S10 (CAN) /CAN
  757. +
  758. *PFKEYS A1 (ALT) /o/cECHO ALT FUNCTION KEYS~pause
  759. *PFKEYS A2 (KED) X $F
  760. *PFKEYS A3 (LIS) LIST $F
  761. *PFKEYS A4 (LOC) /FIND
  762. *PFKEYS A5 (DOS) DOS
  763. *PFKEYS A6 (DSP) /DSPF
  764. *PFKEYS A7 (MAP) /MAP
  765. *PFKEYS A8 (TRE) /TREE
  766. *PFKEYS A9 (XCO) /FIND=XCOPY.EXE
  767. *PFKEYS A10 (PRO) /o/cX \XLIST\XLIST.PRO
  768. +
  769. *PFKEYS C1 (CNT) /o/cECHO CNTL FUNCTION KEYS~pause
  770. *PFKEYS C2 (KED) X $F
  771. *PFKEYS C3 (LIS) LIST $F
  772. *PFKEYS C4 (LOC) /FIND
  773. *PFKEYS C5 (DOS) DOS
  774. *PFKEYS C6 (DSP) /DSPF
  775. *PFKEYS C7 (MAP) /MAP
  776. *PFKEYS C8 (TRE) /TREE
  777. *PFKEYS C9 (BAC) /BD
  778. *PFKEYS C10 (CAN) /CAN
  779.  
  780.  
  781. SAMPLE XLIST PROFILE (Continued)
  782.  
  783.  
  784. *PFKEYS-ZIP 1 (HEL) XHELP -TXLIST -HXLIST.HLP XLIST /O
  785. *PFKEYS-ZIP 2 (KED) /CPKUNZIP -o $A %TEMP% $~X %TEMP%$~PKZIP -U $A
  786.             %TEMP%$~ERASE %TEMP%$
  787. *PFKEYS-ZIP 3 (LIS) /cPKUNZIP -o $A %TEMP% $~LIST %TEMP%$~ERASE %TEMP%$
  788. *PFKEYS-ZIP 4 (DEL) /CPKZIP -D $A $
  789. *PFKEYS-ZIP 5 (EXT) /CPKUNZIP -o $A $
  790. *PFKEYS-ZIP 6 (VIE) /CPKUNZIP -cm $A $~PAUSE
  791. *PFKEYS-ZIP 7 (PRT) /CPKUNZIP -P $A $
  792. *PFKEYS-ZIP 8 (TRE) /TREE
  793. *PFKEYS-ZIP 9 (BAC) /BD
  794. *PFKEYS-ZIP 10 (CAN) /CAN
  795. +
  796. *PFKEYS-ARC 1 (HEL) XHELP -TXLIST -HXLIST.HLP XLIST /O
  797. *PFKEYS-ARC 2 (KED) /CPKXARC -R $A %TEMP% $~X %TEMP%$~PKARC U $A
  798.             %TEMP%$~ERASE %TEMP%$
  799. *PFKEYS-ARC 3 (LIS) /cPKXARC -R $A %TEMP% $~LIST %TEMP%$~ERASE %TEMP%$
  800. *PFKEYS-ARC 4 (DEL) /CPKARC D $A $
  801. *PFKEYS-ARC 5 (EXT) /CPKXARC -R $A $
  802. *PFKEYS-ARC 6 (VIE) /CPKXARC -C $A $~PAUSE
  803. *PFKEYS-ARC 7 (PRT) /CPKXARC -P $A $
  804. *PFKEYS-ARC 8 (TRE) /TREE
  805. *PFKEYS-ARC 9 (BAC) /BD
  806. *PFKEYS-ARC 10 (CAN) /CAN
  807.  
  808.  
  809.  
  810.  
  811. COMMAND LINE COMMANDS
  812.  
  813.  
  814. HOW TO USE THE COMMAND LINE
  815.  
  816.  
  817. XLIST will present the directory vertically down the screen with a input line
  818. next to each entry, this is the "COMMAND LINE".  The user can use the cursor keys
  819. to navigate up and down the directory entering commands.  When the <ENTER> key
  820. is depressed, XLIST will process the commands top-to-bottom.  All commands
  821. entered are first examined by XLIST to find special commands used by XLIST.
  822. These commands are from logical line end characters to special commands used to
  823. sort the directory into another order.
  824.  
  825. There are 33 characters that can be presented to XLIST on the command line at
  826. any one time.  But, by continued typing up to 63 characters can be entered.
  827.  
  828. After the command is entered XLIST will append the filename and extension name
  829. to the command unless told otherwise by the /O line command.
  830.  
  831.  
  832. EXAMPLE:
  833.  
  834.     Fileid          │ Input Area Entry   │ Resulting Command
  835.     ──────────────┼────────────────────┼───────────────────
  836.     fn1  ext1     │ erase           │ erase fn1.ext1
  837.     fn2  ext2     │ masm /           │ masm fn2.ext2
  838.     fn3  ext3     │ copy / a:       │ copy fn3.ext3 a:
  839.     fn4  ext4     │ dir *.* /o       │ dir *.*
  840.  
  841.  
  842.  
  843. GENERAL NOTES:
  844.  
  845. 1.   Do not rename or erase files from a BAT file or with a
  846.      "ERASE *.*" sequence.
  847.  
  848. These situations cannot be detected by XLIST and may result in random displayed
  849. filenames or XLIST termination.  If you do the above, by entering the "/RD"
  850. command, the directory is refreshed.
  851.  
  852.  
  853.  
  854. $     - SUBSTITUTE FILENAME & EXTENSION
  855.  
  856. There are a series of characters using the '$' as a prefix that can be used to
  857. imbed parameters into the command line automatically.
  858.  
  859. /    -->  Substitute the DOS filename & extension.
  860. //    -->  Will pass on one /.
  861. $    -->  Substitute the DOS filename & extension.
  862. $$    -->  Will pass on one $.
  863. $P    -->  Substitute DOS pathname without trailing slash.
  864. $N    -->  Substitute DOS filename without extension.
  865. $E    -->  Substitute DOS extension.
  866. $F    -->  Substitute DOS pathname, filename & extension.
  867. $D    -->  Substitute DOS drive letter without trailing colon.
  868.  
  869.  
  870.  
  871. /A    - CHANGE THE FILE ATTRIBUTES
  872.  
  873. This command is used to modify the file attributes.  The attribute maybe marked
  874. read-only, hidden, made a system file, or have the archive flag turned on.
  875.  
  876. When this is placed on a sub-directory, XLIST will change the attributes of all
  877. the files within the directory.
  878.  
  879. The format is:    /A[+/-][attribute]
  880.  
  881. [+/-] the plus(+) is used to denote adding the attribute and the negative(-) is
  882. used to remove a attribute.
  883.  
  884. [attribute] is the one-character representation of the attribute to be added or
  885. removed from the file.
  886.  
  887.                A  - Archive
  888.                R  - Read-only
  889.                S  - System file
  890.                V  - Volume label
  891.                H  - Hidden file
  892.                D  - Sub-directory
  893.  
  894.  
  895. Example:
  896.  
  897. The following example sets the attribute of the file to read-only.
  898.  
  899.      /A+R
  900.  
  901. The following example will turn off read-only and make the file hidden.
  902.  
  903.      /A-R+H
  904.  
  905.  
  906.  
  907. /AD   -  APPEND TO THE XLIST DIRECTORY
  908.  
  909. The /AD command is used to append to the internal directory.  This can be used
  910. to load entries from other drives or sub-directories.
  911.  
  912. Example:
  913.  
  914. Set XLIST to only append the files with an extension of "EXE":
  915.  
  916.      /AD=*.EXE
  917.  
  918. Append data from the root directory:
  919.  
  920.      /AD=C:\*.*
  921.  
  922.  
  923.  
  924. /BD   - GO BACK TO PRIOR DIRECTORY
  925.  
  926. This command is used to proceed back to previous sub-directory.  Whenever a
  927. sub-directory or drive change is made by entering the PC-DOS commands, XLIST will
  928. save the current directory in the path area reserved by the *PATHSZ profile
  929. command.  By entering /BD the program will roll back to the prior directory.
  930.  
  931.  
  932.  
  933. /C    - CLEAR SCREEN BEFORE EXECUTING COMMAND
  934.  
  935. When the /C is found in the command line it is extracted from the command line
  936. and before the entered command is passed to the DOS command processor the screen
  937. is cleared.
  938.  
  939. When a function key is defined to invoke a program it is more appealing to have
  940. XLIST clear the screen before invoking the program using the "/C" option.  This
  941. also causes XLIST to clear and re-display the entire XLIST screen when control
  942. is passed back from the program called.
  943.  
  944.  
  945.  
  946. /CAN  - CANCEL XLIST
  947.  
  948. This command will exit XLIST and stay in the current directory.
  949.  
  950.  
  951.  
  952. /CLS  - CLEAR COMMAND LINE AREA
  953.  
  954. This command will clear the XLIST command line area.
  955.  
  956.  
  957.  
  958. /DOS    - INVOKE SECONDARY COMMAND PROCESSOR
  959.  
  960. Use the DOS command to pass control to the secondary DOS command processor.  This
  961. command will load a copy of DOS and pass control to it.  You will remain in DOS
  962. until you return to XLIST by entering the EXIT command.
  963.  
  964. You should not execute any commands while in the secondary command processor that
  965. will make them permanently resident.
  966.  
  967.  
  968.  
  969. /DSPF  - DISPLAY USER-DEFINED FUNCTION KEYS
  970.  
  971. You can use the /DSPF function to display the function keys currently defined.
  972.  
  973.  
  974.  
  975. /END  - END XLIST
  976.  
  977. This command will exit XLIST and return to the drive and directory where XLIST
  978. was invoked.
  979.  
  980.  
  981.  
  982. /EXP  - EXPAND AN "ARC" or "ZIP" FILE DIRECTORY
  983.  
  984. This command will read the directory contained within the specified ARC file.
  985. It will then display it using the XLIST directory display features.  Be aware
  986. that the /UD & /A sub-commands will be deactivated.  To redisplay the normal
  987. directory either enter the ESC command or the /RD command.
  988.  
  989. NOTE: You can use the /ZIP command to expand a ZIP file or /ARC to expand a ARC
  990. file.  The /EXP command implies whether or not its a ZIP or ARC file from the
  991. file extension.
  992.  
  993.  
  994.  
  995. /Fnn  - EXECUTE FUNCTION KEY nn
  996.  
  997. This command can be used to invoke function keys from the command line.  As a
  998. matter of fact, when a function key is depressed XLIST will insert into the
  999. command line the above command.
  1000.  
  1001. Example:
  1002.  
  1003. To invoke the F4 function key you would enter "/F4".
  1004.  
  1005.  
  1006.  
  1007. /FIND    - FIND FILES ON CURRENT DRIVE
  1008.  
  1009. The /FIND command will search the current drive locating the location of all
  1010. files that match the selection criteria specified by the /FIND command.  This
  1011. can be used to View, Erase, or execute some other command against the matching
  1012. files.    When the "View" option is specified for a matching file, XLIST will
  1013. execute the command specified by the "VIEW" environment parameter passing the
  1014. name of the file as the first parameter.  This can be used to specify your
  1015. favorite browse utility or to specify some other type of command.  If not
  1016. specified, XLIST will invoke the TYPE command.
  1017.  
  1018. Example:
  1019.  
  1020. Find all batch files that start with either a "A" or "B":
  1021.  
  1022. FIND=[AB]*.BAT
  1023.  
  1024. The right and left bracket is used to specify optional characters in a specified
  1025. location within the name.  The normal "*" and "?" wildcard characters can also
  1026. be used.
  1027.  
  1028.  
  1029.  
  1030. /MOVE    - MOVE FILE
  1031.  
  1032. Use the MOVE command to move a file from one directory to another directory on
  1033. the same drive.  This program uses a feature of the DOS RENAME function that will
  1034. logically move a file from on directory to another.  This command will
  1035. also change the name of the file during the move if you wish.
  1036.  
  1037. Example:
  1038.  
  1039.  Fileid       │ Input Area Entry   │ Results
  1040.  ─────────────┼────────────────────┼───────────────────────────
  1041.  fn1  ext1    │ move / ..\       │ Move file up one directory.
  1042.  fn2  ext2    │ move / \       │ Move file to root directory.
  1043.  fn3  ext3    │ move / demo\*.bat  │ Move to "demo" sub-directory
  1044.           │            │ & rename file to "bat"
  1045.           │            │ extension.
  1046.  
  1047.  
  1048.  
  1049. /O    -  OMIT THE FILENAME & EXTENSION FROM COMMAND
  1050.  
  1051.  
  1052. This command is used to keep XLIST from appending the filename and extension to
  1053. the end of the command entered on the command line.  This can be useful when
  1054. entering DOS commands from the command line, since in most cases the filename
  1055. shouldn't follow the command.
  1056.  
  1057.  
  1058.  
  1059. /P    -  PAUSE AFTER EXECUTING COMMAND
  1060.  
  1061. The /P command is used to cause XLIST to pause after executing the command
  1062. entered on the command line.  This can be used in conjunction with the /C command
  1063. to allow the screen to be viewed before XLIST takes control and refreshes the
  1064. screen.
  1065.  
  1066.  
  1067.  
  1068. /RD   -  RELOAD THE XLIST DIRECTORY
  1069.  
  1070. The /RD command is used to reload the XLIST internal directory.  This can be used
  1071. to refresh the current directory when modules are added or when directory
  1072. clean-up is necessary.
  1073.  
  1074. At this time a optional parameter can be entered resetting the mask used to
  1075. select the entries to reload.
  1076.  
  1077. Example:
  1078.  
  1079. Set XLIST to only load the files with an extension of "EXE":
  1080.  
  1081. /RD=????????.EXE
  1082.  
  1083. Reload the directory with the default mask:
  1084.  
  1085. /RD
  1086.  
  1087.  
  1088.  
  1089. /RF   -  RE-FRESH THE XLIST FUNCTION KEYS
  1090.  
  1091. The /RF command is used to refresh the XLIST function definitions.  This is
  1092. useful when the "XLIST.PRO" file is changed and you want the changes to take
  1093. effect.
  1094.  
  1095.  
  1096.  
  1097. /S[-]    -  SORTING DIRECTORY
  1098.  
  1099. XLIST uses the Shell method of sorting directories when invoked by the "/S[-]"
  1100. command.
  1101.  
  1102. The following methods maybe used to sort the directory:
  1103.  
  1104.      /SA     Sort by file attribute
  1105.      /SB     Sort by filesize in bytes
  1106.      /SD     Sort by file maintenance date
  1107.      /SE     Sort by file extension name
  1108.      /SN     Sort by file name & extension
  1109.      /ST     Sort by file extension and always put the
  1110.          sub-directories on the top.
  1111.  
  1112. The command maybe optionally followed by a "-" to denote a reverse sort sequence.
  1113.  
  1114.  
  1115. Example:
  1116.  
  1117. Sort the directory by the size of the file from the largest to the smallest file:
  1118.  
  1119.      /SB
  1120.  
  1121. Sort the directory by the size of the file from the smallest to the largest file:
  1122.  
  1123.      /SB-
  1124.  
  1125.  
  1126.  
  1127. /SET  -  SET FUNCTION KEYS
  1128.  
  1129. This command provides the user with a method of defining the function keys F1-F10
  1130. interactively while XLIST is currently executing.  This command follows the same
  1131. rules under which the "*PFKEYS" profile command follow.
  1132.  
  1133. The format for the command is as follows:
  1134.  
  1135.     /SET Xnn (btd) function
  1136.  
  1137.            X = Shift key indicator
  1138.              blank = unshifted
  1139.              S = right or left shift depressed
  1140.              C = CTRL depressed
  1141.              A = ALT depressed
  1142.           nn = Function key number (1 thru 10)
  1143.          btd = Abbreviation for display (optional)
  1144.  
  1145.     function = Text of command line
  1146.  
  1147.  
  1148.  
  1149. /TREE -  XLIST DIRECTORY STRUCTURE
  1150.  
  1151. This command will load a graphic directory tree of the current drive.  From
  1152. within the directory tree, you can navigate to other sub-directories, create
  1153. directories.
  1154.  
  1155. To reload a directory tree use the /RTREE command.
  1156.  
  1157.  
  1158.  
  1159. /UD   - UPDATE DIRECTORY ENTRY WITH CURRENT DATE
  1160.  
  1161. The /UD command is used to modify a directory entries date and time stamp.  When
  1162. the command is entered with no operands the corresponding directory entries date
  1163. is set to the currently set DOS date and time.
  1164.  
  1165. The /UD command can optionally be followed be either a date or a time which is
  1166. recognize by XLIST by the forward slash for a date and the colon for a time.
  1167.  
  1168. Example:
  1169.  
  1170.     Set date to current date & time:     /UD
  1171.     Set date to July 2, 1985:         /UD=07/2/85
  1172.     Set time to 12:00 noon:          /UD=12:00:00
  1173.  
  1174.  
  1175.  
  1176. /V    - VERIFY ON ERASE or VERBOSE ON COPY
  1177.  
  1178. The /V command in conjunction with the ERASE command will prompt the user to
  1179. erase the file or not.    With the COPY command, XLIST will display the entry being
  1180. copied.
  1181.  
  1182.  
  1183.  
  1184. /nnn  - DISPLAY DIRECTORY STARTING WITH nnn ENTRY
  1185.  
  1186. The /nnn command is used to make XLIST display the current screen starting with
  1187. the nth directory entry.
  1188.  
  1189.  
  1190.  
  1191. ?  - DISPLAY LAST COMMAND ENTERED
  1192.  
  1193. The ? command will cause XLIST to display the last command entered on the command
  1194. line.
  1195.  
  1196.  
  1197.  
  1198. =  -  REPEAT THE LAST COMMAND ENTERED
  1199.  
  1200. The = command will cause XLIST to execute the last command entered for the
  1201. directory entry adjacent to the command line where the = command is entered.
  1202.  
  1203.  
  1204.  
  1205.