X-Git-Url: http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=blobdiff_plain;f=README;h=41933cfe8e44c53d317498259d92a804c4582f0a;hp=084d119ea273c364b010dd5f6d0b5fb432627fe1;hb=63a96f8504a2773d03bd8956c17eb6bb09a706c7;hpb=db594bb6a56da7a25d58a3b2ec51f67bc4d0db49
diff --git a/README b/README
index 084d119e..41933cfe 100644
--- a/README
+++ b/README
@@ -1,39 +1,31 @@
-###################################################################
-## Geeqie 1.0alpha3 ##
-## ##
-## Copyright (C) 2008 - 2009 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. ##
-###################################################################
+ ###################################################################
+ ## 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. ##
+ ###################################################################
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.
+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.
-Geeqie is currently in alpha state. Everybody is encouraged
-to try the new features, however for stable software look at
-the original project.
+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)
-For more info see:
-http://geeqie.sourceforge.net
+For more info see: http://www.geeqie.org/
-Vladimir Nadvornik
-Petr Ostadal
+Please send any question or suggestions to geeqie-devel@lists.sourceforge.net or
+open an issue on Github (https://github.com/BestImageViewer/geeqie/issues)
-Please send any question or suggestions to
-geeqie-devel@lists.sourceforge.net
-
-
-
-
-======== README contents:
+# README contents:
* Requirements
* Notes and changes for this release
@@ -45,172 +37,93 @@ geeqie-devel@lists.sourceforge.net
* Translation status
* Credits
-======== Requirements
+## Requirements
Required libraries:
- GTK+ 2.4.x: ftp://ftp.gtk.org/pub/gtk
+ 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:
- 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 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 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).
- 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 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
- 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.
+ 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 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!
+ 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 Geeqie Bug Tracker at 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
-!!! FIXME !!!
- - 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
Geeqie is a graphics file viewer. Basic features:
@@ -225,274 +138,13 @@ geeqie-devel@lists.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 (vertical)
- [Shift] - G grayscale image
-
- 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
- [Ctrl] - V display current image in new window
-
- 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...
-
- [Shift] - P print selected images...
-
- [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
-
- 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:
-
- 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.
-
- 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.
-
- %% 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
-
- 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:*\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 *\n" -> display collection name in bold prefixed by
- "Collection " and a newline is appended
-
-
-======== Additional comments:
-
- Hidden options:
- These options are not adjustable in the preferences window, to change
- 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 :)
-
- 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.
-
-
-
-======== Credits [section:credits]
-
+## Credits [section:credits]
Translations:
@@ -500,6 +152,7 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
Zbigniew Chyla
Emil Nowak
Wit Wilinski
+ Tomasz Golinski
for Polish translation
Christopher R. Gabriel
@@ -530,6 +183,7 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
Kam Tik
Abel Cheung
S.J. Luo
+ Levin
for Traditional Chinese (Big5) translation
Junichi Uekawa
@@ -553,6 +207,7 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
Thomas Klausner
Danny Milosavljevic
Ronny Steiner
+ Klaus Ethgen
for German translation
Matej Erman
@@ -626,6 +281,9 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
Antonio C. Codazzi
for Esperanto translation
+ Nikos Papadopoulos
+ for Greek translation
+
Fixes, additions, and patches:
Eric Swalens
@@ -659,64 +317,15 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
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.
-
-
-======== 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
-