summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/feh-cam.pre57
-rw-r--r--man/feh.pre228
-rw-r--r--man/gen-cam-menu.pre33
3 files changed, 133 insertions, 185 deletions
diff --git a/man/feh-cam.pre b/man/feh-cam.pre
deleted file mode 100644
index 4a02753..0000000
--- a/man/feh-cam.pre
+++ /dev/null
@@ -1,57 +0,0 @@
-.Dd $DATE$
-.Dt FEH-CAM 1
-.Os
-.
-.Sh NAME
-.Nm feh-cam
-.Nd utility for viewing live webcam images
-.Sh SYNOPSIS
-.Nm
-.Op Ar options
-.Ar keys
-.
-.Sh VERSION
-This manual documents feh-cam, shipped with feh version $VERSION$
-.
-.Sh DEPRECATION WARNING
-.
-This tool will be removed from the feh distribution by 2013.
-.
-.Pp
-.
-If you still use it, please contact me at
-.Aq derf@finalrewind.org
-.
-.Sh DESCRIPTION
-.Nm
-is a perl wrapper for feh which simplifies viewing webcams using keyed
-bookmarks. It helps manage viewing your favourite webcam sites with feh.
-.
-.Sh OPTIONS
-.Bl -tag -width indent
-.It Cm -a , --add Ar key url refresh
-Add
-.Ar url
-as
-.Ar key
-to the bookmarks file; when viewing, reload it every
-.Ar refresh
-seconds
-.It Cm -l , --list
-List each url / key pair in the bookmarks file
-.It Cm -f , --full-screen
-Start feh in full-screen mode
-.It Cm -k , --keep-images
-Save each webcam image in the current directory
-.It Cm -g , --geometry Ar width No x Ar height
-Use window geometry
-.Ar width No x Ar height
-.It Cm -v , --verbose
-Start feh in verbose mode
-.El
-.
-.Sh FILES
-The bookmarks are stored in
-.Pa ~/.cam_bookmarks
-.Sh SEE ALSO
-.Xr feh 1
diff --git a/man/feh.pre b/man/feh.pre
index 2587501..f59d082 100644
--- a/man/feh.pre
+++ b/man/feh.pre
@@ -32,28 +32,22 @@ $MAN_XINERAMA$, builtin EXIF support $MAN_EXIF$$MAN_DEBUG$
.Sh DESCRIPTION
.
.Nm
-is a mode-based image viewer.
-It is especially aimed at command line users who 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.
+is a light-weight, configurable and versatile image viewer.
+It is aimed at command line users, but can also be started from graphical file
+managers.
+Apart from viewing images, it can compile text and thumbnail
+listings, show (un)loadable files, set X11 backgrounds, and more.
.
.Pp
.
+Features include filelists, various image sorting modes, custom action scripts,
+and image captions.
.Nm
-supports filelists, various image sorting modes, image captions, HTTP and more.
-It can be controlled by configurable keyboard and mouse shortcuts, terminal
+can be controlled by configurable keyboard and mouse shortcuts, terminal
input and signals.
-.
-.Pp
-.
-In many desktop environments,
+When no file arguments or filelists are specified,
.Nm
-can also be used as wallpaper setter.
+displays all files in the current directory.
.
.Pp
.
@@ -96,7 +90,7 @@ and its size can be limited by height, width or both.
.
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
+size and dimensions, 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.
@@ -148,7 +142,7 @@ also supports RAW files provided by cameras and will display the embedded
thumbnails.
Use
.Cm --conversion-timeout Ar num
-with a non-negative value to enable it.
+with a non-negative value to enable support for these formats.
.
.
.Sh OPTIONS
@@ -260,6 +254,22 @@ and viewing image
the caption will be looked for in
.Qq images/captions/foo.jpg.txt .
.
+.It Cm --conversion-timeout Ar timeout
+.
+.Nm
+can use ImageMagick to try converting unloadable files into a supportad
+file format.
+As this can take a long time, it is disabled by default.
+Set
+.Ar timeout
+to a non-negative value to enable it.
+A positive value
+specifies after how many seconds conversion attempts should be aborted,
+zero causes
+.Nm
+to try indefinitely.
+Negative values restore the default by disabling conversion altogether.
+.
.It Cm -L , --customlist Ar format
.
Don't display images, print image info according to
@@ -289,6 +299,12 @@ Show overlay texts
.Pq as created by Cm --draw-filename No et al
on a semi-transparent background to improve their readability
.
+.It Cm --edit
+.
+Enable basic editing of files. This makes rotation and mirroring
+.Pq bound to Qo < Qc , Qo > Qc , Qo | Qc , and Qo _ Qc by default
+change the underlying file and not just its displayed content.
+.
.It Cm -f , --filelist Ar file
.
This option is similar to the playlists used by music software.
@@ -370,14 +386,13 @@ to get a progress bar.
.
Make the window fullscreen.
Note that in this mode, large images will always be scaled down to fit the
-screen,
+screen, and
.Cm --zoom Ar zoom
only affects smaller images and never scales larger than necessary to fit the
screen size.
The only exception is a
.Ar zoom
-of 100, in which case images will always be shown at 100% zoom, no matter
-their dimensions.
+of 100, in which case images will always be shown at 100% zoom.
.
.Pp
.
@@ -388,17 +403,17 @@ The thumbnail list itself will still be windowed.
.
.It Cm -g , --geometry Ar width Cm x Ar height | Cm + Ar x Cm + Ar y | Ar width Cm x Ar height Cm + Ar x Cm + Ar y
.
-Limit (and don't change) the window size.
-Takes an X-style geometry
-.Ar string
-like 640x480 with optional +x+y window offset.
-Use
+Use a fixed window size as specified in the X-style geometry
+.Ar string ,
+e.g. 640x480.
+An optional +x+y window offset can be specified.
+Combine with
.Cm --scale-down
to scale down larger images like in fullscreen mode.
.
-Also note that this option does not enforce the geometry, changing it by a tiling
+Note that this option does not enforce the window size; 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.
+However, auto-resize remains disabled.
.
.It Cm -Y , --hide-pointer
.
@@ -415,8 +430,9 @@ Accepted values: default, checks, or an XColor
.
In windowed mode, the default is checks
.Pq a checkered background so transparent image parts are easy to see .
-In fullscreen and background setting mode, checks is not accepted and the
-default is black.
+In fullscreen and background setting mode,
+.Cm checks
+is not accepted and the default is black.
.
.It Cm -i , --index
.
@@ -445,6 +461,12 @@ is set to
the output will not be displayed by default, but has to be enabled by the
toggle_info key.
.
+.It Cm --insecure
+.
+When viewing files with HTTPS, this option disables all certificate checks. It
+allows images on sites with self-signed or expired certificates to be opened,
+but is no more secure than plain HTTP.
+.
.It Cm -k , --keep-http
.
When viewing files using HTTP,
@@ -455,13 +477,6 @@ specified by
.Cm --output-dir ,
or in the current working directory.
.
-.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
@@ -481,16 +496,6 @@ 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.
.
-.It Cm --conversion-timeout Ar timeout
-.
-Stop trying to convert unloadable files after
-.Ar timeout
-seconds.
-Negative values disable conversion altogether, zero causes
-.Nm
-to try indefinitely.
-By default, conversion is disabled.
-.
.It Cm --max-dimension Ar width No x Ar height
.
Only show images with width <=
@@ -623,8 +628,9 @@ 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.
+Don't recursively expand any directories.
+This is the default, but this option is useful to override themes containing
+.Cm --recursive .
.
.It Cm -R , --reload Ar int
.
@@ -632,7 +638,7 @@ Reload filelist and current image after
.Ar int
seconds.
Useful for viewing HTTP webcams or frequently changing directories.
-.Pq Note that the filelist reloading is still experimental.
+.Pq Note that filelist reloading is still experimental.
.
.Pp
.
@@ -668,10 +674,10 @@ In tiling environments, this also causes the image to be centered in the window.
Scroll
.Ar count
pixels whenever scroll_up, scroll_down, scroll_left or scroll_right is pressed.
-Note that this option accepts negative numbers in case you need to inverse the
-scroll direction; see
+Note that this option accepts negative numbers in case you need to reverse the
+scroll direction. See
.Sx KEYS CONFIG SYNTAX
-to change it permanently.
+for how to reverse it permanently.
Default: 20
.
.It Cm -D , --slideshow-delay Ar float
@@ -688,16 +694,33 @@ in paused mode.
.
.It Cm -S , --sort Ar sort_type
.
-The file list may be sorted according to image parameters.
+Sort file list 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.
+For sort modes other than name, filename, dirname, or mtime, a preload run is
+necessary, causing a delay proportional to the number of images in the list.
+.
+.Pp
+.
+.Cm mtime
+starts with the most recently modified image,
+.Cm width , height , pixels
+and
+.Cm size
+start with the smallest.
+Use
+.Cm --reverse
+to sort by oldest or largest first.
.
.Pp
.
-The mtime sort mode sorts images by most recently modified.
-To sort by oldest first, reverse the filelist with --reverse.
+For
+.Cm name , filename ,
+and
+.Cm dirname ,
+you can use
+.Cm --version-sort
+to sort numbers naturally, so that e.g. 10.jpg comes after 2.jpg.
.
.It Cm -| , --start-at Ar filename
.
@@ -781,11 +804,17 @@ output version information and exit.
.It Cm --version-sort
.
.Pq optional feature, $MAN_VERSCMP$ in this build
-Use natural sorting for file and directory names.
+When combined with
+.Cm --sort name , --sort filename ,
+or
+.Cm --sort dirname :
+use natural sorting for file and directory names.
In this mode, filenames are sorted as an ordinary human would expect, e.g.
.Qq 2.jpg
comes before
.Qq 10.jpg .
+Note that this option only has an effect when a sort mode is set using
+.Cm --sort .
.
.It Cm --xinerama-index Ar screen
.
@@ -966,20 +995,14 @@ be printed.
.
Redraw thumbnail window every
.Ar n
-images.
-In
-.Nm
-<= 1.5, the thumbnail image used to be redrawn after every computed thumbnail
-.Pq so, it updated immediately .
-However, since the redrawing takes quite long
-.Pq especially for thumbnail mode on a large filelist ,
-this turned out to be a major performance penalty.
-As a workaround, the thumbnail image is redrawn every 10th image now by default.
+images while generating thumbnails.
+Redrawing takes quite long, so the default is 10.
Set
.Ar n No = 1
-to get the old behaviour,
-.Ar n No = 0
-will only redraw once all thumbnails are loaded.
+to update the thumbnail window immediately.
+With
+.Ar n No = 0 ,
+there will only be one redraw once all thumbnails are loaded.
.
.El
.
@@ -1215,7 +1238,7 @@ If the files are not found in that directory, it will also try
All config files treat lines starting with a
.Qq #
character as comments.
-Note that mid-line comments are not supported.
+Comments at the end of a line are not supported.
.
.
.Sh THEMES CONFIG SYNTAX
@@ -1408,10 +1431,9 @@ Toggle filename display
.Pq optional feature, $MAN_EXIF$ in this build
Toggle EXIF tag display
.
-.It f Bq save_filelist
+.It f Bq toggle_fullscreen
.
-Save the current filelist as
-.Qq feh_PID_ID_filelist
+Toggle fullscreen
.
.It g Bq toggle_fixed_geometry
.
@@ -1435,10 +1457,15 @@ When enabled,
.Nm
will keep zoom and X, Y offset when switching images.
.
+.It L Bq save_filelist
+.
+Save the current filelist as
+.Qq feh_PID_ID_filelist
+.
.It m Bq toggle_menu
.
Show menu.
-Use the arrow keys and return to select items,
+Use the arrow keys and return to select items, and
.Aq escape
to close the menu.
.
@@ -1471,10 +1498,6 @@ Useful for webcams
Save the current image as
.Qq feh_PID_ID_FILENAME
.
-.It v Bq toggle_fullscreen
-.
-Toggle fullscreen
-.
.It w Bq size_to_image
.
Change window size to fit current image size
@@ -1502,8 +1525,14 @@ are grouped together.
.
.It < , > Bq orient_3 , orient_1
.
-In place editing - rotate the image 90 degrees (counter)clockwise.
-The rotation is lossless, but may create artifacts in some image corners when
+rotate the image 90 degrees (counter)clockwise.
+.
+.Pp
+.
+When
+.Cm --edit
+is used, this also rotates the image in the underlying file.
+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
@@ -1523,11 +1552,19 @@ for details on how to change this flag.
.
.It _ Bq flip
.
-In place editing - vertical flip
+Vertically flip image.
+When
+.Cm --edit
+is used, this also flips the image in the underlying file
+.Pq see above .
.
.It | Bq mirror
.
-In place editing - horizontal flip
+Horizontally flip image.
+When
+.Cm --edit
+is used, this also flips the image in the underlying file
+.Pq see above .
.
.It 0 .. 9 Bq action_0 .. action_9
.
@@ -1586,7 +1623,7 @@ Scroll up
.It Ao keypad Down Ac , Ao Ctrl+Down Ac Bq scroll_down
.
Scroll down.
-Note that the scroll keys work without anti-aliasing for performance reasons,
+Note that the scroll keys work without anti-aliasing for performance reasons;
hit the render key after scrolling to antialias the image.
.
.It Aq Alt+Left Bq scroll_left_page
@@ -1820,7 +1857,7 @@ Switch to previous image
.
Here are some examples of useful option combinations.
See also:
-.Aq http://feh.finalrewind.org/examples/
+.Aq https://feh.finalrewind.org/examples/
.
.Bl -tag -width indent
.
@@ -1892,7 +1929,7 @@ Same as above
.
Show some EXIF information, extracted by exifprobe/exifgrep
.
-.It feh --action 'rm %F' -rl --max-dim 1000x800
+.It feh --action 'rm %F' -rl --max-dimension 1000x800
.
Recursively remove all images with dimensions below or equal to 1000x800 pixels
from the current directory.
@@ -1902,23 +1939,24 @@ from the current directory.
.
.Sh DEPENDENCIES
.
+When
+.Cm --edit
+is used,
.Nm
-requires the
+needs the
.Cm jpegtran
and
.Cm jpegexiforient
binaries
.Pq usually distributed in Qo libjpeg-progs Qc or similar
-for lossless rotation.
+for lossless JPEG rotation.
.
.Pp
.
-To view images from URLs such as http://, you need
+To view images from URLs such as http://,
.Nm
-compiled with libcurl support (enabled by default).
-See the
-.Sx VERSION
-section.
+must be compiled with libcurl support.
+It is $MAN_CURL$ in this build
.
.
.Sh BUGS
@@ -2025,4 +2063,4 @@ Tom Gilbert
.Pp
.
See also:
-http://feh.finalrewind.org
+https://feh.finalrewind.org
diff --git a/man/gen-cam-menu.pre b/man/gen-cam-menu.pre
deleted file mode 100644
index 18064f1..0000000
--- a/man/gen-cam-menu.pre
+++ /dev/null
@@ -1,33 +0,0 @@
-.Dd $DATE$
-.Dt GEN-CAM-MENU 1
-.Os
-.
-.Sh NAME
-.Nm gen-cam-menu
-.Nd utility for updating Enlightenment user menus for feh-cam
-.Sh SYNOPSIS
-.Nm
-.
-.Sh VERSION
-This manual documents gen-cam-menu, shipped with feh version $VERSION$
-.
-.Sh DEPRECATION WARNING
-.
-This tool will be removed from the feh distribution by 2013.
-.
-.Pp
-.
-If you still use it, please contact me at
-.Aq derf@finalrewind.org
-.
-.Sh DESCRIPTION
-.Nm
-is a shell script which creates Enlightenment user menu entries for the
-bookmarks stored by
-.Xr feh-cam 1
-in
-.Pa ~/.enlightenment/ .
-.
-.Sh SEE ALSO
-.Xr feh 1 ,
-.Xr feh-cam 1