Documentation update
[geeqie.git] / README
diff --git a/README b/README
index d86391a..41933cf 100644 (file)
--- a/README
+++ b/README
@@ -1,30 +1,31 @@
-###################################################################
-##                          GQview 2.1.0         (March 5, 2005) ##
-##                                                               ##
-##              Copyright (C) 1999 - 2005 John Ellis.            ##
-##                                                               ##
-##                      Use at your own risk!                    ##
-##                                                               ##
-##  This software released under the GNU General Public License. ##
-##       Please read the COPYING file for more information.      ##
-###################################################################
+      ###################################################################
+      ##                          Geeqie x.x                           ##
+      ##                                                               ##
+      ##              Copyright (C) 2008 - 2016 The Geeqie Team        ##
+      ##              Copyright (C) 1999 - 2006 John Ellis.            ##
+      ##                                                               ##
+      ##                      Use at your own risk!                    ##
+      ##                                                               ##
+      ##  This software released under the GNU General Public License. ##
+      ##       Please read the COPYING file for more information.      ##
+      ###################################################################
 
-Author: John Ellis <johne@verizon.net>
-e-mail: gqview@users.sourceforge.net
-homepage: http://gqview.sourceforge.net
+This is Geeqie, a successor of GQview.
 
+Geeqie has been forked from GQview project, because it was not possible to
+contact GQview author and the only maintainer. Geeqie projects goal is to move
+the development forward and also integrate the existing patches.
 
- BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA!
+Geeqie is currently considered stable. Please report any crash or odd behavior
+to the [mailing list](https://lists.sourceforge.net/lists/listinfo/geeqie-devel)
+and/or to [Github](https://github.com/BestImageViewer/geeqie/issues)
 
- The 2.1.x series are all development releases, and as such may
- contain incredible bugs. Only use if interested in the new features.
+For more info see: http://www.geeqie.org/
 
- The stable release as of this writing is 2.0.0.
+Please send any question or suggestions to geeqie-devel@lists.sourceforge.net or
+open an issue on Github (https://github.com/BestImageViewer/geeqie/issues)
 
- BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA!
-
-
-======== README contents:
+# README contents:
 
     * Requirements
     * Notes and changes for this release
@@ -36,144 +37,95 @@ homepage: http://gqview.sourceforge.net
     * Translation status
     * Credits
 
-======== Requirements
-
-  GTK+ 2.4.x: ftp://ftp.gtk.org/pub/gtk
-
-======== Notes and changes for this release            [section:release_notes]
-
-  Changes:
-
-    + Add Pan View window (name pending) for displaying images as a timeline,
-      calendar, folder tree, folder flower (name pending) and basic grid.
-      Keyboard shortcut for Pan View is Control + J (may change in future).
-    + Panning an image with the mouse while holding down the shift key will
-      increase speed.
-    + Add 'Fast jpeg thumbnailing' option, on by default.
-    - Demote xvpics support to a hidden option.
-    - Update French translation.
-
-
-  Notes:
-
-    For translation status list, see further below.
-
-    Version in perenthesis indicates first appearance of feature or change.
-
-    (1.5.6) The "shared thumbnail cache" is a proposal to unify the method
-    of storing thumbnails, so that they are compatible between different
-    applications. Using this option will allow GQview to share it's
-    thumbnails with, and use thumbnails from, other applications. Current
-    releases of GNOME (through nautilus and gthumb) and the gimp use this
-    new thumbnailing system. The latest draft of the thumbnail standard
-    is located on freedesktop.org in the standards section, and links to:
-
-      http://triq.net/~jens/thumbnail-spec/index.html
-
-    The shared thumbnail standard and GQview's classic mechanism can
-    not be used at the same time, enabling the "use shared thumbnail cache"
-    option will disable the use of classic thumbnails and use the new
-    shared thumbnails.
-
-    (1.5.6) Collections contained in $HOME/.gqview/collections are now
-    updated when moving or renaming files, even if the collection is not
-    open at the time.
-
-    (1.5.6) The new option to the keep the full screen window above other
-    windows is only available when using at least GTK+ 2.4.0
-
-    (1.5.5) Dialog buttons are now ordered as recommended by the GNOME HIG.
-    The GNOME Human Interface Guidelines live at:
-       http://developer.gnome.org/projects/gup/hig/
-    To restore the old button order you must be using GTK 2.6 and set
-    the "gtk-alternative-button-order" key to TRUE in the gtkrc file:
-       $HOME/.gtkrc-2.0
-    by changing or adding this line:
-       gtk-alternative-button-order = 1
-
-    (1.5.5) The dithering option is now a hidden option, to change it
-    please refer to section 10.7 of the manual (help -> contents).
-
-    (1.5.0) Keywords and comments can now be entered for a file. Two places
-    allow keyword and comment entry. The first is via the new image details
-    sidebar accessed with (Ctrl-K), and the second is a details tab in the
-    properties dialog. If multiple files are selected, two buttons are
-    available: One allows adding the keywords to the selected files, the
-    other replaces existing keywords with the new keywords.
-
-    Keyword and comment metadata is stored in $(HOME)/.gqview/metadata, and
-    mirrors the existing filesystem tree. Metadata filenames have a suffix
-    of .meta appended. If 'cache into .thumbnails' is enabled, metadata is
-    stored locally to the original file in a hidden subfolder ".metadata".
-    If write permissions do not allow local saving of metadata, GQview falls
-    back to the default $(HOME)/.gqview/metadata location.
-
-    (1.5.0) Search dialog (F3 key) types:
-       Path       searches files in the entered folder.
-       Comments   searches all file metadata stored in ~/.gqview/metadata.
-       Results    searches the current list of results, allowing refinement.
-
-    (1.3.6) Drag and drop has been significantly improved, with a few
-    changes. Button 1 will now initiate a drag, button 2 will still work
-    for this, the difference is button 2 will not change the selection.
-
-    (1.3.6) A middle button click will now toggle selection of clicked item.
-
-    (1.3.5) UTF-8 and filenames: GQview works fine if your filenames
-    correctly match the prefered locale encoding (LANG environment
-    variable), and prints errors on the console when they do not.
-
-    (1.3.3) Safe delete does not include undo, you will need to go to the
-    trash folder and retrieve the file(s) manually. The files can be viewed
-    by clicking the view button near the safe delete option in the preferences
-    window. Files moved to the trash folder are prefixed with a 6 digit
-    number. Lower numbers are older, and deleted (permanently) first when the
-    trash size limit is reached.
-
-    (1.3.2) New in 1.3.2 are sidebars for exif data display and a sort
-    manager. Exif (ctrl + E) should be self explanatory. The Sort manager is a
-    directory list that allows copying or moving the displayed image to that
-    destination with one click of the button - very helpful when visually
-    sorting many images into subdirectories. To edit, reorder, or remove items
-    in the sort list, use the right click menu. The keyboard can also be used
-    by moving the focus to the desired button, then pressing menu/ctrl+f10 key
-    to display the popup menu, or shift+up/shift+down keys to change the
-    button location in the list. Items can also be added to the list by
-    dragging a directory onto the list.
+## Requirements
+
+  Required libraries:
+    GTK+ 3.00
+               www.gtk.org
+               enabled by default
+               disable with configure option: --disable-gtk3
+    or
+    GTK+ 2.20
+               disabled by default when GTK+3 libraries are found.
+               enable with configure option: --disable-gtk3
+              optional items map display and GPU acceleration are not available
+              with GTK2
+
+              Note: GTK+3 is still somehow experimental. It is needed for some
+              features but we have several complains about the GTK+3 usability.
+
+              So if you need a stable version, you are advised to compile it
+              with GTK+2. If you want to play with the cool new features, use
+              GTK+3.
+
+  Optional libraries:
+    lcms2 2.0
+    or
+    lcms 1.14
+               www.littlecms.com
+               for color management support
+               enabled by default
+               disable with configure option: --disable-lcms
+
+    exiv2 0.11
+               www.exiv2.org
+               for enhanced exif support
+               enabled by default
+               disable with configure option: --disable-exiv2
+
+    lirc
+               www.lirc.org
+               for remote control support
+               enabled by default
+               disable with configure option: --disable-lirc
+
+    libchamplain-gtk 0.12
+    libchamplain 0.12
+    libclutter 1.0
+               wiki.gnome.org/Projects/libchamplain
+               for map display
+               disabled by default
+               enable with configure option: --enable-map
+               enabling will also enable GPU acceleration
+
+    libclutter 1.0
+               www.clutter-project.org
+               for GPU acceleration (a check-box on Preferences/Image must also be ticked)
+               disabled by default
+               enable with configure option: --enable-gpu-accel
+               explicitly disabling will also disable the map feature
+
+    lua 5.1
+               www.lua.org
+               support for lua scripting
+               enabled by default
+               disable with configure option: --disable-lua
+
+## Notes and changes for this release            [section:release_notes]
+
+See NEWS file.
 
   Code hackers:
 
-    If you plan on making any major changes to the code that will be offered
-    for inclusion to the main source, please contact me first - so that we
-    can avoid duplication of effort. A good example is porting any part of
-    GQview that uses deprecated widgets to GTK2 widgets, there are already
-    several such patches floating around. This is especially true if the
-    change is listed in the TODO!
-                                             -John ( johne@verizon.net )
+    If you plan on making any major changes to the code that will be offered for
+    inclusion to the main source, please contact us first - so that we can avoid
+    duplication of effort.
+                                                         The Geeqie Team
 
   Known bugs:
 
-    see the TODO file.
+    See the Geeqie Bug Tracker at https://github.com/BestImageViewer/geeqie/issues
 
-======== Installation
+## Installation
 
-  Compilation: ./configure ; make
+  Compilation: ./autogen.sh ; make
+  Show compile options: ./autogen.sh --help
   General install: make install
   Removal: make uninstall
 
-    - To build an RPM binary:
-
-         on RedHat 6.x, 7.x use 'rpm -tb gqview-x.x.x.tar.gz'.
-         on RedHat 8 and 9 use 'rpmbuild -tb gqview-x.x.x.tar.gz'.
-         on other rpm distros, it depends on which version of rpm is used, if
-         the option fails with the rpm command, try rpmbuild.
-
-      Where the resulting package is placed is distribution specific, for
-      example in RedHat it is placed in /usr/src/redhat/RPMS/{architecture}/
+## Description / Features
 
-======== Description / Features
-
-  GQview is a graphics file viewer. Basic features:
+  Geeqie is a graphics file viewer. Basic features:
 
     - Single click image viewing / navigation.
     - Zoom functions.
@@ -186,231 +138,13 @@ homepage: http://gqview.sourceforge.net
     - Collections.
     - Comparison of images to find duplicates by name, size, date,
       dimensions, or image content similarity.
+      - Rotation invariant detection
     - EXIF support.
+    - support for stereoscopic images
+      - input: side-by-side (JPS) and MPO format
+      - output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
 
-======== Documentation (brief)                         [section:documentation]
-
-  Keyboard commands:
-    [PageDown], [Keypad PageDown]      next image
-    [PageUp], [Keypad PageUp]          previous image
-    [Home], [Keypad Home]              first image in list
-    [End], [Keypad End]                last image in list
-    [Tab]                              tab completion in path entry window
-    [Escape]                           cancel completion in path entry window
-
-  Keyboard commands valid when image has focus (image has black rectangle)
-    arrow keys, [Keypad arrows]        pan image
-    [Shift] - arrow keys               pan image faster
-    [Space]                            next image
-    [Backspace] , B                    previous image
-
-  File menu related:
-    [Ctrl] - N                         new window
-    C                                  new empty collection
-    O                                  open collection
-    D                                  open a Find Duplicates window
-    [Shift]- P                         open Print dialog
-    [Ctrl] - F                         new folder
-    [Ctrl] - C                         copy file
-    [Ctrl] - M                         move file
-    [Ctrl] - R                         rename file
-    [Ctrl] - D, [Delete]               delete file
-    [Ctrl] - W                         close window
-    [Ctrl] - Q                         exit GQview
-
-  Edit menu related:
-    [Ctrl] - 1 .. 0                    run external editor
-    [Ctrl] - A                         select all files
-    [Ctrl] - [Shift] - A               unselect all files
-    [Ctrl] - P                         display image properties window
-    [Ctrl] - O                         configure Options
-    ]                                  rotate image clockwise
-    [                                  rotate image counterclockwise
-    [Shift] - R                        rotate image 180 degrees
-    [Shift] - M                        mirror image (horizontal)
-    [Shift] - F                        flip image (verticle)
-
-  View menu related:
-    +, =, [Keypad +]                   zoom in
-    -, [Keypad -]                      zoom out
-    Z, [Keypad /]                      zoom to original size
-    X, [Keypad *]                      zoom to fit within window
-    W                                  zoom to fit width of window
-    H                                  zoom to fit height of window
-    1, 2, 3, 4                         zoom to Nx (3 = 3x)
-    9, 8, 7                            zoom to -2, -3, -4, respectively
-    T                                  toggle thumbnails in list view
-    [Ctrl] - L                         display files as list view
-    [Ctrl] - I                         display files as icon view
-    [Ctrl] - T                         toggle tree view of directories
-    R                                  refresh list
-    L                                  (Un)float file selection area
-    [ctrl] - H                         (Un)hide file selection area
-    [Ctrl] - K                         toggle Keywords sidebar
-    [Ctrl] - E                         toggle EXIF sidebar
-    [Ctrl] - S                         toggle sort manager sidebar
-    F, V                               toggle full screen
-    S                                  toggle slide show
-    P                                 (Un)pause slideshow
-
-  Collection windows:
-
-    arrows, [Keypad arrows]            move selection
-    [Shift] + arrows                   select multiple images
-    [Ctrl] + arrows                    move without changing selection
-    [Space]                            select only image with focus
-    [Ctrl] + [Space]                   toggle selection of image with focus
-    [Home], [Keypad Home]              move focus to top of images
-    [End], [Keypad End]                move focus to end of images
-      (shift and ctrl work with Home, End, PageUp/Down as with arrows)
-    [Ctrl] - A                         select all images
-    [Ctrl] - [Shift] - A               unselect all images
-
-    [Delete], [Keypad Delete]          remove selected images from collection
-                                       (does not delete file)
-    [Ctrl] - L                         add images from main window file list
-
-    [Ctrl] - T                         toggle display of icon filename text
-
-    N                                  sort collection by name
-    D                                  sort collection by date
-    B                                  sort collection by size (bytes)
-    P                                  sort collection by location (path)
-    I (*)                              sort collection by name numerically
-                                   (file1 file10 file2 -> file1 file2 file10)
-
-    [Enter], [Keypad Enter]            view image with focus in main window
-    V                                  view image with focus in new window
-    [Ctrl] - 1 .. 0                    open selected image(s) in editor
-
-    S                                  save collection
-    [Ctrl] - S                         save collection as...
-    A                                  append to collection...
-
-    [Ctrl] - C                         copy selected files...
-    [Ctrl] - M                         move selected files...
-    [Ctrl] - R                         rename selected files...
-    [Ctrl] - D                         delete selected files
-
-    [Ctrl] - P                         display image properties window
-
-    [Ctrl] - W                         close window
-
-  Find Duplicates window:
-
-    [Ctrl] - A                         select all images
-    [Ctrl] - [Shift] - A               unselect all images
-    1                                  select group 1 duplicates
-    2                                  select group 2 duplicates
-
-    [Ctrl] - L                         add images from main window file list
-    C                                  add selected images to new collection
-
-    [Delete], [Keypad Delete]          remove selected images from list
-    [Ctrl] - [Delete]                  clear window
-
-    [Enter], [Keypad Enter]            view image with focus in main window
-    V                                  view image with focus in new window
-    [Ctrl] - 1 .. 0                    open selected image(s) in editor
-
-    [Ctrl] - C                         copy selected files...
-    [Ctrl] - M                         move selected files...
-    [Ctrl] - R                         rename selected files...
-    [Ctrl] - D                         delete selected files
-
-    [Ctrl] - P                         display image properties window
-
-    [Ctrl] - W                         close window
-
-  (*) This is a compile time option enabled when strverscmp is found.
-
-  Mouse image control:
-
-    Button 1                           view next image
-    Button 2                           view previous image
-    Button 3                           context menu
-
-    Button 1 drag                      scroll/pan image
-    Button 2 drag                      initiate drag and drop
-
-    Wheel up/down                      change to previous/next image
-    Wheel up/down + [Shift]            scroll image up/down
-    Wheel up/down + [Control]          zoom image in/out
-
-======== Editor command macros                               [section:editors]
-
- Any one of the following filename markers may be used:
-
-    %f  Replaced with list of selected files, may occur once.
-    %p  Command is run once for each selected file, may occur multiple times.
-   none When neither %f or %p exist, list of files is appended to command.
-
- Use of the following to display output window for the command:
-
-    %v  Display result of command in output window, must occur as first two
-        characters in the command.
-    %V  Like v above, but when used with %p, only displays output window for
-        multiple files. The output of a single file is suppressed.
-
-======== Additional comments:
-
-  Advanced options:
-    These options are not adjustable in the preferences window, to change
-    them edit $(HOME)/.gqview/gqviewrc while GQview is not running. An option
-    becomes 'advanced' when it is removed from the user's visibility, and
-    only remains so that those few users that really want it will not complain
-    about it's removal :)
-
-  lazy_image_sync: false
-    Set true to enable the old behavior of lazy image updates when changing
-    directories. (viewed image will remain until a new file is selected)
-
-  display_dialogs_under_mouse: false
-    Set true to force dialogs to display under the current mouse position,
-    note that this goes against the preference set for the window manager.
-
-======== Translation status:
-
- (as of 1.5.8)
-
-   Please send po files/patches in gzipped form to ensure data integrity.
-
-Language     Comp (%)  Trans   Fuzzy Untrans  Warn
---------------------------------------------------
-ar                67     448     149      70
-bg               100     667       0       0
-cs                58     387     186      94
-da                20     137     286     244
-de                56     375     185     107
-es               100     667       0       0
-et                30     203     283     181
-fi                58     387     189      91
-fr                91     609      50       8
-hu                55     373     186     108
-id                31     207     284     176
-it               100     667       0       0
-ja               100     667       0       0
-nl               100     667       0       0
-no                25     168     296     203
-pl                80     538      51      78
-pt_BR             25     168     296     203
-ro                58     387     188      92
-ru               100     667       0       0
-sk                58     387     189      91
-sl                23     154     302     211
-sv                99     664       2       1
-th                24     161     295     211
-tr                10      70     286     311
-uk                26     179     292     196
-vi                56     380     189      98
-zh_CN.GB2312      25     168     296     203
-zh_TW             55     368     186     113
---------------------------------------------------
-
-
-
-======== Credits                                             [section:credits]
-
+## Credits                                             [section:credits]
 
   Translations:
 
@@ -418,6 +152,7 @@ zh_TW             55     368     186     113
      Zbigniew Chyla <cyba@gnome.pl>
      Emil Nowak <emil5@go2.pl>
      Wit Wilinski <wit.wilinski@gmail.com>
+     Tomasz Golinski <tomaszg@math.uwb.edu.pl>
          for Polish translation
 
      Christopher R. Gabriel <cgabriel@pluto.linux.it>
@@ -427,12 +162,14 @@ zh_TW             55     368     186     113
 
      Sandokan <cortex@nextra.sk>
      Ivan Priesol <priesol@iris-sk.sk>
+     Mgr. Peter Tuharsky <tuharsky@misbb.sk>
          for Slovak translation
 
      Rodrigo Sancho Senosiain <ruy_ikari@bigfoot.com>
      Ariel Fermani <the_end@bbs.frc.utn.edu.ar>
          for Spanish translation
 
+     Laurent Monin <i18n@norz.org>
      Eric Lassauge <lassauge@users.sf.net>
      Jean-Pierre Pedron <jppedron@club-internet.fr>
      Pascal Bleser <pascal.bleser@atosorigin.com>
@@ -446,6 +183,7 @@ zh_TW             55     368     186     113
      Kam Tik <kamtik@hongkong.com>
      Abel Cheung <deaddog@deaddog.ws>
      S.J. Luo <crystal@mickey.ee.nctu.edu.tw>
+     Levin <zjlevin@hotmail.com>
          for Traditional Chinese (Big5) translation
 
      Junichi Uekawa <dancer@debian.org>
@@ -456,6 +194,7 @@ zh_TW             55     368     186     113
 
      Guilherme M. Schroeder <slump@ieg.com.br>
      Vitor Fernandes <vitor_fernandes@SoftHome.net>
+     Herval Ribeiro de Azevêdo <heraze@gmail.com>
          for Brazilian Portuguese translation
 
      Shingo Akagaki <akagaki@ece.numazu-ct.ac.jp>
@@ -467,6 +206,8 @@ zh_TW             55     368     186     113
      Matthias Warkus <mawarkus@t-online.de>
      Thomas Klausner <wiz@danbala.ifoer.tuwien.ac.at>
      Danny Milosavljevic <danny_milo@yahoo.com>
+     Ronny Steiner <Post@SIRSteiner.de>
+     Klaus Ethgen <Klaus@Ethgen.de>
          for German translation
 
      Matej Erman <matej.erman@guest.arnes.si>
@@ -525,11 +266,35 @@ zh_TW             55     368     186     113
      Youssef Assad <youssef@devcabal.org>
          for Arabic translation
 
+     catux.org <mecatxis@ya.com>
+         for Catalan translation
+
+     Hyun-Jin Moon <moonhyunjin@gmail.com
+         for Korean translation
+
+     Pavel Piatruk <berserker@neolocation.com>
+         for Belarusian translation
+
+     Piarres Beobide <pi@beobide.net>
+         for Basque translation
+
+     Antonio C. Codazzi <f_sophia@libero.it>
+         for Esperanto translation
+
+     Nikos Papadopoulos
+        for Greek translation
+
  Fixes, additions, and patches:
 
      Eric Swalens
      Quy Tonthat
-         for Exif support.
+         for initial Exif support.
+
+     Daniel M. German <dmgerman at uvic.ca>
+         for Canon raw image support.
+
+     Lars Ellenberg
+         for Fujifilm raw image support.
 
      Diederen Damien <D.Diederen@student.ulg.ac.be>
          for .xvpics thumbnail reading support.
@@ -547,10 +312,20 @@ zh_TW             55     368     186     113
      Vadim Shliakhov
          for miscellaneous fixes.
 
+     Uwe Ohse
+         for Exif enhancements, histogram and other patches
 
-     And...
-         Thanks to the users for finding GQview useful.
+     Timo Horstschäfer
+         for customizable fullscreen overlay
+
+     Michael Mokeev
+         for print related enhancements
 
+     Carles Pina i Estany
+         for copy path to clipboard patch
 
-========
+     Kjell Morgenstern
+         for random slide show speedup patch
 
+     And...
+         Thanks to the users for finding Geeqie useful.