summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/Makefile2
-rw-r--r--man/feh.pre160
2 files changed, 127 insertions, 35 deletions
diff --git a/man/Makefile b/man/Makefile
index 1927963..65f2bc2 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -8,7 +8,7 @@ all: ${TARGETS}
.pre.1:
sed \
-e 's/\$$VERSION\$$/${VERSION}/g' \
- -e 's/\$$DATE\$$/'"$$(date '+%B %d, %Y')"/g \
+ -e 's/\$$DATE\$$/${MAN_DATE}/g' \
-e 's/\$$MAN_CURL\$$/${MAN_CURL}/' \
-e 's/\$$MAN_DEBUG\$$/${MAN_DEBUG}/' \
-e 's/\$$MAN_EXIF\$$/${MAN_EXIF}/' \
diff --git a/man/feh.pre b/man/feh.pre
index 10ea58f..f5b73e8 100644
--- a/man/feh.pre
+++ b/man/feh.pre
@@ -13,7 +13,7 @@
.
.Nm
.Op Ar options
-.Ar files or directories or URLs ...
+.Op Ar files No | Ar directories No | Ar URLs ...
.
.
.Sh VERSION
@@ -36,6 +36,10 @@ need a fast image viewer without huge GUI dependencies, though it can also be
started by
.Pq graphical
file managers to view an image.
+By default
+.Pq unless arguments or a filelist are specified
+.Nm
+displays all files in the current directory.
.
.Pp
.
@@ -51,11 +55,12 @@ can also be used as wallpaper setter.
.
.Pp
.
-A little note about EXIF support: The recommended way to display EXIF data is
-using exiv2 / exifgrep via
+EXIF tags are supported either using exiv2 / exifgrep via
.Cm --info
-.Pq see the Sx USAGE EXAMPLES No section .
-However, if you compile feh with exif=1, you can also display it directly.
+.Pq see the Sx USAGE EXAMPLES No section ,
+or by compiling
+.Nm
+with exif=1.
.
.
.Sh MODES
@@ -131,7 +136,7 @@ For animated images, only the first frame is shown.
.
.Bl -tag -width indent
.
-.It Cm -A , --action Oo Ar flag Oc Ns Ar action
+.It Cm -A , --action Oo Ar flag Oc Ns Oo [ Ar title ] Oc Ns Ar action
.
Specify a shell command as an action to perform on the image. In slideshow or
multiwindow mode, the action will be run when the action_0 key is pressed, in
@@ -146,18 +151,38 @@ If
is
.Qq \&; ,
.Nm
-will reload the current image instead of switching to the next one after
+will reload the current image instead of switching to the next one
+.Pq slideshow mode
+or closing the window
+.Pq multiwindow mode
+after
executing the action.
.
+If
+.No [ Ar title ]
+is specified
+.Pq note the literal Qo \&[ Qc and Qo ] Qc ,
+.Cm --draw-actions
+will display
+.Ar title
+instead of
+.Ar action
+in the action list. Note that
+.Ar title
+must not start with a space. If it does, the action is handled as if it did
+not have a title. This special case exists for backwards compatibility reasons
+and makes sure that actions like
+.Qq \&[ -L %F \&] && foo
+still work.
+.
+.
.Pp
.
The action will be executed by /bin/sh. Use format specifiers to refer to
-image info. See
+image info, see
.Sx FORMAT SPECIFIERS
-for examples. E.g.
-.Qq feh -A "mv ~/images/%n" * .
-In slideshow mode, the next image will be shown after running the action, in
-multiwindow mode, the window will be closed.
+for details. Example usage:
+.Qq feh -A Qo mv ~/images/%N Qc * .
.
.It Cm --action1 No .. Cm --action9
.
@@ -316,8 +341,9 @@ like 640x480 with optional +x+y window offset.
Note that larger images will be zoomed out to fit, but you can see them at 1:1
by clicking the zoom button.
.
-Note that this option does not enforce the geometry, changing it by a tiling
-WM or manually is still possible.
+Also note that this option does not enforce the geometry, changing it by a tiling
+WM or manually is still possible. After each resize, the resulting window size
+is used as the new size limit.
.
.It Cm -Y , --hide-pointer
.
@@ -348,6 +374,10 @@ below thumbnails in index / thumbnail mode. See
.Sx FORMAT SPECIFIERS .
May contain newlines.
.
+Use
+.Qq --index-info So Sc
+to display thumbnails without any info text
+.
.Pp
.
Note: If you specify image-related formats
@@ -387,6 +417,12 @@ with
.Qq Nm
in the name.
.
+.It Cm --insecure
+.
+When viewing files with HTTPS, this option disables strict hostname and peer
+checking. This allows images on sites with self-signed certificates to be
+opened, but is no more secure than plain HTTP.
+.
.It Cm --keep-zoom-vp
.
When switching images, keep zoom and viewport settings
@@ -501,6 +537,11 @@ transitions from last to first image).
Recursively expand any directories in the commandline arguments
to the content of those directories, all the way down to the bottom level.
.
+.It Cm --no-recursive
+.
+Don't recursively expand any directories (enabled by default).
+Useful to override theme options.
+.
.It Cm -R , --reload Ar int
.
Reload filelist and current image after
@@ -526,7 +567,9 @@ E.g. to sort in reverse width order, use
.It Cm -. , --scale-down
.
Scale images to fit window geometry (defaults to screen size when no geometry
-was specified).
+was specified). Note that the window geometry is not updated when changing
+images at the moment. This behaviour may change in the future.
+.
This option is ignored when in fullscreen mode.
.
.Pp
@@ -557,10 +600,10 @@ in paused mode.
.
.It Cm -S , --sort Ar sort_type
.
-The file list may be sorted according to image parameters. Allowed sort
-types are: name, filename, mtime, width, height, pixels, size, format. For sort
-modes other than name, filename, or mtime, a preload run will be necessary,
-causing a delay proportional to the number of images in the list.
+The file list may be sorted according to image parameters. Allowed sort types
+are: name, filename, dirname, mtime, width, height, pixels, size, format. For
+sort modes other than name, filename, dirname, or mtime, a preload run will be
+necessary, causing a delay proportional to the number of images in the list.
.
.Pp
.
@@ -639,6 +682,30 @@ output useful information, progress bars, etc.
.
output version information and exit.
.
+.It Cm --xinerama-index Ar screen
+.
+Override
+.Nm Ns No 's
+idea of the active Xinerama screen. May be useful in certain circumstances
+where the window manager places the feh window on Xinerama screen A while
+.Nm
+assumes that it will be placed on screen B.
+.
+.Pp
+.
+In background setting mode: When used with any option other than
+.Cm --bg-tile :
+Only set wallpaper on
+.Ar screen .
+All other screens will be filled black/white.
+.
+This is most useful in a Xinerama configuration with
+overlapping screens. For instance, assume you have two overlapping displays
+(index 0 and 1), where index 0 is smaller. To center a background on the
+display with index 0 and fill the extra space on index 1 black/white, use
+.Qq --xinerama-index 0
+when setting the wallpaper.
+.
.It Cm --zoom Ar percent No | Cm max No | Cm fill
.
Zoom images by
@@ -820,7 +887,12 @@ on screen 0, the second on screen 1, and so on.
.
Use
.Cm --no-xinerama
-to treat the whole X display as one screen when setting wallpapers.
+to treat the whole X display as one screen when setting wallpapers. You
+may also use
+.Cm --xinerama-index
+to use
+.Nm
+as a background setter for a specific screen.
.
.Bl -tag -width indent
.
@@ -1200,6 +1272,9 @@ Toggle fullscreen
.It w Bq size_to_image
.
Change window size to fit current image size
+.Pq plus/minus zoom, if set .
+In scale-down and fixed-geometry mode, this also updates the window size
+limits.
.
.It x Bq close
.
@@ -1209,9 +1284,15 @@ Close current window
.
Jump to a random position in the current filelist
.
+.It \&[, \&] Bq prev_dir, next_dir
+.
+Jump to the first image of the previous or next sequence of images sharing
+a directory name in the current filelist. Use --sort dirname if you would
+like to ensure that all images in a directory are grouped together.
+.
.It < , > Bq orient_3 , orient_1
.
-In place editing - rotate the images 90 degrees (counter)clockwise.
+In place editing - rotate the image 90 degrees (counter)clockwise.
The rotation is lossless, but may create artifacts in some image corners when
used with JPEG images. Rotating in the reverse direction will make them go
away. See
@@ -1219,14 +1300,13 @@ away. See
for more about lossless JPEG rotation.
.
.Em Note:
-jpegtran does not update EXIF orientation tags. However,
.Nm
-assumes that you use the feature to normalize image orientation and want it to
-be displayed this way everywhere. After every rotation, it will unconditionally
-set the EXIF orientation to 1
-.Pq Qq 0,0 is top left .
-Should you need to reverse this, see
-.Xr jpegexiforient 1 .
+assumes that this feature is used to normalize image orientation. For JPEG
+images, it will unconditionally set the EXIF orientation tag to 1
+.Pq Qq 0,0 is top left
+after every rotation. See
+.Xr jpegexiforient 1
+for details on how to change this flag.
.
.It _ Bq flip
.
@@ -1234,10 +1314,7 @@ In place editing - vertical flip
.
.It | Bq mirror
.
-In place editing - horizontal flip.
-Again, see
-.Xr jpegtran 1
-for more information.
+In place editing - horizontal flip
.
.It 0 .. 9 Bq action_0 .. action_9
.
@@ -1591,7 +1668,7 @@ Show some EXIF information, extracted by exifprobe/exifgrep
.
.It feh --action 'rm %F' -rl --max-dim 1000x800
.
-Resursively remove all images with dimensions below or equal to 1000x800 pixels
+Recursively remove all images with dimensions below or equal to 1000x800 pixels
from the current directory.
.
.El
@@ -1647,6 +1724,21 @@ section.
.
.Pp
.
+On systems with Imlib2 >= 1.4.7 and giflib >= 5.1.2,
+.Nm
+may be unable to load gif images. For affected mips, mipsel and arm devices,
+gif support is completely broken, while on x86 / x86_64 gifs can usually
+only be loaded if they are the first image in the filelist.
+This appears to be an Imlib2 and/or giflib bug introduced in giflib 5.1.2.
+See
+.Aq https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=813729
+for details. Workaround: Use
+.Cm --magick-timeout 5
+.Pq or some other positive value
+to load gifs with imagemagick instead, or downgrade giflib to 5.1.1.
+.
+.Pp
+.
Thumbnail mode is somewhat inefficient, and because of that not nearly as fast
as it could be.
.
@@ -1689,7 +1781,7 @@ Make zoom options more intuitive
.
Copyright (C) 1999, 2000 by Paul Duncan.
Copyright (C) 1999, 2000 by Tom Gilbert (and various contributors).
-Copyright (C) 2010-2014 by Daniel Friesel (and even more contributors).
+Copyright (C) 2010-2016 by Daniel Friesel (and even more contributors).
.
.Pp
.