Adding debian packaging informations
[geeqie.git] / README
diff --git a/README b/README
index d9cc342..a0c4ca2 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,7 @@
 ###################################################################
-##                          GQview 2.1.2      (October 14, 2006) ##
+##                          Geeqie 1.0alpha3                     ##
 ##                                                               ##
+##              Copyright (C) 2008 - 2009 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 in alpha state. Everybody is encouraged 
+to try the new features, however for stable software look at 
+the original project.
 
- 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,26 +47,50 @@ homepage: http://gqview.sourceforge.net
 
 ======== Requirements
 
-  GTK+ 2.4.x: ftp://ftp.gtk.org/pub/gtk
+  Required libraries:
+    GTK+ 2.4.x: 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')
+    lirc, for remote control support: http://www.lirc.org/
+       (disable with configure option: '--disable-lirc')
 
 ======== Notes and changes for this release            [section:release_notes]
 
   Changes:
 
-    + Add more flexible auto-renaming option to rename dialog.
-    - Update translations de, fr, it, pl, pt_BR, ru, sk, zh_TW
-    - Add translations be, ca, ko
-    * Allow data cache reader to tolerate older/future features of GQview.
-    * Fix renaming a folder to an existing folder from clobbering
-      the existing folder.
-    * Exif timezone fix.
-    * Fix compile time warnings on newer gcc and gtk+.
+    + Add support for color profiles (requires lcms, see Notes).
+    + Add ability to delete a folder and it's contents (with restrictions).
+    - Add support for jpegs embedded in pentax and olympus raw files.
+    - Add icons for image state, enabled with I keyboard shortcut.
+    - For pan view calendar only show months that contain an image.
+    - Make scrolling with overlays (full screen info display) a bit smoother.
+    - Make sort menus display choices as radio group instead of checkbox.
+    - Use white background for transparent images when printing.
+    * Escape filename characters "`$\ before passing them to the system shell
+      when running an editor command.
+    * Fix occasional crash in icon view when removing files.
+    * Always use aligned memory access in EXIF parser, fixes crash
+      with BUS error on sparc.
+    * Fix progress bar warning when removing files while loading thumbnails.
+    * Fix image count in full screen information overlay when in slideshow.
+    * Fix memory leak when unable to start a slideshow.
 
   Notes:
 
     For translation status list, see further below.
 
-    Version in perenthesis indicates first appearance of feature or change.
+    Version in parentheses indicates first appearance of feature or change.
+
+!!! FIXME Geeqie changes !!!
+       
+    Below are GQView releases:
+    (2.1.5) Add support for color profiles when lcms is installed. To
+    disable color profiles and use of lcms, run configure
+    with '--without-lcms'.
 
     (2.1.1) Add support for viewing jpeg images and EXIF embedded within
     raw files for Canon (.crw, .cr2) Fujifilm (.raf), and Nikon (.nef).
@@ -125,7 +158,7 @@ homepage: http://gqview.sourceforge.net
     (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
+    correctly match the preferred 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
@@ -135,8 +168,8 @@ homepage: http://gqview.sourceforge.net
     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
+    (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
@@ -149,16 +182,16 @@ homepage: http://gqview.sourceforge.net
   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
+    for inclusion to the main source, please contact us 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 )
+                                                         The Geeqie Team
 
   Known bugs:
 
-    see the TODO file.
+    see the Geeqie Bug Tracker at TODO file.
 
 ======== Installation
 
@@ -166,6 +199,7 @@ homepage: http://gqview.sourceforge.net
   General install: make install
   Removal: make uninstall
 
+!!! FIXME !!!
     - To build an RPM binary:
 
          on RedHat 6.x, 7.x use 'rpm -tb gqview-x.x.x.tar.gz'.
@@ -178,7 +212,7 @@ homepage: http://gqview.sourceforge.net
 
 ======== 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.
@@ -233,7 +267,8 @@ 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:
     +, =, [Keypad +]                   zoom in
@@ -257,6 +292,7 @@ homepage: http://gqview.sourceforge.net
     F, V                               toggle full screen
     S                                  toggle slide show
     P                                 (Un)pause slideshow
+    [Ctrl] - V                         display current image in new window
 
   Collection windows:
 
@@ -292,6 +328,8 @@ homepage: http://gqview.sourceforge.net
     [Ctrl] - S                         save collection as...
     A                                  append to collection...
 
+    [Shift] - P                        print selected images...
+
     [Ctrl] - C                         copy selected files...
     [Ctrl] - M                         move selected files...
     [Ctrl] - R                         rename selected files...
@@ -327,6 +365,11 @@ homepage: http://gqview.sourceforge.net
 
     [Ctrl] - W                         close window
 
+  Pan View:
+
+    [Ctrl] - F, /                      show search bar
+    [Ctrl] - G                         repeat previous search
+
   (*) This is a compile time option enabled when strverscmp is found.
 
   Mouse image control:
@@ -342,14 +385,14 @@ 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
@@ -362,12 +405,81 @@ homepage: http://gqview.sourceforge.net
     %w  Prevent full screen from deactivating when command is executed,
         must occur as the first two characters.
 
+    %%  This will be replaced by one '%'. This is the way to escape '%'.
+
+    %d  This only makes sense for external commands like copy or move as this
+        is replaced by the destination.
+
+======== 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 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 <b>*</b>\n" -> display collection name in bold prefixed by
+                             "Collection " and a newline is appended
+
+
 ======== Additional comments:
 
-  Advanced options:
+  Hidden 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
+    them edit $(HOME)/.geeqie/geeqierc while Geeqie is not running. An option
+    becomes 'hidden' 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 :)
 
@@ -379,50 +491,6 @@ homepage: http://gqview.sourceforge.net
     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.2)
-
-   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     448     175      89
-be                98     703       6       3
-bg                93     666      27      19
-ca                93     666      27      19
-cs                93     666      27      19
-da                19     138     309     265
-de                93     666      27      19
-es                93     666      27      19
-et                28     204     306     202
-fi                54     388     213     111
-fr                99     706       3       3
-hu                52     373     211     128
-id                29     208     307     197
-it                98     703       6       3
-ja                93     666      27      19
-ko                16     114       9     589
-nl                93     668      25      19
-no                23     169     319     224
-pl                88     630       6      76
-pt_BR             98     703       6       3
-ro                54     387     213     112
-ru                93     666      27      19
-sk                96     689       7      16
-sl                21     155     325     232
-sv                93     664      28      20
-th                22     161     317     234
-tr                 9      71     308     333
-uk                25     180     315     217
-vi                53     381     213     118
-zh_CN.GB2312      23     169     319     224
-zh_TW             97     694       6      12
---------------------------------------------------
 
 
 ======== Credits                                             [section:credits]
@@ -450,6 +518,7 @@ zh_TW             97     694       6      12
      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>
@@ -486,6 +555,7 @@ zh_TW             97     694       6      12
      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>
@@ -551,7 +621,13 @@ zh_TW             97     694       6      12
          for Korean translation
 
      Pavel Piatruk <berserker@neolocation.com>
-         for Belarusion translation
+         for Belarusian translation
+
+     Piarres Beobide <pi@beobide.net>
+         for Basque translation
+
+     Antonio C. Codazzi <f_sophia@libero.it>
+         for Esperanto translation
 
  Fixes, additions, and patches:
 
@@ -581,10 +657,72 @@ zh_TW             97     694       6      12
      Vadim Shliakhov
          for miscellaneous fixes.
 
+     Uwe Ohse
+         for Exif enhancements, histogram and other patches
+
+     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 GQview useful.
+         Thanks to the users for finding Geeqie useful.
+
 
+======== Translation status:
+
+   Please send po files/patches in gzipped form to ensure data integrity.
 
-========
+Translations statistics
+Date: Fri, 05 Sep 2008 00:30:54 +0200
+
+Note: completion % in the chart below may not be quite correct
+      when fuzzy translations exist but do not appear in the source.
+      For exact results, run make update-po with up to date POTFILES.in.
+      comp % = trans / (trans + fuzzy + untrans)
+
+Language      Comp(%)  Trans  Fuzzy  Untrans  Total
+fr             100.00    996      0        0    996
+be              82.43    821     77       98    996
+ru              71.99    717    128      151    996
+eu              62.05    618    185      193    996
+eo              61.95    617    186      193    996
+vi              61.85    616    192      188    996
+it              61.65    614    187      195    996
+pt_BR           61.65    614    187      195    996
+zh_TW           60.84    606    183      207    996
+sk              60.34    601    192      203    996
+fi              58.23    580    211      205    996
+nl              58.23    580    214      202    996
+sv              58.03    578    207      211    996
+bg              57.93    577    208      211    996
+ca              57.93    577    208      211    996
+cs              57.93    577    208      211    996
+de              57.93    577    208      211    996
+es              57.93    577    208      211    996
+ja              57.93    577    208      211    996
+pl              55.32    551    180      265    996
+ar              38.86    387    332      277    996
+ro              34.34    342    352      302    996
+hu              32.93    328    342      326    996
+id              17.17    171    412      413    996
+et              16.77    167    411      418    996
+uk              14.86    148    413      435    996
+nb              13.76    137    418      441    996
+zh_CN.GB2312    13.76    137    419      440    996
+th              12.95    129    413      454    996
+sl              12.55    125    422      449    996
+da              11.85    118    406      472    996
+ko              11.04    110     65      821    996
+tr               4.92     49    395      552    996