
   [the file may be CRLF delimited,less won't have problem with it:)]

   ------------------------------------------------------------------

   VF File Manager for Unix/Linux ( VFU ) v1.42
   by Vladi Belperchinov-Shabanski "Cade" <cade@biscom.net>
   http://www.biscom.net/~cade/vfu

   ------------------------------------------------------------------
   PLEASE SEND A MESSAGE THAT CONTAINS `I'M USING/EVALUATING VFU'
   TO <cade@biscom.net>. I WANT TO KEEP TRACK OF THE INTEREST IN VFU!
                                                      Thanx.adv! Cade
   ------------------------------------------------------------------

   [0] CONTENTS:

   [0] CONTENTS:
   [1] DISCLAIMER AND LICENSE
   [2] Distribution notes
   [3] Installation notes + vfu.rc description
   [4] Usage notes
   [5] FAQs
   [6] TO DO
   [7] Troubleshooting
   [8] HISTORY
   [9] Author/contact/end notes


   ------------------------------------------------------------------
   [1] DISCLAIMER AND LICENSE

         VFU is distributed AS IS w/o warranty of any kind.
         The author does NOT guarantee problem-free work
         with VFU and He will not be liable for any direct
         or indirect damages resulted from the use of VFU.
         During the tests of VFU no damages or problems had
         been noticed.
         ( this is the old disclaimer note, but it is still true  )
         
         Since version 1.41 VFU is distributed under the GPL
         ( GNU General Public License ). See the `COPYING' for
         the full GPL text.

   ------------------------------------------------------------------
   [2] Distribution notes

     - source packages are available only for the stable versions
     - the official distribution site is http://www.biscom.net/~cade/away
     - VFU packages are named in this way: vfuXNNNT.zip where
       `X' is the platform ( `l' linux, `d' dos )
       `NNN' is version number ( NOTE: YOU SHOULD GET THE HIGHEST ONE! )
       `T' is package type ( `s' sources, `d' documentations,
                             `b' binary/dynamic-linked,
                             `i' binary/static-linked )
     - note that even if source pack is named 'l' ( linux ) it is
       the same sources for dos and other platforms. 
     - only .zip (InfoZip, PKZip) packages are distributed now.
       if someone wants .tgz pack -- call me, I'll see what can do :))

     When obtain new version always check HISTORY section in this
     document -- it often contains some usage notes/explanations!

   ------------------------------------------------------------------
   [3] Installation notes + vfu.rc description

     1. If you have problems with screen, export your terminal type, 
        for example:

        export TERM=vt100
       
        Well, I suggest first to try without this ( TERM is required
        by the Curses library if it cannot find terminal type )

     2. by default VF/U uses Joe for text editor and Less for text broser
        you can change this in the .vfurc file or via environment:

        export EDITOR=joe
        export PAGER=less

        NOTE: you CANNOT give `%f' or other macros here! if you want to
        do it -- do it in the vfurc file.

     3. vfurc file:

     $HOME/.vfurc
     or
     /usr/local/vfurc
     or
     /usr/local/lib/vfurc

     vfurc options:               | option description
     -----------------------------|----------------------------
     editor=shell-line             your (text) editor command (joe %f)
     browser=shell-line            your browser/pager command (less %f)
     pager=shell-line              same as 'browser' (cat %f|more)
     ; -note: you should try first the internal browser
     ;        to do so just leave `browser/pager' option out!

     presetdir0=dirname/path
      preset favorite dirs Alt+1 
     ...
     presetdir9=...
               Alt+9
     dir1=...                      these are aliases for presetdir1
     ...                           ...
     dir9=...                      == presetdir9 etc.

     cGREEN=.ext.ext.ext.          which files are GREEN
     chGREEN=.ext.ext.ext.         which files are Light(Hi) GREEN
     cBLUE=...                     ... BLUE
     ...

     ux=descr,key,.exts.,shell-line define user external command

     ---eof-----------------------|----------------------------

     See sample `vfurc' from the VFU pack.

     some examples:
     1. add "presetdir5=/usr/bin" to .vfurc
     2. press "`" + "5" and vfu will change directory to "/usr/bin"...
        (or press alt-5 on some terminals)

     3. cBLUE=.cpp.c.h.cxx.
     4. cYELLOW=.zip.Z.tgz.gz.

     5. UserExternals example:

        ux=TEST ZIP,KEY_F4,.zip.,unzip -t %f
        ux=View HTML,KEY_ENTER,.html.htm.,lynx %f

     6. UserExternals keys are:
        F1   -- F1
        F10  -- F10
        #F1  -- SHIFT+F1
        #F10 -- SHIFT+F10
        @F1  -- ALT+F1   (not available under Linux)
        @F10 -- ALT+F10  (not available under Linux)
        ^F1  -- CTRL+F1  (not available under Linux)
        ^F10 -- CTRL+F10 (not available under Linux)
        IC   -- `Insert' key
        INS  -- `Insert' key
        INSERT -- `Insert' key
        ENTER  -- `Enter' key

     'shell-line's may contain these macros:

     %f  -- replaced w. current filename (w/o path)
     %F  -- replaced w. full pathname of the current file
     %e  -- current file name without extension
     %E  -- current file extension
     %s  -- current file size
     %c  -- current path ( with slash at the end )
     %C  -- startup path ( with slash at the end )
     %R  -- re-read directory content after shell
     %?  -- prompt for user input and replace it in. if you press
            ESC shell will be aborted.
     %w  -- wait a key after shell. replaced w. `' (i.e. empty string)
     %x  -- replaced w. `x'. `x' can be any char that doesn't recognized
            as any of the previous macros. so `%%' becomes `%',
            `%^' -> `^', `%A' -> `A', etc.

     DOS version only:
     %_  -- use short file names (SFN) for %f and %F
     %\  -- use backslashes for paths

   ------------------------------------------------------------------
   [4] Usage notes

     1. Archives support
        VFU supports archives as kind of storage/directory, so you
        can enter into archive, browse/view the files, select some
        of them and copy/extract to somewhere.

        Supported archives are:
        ZIP -- PKZIP 2.04, InfoZip unzip 5.12
        TAR -- TapeArchiver
        TGZ -- TapeArchiver+GZIP (tar z)
        GZ  -- alias for TGZ ( may be disabled )
        BZ2 -- TapeArchiver+BZip2
        TBZ -- alias for BZ2
        ARJ -- ARJ 2.41
        RAR -- RAR 2.00
        LZH -- LHarc 1.14

        Of course all these archives are supported through the
        appropriate external executable!

        WARNING: some of the following archivers notes/limitations 
                 may be out of date!

        Limitations/Notes:
        -- UC2 -- still cannot open .uc2 files on read-only devices
                 (I cannot imagine why UC2 should try to write when
                  the only thing is to report archive contents!?)
                  Workaround: when UC2 report write-error you
                  should answer `A'-Abort and everything will be
                  just fine.

                  I could NOT find way to print file directly to
                  the console/stdout with UC2. Actually there is
                  one alternative -- you have to change this line
                  in AIP-NL.INI file:

                  PRINT-FILE = COPY % PRN ^ ECHO + > PRN
                  to
                  PRINT-FILE = cat %
                  or
                  PRINT-FILE = type %

                  This is needed to view files from .uc2 archives.

        -- LHA -- my version (1.14) doesn't support list files
                  (@listfile -- this is big problem)
                  so you can only browse/view files from LZH's

        -- RAR -- All zero size files are not read from the file
                  list -- these files are accepted as directories.
                  (Well, really there is a dir-attribute but I cannot
                  rely on it for compatibility reasons)

        -- JAR -- same as RAR but not for compatibility reasons :)
                  Also cannot print files to stdout.

        -- ZIP -- for compatibility reasons and for LFN's under Win95
                  (s*** anyway) zip files are handled with
                  InfoZip/unzip utility. However if you haven't
                  unzip you can use pkunzip through this BAT file:

                  ---cut-here---
                  @echo off
                  pkunzip %1 %2 %3 %4 %5 %6 %7 %8 %9
                  ---cut-here---

                  Just name it `unzip.bat' and place it somewhere
                  in the PATH directories.


   ------------------------------------------------------------------
   [5] FAQs

     1. What is `TP' field on the third line?
        This stands for "type" and means:
        [] -- directory
        <> -- link to directory
        -> -- link
        ** -- executable
        ++ -- character device
        ## -- socket
        () -- FIFO (pipe)
        == -- block device
        -- -- regular file

     2. Does VFU follows directory links when calculating directory(ies) size?
        No. :)

     3. I cannot see entire filename?
        Try '>' -- it will show only filenames... or  
        Try options/toggle `1'..`6'.

     4. What means this `!' at the end of the directories sizes?
        It means that the shown size is taken from the directory entry info,
        but not exact size of all files in it. Press `z' or `Z' to
        calculate real size of the directory (the sum of all files' sizes
        in it). Note: this can hardly be seen by now :)

     5. Do I need to set `HOME' environment variable under DOS, and where
        it is supposed to point?
        Yes. In general, the HOME directory is used to keep all
        configuration and status files. Well, if you don't set it, VFU
        will accept the VFU starting directory as HOME.
        But keep in mind that VFU is UNIX file manager in nature so
        it can use HOME under DOS for something else in the future, 
        so it is recommended to set it. ( just to be safe )

     6. How can I use `JumpToMountpoint' function under DOS?
        The information for this function comes from the `/etc/mtab'
        file. This file always show currently mounted file systems.
        Under DOS platform the only way is to simulate this file, which
        is quite simple -- You have just to create `_vfu.mtb' file in the
        HOME directory. The example content of this file is:
        ---cut---
        -        c:/
        -        d:/
        -        j:/
        ---cut---
        Please note the leading `-', it must be here. However you can
        add whatever you want ( I mean paths ), but normally you just 
        should add roots of all drives.

     7. I've just created `some/newdir' in the current directory. VFU
        reported no error, but I cannot see it.
        Well, you just have to hit 'r' to reload directory content.
        I know this may be confusing at first, but you'll get used to
        it quite fast. :)

     8. What `ExitCDHack' option means?!
        I couldn't find way to change working directory form inside VFU,
        and exit with it (I suppose this cannot be done?). `bash' always 
        returns to the working directory in which I've started VFU. So... if you want to use that do following:

        -- turn `ON' the `ExitCDHack' option ( VFU will save needed exit
           directory to `HOME/.vfu.hcd' )
        -- put this command into `.profile'
           ---cut---
           alias vf="vfu; cd \`cat ~/.vfu.hcd\`; rm ~/.vfu.hcd"
           ---cut---
        -- done.

        After this you can use `q' to exit VFU and cd to the VFU's current
        working directory.

        NOTE: DOS version should work without this -- the `q'uit function
              will work alone.

        *if you have problems with this option, please send me message*

     9. What is `Name###' sort order? And why should I RTFM?! :)
        Well, you have to RTFM 'cos this `Name###' is not much meaningfull
        I think.
        So... the example follows:

        file names are: `vs011.txt', `vs04.txt', `vs030.txt'
        sort order is : `Name'
        the result is : `vs011.txt', `vs030.txt', `vs04.txt'

        sort order is : `Name###'
        the result is : `vs04.txt', `vs011.txt', `vs030.txt'

        And in a few words: if the file name (until first dot if exist)
        ends with number, VFU will sort them in regard to the numeric
        values found at the ends of the filenames.

        NOTE: This mode drops all after the first dot (for now)!
        NOTE: This mode will be replaced with normal `Name' sort
              order when restart VFU.

    10. How is done the tilde expansion in VFU?
        There is no real tilde expansion in VFU now. If you enter
        tilde `~' in the first position of the input line -- it will
        be replaced with the HOME directory. In any other case it
        will be added as normal char. Note that if tilde is hit first
        it will be positioned on position 0 -- i.e. it will get expanded.
        `~username/' works as well.

        FAQ: If I enter just `~' vfu complains there's no such path, why?
             You have to add '/', i.e. enter `~/' instead of `~'.

    11. Whenever I type a file mask it becomes different (with `*' to
        the front or the end). Why is that?!
        This is mask expansion -- it is explained below. If you don't
        like it you can turn it off form the `Options'
        (key `O' or Alt+O)

    12. What are the mask expansion rules?
        If no `*' or `?' found in the mask then:
          1. add `*' at the end
          2. if mask starts with `.' then add `*' to the front
        else
          1. leave it `as is'
        Just try it -- if you don't like the expansion -- switch it
        off: Options(Toggles)/FilesMaskExpand and FileFindMaskExpand.

    13. Can I browse/view more than one file at the same time?
        Yes! You have just to select needed files and press 'B'
        (browse). Then use `1'..`0' to switch between files/slots.
        The limit is 10 files.
        
    14. What `Show Real Free Space' option means?
        Most of the operating systems keep users from filling the
        entire disks. So there is two `free spaces' the one is the
        `real free space' ( i.e. physical one ) and `user free space' 
        which is the free space available to any user.
        By default VFU shows the free space available to the user.
        If you want to use the real free space count -- turn this on.

   ------------------------------------------------------------------
   [6] TO DO

     1. ...

   ----------------------------------------------------------------------
   [7] Troubleshooting

     1. By now the main problem is change from version to version.
        If you hit a problem first of all try to delete:

          `.vfu.opt' in UNIX/Linux

        or

          `_vfu.opt' in DOS

        This file keeps configuration + cache -- is safe to delete
        it anytime (You'll have to do some config after that anyway).

     2. If you get `Segmentation fault/Core dumped/SIGABRT/etc...'
        on VFU launch try first to erase `.vfu.opt'/`_vfu.opt' file
        from your home directory and try to restart VFU.

     3. Currently after editing of `.vfu.rc' file from inside VFU you
        should restart the program to reload properly some
        options/user-externals.


   ----------------------------------------------------------------------
   [8] HISTORY

      + feature add
      - feature changed
      x feature removed
      ! bugfix
      % note

   1.42: 03.Feb.98
   
      + 1. External scanning ( panelize ).
           Just enter `command |' in the files masks input line
           to use it ( i.e. instead of "*.txt" enter 
           "find / -name '*.txt'" ).
           
      ! 2. The problem with files/dirs' sizes >2GB is now fixed!
      
   1.41: 04.Dec.97
   
      + 1. Added Options/FileCopyPreserveOwner/Group option.
           If enabled VFU will try to preserve files owner and
           group id's on copy/move if possible.

      - 2. Now `dir1' is equal to `presetdir1' etc. in the vfurc
           meaning.

      + 3. BZip2 archives now supported
           NOTE!: you have to get tar-1.2+ patched to support -I
           option which is BZip2 support. required extensions for
           such files are `bz2' or `tbz' (second one is mine:))

      + 4. `Time/Touch' entry added to the `EditEntry' function
            (TAB key), i.e. change file(s)'s modify and access
            times.

      + 5. Now VFU expands ~ with username (~cade/boo) but only if
           target directory is started with ~.
        
      + 6. Added `Show Real Free Space' toggle to the options.

      + 7. Recursive rescanning added ( Ctrl+R key menu ). Now
           you can operate over all files from a tree branch!
           
      + 8. A lot of cleanup work done.     

   0.40 ... 1.41: xx.xxx.xx

      % 0. FAQ: Why is this? You have skipped these version numbers?
           Well the answer is something like:

           The versions 0.xx were meant to be kind of alpha/beta
           versions and are not supposed to be released to the public
           in the beginning ( didn't happen :)). Well, the
           versions after 0.40 are considered `stable' and `official'
           now, so I've added `1' to them... ( there's 1 year since
           BETA status was removed :))
      
   0.40: 31.Sep.98

      + 1. Internal Text/Hex file viewer/browser added!
           See Options/InternalViewer. Hit `H' to get help inside
           viewer. (The viewer is available and as standalone
           utility called `See')

      + 2. Extended filename completion: now you can enter for
           example: `/level/next/one[mM]o?r*' and hit TAB to complete!

      + 3. Everywhere you enter directory path you can use:
             Ctrl+X -- expand to real path
             Ctrl+A -- delete back one dir level
             Ctrl+S -- show list with matching directories (kind of
                       visual tab-completion)

      + 4. Key-names for `user external commands' are shorter:
             KEY_F1 is now F1
             KEY_SH_F1 is now #F1 (Shift+F1)
             KEY_ALT_F1 is now @F1 (not available under Linux)
             KEY_CTRL_F1 is now ^F1 (not available under Linux)
             KEY_IC is now either INSERT, INS or IC
             KEY_ENTER is now ENTER

      + 5. `Tools/Classify move' tool added.

      + 6. `GlobalSelect/Extended/Find;Scan;Hex;Regexp;String' added!

      + 7. Extended FileFind menu added (Ctrl+N).
           FileFind with Find/Scan/Hex/Regexp string added.

      - 8. New Options/Toggles system (Now it is more flexible for
           adding/displaying new toggles -- really sorry if you
           liked old one :( )

      + 9. Now file types: `** [] <> () etc...' can be used instead
           of file extensions in the user external command:
           ux=EXECUTE,INS,.**.,%w

      +10. Now VFU has option to zap/erase READ-ONLY files. (see options)

      +11. Many command line switches added! (run `VFU -h' for help)

      +12. Find/Scan/Hex/Regexp string search added to the internal
           file viewer/browser!

      +13. User External Commands are now available and in InArchive
           mode!

      +14. FileMasks expanding added to `files mask' filter and file find
          tool.
          ( for more details see `FAQ/What are the mask expansion rules' )

      +15. GlobalSelect/Different function added.

   0.30: 25.Sep.98

      + 1. Archives support! Now VFU supports the following archives:
           zip, tar, tgz, uc2, arj, lha, rar
           (for more details see `Usage notes' section)

      + 2. Now VFU follows sym-links.

   0.22: 30.Aug.98

      % 1. Support VFUSHELL environment variable -- it is used to
           override SHELL variable (to use login shell for example)

      + 2. Added `GlobalSelect/All+Dirs' function.
      + 3. Preserve timestamps on copy.
      + 4. Report target file status on overwrite (copy/move/etc.).
      + 5. `Insert/Overstrike' modes in all input lines.
      + 6. Added `History' to most of the input lines.
           (try PageUp/PageDown keys in input lines)

      + 7. Now incremental search can work and with patterns.
          (for example if you enter `>*.cpp' VFU will track on all
           *.cpp files -- please note the leading `>'!)

      - 8. Now options(keywords) in the vfu.rc file are
           NOT case sensitive.
           (for example you can type `BrOwSeR=less %f')

      + 9. `TrimTree' option added to vfu.rc.
            example: TrimTree=/mnt/cdrom/ /proc/ /tmp/
            You can use these separators: [,:;] and space.
            DOS users note: TrimTree doesn't support
            driveletters! I mean if you want to trim `c:/tmp/'
            you should add `TrimTree=/tmp/' but this will cut also
            `d:/tmp/' -- This is NOT bug but WAD.
      +10. Now you can use file type identifiers for filename
           colorization (also `dotfiles' for `.name' dotfiles).
           For example:

           cGREEN=.cpp.h.**.().
           cRED=.[].txt.dotfiles.
           cBLUE=.<>.

           all .cpp, .h, executable files and pipes are GREEN
           all .txt, dotfiles and directories are RED
           all links to directories are BLUE


   0.21: 02.Aug.98

      % 0. Oops... I forgot -- If someone want to know why I'm
           trying to support DOS platform: the reason is that I
           use DJGPP+RHIDE for development environment -- it is
           more comfortable than gcc+joe :) Well I know that
           there is RHIDE for Linux but I haven't tried it yet...

      + 1. New files' attributes/mode set/get engine.
           Now VFU supports different attrib's under
           different OS-es transparently:
           Linux/UNIX: `drwxrwxrwx'
           DOS:        `DV----RHSA'

      + 2. `VFFilenames' style added for DOS *only*! This means
           all dirs' names are upper case and all files' names
           are lower case (but this is only for the screen!)

      + 3. Added IncrementalSearch to the file list and the
           directory tree ( key Ctrl+S, and TAB to advance ).

      + 4. Copy/Move/Erase now work on directories (w. entire
           substructures)!

      + 5. `CDTree' option added. This is similar to bash's
           CDPATH env.variable but the needed path is searched
           in the directory tree. For example: if you are in the
           HOME directory and try to ChDir to `rc.d' -- VFU will
           check for HOME/rc.d, which not exist, then will try to
           find such dir in the DirTree (if the tree is not built,
           VFU will try to just to load it from disk), most probably
           `/etc/rc.d/' will be found and VFU will ChDir to it.

      + 6. New shell-macros: %e, %E, %s, %R, %c, %C
      + 7. Added `JumptToMountpoint' function ( key `J' )
      + 6. Added `MakeDirectory' to `Tools' menu ( key `T' )

   0.20:  4.Jul.98

      % 0. Changes are too much to list (will try to describe
           most important ones). The main change is that

           -- VFU goes portable --

           Currently it supports Linux, Solaris, DOS(!).
           (I mean that I have compiled it for these OS-es myself)
           Win32 version is on the way...
           Note that DOS version supports long filenames (LFN's)!
           To use this support you have to `set LFN=Y' in the
           environment.

      + 1. `Options/Toggles' screen added (key `O' or Alt+O)
           Options menu (key `o') still exists but is empty for now.
      + 2. Now you can switch off parts of file informations
           (i.e. mode/attr, owner, group, time, size...
            see Options/Toggles).
      + 3. DirectoryTree added (key Ctrl+D) incl. hot key
           search `a'-`z'.
      + 4. `DynamicScroll' option added -- it switch all lists
           scrolling between `page-by-page' or `line-by-line'.

   0.15: 15.Mar.98

      + 1. FileFind function added. (key `n')
      ! 2. Screen redraw after shell fixed.

   0.14: 17.Oct.97

      + 1. SymLinks -- `l' key.
      ! 2. RmDir/Links bug is now fixed.
      ! 3. Other minor bugfixes.

      % 4. Since VF/U passed large enough test period without
           any major problems or any kind of data loss etc.,
           `BETA' status has been removed.

   0.13BETA: 17.Oct.97

        There's not such version really. :) trust me... :)

   0.12BETA: 06.Oct.97

      + 1. GlobalSelect/+/-/= -- select/deselect by mask.
      + 2. UserExternals commands added (see vfurc description).
      + 3. Now vfu will search for environment variables 'EDITOR'
           and 'PAGER' (or 'BROWSER') to set editor and pager/browser.
           (if not given in vfurc file)
      + 4. TAB/chown now accepts 'username.groupname' instead
           of 'uid.gid'.
      + 5. GlobalSelect/Same..name/ext/size/owner/group added.
      + 6. Inline editing caps added.
      + 7. File masks added.
      + 8. VFU or VF screen/view styles added.

   0.11BETA: 20.Aug.97

      ! 1. Some bugfixes.

   0.10BETA: 07.Aug.97

      ! 1. bug with following directory links when calculating
           directory(ies) size is now removed.
      ! 2. now vfu shows file type correctly. (links,dir.links)
      + 3. link realpaths are now shown: "linkname -> realpath".
      + 4. "Tools/r-realpath" added, shows real path for a link.
      + 5. "Options" added -- key "o"/"O".
      ! 6. problem with unknown uid/gid is now fixed.
      + 7. "ChDirHistory" added -- key "D".

   0.09BETA: 01.Apr.97

      + 1. now vfu prompts you before overwriting existing file.
           (while copy or move files)

   0.08BETA: 30.Mar.97

      ! 1. get dir name logic fixed.
           ( don't worry if you don't know what that means,
             however it's better now :))

   0.07BETA: 28.Mar.97

      % 0. elf version.
      - 1. now tab-completion procedure adds '/' at the end.
      + 2. octal mode chmod (TAB+A+\).
      + 3. now vfu remembers last copy/move paths.
      + 4. chdir shows last path you were in.

   0.06BETA:

      history lost...

   ----------------------------------------------------------------------
   [9] Author/contact/end notes

   that's all for now ...

   If you cannot understand something (?) feel free to send mail to me.

   NOTE1: I WILL BE GLAD TO RECEIVE YOUR BUG REPORTS AND/OR ADVISES!

   NOTE2: PLEASE,... READ NOTE1!

   NOTE3: DO CHECK [ http://www.biscom.net/~cade/vfu ] OFTEN!
          THERE MIGHT BE NEW VERSION...

   Vladi Belperchinov-Shabanski `Cade'. <cade@biscom.net>

   An emergency (:)) address is <cade@iname.com>

   ------------------------------------------------------------------
   EOF
