Skip to content
Snippets Groups Projects
feh.pre 28.3 KiB
Newer Older
.Dd $DATE$
.Nm feh
.Nd image viewer and cataloguer
.
.Nm
.Op Ar options
.Ar files or directories ...
This manual documents feh $VERSION$
.Pp
Compile-time switches: libcurl support $MAN_CURL$, Xinerama support
$MAN_XINERAMA$$MAN_DEBUG$
.Sh DESCRIPTION
is a mode-based image viewer.  It is especially aimed at commandline users who
need a fast image viewer without huge GUI dependencies, though it can also be
started by
file managers to view an image.
supports filelists, various image sorting modes, image captions and more.
Configurable keyboard shortcuts are used to control it; the mouse is also
supported, but only required for very few actions.
.Nm
is based on various modes, which are selected at startup by comandline
options.
.Pp
Slideshow mode is the default.  It opens one window and displays the first
image in it, the keyboard and mouse can be used to change slides
.Pq images .
In slideshow mode, images can be deleted either from the filelist or from the
disk, the new filelist can then be saved to the disk and reopened at a later
time.
.Pp
Montage mode forms a montage from the filelist.  The resulting image can be
viewed or saved, and its size can be limited by height, width or both.
.Pp
Collage mode is very similar to montage mode, except the images are distributed
randomly and may overlap each other.
.Pp
Index mode forms an index print from the filelist.  Image thumbnails are shown
along with the filename, filesize and pixel size, printed using a truetype
font of your choice.  The resulting image can be viewed or saved, and its size
can be limited by height, width or both.
.Pp
Thumbnail mode is like index mode, but the mini-images are clickable and open
the selected image in a new window.
.Pp
Multiwindow mode shows images in multiple windows, instead of as a slideshow
in one window.  Don't use with a large filelist ;)
.Pp
List mode doesn't display images.  Outputs an
.Cm ls - No style
listing of the files in the filelist, including image info such as size,
pixels, type, etc.  Customlist mode will display whatever image info you want,
in the format you choose.
.Pp
.Nm
can also list either all the loadable files in a filelist or all the
unloadable files.  Useful for preening a directory.
.
.Bl -tag -width indent
.It Cm -A , --action Oo Ar flag Oc Ns Ar action
Specify a string as an action to perform on the image.  In slideshow or
multiwindow modes, the action will be run when the enter key is pressed, in
list mode, the action will be run for each file listed.  In
loadables/unloadables mode, the action will be run for each
loadable/unloadable file, respectively.
.Pp
If
.Ar flag
is
.Qq \&; ,
.Nm
will not switch to the next image after executing the action.
.Pp
The action will be executed by /bin/sh.  Use format specifiers to refer to
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.
.It Cm --action1 No .. Cm --action9
Extra actions which can be set and triggered using the appropiate number key.
.It Cm -Z , --auto-zoom
Zoom pictures to screen size in fullscreen
.Pq affected by Cm --stretch No and Cm --ignore-aspect .
.It Cm -x , --borderless
Create borderless windows.
.It Cm -P , --cache-thumbnails
Enable (experimental) thumbnail caching in
.Pa ~/.thumbnails .
Only works with thumbnails <= 256x256 pixels.
.It Cm -K , --caption-path Ar path
Path to directory containing image captions.  This turns on caption viewing,
and if captions are found in
.Ar path ,
which is relative to the directory of each image, they are overlayed on the
displayed image.  E.g. with caption path
.Qq captions/ ,
and viewing image
.Qq images/foo.jpg ,
the caption will be looked for in
.Qq images/captions/foo.jpg.txt .
.It Cm -c , --collage
Enable collage mode.  Collage mode is very similar to montage mode, except
the images are distributed randomly.
When using collage mode, you should also specify
.Cm --limit-width
and
.Cm --limit-height .
.It Cm -L , --customlist Ar format
Use
.Ar format
.Pq printf-like string containing image info specifiers
for list output.  See
.Sx FORMAT SPECIFIERS .
.It Cm --cycle-once
Exit feh after one loop through the slideshow.
.It Cm -G , --draw-actions
Draw the defined actions and what they do at the top-left of the image.
.It Cm -d , --draw-filename
Draw the filename at the top-left of the image.
.It Cm -f , --filelist Ar file
This option is similar to the playlists used by music software.  If
.Ar file
exists, it will be read for a list of files to load, in the order they appear.
The format is a list of image filenames, absolute or relative to the current
directory, one filename per line.  If
.Ar file
doesn't exist, it will be created from the internal filelist at the end of a
viewing session.  This is best used to store the results of complex sorts
.Pq Cm -Spixels No for example
for later viewing.  Any changes to the internal filelist
.Pq such as deleting a file or it being pruned for being unloadable
will be saved to
.Ar file
when
.Nm
exits.  You can add files to filelists by specifying them on the commandline
when also specifying the list.
.It Cm -e , --font Ar font
Set global font.  Should be a truetype font, resident in the current directory
or the font directory, and should be defined in the form fontname/points, like
.Qq myfont/12 .
.It Cm -C , --fontpath Ar path
Specify
.Ar path
as extra directory in which to search for fonts; can be used multiple times to
add multiple paths.
.It Cm --force-aliasing
Disable antialiasing for zooming, background setting etc.
.
.It Cm -I , --fullindex
Same as Index mode, but you also get image size and dimensions printed
below each thumbnail.
Make the window fullscreen.
.It Cm -g , --geometry Ar width No x Ar height
Loading
Loading full blame...