"Fossies" - the Fresh Open Source Software Archive

Member "xfe-1.43.2/README" (6 Jun 2019, 18590 Bytes) of package /linux/privat/xfe-1.43.2.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "README": 1.43.1_vs_1.43.2.

    1 
    2 
    3  XFE, X File Explorer File Manager
    4  Copyright (C) 2002-2019 Roland Baudin
    5  <http://roland65.free.fr/xfe>
    6  <http://sourceforge.net/projects/xfe>
    7 
    8  This program is free software; you can redistribute it and/or modify it under the terms of the GNU General
    9  Public License as published by the Free Software Foundation; either version 2, or (at your option) any later
   10  version.
   11  
   12  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even 
   13  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
   14  See the GNU General Public License for more details.
   15 
   16  Icons were taken from different file managers and desktops: gentoo, xplore, dfm, nautilus, Gnome, KDE, XFCE
   17  and some of them were modified.
   18 
   19  This software uses the FOX Toolkit Library (http://www.fox-toolkit.org).
   20  
   21  
   22  *IMPORTANT REMARKS *
   23  
   24  1. You must use the current stable Fox version 1.6.36 (required!) or higher in the 1.6.x branch. 
   25  The current version of Xfe neither can be build using the Fox 1.0.x, 1.2.x, 1.4.x, nor using the 1.7.x series.
   26  
   27  2. UTF-8 is now supported, thus check that your LANG environment variable is set to be UTF-8 compliant otherwise
   28  accents and special characters could be wrong displayed. For composed characters to work (like ü or ê), FOX *must*
   29  be compiled with the --with-xim configure option. See the "Non Latin based languages" section of this README file for
   30  complementary informations.
   31   
   32  
   33  
   34  Description
   35  =-=-=-=-=-=
   36  
   37   X File Explorer (Xfe) is a lightweight file manager for X11, written using the FOX toolkit.
   38   It is desktop independent and can easily be customized.
   39   It has Commander or Explorer styles and it is very fast and small.
   40   Xfe is based on the popular, but discontinued X Win Commander, originally written by Maxim Baranov.
   41 
   42 
   43 
   44  System requirements
   45  =-=-=-=-=-=-=-=-=-=
   46 
   47   Xfe is written in C++ and built using the FOX graphical toolkit library. Thereore, to build the current Xfe version,
   48   you need the FOX library 1.6.x installed on your system. Note that Xfe do not compile with the development version
   49   1.7.x of FOX!
   50 
   51   Xfe is known to run on Linux based systems. It should compile and run on any Unix or Unix-like system. It doesn't run
   52   on Windows.
   53 
   54   Installation instructions are given below.
   55   
   56   	
   57  
   58  Features
   59  =-=-=-=-=
   60 
   61     - Very fast graphic user interface
   62     - Small memory footprint
   63     - UTF-8 support
   64     - Commander/Explorer interface with four file manager modes: a) one panel, b) a folder tree
   65 	  and one panel, c) two panels and d) a folder tree and two panels
   66     - Horizontal or vertical file panels stacking
   67     - Panels synchronization and switching 
   68     - Integrated text editor and viewer (X File Write, Xfw)
   69     - Integrated image viewer (X File Image, Xfi)
   70     - Integrated package (rpm or deb) viewer / installer / uninstaller (X File Package, Xfp)
   71     - Custom shell scripts (like Nautilus scripts)
   72     - Search files and directories
   73     - Natural sort order (foo10.txt comes after foo2.txt...)
   74     - Copy/cut/paste files from and to your favorite desktop (GNOME/KDE/XFCE/ROX)
   75     - Drag and Drop files from and to your favorite desktop (GNOME/KDE/XFCE/ROX)
   76     - Disk usage command
   77     - Root mode with authentication by su or sudo
   78     - Status line
   79     - File associations
   80     - Optional trash can for file delete operations (compliant with Freedesktop standards)
   81     - Auto save registry
   82     - Double click or single click files and directories navigation
   83     - Mouse right click pop-up menu in tree list and file lists
   84     - Change file attributes
   85     - Mount/Unmount devices (Linux only)
   86     - Warn when mount point are not responding (Linux only)
   87     - Toolbars
   88     - Bookmarks
   89     - Back and forward history lists for folder navigation
   90     - Path linker for folder navigation
   91     - Color themes (GNOME, KDE, Windows...)
   92     - Control themes (Standard or Clearlooks like)
   93     - Icon themes (Xfe, GNOME, KDE, Tango, Windows...)
   94     - Create archives (tar, compress, zip, gzip, bzip2, xz and 7zip formats are supported)
   95     - Extract archives (tar, compress, zip, gzip, bzip2, xz, lzh, rar, ace, arj and 7zip formats are supported)
   96     - File comparison (through external tool)
   97     - Tooltips with file properties
   98     - Progress bars or dialogs for lengthy file operations
   99     - Thumbnails image previews
  100     - Configurable key bindings
  101     - Startup notification (optional)
  102     - and much more...
  103 
  104 
  105  
  106  Default Key bindings
  107  =-=-=-=-=-=-=-=-=-=-=
  108  
  109   Below are the global default key bindings. These key bindings are common to all X File applications.
  110  
  111     * Select all 						- Ctrl-A
  112     * Copy to clipboard					- Ctrl-C
  113 	* Search                            - Ctrl-F
  114 	* Search previous                   - Ctrl-Shift-G
  115 	* Search next                       - Ctrl-G
  116 	* Go to home folder                 - Ctrl-H
  117     * Invert selection 					- Ctrl-I
  118 	* Open file                         - Ctrl-O
  119 	* Print file                        - Ctrl-P
  120     * Quit application  				- Ctrl-Q
  121     * Paste from clipboard				- Ctrl-V
  122 	* Close window                      - Ctrl-W
  123     * Cut to clipboard					- Ctrl-X
  124     * Deselect all 						- Ctrl-Z
  125 	* Display help						- F1
  126 	* Create new file					- Ctrl-N
  127     * Create new folder					- F7
  128 	* Big icon list						- F10
  129 	* Small icon list					- F11
  130 	* Detailed file list				- F12
  131     * Toggle display hidden files   	- Ctrl-F6
  132 	* Toggle display thumbnails  	    - Ctrl-F7
  133 	* Vertical panels                   - Ctrl-Shift-F1
  134 	* Horizontal panels                 - Ctrl-Shift-F2
  135 	* Go to working folder              - Shift-F2
  136 	* Go to parent folder               - Backspace
  137 	* Go to previous folder             - Ctrl-Backspace
  138 	* Go to next folder                 - Shift-Backspace
  139 	
  140 
  141   Below are the default X File Explorer key bindings. These key bindings are specific to the Xfe application.
  142 	
  143     * Add bookmark	  				    - Ctrl-B
  144 	* Filter files                      - Ctrl-D
  145     * Execute command	  				- Ctrl-E
  146 	* Create new symbolic link          - Ctrl-J
  147 	* Switch panels                     - Ctrl-K
  148 	* Clear location bar                - Ctrl-L
  149     * Mount file system (Linux only)	- Ctrl-M
  150     * Rename file						- F2
  151     * Refresh panels					- Ctrl-R
  152 	* Symlink files to location         - Ctrl-S
  153 	* Launch terminal                   - Ctrl-T	
  154     * Unmount file system (Linux only)	- Ctrl-U
  155 	* Synchronize panels                - Ctrl-Y
  156 	* Create new window					- F3
  157     * Edit 								- F4
  158     * Copy files to location			- F5
  159     * Move files to location			- F6
  160     * File properties					- F9
  161     * One panel mode					- Ctrl-F1
  162     * Tree and panel mode   			- Ctrl-F2
  163     * Two panels mode					- Ctrl-F3
  164     * Tree and two panels mode			- Ctrl-F4
  165 	* Toggle display hidden directories - Ctrl-F5
  166 	* Go to trash can                   - Ctrl-F8
  167 	* Create new root window			- Shift-F3
  168 	* View                              - Shift-F4
  169 	* Move files to trash can           - Del
  170 	* Restore files from trash can      - Alt-Del
  171 	* Delete files                      - Shift-Del
  172 	* Empty trash can                   - Ctrl-Del
  173 	
  174  
  175   Below are the default X File Image key bindings. These key bindings are specific to the Xfi application.
  176 	
  177 	* Zoom to fit window                - Ctrl-F
  178 	* Mirror image horizontally         - Ctrl-H
  179 	* Zoom image to 100%                - Ctrl-I
  180 	* Rotate image to left              - Ctrl-L
  181 	* Rotate image to right             - Ctrl-R 
  182 	* Mirror image vertically           - Ctrl-V
  183 	
  184  
  185   Below are the default X File Write key bindings. These key bindings are specific to the Xfw application.
  186 	
  187 	* Toggle word wrap mode             - Ctrl-K
  188 	* Goto line                         - Ctrl-L
  189 	* Create new document               - Ctrl-N
  190 	* Replace string                    - Ctrl-R
  191 	* Save changes to file              - Ctrl-S
  192 	* Toggle line numbers mode	        - Ctrl-T
  193 	* Toggle upper case mode            - Ctrl-Shift-U
  194 	* Toggle lower case mode            - Ctrl-U
  195 	* Redo last change                  - Ctrl-Y
  196 	* Undo last change                  - Ctrl-Z
  197 	
  198 	
  199   X File Package (Xfp) only use some of the global key bindings.
  200   
  201   Note that all the default key bindings listed above can be customized in the Xfe Preferences dialog. However,
  202   some key actions are hardcoded an cannot be changed. These include:
  203 
  204 	* Ctrl-+ and Ctrl--                 - zoom in and zoom out image in Xfi
  205 	* Shift-F10							- display context menus in Xfe
  206 	* Space								- select an item in file lists
  207 	* Return							- enter directories in file lists, open files, select button actions, etc.
  208 	* Esc								- close current dialog, unselect files, etc.
  209 
  210 
  211 	
  212  Drag and Drop operations
  213  =-=-=-=-=-=-=-=-=-=-=-=-=
  214  
  215   Dragging a file or group or files (by moving the mouse while maintaining the left button pressed)
  216   to a folder or a file panel optionally opens a dialog that allows one to select the file operation: copy,
  217   move, link or cancel.
  218 
  219 
  220 
  221  Trash system
  222  =-=-=-=-=-=-=
  223  
  224   Starting with version 1.32, Xfe implements a trash system that is fully compliant with the Freedesktop standards.
  225   This allows the user to move files to the trash can and to restore files from it, from within Xfe or your favorite
  226   desktop.
  227   Note that the trash files location is now: $home/.local/share/Trash/files
  228 
  229 
  230 
  231  Configuration
  232  =-=-=-=-=-=-=
  233  
  234   You can perform any Xfe customization (layout, file associations, key bindings, etc.) without editing any file
  235   by hand. However, you may want to understand the configuration principles, because some customizations can also
  236   easily be done by manually editing the configurations files.
  237   Be careful to quit Xfe before manually editing any configuration file, otherwise changes could not be taken
  238   into account.
  239 
  240   The system-wide configuration file xferc is located in /usr/share/xfe, /usr/local/share/xfe
  241   or /opt/local/share/xfe, in the given order of precedence. 
  242 
  243   Starting with version 1.32, the location of the local configuration files has changed. This is to be compliant
  244   with the Freedesktop standards.
  245   
  246   The local configuration files for Xfe, Xfw, Xfi, Xfp are now located in the ~/.config/xfe folder.
  247   They are named xferc, xfwrc, xfirc and xfprc.
  248   
  249   At the very first Xfe run, the system-wide configuration file is copied into the local configuration file
  250   ~/.config/xfe/xferc which does not exists yet. If the system-wide configuration file is not found
  251   (in case of an unusal install place), a dialog asks the user to select the right place. It is thus easier to
  252   customize Xfe (this is particularly true for the file associations) by hand editing because all the local options are
  253   located in the same file.
  254 
  255   Default PNG icons are located in /usr/share/xfe/icons/xfe-theme or /usr/local/share/xfe/icons/xfe-theme, depending
  256   on your installation. You can easily change the icon theme path in Preferences dialog. 
  257   
  258  
  259  
  260  Scripts
  261  =-=-=-=
  262  
  263   Custom shell scripts can be executed from within Xfe on the files that are selected in a panel. You have to first
  264   select the files you want to proceed, then right click on the file list and go to the Scripts sub menu. Last, choose
  265   the script you want to apply on the selected files.
  266   
  267   The script files must be located in the ~/.config/xfe/scripts folder and have to be executable. You can organize
  268   this folder as you like by using sub-folders. You can use the Tools / Go to script folder menu item to directly go
  269   to the script folder and manage it.
  270   
  271   Here is an example of a simple shell script that list each selected file on the terminal from where Xfe was launched:
  272   
  273   #!/bin/sh
  274   for arg
  275   do
  276   /bin/ls -la "$arg"
  277   done
  278 
  279   You can of course use programs like xmessage, zenity or kdialog to display a window with buttons that allows you to
  280   interact with the script. Here is a modification of the above example that uses xmessage:
  281   
  282   #!/bin/sh
  283   (
  284   echo "ls -la"
  285   for arg
  286   do
  287   /bin/ls -la "$arg"
  288   done
  289   ) | xmessage -file -
  290 
  291   Most often, it is possible to directly use Nautilus scripts found on the Internet without modifications.
  292    
  293  
  294  
  295  Search files and directories
  296  =-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  297  
  298   Xfe can quickly search files and directories by using find and grep command backends. This is done through the
  299   Tools / Search files menu item (or by using the Ctrl-F shortcut).
  300   
  301   In the search window, users can then specify usual search patterns like name and text, but more sophisticated search
  302   options are also available (size, date, permissions, users, groups, follow symlinks and empty files). Results appear
  303   in a file list and users can use the right click menu to manage their files, the same way as they do in the file
  304   panels.
  305   
  306   The search can be interrupted by clicking on the Stop button or pressing the Escape key.
  307  
  308  
  309  
  310  Non Latin based languages
  311  =-=-=-=-=-=-=-=-=-=-=-=-=
  312  
  313   Xfe can display its user interface and also the file names in non latin character based languages, provided that you
  314   have selected a Unicode font that supports your character set. To select a suitable font, use the
  315   Edit / Preferences / Font menu item.
  316  
  317   Multilingual Unicode TrueType fonts can be found at this address: http://www.slovo.info/unifonts.htm
  318  
  319 
  320 
  321  Tips
  322  =-=-=
  323  
  324   File list
  325     - Select files and right click to open a context menu on the selected files
  326     - Press Ctrl + right click to open a context menu on the file panel
  327     - When dragging a file/folder to a folder, hold on the mouse on the folder to open it
  328 
  329   Tree list
  330     - Select a folder and right click to open a context menu on the selected folder
  331     - Press Ctrl + right click to open a context menu on the tree panel
  332     - When dragging a file/folder to a folder, hold on the mouse on the folder to expand it
  333 
  334   Copy/paste file names
  335     - Select a file and press Ctrl-C to copy its name into the clipboard. Then in a dialog,press Ctrl-V to paste
  336       the file name.
  337     - In a file operation dialog, select a filename in the line containing the source name and paste it directly
  338       to the destination using the middle button of your mouse. Then modify it to suit your needs.
  339 
  340   Add files to the clipboard	
  341     - You can select files from a directory, copy them to the clipboard by pressing Ctrl-C. This erases the previous
  342       clipboard content. Then, you can move to another directory, select other files and add them to the clipboard
  343       content by pressing Shift-Ctrl-C. This does not erase the previous clipboard content. At last, you can move
  344       to the destination and press Ctrl-V to copy all the files you have in the clipboard. Of course, this also works
  345       with Ctrl-X and Shift-Ctrl-X to cut and paste the files.
  346       
  347   Startup notification
  348     - Startup notification is the process that displays a feedback (a sandbox cursor or whatever) to the user when he
  349       has started an action (file copying, application launching, etc.). Depending on the system, there can be some
  350       issues with startup notification. If Xfe was compiled with startup notification support, the user can disable
  351       it for all applications at the global Preferences level. He can also disable it for individual applications,
  352       by using the dedicated option in the first tab of the Properties dialog. This latter way is only available
  353       when the file is an executable. Disabling startup notification can be useful when starting an old application
  354       that doesn't support the startup notification protocol (e.g. Xterm, Xpdf).
  355 
  356   Root mode
  357     - If you use the sudo root mode, it can be useful to add password feedback to the sudo command. For this purpose,
  358       edit your sudoers file like this:
  359           sudo visudo -f /etc/suoders
  360       and then add 'pwfeedback' to the default options, as shown below:
  361           Defaults         env_reset,pwfeedback
  362       After that, you should see stars (like *****) when you type your password in the small authentication window.
  363 
  364 
  365  Install from sources
  366  =-=-=-=-=-=-=-=-=-=-=
  367 
  368   To install Xfe in /usr/local, type (the last line must be run as root):
  369 
  370     ./configure
  371      make
  372      make install
  373   
  374   To install Xfe in another place, for example in /opt, type (last line as root):
  375 
  376     ./configure --prefix=/opt
  377      make
  378      make install
  379 
  380   The above installations assume that the FOX library is installed in a standard place (/usr or /usr/local). If FOX is
  381   installed in a non standard place, for example in /opt, then you should run (last line as root):
  382   
  383   PATH=$PATH:/opt/bin CPPFLAGS=-I/opt/include LDFLAGS=-L/opt/lib ./configure --prefix=/opt
  384   make
  385   make install
  386 
  387 
  388 
  389  Build an RPM package
  390  =-=-=-=-=-=-=-=-=-=-=
  391 
  392   You first need the correct fox-1.6.x and fox-devel-1.6.x packages to be installed.
  393 
  394   To create an RPM package from the Xfe sources, simply type:
  395     rpmbuild -ta Xfe-VVV.tar.gz
  396 
  397   where VVV is the Xfe version number (e.g. 1.35).
  398  
  399   The created RPM package Xfe-VVV-1.i386.rpm is usually located in /usr/src/rpm/RPM/i386, but this
  400   may vary depending on your distribution and/or your customizations.
  401  
  402   To install the created RPM package Xfe-VVV-1.i386.rpm, enter the following command (as root):
  403     rpm -Uvh Xfe-VVV-1.i386.rpm
  404  
  405  
  406  
  407  Build a Debian package
  408  =-=-=-=-=-=-=-=-=-=-=-=
  409 
  410   You first need the correct libfox1.6 and libfox1.6-dev packages to be installed.
  411  
  412   Extract the sources and enter the source folder:
  413     tar zxvf Xfe-VVV.tar.gz
  414     cd Xfe-VVV
  415  
  416   Then, build the Debian package (no need to sign the package, thus the -uc -us options):
  417     fakeroot dpkg-buildpackage -uc -us
  418  
  419   And finally, install the created package (as root):
  420     cd ..
  421     dpkg -i Xfe_VVV-1_i386.deb
  422 
  423 
  424 
  425  Bugs
  426  =-=-=
  427  
  428   Please report any found bug to Roland Baudin <roland65@free.fr>. Don't forget to mention the Xfe version you use,
  429   the FOX library version and your system name and version.
  430 
  431  
  432  
  433  Translations
  434  =-=-=-=-=-=-=
  435   
  436   Xfe is now available in 24 languages but some translations are only partial. To translate Xfe to your language,
  437   open the Xfe.pot file located in the po folder of the source tree with a software like poedit, kbabel
  438   or gtranslator and fill it with your translated strings (be careful to the hotkeys and c-format characters),
  439   and then send it back to me. I'll be pleased to integrate your work in the next Xfe release.
  440  
  441  
  442  
  443  Patches
  444  =-=-=-=
  445  
  446   If you have coded some interesting patch, please send it to me, I will try to include it in the next release...
  447 
  448 
  449  Enjoy!
  450  
  451   Many thanks to Maxim Baranov for his excellent X Win Commander and to all people that have provided useful
  452   patches, translations, tests and advices.
  453  
  454  [Last revision: 7/11/2016]
  455 
  456 
  457