summaryrefslogtreecommitdiff
path: root/man/feh.pre
diff options
context:
space:
mode:
Diffstat (limited to 'man/feh.pre')
-rw-r--r--man/feh.pre110
1 files changed, 83 insertions, 27 deletions
diff --git a/man/feh.pre b/man/feh.pre
index 419820c..cd65b83 100644
--- a/man/feh.pre
+++ b/man/feh.pre
@@ -41,6 +41,9 @@ libexif builtin EXIF reader $MAN_EXIF$
.It
inotify-based auto-reload of changed files $MAN_INOTIFY$
.
+.It
+libmagic $MAN_MAGIC$
+.
.El
.
$MAN_DEBUG$
@@ -151,34 +154,41 @@ pnm, tiff, and bmp.
The gif format is also supported, but only for static images.
In case of animations, only the first frame will be shown.
.
-If the convert binary
-.Pq supplied by ImageMagick
-is available, it also has limited support for many other file types, such as
-svg, xcf and otf.
-If dcraw is available,
-.Nm
-also supports RAW files provided by cameras and will display the embedded
-thumbnails.
-Use
+.Pp
+.
+When invoked with
.Cm --conversion-timeout Ar timeout
-with a non-negative value to enable support for these formats.
+.Po
+and a non-negative
+.Ar timeout
+value
+.Pc ,
+.Nm
+also has limited support for various other file types by means of external
+conversion programs.
+If the dcraw binary is available,
+.Nm
+will use it to display the thumbnails embedded into RAW files provided by
+digital cameras and similar.
+If the ImageMagick convert binary is available,
+.Nm
+will use it to load file types such as svg, xcf, and otf.
.
.Pp
.
-As Imlib2 may take several seconds to determine whether it can load a file or
-not
-.Pq e.g. when attempting to open a large video ,
+.Pq optional feature, $MAN_MAGIC$ in this build
+.Nm
+can use libmagic to only pass image files to Imlib2.
+When using
.Nm
-checks each file's header before loading it.
-If it looks like an image, it is passed on to Imlib2, otherwise, it is
-assumed to be unloadable.
-This greatly improves performance when working in directories with mixed files
-.Pq i.e., directories which do not exclusively contain image files .
+with lots of non-image files
+.Pq especially with Imlib2 version 1.6.x or 1.7.0 ,
+this can speed up the detection of non-image files significantly.
If you think that Imlib2 can load a file which
.Nm
has determined to be likely not an image, set the environment variable
.Qq FEH_SKIP_MAGIC
-to pass all files directly to Imlib2, bypassing the header check.
+to pass all files directly to Imlib2, bypassing this check.
The environment variable's value does not matter, it just needs to be set.
.
.Sh OPTIONS
@@ -261,9 +271,16 @@ Automatic reload is not supported in montage, index, or thumbnail mode.
.It Cm --auto-rotate
.
.Pq optional feature, $MAN_EXIF$ in this build
+.Pq deprecated in favor of Imlib2's auto-orientation support
Automatically rotate images based on EXIF data.
Does not alter the image files.
.
+.Pp
+.
+Note that Imlib2 version 1.7.5+ performs auto-rotation by itself, so this option is obsolete on systems with Imlib2 version 1.7.5 or later.
+.Nm
+currently cannot detect this at runtime.
+.
.It Cm -Z , --auto-zoom
.
Zoom pictures to screen size in fullscreen / fixed geometry mode.
@@ -558,6 +575,9 @@ Useful in scripts to hunt out images of a certain size/resolution/type etc.
Don't display images.
Just print out their names if imlib2 can successfully load them.
Returns false if at least one image failed to load.
+When combined with
+.Cm --action ,
+the specified action will be run for each loadable image.
.
.It Cm --max-dimension Ar width No x Ar height
.
@@ -654,7 +674,10 @@ and next image.
.Cm quit
will cause
.Nm
-to quit when trying to advance past the last image in the slide show.
+to quit when trying to advance past the last image in the slide show. This is
+the behavior of the obsolete
+.Cm --cycle-once
+option.
.
.Pp
.
@@ -782,9 +805,9 @@ in paused mode.
.
Sort file list according to image parameters.
Allowed sort types are:
-.Cm name , filename , dirname , mtime , width , height , pixels , size , format .
+.Cm name , none , filename , dirname , mtime , width , height , pixels , size , format .
For sort modes other than
-.Cm name , filename , dirname ,
+.Cm name , none , filename , dirname ,
or
.Cm mtime ,
a preload run is
@@ -812,6 +835,11 @@ you can use
.Cm --version-sort
to sort numbers naturally, so that e.g. 10.jpg comes after 2.jpg.
.
+.Pp
+.
+.Cm none
+is the default; you can specify it explicitly to discard a sort mode that has
+been specified at an earlier point in the command line arguments.
.It Cm -| , --start-at Ar filename
.
Start the filelist at
@@ -898,6 +926,9 @@ See
Don't display images.
Just print out their names if imlib2 can NOT successfully load them.
Returns false if at least one image was loadable.
+When combined with
+.Cm --action ,
+the specified action will be run for each unloadable file.
.
.It Cm -V , --verbose
.
@@ -963,7 +994,7 @@ when setting the wallpaper.
.Pp
.
Use
-.Cm xrandr --listmonitor
+.Cm xrandr --listmonitors
to determine how Xinerama monitor IDs map to screens/monitors in your setup.
.
.
@@ -1335,6 +1366,14 @@ Number of current file
.
Image width
.
+.\" .It %W
+.\" .
+.\" Window dimensions and offset as WxH+x+y
+.\" .Pq X11 geometry format .
+.\" Note that this is currently only properly updated when changing images;
+.\" offsets for the first image after starting feh and after changing window
+.\" geometry may be bogus.
+.
.It %v
.
.Nm
@@ -1905,6 +1944,13 @@ section can also be bound to a button.
.
Reload current image
.
+.It 0 Ao cursor movement while not panning, zooming, or similar Ac
+.
+Does not have a default binding.
+By binding it to
+.Cm quit ,
+you can turn feh into a simple screensaver.
+.
.It 1 Ao left mouse button Ac Bq pan
.
pan the current image
@@ -2130,6 +2176,15 @@ stdin or network URLs on systems using an Imlib2 version older than 1.7.4.
.
.Pp
.
+Imlib2 releases 1.7.5+ automatically rotate images based on their EXIF tags.
+When combined with the
+.Cm --auto-rotate
+option, this causes images to be rotated twice and end up in an incorrect orientation.
+As a workaround, do not use
+.Cm --auto-rotate
+on systems with Imlib2 version 1.7.5 or later.
+.Pp
+.
On systems with giflib 5.1.2,
.Nm
may be unable to load gif images.
@@ -2169,21 +2224,22 @@ If you find a bug, please report it to
.Aq derf+feh@finalrewind.org
or via
.Aq https://github.com/derf/feh/issues .
-You are also welcome to direct any feh-related comments/questions/... to #feh
-on irc.oftc.net.
.
.Pp
.
Please include the feh version
.Aq the output of Qq feh --version ,
steps to reproduce the bug and, if necessary, images to reproduce it.
+Note that
+.Nm
+is a hobby project, so bug reports may be addressed with significant delays.
.
.
.Sh LICENSE
.
Copyright (C) 1999, 2000 by Paul Duncan.
Copyright (C) 1999, 2000 by Tom Gilbert and contributors.
-Copyright (C) 2010-2020 by Daniel Friesel and contributors.
+Copyright (C) 2010-2023 by Birte Kristina Friesel and contributors.
.
.Pp
.
@@ -2213,7 +2269,7 @@ SOFTWARE.
.
.Pp
.
-Current developer: Daniel Friesel
+Current developer: Birte Friesel
.Aq derf@finalrewind.org
.
.Pp