$Id: README,v 1.21 2004/01/23 13:45:46 cairo Exp $

this file is part of emelFM2.

emelFM2 is free software (GPL).

please send bug reports, comments or feature requests to tooar. thanks! 

RELEASE NOTE 0.0.5
~~~~~~~~~~~~~~~~~~
there are 3 things you should note:

1) the toolbar behaviour has changed a bit. style options like icon size
and item style now only affect root items, ie. the buttons on the toolbar
itself. the menu style can be changed on the interface.menus page of the
config dialog.

2) besides, pango markup is supported for button/menu labels. currently,
that's always only the first column of the tree options. you can change
the font, formating and colors with them. for more details, take a look at
http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html

3) there is a new bookmark system. if you upgrade from an earlier release,
you might want to add an item of type "<bookmarks>" to your context-menu or
toolbars.


RELEASE NOTE 0.0.4
~~~~~~~~~~~~~~~~~~
this release introduces the commandbar, a configurable replacement of the former
command line and user button bar. besides the context menu of both toolbars
has been improved and the column order of the tree options has been changed
once again. furthermore there is now an emelFM2 wiki at
http://dasui.prima.de/e2wiki/. you should also notice that the default install
PREFIX was changes to /usr/local.


HINT
~~~~
if you have filenames in your locale (ie. with german umlauts), you HAVE to set
the environment variable G_BROKEN_FILENAMES=1 to to allow emelFM2 to handle
them correctly. (it will crash if you don't)
if you don't set G_BROKEN_FILENAMES=1 emelFM2 will use utf8 to store non-ascii
characters. this might have strange results for programs which can't handle
utf8. you also may want to set LC_ALL=en_US.UTF8 or something similar.


DESCRIPTION
~~~~~~~~~~~
emelFM2 is a file manager that implements the popular two-pane design. It
features a simple GTK+2 interface, a flexible filetyping scheme, and a built-in
command line for executing commands without opening an xterm.


COMPILATION, INSTALLATION, UNINSTALLATION
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
see docs/INSTALL


HOMEPAGE
~~~~~~~~
emelFM2: http://freshmeat.net/projects/emelfm2/
wiki: http://dasui.prima.de/e2wiki/

old emelFM: http://www.pitt.edu/~macst92/emelFM/
            http://emelFM.sourceforge.net/


HELP
~~~~
your help is wanted! i'm currently looking for someone, who can make an emelFM2
icon. besides, it is always nice to get bug reports, comments or
feature requests. by the way, there is an emelFM2 wiki at
http://dasui.prima.de/e2wiki/ where some contents needs to be added.


DEFAULT KEY BINDINGS
~~~~~~~~~~~~~~~~~~~~
Open            Enter, Right         Open/Close          Ctrl+W
Up Dir          Backspace, Left      output window
Home Dir        HOME
Switch Panels   Space, Tab           Switch focus        Ctrl+Z
Tag             Ctrl+T, INS          to command line
Find            Ctrl+F
                                     Toggle Hidden       Ctrl+H
Copy            Ctrl+C               files
Copy As         Ctrl+Shift+C
Move            Ctrl+M               Maximize/Minimize   Ctrl+,  (left)
Move As         Ctrl+Shift+M         Panels              Ctrl+.  (right)
SymLink         Ctrl+S
SymLink As      Ctrl+Shift+S         Menu                Ctrl+P
Rename          Ctrl+R               Plugins Menu        Ctrl+[
Delete          DEL                  User Menu           Ctrl+]
Make Dir        Ctrl+D
Refresh         Ctrl+L
Sync Dirs       Ctrl+X
Quit            Ctrl+Q			


COMMAND LINE
~~~~~~~~~~~~
Ctrl+Enter Copies the selected filenames in the active pane
Ctrl+l     Copies the selected pathnames in the inactive pane
Ctrl+d     Copies the active directory name
Ctrl+o     Copies the inactive directory name
Ctrl+z     Change focus to current file list
Ctrl+w     toggle output window
Ctrl+e     toggle output window fullscreen
(Note: Command line shortcuts also work with Alt+<letter>)

If you prefix a command with an 'x', emelFM2 will open an xterm and execute
the command from there. For example 'x man fopen', will open an xterm with
the manpage for fopen. This is useful for interactive programs that the
emelFM2 command line can't handle.

If you prefix a command with 'su', emelFM2 will open an xterm and su to root to
execute the command. For example 'su make install', will open an xterm, prompt
for the root password, and then execute the 'make install' in the current
directory.

If you append an '&' to the end of a command emelFM2 will not capture the output
of the process.

Typing 'keys' at the command line will list the keyboard shortcuts.
Typing 'clear' at the command line will clear the output field


DRAG & DROP
~~~~~~~~~~~
Drag and drop is activated by selecting the files you want to copy/move/link,
and then clicking the middle mouse button and dragging to another location in
either of the directory lists. If you drag to a directory the files will be
copied/moved/linked to that directory, otherwise they will be copied/moved/
linked to the directory of the list. When you release the button, a menu will
prompt you for the operation you want to perform (copy/move/link). I find that
this is most useful for moving files into a subdirectory of the current
possible to drag and drop between different instances emelFM2 and some other
gtk+ apps like Gnome Midnight Commander and GQView.


ACTION NOTES
~~~~~~~~~~~~
Prefixing an action with 'x' will open an xterm to execute the action.
Prefixing an action with 'su' will open an xterm and su to root to execute the
action.
Appending the '&' character to an action will cause emelFM2 to discard the output
of the command. (By default, emelFM2 will capture the output and print it to the
output window)
prepending another '%' character to the macros (ie. '%%f') will suppress the
automatic quotes around the argument.

Macros:
%f = The selected filename(s) in the active directory
%F = The full pathname(s) of files selected in inactive directory
%d = The active directory name
%D = The inactive directory name
%{Prompt message} = Prompt for input with the message "Prompt message"

Examples:

  x rpm -qlip %f | less

This opens an xterm and executes an rpm query command and pipes the output
to 'less'. If the output were not piped to 'less', the xterm would exit after
the query finished and the user would not be able to see the results for very
long.

  su rpm -Uvh %f

This opens an xterm and su's to root, prompting for the root password. Then it
executes the RPM install command which would probably fail if done as a normal
user.

  tar xzvf %f -C %D &

This unpacks a tarball from the active directory into the inactive directory.
Because of the '&' at the end, emelFM2 will *not* capture the output.

  diff -c %f %F > %{Filename for patch:}

This runs the diff command to create a patch between the selected files,
prompting for the filename for the patch.


OTHER NOTES
~~~~~~~~~~~
you can have different context menus if you hold down shift or control while
clicking with the mouse. see the context-dialog category in the config dialog.

Right Clicking on the "Up Dir" button will take you to the home directory
Right Clicking on the "<" button will change the directory to the opposite
directory (like sync dirs).

Typing 'keys' at the command line will list the keyboard shortcuts.
Typing 'clear' at the command line will clear the output field.


COPYRIGHT & CREDITS
~~~~~~~~~~~~~~~~~~~
see docs/CREDITS
