README for PCManFM-Mod v1.2.0
    (A modified version of the legacy PCMan File Manager v0.5.2)

For updates and instructions visit:
    http://igurublog.wordpress.com/downloads/mod-pcmanfm/


CONTENTS:

    DESCRIPTION
    BUILD INSTRUCTIONS 
    AUTOMATIC BUILD INSTRUCTIONS (ARCH LINUX AUR)
    MANUAL UN-INSTALL INSTRUCTIONS
    INCLUDED FILES
    MODIFICATIONS
    USAGE NOTES
    KNOWN ISSUES
    CHANGELOG FOR PCMANFM-MOD
    

DESCRIPTION:

    PCManFM-Mod is a minor fork of the legacy version of PCManFM 0.5.2, which
    uses HAL for mounting (optional) and has minimal Gnome dependencies
    (compared with the newer PCManFM version 0.9 which uses gnome-vfs).  This
    modified legacy version adds user-definable commands and other features and
    also includes a number of bugfixes as fully detailed in the MODIFICATIONS
    section below.
    
    PCManFM-Mod installs as /usr/bin/pcmanfm-mod and uses
    ~/.config/pcmanfm-mod/ as its config folder, thus making it run
    independently of other versions of pcmanfm.


BUILD INSTRUCTIONS:

1)  Install required build dependencies.

    On Arch Linux:
    Required: base base-devel desktop-file-utils gamin gtk2 hal
              shared-mime-info startup-notification intltool gettext
    Recommended: gksu gnome-icon-theme
    
    On Debian/Ubuntu:
    Required: build-essential dbus desktop-file-utils gamin hal libc6
              libcairo2 libdbus-1-3 libdbus-glib-1-2 libgamin0 libglib2.0-0
              libgtk2.0-0 libhal-storage1 libhal1 libpango1.0-0
              libstartup-notification0 libx11-6 shared-mime-info libhal-dev
              libgamin-dev libgtk2.0-dev libglib2.0-dev
              libstartup-notification0-dev libdbus-1-dev libhal-storage-dev
    Recommended: gksu gnome-icon-theme 

    Other Linux distributions will have similar named libraries.
    
2)  Extract tarball and enter directory.  The following commands will build
    and install as "/usr/bin/pcmanfm-mod":
    
        ./configure --prefix=/usr
        make
        sudo make install
        sudo install -c -m 755 pcmanfm-opener /usr/bin

3)  LXDE USERS ONLY
    If you want LXDE to use pcmanfm-mod for desktop management, you can
    remove pcmanfm and:
    
        sudo ln -s /usr/bin/pcmanfm-mod /usr/bin/pcmanfm

    See also /etc/xdg/lxsession/ and ~/.config/lxsession/ config files to
    control pcmanfm startup and desktop management.

For additional information consult the README-LEGACY and INSTALL files.


AUTOMATIC BUILD INSTRUCTIONS (ARCH LINUX AUR):

    There are two automated AUR packages for Arch Linux: pcmanfm-mod installs
    without conflicts with other versions of pcmanfm; pcmanfm-mod-prov
    provides pcmanfm but conflicts with other versions of pcmanfm (as far as
    Pacman is concerned) (recommended for LXDE users who want pcmanfm-mod to
    manage the desktop).
    
        pcmanfm-mod:       http://aur.archlinux.org/packages.php?ID=34819
        pcmanfm-mod-prov:  http://aur.archlinux.org/packages.php?ID=39547
    
    Or copy PKGBUILD and pcmanfm-mod.install to a temp folder and run:
        makepkg -si

    Or copy PKGBUILD-prov and pcmanfm-mod-prov.install into a temp folder
    and run:
        mv PKGBUILD-prov PKGBUILD
        makepkg -si


MANUAL UN-INSTALL INSTRUCTIONS:

1)  As root:
        rm /usr/bin/pcmanfm-mod
        rm /usr/bin/pcmanfm-opener
        rm -r /usr/share/pcmanfm-mod
        rm /usr/share/pixmaps/pcmanfm-mod.png
        rm /usr/share/pixmaps/pcmanfm-mod-root.png
        rm /usr/share/mime/packages/libmimetype.xml
        rm /usr/share/locale/*/LC_MESSAGES/pcmanfm-mod.mo
        rm /usr/share/applications/pcmanfm-mod*.desktop
        rm /usr/share/applications/pcmanfm-user*.desktop
        update-mime-database usr/share/mime > /dev/null
        update-desktop-database -q
        
2)  Optional: To remove pcmanfm-mod user configurations:
        rm -r /home/*/.config/pcmanfm-mod
          OR
        rm -r $XDG_CONFIG_HOME/pcmanfm-mod   # run for each user


INCLUDED FILES:

    README                          this file
    README-LEGACY                   Original README from PCManFM 0.5.2
    0.5.2 source and make files     modified source files of PCManFM 0.5.2
                                    (search for "//MOD" to see changes)
    pcmanfm-opener                  a script to open all files passed to it
    data/pcmanfm-mod*.desktop       desktop files for the PCManFM-Mod program
    data/pcmanfm-user-f*.desktop    desktop files for user commands
    data/pcmanfm-mod.png            program icon
    data/pcmanfm-mod-root.png       program icon when run as root
    PKGBUILD*                       Arch Linux makepkg build files
    pcmanfm-mod*.install            Arch Linux makepkg install files
    mkaur                           A script to create source and AUR packages


MODIFICATIONS:

    PCManFM-Mod is identical to legacy PCManFM v0.5.2 except for the
    following changes:

1)  Adds five user-definable commands to the right-click and Tools
    menus (keys F4, F6-F9).  The menu item names, icons, and
    commands are derived from .desktop files.  When run, all
    selected files are passed to the command.  (see NOTES below)

2)  An example opener script is included as the default F4
    user command, which opens all selected files. (see NOTES below)

3)  A "Run Command..." (Ctrl-R) has been added to the Tools and
    right-click menus.  This allows the user to run an 
    arbitrary command line, include %F to insert all selected
    files into the command, and optionally run the command
    in a terminal to see the output.

4)  Files can now be dragged and dropped into the Directory Tree
    side pane.

5)  The Copy/Move dialog, widened and cleaned up, now shows file
    count, transfer size, current and average speeds, time remaining.
     
6)  A "Paste as Link" (Ctrl-Shift-V) command has been added to the
    Edit and right-click menus to paste links to files on the
    clipboard.

7)  A "Paste as Target" (Alt-Shift-V) command has been added to the
    Edit and right-click menus to paste the targets of links on the
    clipboard.

8)  A "Copy as Text" (Ctrl-Shift-C) command has been added to the
    Edit and right-click menus to copy quoted filenames to the
    clipboard for pasting into a terminal.

9)  A "Copy Name" (Alt-Shift-C) command has been added to the
    Edit and right-click menus to copy filenames to the
    clipboard (without path).

10)  When a single symlink is selected, its target and target's
    size are displayed in the status bar

11) Compress and Extract now support tar.xz

12) Sticky bit is displayed in the Permissions field

13) IEC binary units now display as KB/MB/GB/TB instead of KiB/MiB/GiB/TiB,
    and IEC binary units are now the default (may be changed in Preferences)
    
14) Support added for Nautilus-style .hidden file to hide files

15) The Paste items on the content menu are now disabled if the clipboard
    does not contain a pastable file list

16) The Paste and Create items now appear on the context menu even if the
    cursor is over a file
      
17) Configuration is stored in $XDG_CONFIG_HOME/pcmanfm-mod/

18) The default home folder can be set in the main config file
    (see NOTES below)

19) "no_execute" can be set in the main config file to prevent
    launching of executables by clicking (see NOTES below)

20) "no_confirm" can be set in the main config file to delete files without
    a confirmation dialog (see NOTES below)

21) "su_cmd" can be set in the main config file to specify what su program
    is used to open a folder as root (see NOTES below)

22) ktsuss is now a supported su program

23) A different program icon (taken from Tango) is used, and a red
    folder program icon is used when in super user mode

24) The Go|Home key is changed from Alt-Home to Escape

25) The Open Terminal key is changed from F4 to Ctrl-S

26) The default button on the delete dialog is changed to Yes

27) When enter is pressed in the Rename/Overwrite dialog, rename is
    assumed

28) Ctrl-F is assigned to Create New Folder instead of search
    (pressing any normal key still initiates a search)

29) The F5 Refresh function has been improved

30) .desktop files display their actual filenames rather than name,
    except in the user's Desktop folder

31) File list is given focus when a dir is entered or a new tab added

32) When a new file/folder is created in Detailed view mode, it is given focus

33) Middle-clicking on a tab will close it

34) Copying and pasting a single folder into its own parent now
    asks for a new name rather than attempting to copy the folder into
    itself.  Pasting a folder into a selected folder no longer works.

35) Link creation (Paste or drag methods) can now generate
    overwrite/rename query instead of "File Exists" error

36) Accepts --desktop-pref, --profile, and --desktop for compatibility
    with PCManFM 0.9
    
37) Bugfix: A serious bug which caused the target of a link to be
    overwritten rather than the link itself has been corrected

38) Bugfix: A bug which caused the target names of copied links to be
    mangled been corrected
     
39) Bugfix: Right-clicking on a dangling sym-link now displays menu

40) Bugfix: Find Files now displays all results

41) Bugfix: Find Files 'Search in Sub Directories' now obeyed

42) Bugfix: Invalid cross-device link error fixed

43) Bugfix: Context menu write permissions are now based on directory
    write permission instead of one selected file; symlinks not
    erroneously followed for write permission to symlinks
    
44) Bugfix: A bug which prevented opening multiple folders on the
    pcmanfm command line has been corrected

45) Bugfix: Fixed error message on create new folder cancel

46) Bugfix: Default save folder for the Compress function is corrected

47) Bugfix: Links to broken links may now be created

48) Bugfix: Fixed syntax errors in ca.po to prevent make error
   
49) Bug Workaround: A bug in GTK 2.20 which prevents double-clicking
    should not affect pcmanfm-mod 0.9.6 and later
    See http://bugzilla.gnome.org/show_bug.cgi?id=612802


USAGE NOTES:

*** Custom Commands ***

/usr/bin/pcmanfm-opener is an example script to open all files passed
to it - by default this is assigned to F4.  Functions F6-F9 also run
the same command until you customize them.  The default pcmanfm-opener
script mostly uses xdg-open to open files - modify this script to use
your favorite apps.  USE BY THE ROOT USER IS DISABLED BY DEFAULT (edit
the script to adjust this).

To change the name and command for User Command F6, copy the file
/usr/share/applications/pcmanfm-user-f6.desktop to 
~/.local/share/applications/  Edit this file and add your desired command
to "Exec=" (do not use %F or %U, just the command name).  This can be a
custom script or an application.  Edit "Name=" to the command name as you
want it to appear on the right-click menu.  Use underscore for shortcut
keys (for example, "User Co_mmand").  "Icon=" may be added if desired.
Other commands are modified with the same method - there is one desktop
file for each.  Don't change the filenames of these .desktop
files or they won't work.


*** Config File ***

PCManFM-Mod recognizes additional settings in the [General] section of the
"main" config file:
    home_folder=FOLDER  Changes your default home folder (for the Go|Home
                        and toolbar commands)
    no_execute=1        Makes double-clicking on an executable NOT run it
    no_confirm=1        Causes no confirmation dialog when deleting files
                        (use this with caution as there is no trash can)
    su_cmd=PROGRAM      Changes the su command used by PCmanFM-Mod for
                        opening a folder as root and mounting as root

For example, with all PCManFM-Mod windows and daemons closed, edit the
file ~/.config/pcmanfm-mod/main (or main.lxde if using LXDE):
   [General]
   ...
   home_folder=/media
   no_execute=1
   no_confirm=1
   su_cmd=ktsuss


*** Hide Files ***

To hide a folder's files from view in PCManFM-Mod, create a text file in
the folder named '.hidden'  List files to be hidden in this file, one per
line (file name only, not the path).  For example, to hide a file:

   echo "hidethisexample.txt" >> .hidden


KNOWN ISSUES:

1)  The Run In Terminal mod command may not work with all terminals (choose
    your terminal in Edit|Preferences|Advanced).  The terminal must accept
    the -e argument unquoted.  These terminals are known to work: roxterm,
    aterm, konsole, xterm, Eterm, lxterminal*, gnome-terminal*.
    * Note that when using lxterminal and gnome-terminal, you cannot use
    single quotation marks (') in the command.
    

CHANGELOG FOR PCMANFM-MOD:

1.2.0:
    copy/move progress dialog count, size, speed
    added .hidden support
    fixed find files bug not displaying all results
    fixed find files recursive bug
    fixed invalid cross-device link error
    improved View|Refresh function - update model twice
    adjustments to status bar
1.1.3:
    workaround for root user roxterm dbus error
    added --desktop, --profile, and --desktop-pref for compat with 0.9
1.1.2:
    no_execute will now execute if Execute is selected from the context menu
    no_confirm added
    DSO patch for Fedora applied
    su_cmd added
    ktsuss now supported
    progress dialog simplified
    IEC binary units now show KB/MB/GB/TB; SI show kB/MB/GB/TB
    IEC binary units now default 
1.1.1:
    copy/move/delete progress dialog widened to 700
    added Copy Name (Alt-Shift-C) to Edit and context menus
    Paste and Create now always shown in context menu
    Paste items in context menu now insensitive if invalid clipboard
1.1.0:
    makefiles changed to build and install as "pcmanfm-mod"
    AUR package updated - installs as pcmanfm-mod, provides pcmanfm
    uses $XDG_CONFIG_HOME/pcmanfm-mod/ as config folder - imports from
      pcmanfm if missing
    Compress and Extract functions now support tar.xz
    Default save folder of Compress function now working folder (bugfix)
    program icons (normal and root user) changed
    refresh function improved
    middle-click on tab now closes it
    Create new file/folder in detailed list view now focuses new file
      (same behavior as icon view)
    File list given focus after create new file/folder (all views)
1.0.4:
    corrected compress/extract appearance in context menu
1.0.3:
    fixed error on drag to link in directory tree
1.0.2:
    added drag and drop to directory tree
    added Copy as Text (Ctrl-Shift-C) to Edit and context menus
    added Paste as Link and Paste as Target to context menu
    icons for user commands now displayed in context menu
    changed Run Command %U to %F (%U still works)
    home_folder used on home activate
    source tarball now bzip2
1.0.1:
    added "Edit|Paste as Target" (Alt-Shift-V) to paste targets
    fixed overwrite of link target
    context menu write permissions derive from current directory
      permissions instead of one selected file; no longer derived
      from resolved symlink target
    links to broken links may now be created
    link creation can now generate overwrite/rename query instead
      of "File Exists" error
    terminated buffer on link copy to prevent mangled target names
    AUR PKGBUILD now prefers gamin over fam
1.0.0:
    permissions now show sticky bit
    added keyboard shortcut Ctrl-S for Open Terminal
    unassigned user commands not shown in menus
    Refresh function now reloads even if busy
0.9.6:
    removed use of exo_noop_false to workaround GTK 2.20 bug 
    .desktop files in Desktop folder now display app name
    removed confusing error message from installmod script
    corrected "// MOD" to "//MOD" in ptk-file-browser.c
    added version number to About dialog
0.9.5:
    changed Tools menu "Open Terminal" to "Open _Terminal"
    added special Run In Terminal for lxterminal and gnome-terminal
      (these require -e argument quoted)
0.9.4:
    removed diagnostic error pop-up in bookmark function
    added "Edit|Paste as Link" (Ctrl-Shift-V) to paste links
    added link target and target size in status bar
    added home_folder in main config file for Go|Home
    added no_execute in main config file to stop execution
    changed program icon for root user mode to folder-saved-search
0.9.3:
    removed diagnostic premature return that prevented right-click
      'open with' menu from displaying (ptk-file-menu.c)
0.9.2:
    modified About dialog to indicate it is a modified version
    .desktop files display their actual filenames instead of name
    focus in file list after change directory and new tab
    Go|Home now Escape key instead of Alt-Home
    right-click on dangling symlink now displays popup menu
    copy/paste folder prompts for new name; no paste to selected
    rewrote str_replace used by Run Command without static buffer
    Run and Run In Terminal now have alt shortcut keys R & T
    Run In Terminal now terminates with open bash shell
    restored Open In Terminal to Tools and right-click menus
    installmod script now won't overwrite existing .desktop files
      or /usr/bin/pcmanfm-opener
0.9.1:
    fixed syntax errors in ca.po to prevent make error
    changed default button on delete dialog to Yes
    fixed error message on create new folder cancel
    improved F5 Refresh function
    added user commands and Run Command to right-click menu
    reorganized Tools menu
    fixed multiple instance -t opening of tabs
    added enter callback signal on rename/overwrite dialog
    Changed crtl-f to Create New Folder
    added uninstall instructions to README
    changed opener script - old script will not work correctly
    added desktop files for user commands and pcmanfm-mod
0.9.0:
    added user commands to Tools menu, keys F4, F6-F9
    fixed bug when opening multiple folders on command line


See also: README-LEGACY
