Remove commented out code.
[geeqie.git] / README
diff --git a/README b/README
index cb0f38b..9e12393 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,7 @@
 ###################################################################
-##                          GQview 2.1.3      (November 4, 2006) ##
+##                            Geeqie 1.1                         ##
 ##                                                               ##
+##              Copyright (C) 2008 - 2012 The Geeqie Team        ##
 ##              Copyright (C) 1999 - 2006 John Ellis.            ##
 ##                                                               ##
 ##                      Use at your own risk!                    ##
 ##       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 bugtracker:
+https://sourceforge.net/tracker/?group_id=222125&atid=1054680
 
- 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://geeqie.sourceforge.net
+
+Vladimir Nadvornik
+Petr Ostadal
+
+Please send any question or suggestions to
+geeqie-devel@lists.sourceforge.net
 
- The stable release as of this writing is 2.0.0.
 
- BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA!
 
 
 ======== README contents:
@@ -38,144 +47,37 @@ homepage: http://gqview.sourceforge.net
 
 ======== Requirements
 
-  GTK+ 2.4.x: ftp://ftp.gtk.org/pub/gtk
-
+  Required libraries:
+    GTK+ 2.20: ftp://ftp.gtk.org/pub/gtk
+
+  Optional libraries:
+    lcms, for color management support: http://www.littlecms.com
+        (disable with configure option: '--without-lcms')
+    exiv2, for enhanced exif support: http://www.exiv2.org/
+        (disable with configure option: '--without-exiv2')
+        - due to fast development, newer versions work significantly better
+        FIXME: minimal version ?
+    lirc, for remote control support: http://www.lirc.org/
+       (disable with configure option: '--disable-lirc')
+    libchamplain - experimental map support, dissabled by default
+        http://projects.gnome.org/libchamplain/
+        WARNING: this library has a lot of dependencise
+        
 ======== Notes and changes for this release            [section:release_notes]
 
-  Changes:
-
-    + Add translations eo, eu; updated translation be.
-    + Add command to view image as grayscale with [Shift]+[G].
-    - Make [F11] also toggle fullscreen.
-    - Make [Shift]+[P] show print dialog in additional places.
-    - Make [Control]+[V] display current image in a new window.
-    - Use new window icons, and include original svg images with source.
-    - Add --geometry command line option.
-    - In Pan View, make [Control]+[F] show search bar,
-      and [Control]+[G] repeat last search.
-    - Add Pan View option to display EXIF data with info popup.
-    - Add Pan View option to display full size image with info popup.
-    * Fix Pan View inability to scroll to popups that are offscreen.
-    * Fix Pan View shortcuts to work regardless of widget focus.
-    * Fix command line parsing when given multiple folders.
-    * Use correct folder name (.thumblocal) to store local thumbnails
-      as described in the freedesktop thumbnail managing standard.
-    * Fix auto rename utility to allow counting from zero.
-    * Fix [Shift]+[R] from also activating refresh when in fullscreen.
-    * Fix [Shift]+[F] from also deactivating fullscreen, then crashing.
-    * Fix long standing bug of partially obscured window not properly
-      redrawing when panning the image.
-    * Fix using [Escape] key to close image windows from eventually
-      leading to crash.
-    * Fix very slow re-sort in the file list.
-    * Fix warning when attempting to draw zero length string onto pixbuf.
-
-  Notes:
-
-    For translation status list, see further below.
-
-    Version in perenthesis indicates first appearance of feature or change.
-
-    (2.1.1) Add support for viewing jpeg images and EXIF embedded within
-    raw files for Canon (.crw, .cr2) Fujifilm (.raf), and Nikon (.nef).
-    Note that not all cameras that support a raw format will necessarily
-    save a usable jpeg in the raw file (for example some Nikon cameras only
-    store a tiny thumbnail within the raw .nef file).
-
-    (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.
+See http://geeqie.wiki.sourceforge.net/new_features
+
 
   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 )
+    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 TODO file.
 
 ======== Installation
 
@@ -183,19 +85,9 @@ homepage: http://gqview.sourceforge.net
   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
 
-  GQview is a graphics file viewer. Basic features:
+  Geeqie is a graphics file viewer. Basic features:
 
     - Single click image viewing / navigation.
     - Zoom functions.
@@ -209,9 +101,17 @@ homepage: http://gqview.sourceforge.net
     - Comparison of images to find duplicates by name, size, date,
       dimensions, or image content similarity.
     - EXIF support.
+    
+  Geeqie 1.1:
+    - 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]
 
+This sections lists default hotkeys. Most of the hotkeys can be redefined 
+in the Preferences dialog.
+
   Keyboard commands:
     [PageDown], [Keypad PageDown]      next image
     [PageUp], [Keypad PageUp]          previous image
@@ -238,10 +138,11 @@ homepage: http://gqview.sourceforge.net
     [Ctrl] - R                         rename file
     [Ctrl] - D, [Delete]               delete file
     [Ctrl] - W                         close window
-    [Ctrl] - Q                         exit GQview
+    [Ctrl] - Q                         exit Geeqie
 
   Edit menu related:
-    [Ctrl] - 1 .. 0                    run external editor
+    1 .. 6                             toggle mark
+    [Ctrl] - 1..6                      select mark
     [Ctrl] - A                         select all files
     [Ctrl] - [Shift] - A               unselect all files
     [Ctrl] - P                         display image properties window
@@ -250,7 +151,7 @@ homepage: http://gqview.sourceforge.net
     [                                  rotate image counterclockwise
     [Shift] - R                        rotate image 180 degrees
     [Shift] - M                        mirror image (horizontal)
-    [Shift] - F                        flip image (verticle)
+    [Shift] - F                        flip image (vertical)
     [Shift] - G                        grayscale image
 
   View menu related:
@@ -260,8 +161,6 @@ homepage: http://gqview.sourceforge.net
     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
@@ -269,8 +168,8 @@ homepage: http://gqview.sourceforge.net
     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] - K                         toggle sidebar with EXIF or keywords
+    [Ctrl] - E                         show EXIF window
     [Ctrl] - S                         toggle sort manager sidebar
     F, V                               toggle full screen
     S                                  toggle slide show
@@ -305,7 +204,6 @@ homepage: http://gqview.sourceforge.net
 
     [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...
@@ -368,89 +266,75 @@ homepage: http://gqview.sourceforge.net
     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, or immediately after the "%w" macro.
-    %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 macros:
-
-    %w  Prevent full screen from deactivating when command is executed,
-        must occur as the first two characters.
-
-======== 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 2.1.3)
-
-   Please send po files/patches in gzipped form to ensure data integrity.
-
-   Note: completion % in the chart below may not be quite correct when fuzzy
-         translations exist but do not appear in the source.
-         comp % = trans / (trans + fuzzy + untrans)
-
-Language     Comp (%)  Trans   Fuzzy Untrans  Warn
---------------------------------------------------
-ar                62     449     175      93
-be                99     712       1       4
-bg                93     667      27      23
-ca                93     667      27      23
-cs                93     667      27      23
-da                19     138     310     269
-de                93     667      27      23
-eo                98     707       6       4
-es                93     667      27      23
-et                28     204     307     206
-eu                99     712       1       4
-fi                93     669      25      23
-fr                98     706       4       7
-hu                52     374     211     132
-id                29     208     308     201
-it                98     704       6       7
-ja                93     667      27      23
-ko                15     114      10     593
-nl                93     669      25      23
-no                23     169     320     228
-pl                88     631       6      80
-pt_BR             98     704       6       7
-ro                54     388     213     116
-ru                93     667      27      23
-sk                96     690       7      20
-sl                21     155     326     236
-sv                92     665      28      24
-th                22     161     318     238
-tr                 9      71     309     337
-uk                25     180     316     221
-vi                98     705       5       7
-zh_CN.GB2312      23     169     320     228
-zh_TW             96     695       6      16
---------------------------------------------------
+Editors are configured via standard desktop files, see
+https://sourceforge.net/apps/trac/geeqie/wiki/GuideEditorsConfig
+
+
+======== Overlay Info                                        [section:overlay]
+
+Overlay info format string syntax is: %tag[:max_length][:extra]%
+
+  %name%       Filename of the picture.
+  %collection% Name of the collection
+  %number%     Current number of image in the list
+  %total%      Total number of images
+  %date%       File date
+  %size%       File size
+  %width%      Image width
+  %height%     Image height
+  %res%        Image resolution
+  %keywords%   Image keywords from metadata
+  %comment%    Image comment from metadata
+
+  To access exif data use the exif name:
+  %Exif.Photo.DateTimeOriginal%        Date of the original shot
+
+  Pre-formatted exif data is also available:
+  formatted.Camera              Camera and sofware name
+  formatted.DateTime            Image Date
+  formatted.ShutterSpeed        Shutter speed in seconds (ie. 1/60s)
+  formatted.Aperture            Aperture (ie. f5.6)
+  formatted.ExposureBias        Exposure bias (ie. +0.3)
+  formatted.ISOSpeedRating      ISO sensitivity (ie. 100)
+  formatted.FocalLength         Focal length
+  formatted.FocalLength35mmFilm Focal length 35mm
+  formatted.SubjectDistance     Subject distance
+  formatted.Flash               Flash
+  formatted.Resolution          Resolution
+  formatted.ColorProfile        Color profile
+  formatted.GPSPosition                GPS position
+  formatted.GPSAltitude                GPS altitude
+
+  You can limit the length of displayed data using :number notation:
+  %formatted.Camera:20% will truncate the displayed data to 20 characters
+  and will add 3 dots at the end to denote the truncation.
+
+  If two or more variables are connected with the |-sign, it prints available
+  variables with a separator:
+  %formatted.ShutterSpeed%|%formatted.ISOSpeedRating%|%formatted.FocalLength%
+  could show:
+    "1/20s - 400 - 80 mm"
+  or
+    "1/200 - 80 mm" if there's no ISO information in the Exif data.
+
+  If a line is empty, it is removed.
+  This allows one to add lines that totally disappear when no data is available.
+
+  Extra string uses special character '*' to mark the position of the data.
+  If no '*' is present, then extra string is just appended to data.
+  Any "\n" is replaced by a newline on display.
+  Pango mark up is accepted in left and right parts.
+  If data is empty, nothing will be displayed.
+
+  Examples:
+  "%name:<i>*</i>\n%" -> name is displayed in italics ended with a newline
+  "%size:\n%"         -> size is displayed with a newline at end
+  "%formatted.ISOSpeedRating:ISO *%"      -> ie. "ISO 100"
+  "%collection: Collection <b>*</b>\n%" -> display collection name in bold prefixed by
+                             "Collection " and a newline is appended
 
 
 ======== Credits                                             [section:credits]
@@ -478,6 +362,7 @@ zh_TW             96     695       6      16
      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>
@@ -514,6 +399,7 @@ zh_TW             96     695       6      16
      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>
@@ -579,7 +465,7 @@ zh_TW             96     695       6      16
          for Korean translation
 
      Pavel Piatruk <berserker@neolocation.com>
-         for Belarusion translation
+         for Belarusian translation
 
      Piarres Beobide <pi@beobide.net>
          for Basque translation
@@ -615,10 +501,25 @@ zh_TW             96     695       6      16
      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
+
+     Klaus Ethgen <Klaus@Ethgen.de>
+         for GPS integration, Search enhancement and other patches
 
+     And...
+         Thanks to the users for finding Geeqie useful.
 
-========