home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / fileutil / filecom / readme.doc < prev    next >
Text File  |  1992-12-03  |  16KB  |  331 lines
  1.                   File Commando - A file utility for OS/2
  2.  
  3. For those familiar with the DOS utility Norton Commander, FC (following the
  4. axiom that imitation is the sincerest form of flattery) attempts to provide
  5. most of the same functionality under OS/2.
  6.  
  7. Using FC you can copy, move, rename, delete, find, view, and edit files in
  8. a multi-window file list.  This list shows two directories, through which
  9. you can navigate using the cursor, page up & down, home and end keys.  The
  10. TAB key switches between the two directory windows.  Pressing the RETURN key
  11. when a directory is highlighted will move into that directory.  Pressing the
  12. SPACE BAR or INS key when a file is highlighted will mark that file for later
  13. copy, move, or delete operations.  Directories cannot be marked.
  14. The + and - keys can be used to select or unselect (respectively), files
  15. matching a specified pattern.
  16.  
  17. Commands are shown at the bottom of the main screen, and most can also be
  18. accessed using mnemonic characters.  The available functions are:
  19.  
  20. F1, g - Goto:    Change the drive or directory of the current panel
  21.  
  22. F2, r - Rename:  Rename a single file
  23.  
  24. F3, v - View:    Launches a viewing program to examine the selected file.
  25.                  The viewing program is specified in the INI file, see below
  26.                  for details.
  27.  
  28. F4, e - Edit:    Launches an editor in the same way as the viewer, above.
  29.  
  30. F5, c - Copy:    Copies the current file (highlighted by the bounce bar) or
  31.                  the marked files to the other directory.  If you a press
  32.                  Copy while a directory is selected, the whole directory,
  33.                  along with all its files and subdirectories, will be copied
  34.                  to the other directory.
  35.  
  36. F6, m - Move:    Moves the current file (highlighted by the bounce bar) or
  37.                  the marked files to the other directory.
  38.  
  39. F7, k - Mkdir:   Creates a new directory in the current directory
  40.  
  41. F8, d - Delete:  Deletes the current file (highlighted by the bounce bar) or
  42.                  the marked files from the current directory.  If you press
  43.                  Delete while a directory is highlighted, FC will ask you to
  44.                  confirm removing the directory, and will then REMOVE THE
  45.                  ENTIRE SUBDIRECTORY TREE BASED AT THAT POINT.  This can
  46.                  obviously be dangerous, and YOU HAVE BEEN WARNED!
  47.  
  48. F9, f - Menu:    Brings up a menu of other functions:
  49.                  Change Sort Order:   Allows you to sort the directory list by
  50.                                       name, extension, file date and time,
  51.                                       or size.
  52.                  Compare Directories: Marks all files which do not appear in
  53.                                       both directories, or the newer version
  54.                                       of files which are in both directories.
  55.                  Find File:           Searches the disk for files matching
  56.                                       a given pattern.
  57.                  File Info:           Brings up the File Info dialog,
  58.                                       see F11 below.
  59.                  Help:                Displays a list of command keys
  60.                  Select Files:        Selects a group of files matching a
  61.                                       given pattern.
  62.                  Deselect Files:      Un-Selects a group of files matching a
  63.                                       given pattern.
  64.                  About:               Shows author and copyright info about FC.
  65.  
  66. F10, q - Quit:   Immediately terminates FC.
  67.  
  68. F11, ?:          Show full filename and attributes (for long [HPFS] filenames)
  69.                  In addition, you can change the file attributes by entering
  70.                  'A' in response to the prompt, then toggle the attributes you
  71.                  wish using the keys:
  72.                    A = Archived
  73.                    H = Hidden
  74.                    S = System
  75.                    R = Read Only
  76.                  If you want to save these attribute changes, you can then press
  77.                  ENTER to accept them, or ESC to cancel.
  78.  
  79. F12              Toggle COMMAND MODE - when in COMMAND MODE, all alphanumeric
  80.          keys are accumulated into a COMMAND BUFFER, which is
  81.          displayed at the bottom of the screen and executed when ENTER
  82.                  is pressed.  As in NC, pressing CTRL+ENTER when on a file
  83.                  name will add the filename to the current command line,
  84.                  followed by a space.  Command mode can also be activated
  85.                  on startup by entering "COMMANDMODE=YES" into your INI
  86.          file.  While in COMMAND MODE, a 'C' appears at the extreme
  87.                  lower right corner of the screen.  Because most characters
  88.                  are passed through to the command line, most of the mnemonic
  89.                  characters for commands are disabled, and commands must be
  90.                  accessed through the function keys and the menu (F9).
  91.          
  92. Other commands, not on the menu, are:
  93. +:               Select files in current panel matching a pattern.  Patterns
  94.                  are specified according to the following rules:
  95.                     '*' matches any sequence of characters (0 or more)
  96.                     '?' matches any single character
  97.                     [SET] matches any character in the specified set,
  98.                     [^SET] matches any character not in the specified set.
  99.  
  100.                     A set is composed of characters or ranges; a range looks
  101.                     like character hyphen character (as in 0-9 or A-Z).
  102.                     [0-9a-zA-Z_] is the minimal set of characters allowed in
  103.                     the [..] pattern construct.
  104.  
  105.                     To suppress the special syntactic significance of any
  106.                     of `[]*?!^-\', and match the character exactly, precede
  107.                     it with a `\'.
  108.  
  109.  
  110. -:               Un-select files in current panel matching a pattern (as
  111.                  described above).
  112.  
  113. /:               Search for a file.  This scans the current list for the first 
  114.                  file name most closely matching the string you enter at
  115.                  the 'Find:' prompt (which appears under the list windows)
  116.                  
  117. !:               Execute a command in the current directory.  This allows you
  118.                  to type in a command line to execute (at the '!' prompt).  The
  119.                  command is executed in the current session, so you cannot 
  120.                  launch a PM program.  Any '@' character in the command line
  121.                  is replaced with the full path of the current file.  A '^' 
  122.                  character is replaced with the names (but not paths) of all
  123.                  files which are marked in the current directory.  So, for 
  124.                  example, you could mark a bunch of files and then type:
  125.                     !pkzip files.zip ^
  126.                  to archive all the marked files into files.zip.
  127.  
  128. h:               Show a help screen with all command keys
  129.  
  130. ALT+F1:          Get a new drive/directory for the left panel
  131.  
  132. ALT+F2:          Get a new drive/directory for the right panel
  133.  
  134. CTRL+F1:         Re-read the directory for the left panel
  135.  
  136. CTRL+F2:         Re-Read the directory for the right panel
  137.  
  138.  
  139. The INI file
  140. ------------
  141.   For those unfamiliar with Microsoft products, many are configured using
  142. ASCII text configuration files, one of which is called TOOLS.INI  (You might
  143. be more familiar with the WIN.INI file).  This file is usually located in the
  144. directory pointed to by the INIT environment variable.
  145.   The TOOLS.INI file is divided into sections, delimited by "[SECTIONNAME]",
  146. and within each section are placed one or more configuration parameters in the
  147. format "parm = value".  Any text following a ';' is ignored.
  148.   Here is an example section from a TOOLS.INI file for FC, which shows each of
  149. the available parameters along with an explanation of what the parameter is
  150. for.
  151.  
  152.  
  153. ;-------------------Configuration for FILE COMMANDO---------------------------
  154.  
  155. ;   The first five parameters specify screen attributes used by FC.  All video
  156. ; attributes are defined as bytes as shown below.
  157. ;   Calculate a color value by taking the desired background color in the high
  158. ; nibble and the foreground color in the low nibble and computing the decimal
  159. ; equivalent.  For example, Cyan letters on a Red background would
  160. ; correspond to a Hex value of 0x43, or decimal 67.  The color values are
  161. ; shown in the chart below.
  162. ;
  163. ;
  164. ;       BLACK   0x0    BLUE      0x1    GREEN   0x2    CYAN    0x3
  165. ;       RED     0x4    MAGENTA   0x5    BROWN   0x6    LTGREY  0x7
  166. ;       DKGREY  0x8    LTBLUE    0x9    LTGREEN 0xA    LTCYAN  0xB
  167. ;       LTRED   0xC    LTMAGENTA 0xD    YELLOW  0xE    WHITE   0xF
  168.  
  169. [FC]
  170.   BorderColor = 27                ; Window Borders
  171.   WindowColor = 27                ; Window Inside Text
  172.   HilightColor = 30               ; Marked Files
  173.   SelectedColor = 48              ; Bounce Bar
  174.   HilightSelectedColor = 62       ; Bounce Bar on Marked File
  175.  
  176. ;   The VIEWER and EDITOR parameters specify the programs to be launched by the
  177. ; the VIEW and EDIT commands described above.  The full path of the executable
  178. ; file must be specified, including the extension (.com or .exe).  The '@'
  179. ; character in the command will be replaced by the full path specification of
  180. ; the selected file. See EXTENSIONS below for more info.
  181.  
  182.   Viewer = c:\os2\e.exe @
  183.   Editor = c:\os2\e.exe @
  184.  
  185. ; The COMMANDMODE parameter specifies whether or not FC will start up in
  186. ; COMMAND mode, allowing you to type a command directly instead of using
  187. ; the ! operator.
  188.  
  189.   CommandMode = NO
  190.  
  191. ; The IGNORECASE option indicated whether or not FC should ignore alphabetic
  192. ; case when comparing and sorting file names.  HPFS volumes allow you to
  193. ; distinguish between upper and lower case in file names.
  194.  
  195.   IgnoreCase = YES
  196.  
  197. ; The INSERTMODE option specifies whether text input starts in insert mode or
  198. ; overwrite mode by default.  Insert mode can sometime be toggled using the
  199. ; INS key.  The default is YES.
  200.  
  201.   InsertMode = YES
  202.  
  203. ; The CONFIRMCOPY and CONFIRMMOVE options tell FC whether or not to ask for
  204. ; confirmation when completing non-destructive copy and move operations
  205. ; (ones which would not result in a file being over-written).  The default
  206. ; for both options is YES
  207.  
  208.   ConfirmCopy = NO
  209.   ConfirmMove = NO
  210.  
  211. ;   The EXTENSIONS paramter allows you to specify commands to be executed
  212. ; when you press ENTER on a file list entry.  Each extension specified on the
  213. ; EXTENSIONS line must have a corresponding parameter listing the command (in
  214. ; the same format as for the VIEWER above) to be executed for files with that
  215. ; extension.  This command will be started in a new session, separate from FC.
  216. ; This will allow you to start PM programs from FC, as well as VIO programs.
  217. ; When launching external programs, the default is to run the program in
  218. ; whatever tyye of window the OS/2 session manager chooses, which means that
  219. ; if FC is running full screen, your external programs will be launched
  220. ; in another full-screen session, and if FC is running in a VIO window,
  221. ; external programs will also launch in a VIO window.  You can over-ride this
  222. ; default behavior by prefixing an external command with a program type
  223. ; in parenthesis.  Valid prefixes are (V) for a VIO session, (F) for a
  224. ; Full-Screen session, (P) for a PM program (usually not needed) and (C) for
  225. ; the default session.  These prefixes can also be used for the Editor and
  226. ; Viewer parameters, above.  An example is shown below for the .C extension
  227. ; Also, be sure to put the .EXE or .COM extension on the program so OS/2 knows
  228. ; what to run.
  229.  
  230.   Extensions = EXE COM CMD ZIP C
  231.   EXE = @
  232.   COM = @
  233.   CMD = cmd.exe /C @
  234.   TXT = c:\os2\e.exe @
  235.   C   = (F)VI.EXE @
  236. ;-------------------Configuration for FILE COMMANDO------------------------
  237.  
  238.   If you do not currently have a TOOLS.INI file, you can use file included
  239. in the archive with FC, which contains the example parameters shown above.
  240.  
  241.   There are four places that FC will look for its INI file, in this order:
  242.     1) In the directory specified by the '-i' command line option
  243.     2) In the directory given by the FCINI environment variable
  244.        (e.g. SET FCINI=C:\BIN)
  245.     3) In the directory given by the INIT environment variable
  246.        (e.g. SET INIT=C:\C60\INIT)
  247.     4) In the directory that FC was executed from
  248.  
  249.  
  250. Command Line Arguments
  251.   The following values can be passed to FC through their associated command
  252. line options.
  253.   -i           Don't Ignore Case in file sorting and comparisons.
  254.                The default is to ignore case
  255.  
  256.   -p[path]     Supplies the path to the TOOLS.INI file
  257.  
  258.   -f[filename] Supplies the name of the initialization file (to override
  259.                the default name of TOOLS.INI
  260.  
  261. For example:
  262.    FC -I -PC:\TMP -FFC.INI
  263. Would be a valid command line to start FC with the above options.
  264.  
  265.  
  266. Note for modem users.
  267.   Since the cursor movement keys do not usually transfer well through most
  268. terminal programs, the numbers on the numeric keypad corresponding to the
  269. cursor keys will also be accepted for movement in most lists.  In addition,
  270. all of the function key commands (except command mode) have character key 
  271. equivalents to enhance this functionality.
  272.  
  273.  
  274.   FC was written by Sean Purcell, and is copyright (c) 1991,1992 by 
  275. Sean Purcell, all rights reserved.  FC is provided as FREEWARE, no 
  276. compensation need be provided for it's use, although a six pack of good beer 
  277. is always welcome. :-)
  278.   FC has been tested with OS/2 version 1.21, 1.3, and 2.0
  279.  
  280. Send questions or comments to the author at: 
  281.         CIS: 73650,372
  282.         Internet: 73650.372@compuserve.com
  283.  
  284. Please let me know if you use this program, whether or not you like it, and
  285. what you would like to see added, enhanced, or changed.
  286.  
  287. Revision History
  288. v1.1:  Internal use, testing
  289. v1.2:  Added string editing, file selection count, sort by size,
  290.          directory stacking.  First release version.
  291. v1.9:  Beta test version for 2.0:
  292.        Fixed Move and Copy of a single file in the same directory
  293.        Fixed '/' option to find first matching file, skipping directories
  294.        Fixed PgUp and PgDn keys to behave the way they should
  295.        Removed '..' entry from the root of an HPFS volume
  296.        Changed time-sort to reverse order (newest first)
  297.        Added Command Mode
  298.        Added long filename (HPFS) support
  299.        Added '?' key to view long filenames and view and change attributes
  300.        Added help screen
  301.        Right-justified file extentions
  302.        Added check for FCINI and command line options for INI file
  303.        Added check for TOOLS.INI in the directory FC runs from
  304.        Added case sensativity options
  305.        Added support for international date/time formats
  306.        Added ALT+F1 and ALT+F2 to change directory in left & right panels
  307.        Added CTRL+F1 and CTRL+F2 to force re-read of left & right panels
  308. v1.95: Fixed some problems in Beta version
  309.        Added CONFIRMCOPY and CONFIRMMOVE options
  310.        Added support for internal OS/2 commands (DIR, COPY, etc.)
  311.        Fixed problem in directory compare caused by changing time-order sort
  312.        Added new color option for bounce bar on selected file.
  313.        Added INSERTMODE option to control default insert mode in edit fields
  314.        Fixed problem where child sessions didn't inhetit FC's current directory,
  315.          so, for example, unzipped files didn't go to the right place.
  316.        Improved (but not yet perfected) the behavior of the hilight bar when
  317.          moving up and down through the directory tree.  As long as you're
  318.          not deleting files the bounce bar should stay in the right place.
  319. v2.0:  Released to public.
  320.  
  321.  
  322. Known Problems:
  323. +  The bounce bar sometimes leaves a ghost behind after a '/' operation.
  324. +  Screen colors are not preserved when launching external programs
  325.  
  326. Plans for the Future:
  327. +  Handling ciritcal errors (e.g. no disk in drive).
  328. +  Built-in archive file viewers for popular formats (ZIP, ZOO, LZH, etc.)
  329.  
  330. $Header: F:\fc\RCS\readme.doc 1.95 1992/10/04 17:40:27 SCP Exp $
  331.