home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 206.lha / Flist_v1.2 / Flist.doc < prev    next >
Encoding:
Text File  |  1988-12-28  |  9.5 KB  |  222 lines
  1. NAME
  2.  
  3.     flist - file lister and sorting utility
  4.  
  5. SYNOPSIS
  6.  
  7.     flist [directory] [FROM file] [?]
  8.  
  9. DESCRIPTION
  10.  
  11.     Flist will display files as given on the command line, or if there
  12.     are no arguments the current directory. Flist allows  commands to 
  13.     be executed as if they were typed at a CLI. The list of files may
  14.     be sorted by name, time, size or by a pattern. Most of flist's commands
  15.     are control sequences as defined below.
  16.  
  17.     You may also specify the name of a file that contains file names to 
  18.     be displayed by flist.
  19.  
  20.     Control sequences are indicated by the '^' character preceding an
  21.     uppercase letter. To invoke the command from flist it is not necessary
  22.     to capitilize the letter. You may also use the Menu shortcuts, which
  23.     for the most part follow the same lettering scheme as the control 
  24.     sequences (but check first).
  25.  
  26.     ^A - Invoke the ARP filerequestor. The ARP filerequestor will appear on
  27.     the flist screen starting at the RAM: directory. All that is required
  28.     is for the user to select a directory for flist to display. By clicking
  29.     on the right mouse button, you can get a list of devices in the system.
  30.     When the directory that is desired is displayed by the requestor, then
  31.     select the OK button. If you want to abort the operation then select
  32.     the CANCEL button.
  33.  
  34.     ^C - Abort flist. If you want to terminate flist from the keyboard,
  35.     typing control-c will bring up a requestor to make sure that this is
  36.     what you want to do. (HINT: hitting A-v will select the OK button)
  37.  
  38.     ^D - Change directory. (Refer to the diagram below) To change directory
  39.     place the cursor opposite a 'Dir' entry in flist using the cursor keys
  40.     (input area 6). Typing control-d at this time will change directory 
  41.     to the left (Directory1) of the input area.
  42.  
  43.  
  44.     ---------------------------------------------------------------------
  45.     | Current directory   Files = 10                                    |
  46.     ---------------------------------------------------------------------
  47.     | filename1     |                   | date  time    filesize        |
  48.     | filename2     |                   | date  time    filesize        |
  49.     | filename3     |                   | date  time    filesize        |
  50.     | filename4     |                   | date  time    filesize        |
  51.     | filename5     |                   | date  time    filesize        |
  52.     | Directory1    | ^D                | date  time     Dir            |
  53.     | filename7     |                   | date  time    filesize        |
  54.     | filename8     |                   | date  time    filesize        |
  55.     | filename9     |                   | date  time    filesize        |
  56.     | filename10    |                   | date  time    filesize        |
  57.                         ^^input area
  58.  
  59. and so on...
  60.  
  61.     ^K - Kill (delete) file. By placing the cursor to the right of the filename
  62.     that is to be deleted (also directories) and typing control-k, the 
  63.     filename will be deleted from the media.
  64.     
  65.     ^L - Restore screen. This command redraws the entire screen. It also
  66.     resets all the internal pointers to the top of the list.
  67.  
  68.     ^N - Make new directory. A string requestor will appear, prompting
  69.     you to enter the name of the new directory. Hitting return with
  70.     no entry in the requestor will do nothing.
  71.  
  72.     ^P - Get parent directory. Typing the sequence control-p will force
  73.     flist to go up the file structure one level.
  74.  
  75.     ^R - Rename file/directory. A string requestor will prompt you to enter
  76.     the new file. The cursor will continue to be displayed to indicate the
  77.     file that is to be changed. Hitting return with no entry in the requestor
  78.     will do nothing.
  79.  
  80.     ^S - Sort the filenames and directories alphabetically.
  81.  
  82.     ^Z - Sort the filenames by size. Directories will be listed first.
  83.  
  84.     ^Y - Sort the filenames by the day created.
  85.  
  86.     ^T - Sort the filenames and directories by creation TIME.
  87.  
  88.     ^O - Sort the filenames by pattern. A string requestor will promt you
  89.     to enter the pattern to sort the current list by. Hitting return with
  90.     no entry in the requestor will do nothing. Entering a pattern will
  91.     exclude all entries in the list except those that match the pattern.
  92.     Patterns may be standard AmigaDOS or ARP wildcards.
  93.  
  94.     ^G - Re-get the current directory. Useful if you move or sort the
  95.     files, and you want Flist to be operating on current information.
  96.  
  97.     ^U - Erase the contents of the current line and place the cursor at 
  98.     the beginning of the input area.
  99.     
  100.     ^X - Invoke an Flist AREXX macro. A string requestor will prompt you
  101.     to enter the macro name. Hitting return with no entry in the requestor
  102.     will do nothing.
  103.  
  104.     Help key - Hitting the help key will give you a synopsis of the 
  105.     keyboard control commands. Type any key on the main keyboard (make 
  106.     sure the help window is activated) to get rid of the help window.
  107.  
  108.     SHIFT-UP - Holding the shift key down and pressing the up arrow key
  109.     will move the list up by 10 lines (if possible).
  110.  
  111.     SHIFT-DOWN - Holding the shift key down and pressing the down arrow key
  112.     will move the list down by 10 lines (if possible).
  113.  
  114.     SHIFT-LEFT - Holding the shift key down and pressing the left arrow key
  115.     will move the cursor to the first character on the typed line.
  116.  
  117.     SHIFT-RIGHT - Holding the shift key down and pressing the right arrow key
  118.     will move the cursor to the last character on the typed line.
  119.  
  120.     INPUT AREA:
  121.  
  122.         The input area provides a powerful tool for the lazy typist (me).
  123.         As an example, say you want to copy two files to another directory.
  124.         First type the command 'copy ' on any line, then place the cursor 
  125.         opposite the first file to copy (using the up and down arrow keys)
  126.         and then press the Esc key. The file name will be inserted into the 
  127.         input area. Then to get the second file name, move the cursor again
  128.         to the line opposite the second file name and press the Esc key again.
  129.         Then type the volume or directory path for the files destination and 
  130.         hit return to execute the command. Flist will update the line/screen
  131.         as the cursor moves up or down the display.
  132.  
  133.     If the command is larger than the input area, then Flist will scroll
  134.     up to 90 characters to fit the input into the display.
  135.  
  136. AmigaDOS SUPPORT:
  137.  
  138.     Flist will execute any command that is typed in the input area
  139.     and in the current search path. To execute a command, type it in
  140.     with the correct path information, and hit return. Flist will open
  141.     a window for I/O (for those commands that require output or an inter-
  142.     active stream) and ask for you to hit return when the command has
  143.     finished execution.
  144.  
  145.     Many of the most usefull operations that can be performed on a directory
  146.     are included as standard functions in Flist. It is adviseable to use
  147.     these features instead of bypassing Flist and executing the command 
  148.     directly. In this way you can always be sure that list of files that are
  149.     displayed represent the true state of the directory. If you perform an
  150.     operation that does change the state of the directory, such as moving
  151.     a file to another directory, typing ^G (re-get directory) will re-initial-
  152.     ize the directory list.
  153.  
  154. AREXX SUPPORT:
  155.  
  156.     To initiate an Flist/AREXX macro program, select 'Execute REXX' from 
  157.     the menu. Or 'Ae' (left or right amiga and 'e') or even ^X (control-x)
  158.     to invoke the string requestor. The string requestor will prompt you 
  159.     to enter the macro name. If you are in the directory containing the 
  160.     supplied 'fl.flex' example, all you need type in the requestor is:
  161.  
  162.         'fl' and the return key (don't type the single quotes).
  163.         
  164.     You NEVER have to type the extension '.flex' when invoking a macro.
  165.  
  166.     Flist supports the following commands from the AREXX port. They are:
  167.  
  168.     'sort s'    - sort alphabetically.
  169.     'sort z'    - sort by size.
  170.     'sort t'    - sort by creation TIME.
  171.     'sort o'    - sort by pattern.
  172.     'sort y'    - sort by day.
  173.     'iconify'   - iconify Flist.
  174.     'end'       - tell Flist to stop listening to AREXX.
  175.     'parent'    - get the parent directory.
  176.     'redraw'    - redraw the screen.
  177.     'reget'     - reget the current directory.
  178.     'request'   - Bring up the ARP filerequestor.
  179.     'makedir'   - make a new directory.
  180.     'changedir "dirname"' - change to "dirname" directory.
  181.  
  182.     A more extensive command set is planned for the future.
  183.  
  184.     An Flist/AREXX macro must have the extension '.flex'.
  185.  
  186.     An Flist/AREXX macro must reside either in the current directory
  187.     or the REXX: logical directory.
  188.  
  189.     The line 'address "flport"' must preface any flist commands.
  190.  
  191.     If for some reason Flist is stuck waiting for a command from REXX
  192.     you can type this line (exactly) in another CLI to break the deadlock:
  193.  
  194.         rx "address 'flport' 'end'"
  195.  
  196.     See the supplied 'fl.flex' program for an example.
  197.  
  198. AUTHOR
  199.  
  200.     A lot of the code in Flist came from the public domain. That is the
  201.     primary reason Flist is PD, it's my way of saying thanks! The various
  202.     authors whose code fragments I borrowed are:
  203.     
  204.     Leo Schwab          -   iconify routines.
  205.     W.G.J. Langeveld    -   PathName routines.
  206.     Carolyn Schnepper   -   code stolen from timerwin.c
  207.  
  208.     My name is:  Steve (Raz) Berry. 
  209.  
  210.  I can be reached at:
  211.  
  212.     The Checkered Ball
  213.     A-7 Sinai Circle
  214.     Chelmsford, Ma. 01824
  215.     c/o Steve (Raz) Berry
  216.  
  217.     BIX: razberry
  218.     UUCP: ...alliant!mistress!amiga
  219.  
  220.     This is not a Shareware product. But don't let that stop you from sending
  221.     cash!
  222.