summaryrefslogtreecommitdiff
path: root/src/help.raw
diff options
context:
space:
mode:
Diffstat (limited to 'src/help.raw')
-rw-r--r--src/help.raw211
1 files changed, 211 insertions, 0 deletions
diff --git a/src/help.raw b/src/help.raw
new file mode 100644
index 0000000..0e99c68
--- /dev/null
+++ b/src/help.raw
@@ -0,0 +1,211 @@
+" PACKAGE " version " VERSION "
+
+Usage : " PACKAGE " [options] <files or directories ...>
+
+ This is just a short option summary. Please see \"man " PACKAGE "\" for details.
+
+OPTIONS
+ -h, --help Show help and exit
+ -v, --version Show version information and exit
+ -V, --verbose Show progress bars and other extra information
+ -q, --quiet Hide non-fatal errors. May be used with --verbose
+ -T, --theme THEME Load options with name THEME
+ -r, --recursive Recursively expand any directories in FILE to
+ the content of those directories
+ --no-recursive Do not recursively expand directories
+ (this is the default)
+ -z, --randomize Randomize the filelist
+ --no-jump-on-resort Don't jump to the first image when the filelist
+ is resorted
+ -g, --geometry WxH[+X+Y] Limit the window size to DIMENSION[+OFFSET]
+ -f, --filelist FILE Load/save images from/to the FILE filelist
+ -|, --start-at FILENAME Start at FILENAME in the filelist
+ -p, --preload Remove unloadable files from the internal filelist
+ before attempting to display anything
+ -., --scale-down Automatically scale down images to fit screen size
+ -F, --fullscreen Make the window full screen
+ -Z, --auto-zoom Zoom picture to screen size in fullscreen/geom mode
+ --zoom PERCENT Zooms images by a PERCENT, when in full screen
+ mode or when window geometry is fixed. If combined
+ with --auto-zoom, zooming will be limited to the
+ the size. Also support \"max\" and \"fill\"
+ --zoom-step PERCENT Zoom images in and out by PERCENT (default: 25)
+ when using the zoom keys / buttons
+ --keep-zoom-vp Keep viewport zoom and settings while changing images
+ -w, --multiwindow Open all files at once, one window per image
+ -x, --borderless Create borderless windows
+ -d, --draw-filename Show the filename in the image window
+ --draw-tinted Show overlay texts on semi-transparent background
+ --draw-exif Show some Exif information (if compiled with exif=1)
+ --edit Make flip/rotation keys flip/rotate the underlying file
+ --auto-rotate Rotate images according to Exif info (if compiled with exif=1)
+ -^, --title TITLE Set window title (see FORMAT SPECIFIERS)
+ -D, --slideshow-delay NUM Set delay between automatically changing slides
+ --on-last-slide quit Exit after one loop through the slide show (old --cycle-once)
+ --on-last-slide hold Stop at both ends of the filelist
+ -R, --reload NUM Reload images after NUM seconds
+ -k, --keep-http Keep local copies when viewing HTTP/FTP files
+ --insecure Disable peer/host verification when using HTTPS.
+ -K, --caption-path PATH Path to caption directory, enables caption display
+ -j, --output-dir With -k: Output directory for saved files
+ -l, --list list mode: ls-style output with image information
+ -L, --customlist FORMAT list mode with custom output, see FORMAT SPECIFIERS
+ -U, --loadable List all loadable files. No image display
+ -u, --unloadable List all unloadable files. No image display
+ -S, --sort SORT_TYPE Sort files by:
+ name, filename, mtime, width, height, pixels, size,
+ or format
+ -n, --reverse Reverse sort order
+ --version-sort Natural sort of (version) numbers within text
+ -A, --action [;]ACTION Specify action to perform when pressing <return>.
+ Executed by /bin/sh, may contain FORMAT SPECIFIERS
+ reloads image with \";\", switches to next otherwise
+ --action[1-9] Extra actions triggered by pressing keys <1>to <9>
+ -G, --draw-actions Show the defined actions in the image window
+ --tap-zones Enable tap zones for previous/next file in slide show mode
+ --force-aliasing Disable antialiasing
+ -m, --montage Enable montage mode
+ -i, --index Create an index print of all images
+ --info CMD Run CMD and show its output in the image window
+ -t, --thumbnails Show images as clickable thumbnails
+ -P, --cache-thumbnails Enable thumbnail caching for thumbnail mode.
+ Only works with thumbnails <= 256x256 pixels
+ -J, --thumb-redraw N Redraw thumbnail window every N images
+ -~, --thumb-title STRING Title for windows opened from thumbnail mode
+ -I, --fullindex Index mode with additional image information
+ --index-info FORMAT Show FORMAT below images in index/thumbnail mode
+ --bg-center FILE Set FILE as centered desktop background
+ --bg-fill FILE Like --bg-scale, but preserves aspect ratio by
+ zooming the image until it fits. May cut off
+ corners
+ --bg-max FILE Like --bg-fill, but scale the image to the maximum
+ size that fits the screen with black borders on one
+ side
+ --bg-scale FILE Set FILE as scaled desktop background. This will
+ fill the whole background, but the images' aspect
+ ratio may not be preserved
+ --bg-tile FILE Set FILE as tiled desktop background
+ --no-fehbg Do not write a ~/.fehbg file
+ -C, --fontpath PATH Specify an extra directory to look in for fonts,
+ can be used multiple times to add multiple paths.
+ -M, --menu-font FONT Use FONT for the font in menus.
+ -B, --image-bg STYLE Set background for transparent images and the like.
+ Accepted values: default, checks, or a XColor (eg. #428bdd)
+ --xinerama-index I Assumee that I is the active xinerama screen
+ -N, --no-menus Don't load or show any menus.
+ --no-xinerama Disable Xinerama support
+ --no-screen-clip Do not limit window size to screen size
+ -Y, --hide-pointer Hide the pointer
+ --conversion-timeout INT Load unknown files with dcraw or ImageMagick,
+ timeout after INT seconds (0: no timeout)
+ --min-dimension WxH Only show images with width >= W and height >= H
+ --max-dimension WxH Only show images with width <= W and height <= H
+ --scroll-step COUNT scroll COUNT pixels when movement key is pressed
+ --cache-size NUM imlib cache size in mebibytes (0 .. 2048)
+ --auto-reload automatically reload shown image if file was changed
+ --window-id ID Draw to an existing X11 window by its ID
+
+MONTAGE MODE OPTIONS
+ -X, --ignore-aspect Set thumbnail to specified width/height without
+ retaining aspect ratio
+ -s, --stretch Scale up images if they are smaller than the
+ specified thumbnail size
+ -y, --thumb-width NUM Set thumbnail width in pixels
+ -E, --thumb-height NUM Set thumbnail height in pixels
+ -W, --limit-width NUM Limit the width of the montage in pixels
+ -H, --limit-height NUM Limit the height of the montage in pixels
+ (at least one of these two must be specified)
+ -b, --bg FILE|trans Set montage background
+ -a, --alpha NUM Set thumbnail transparency level (0 .. 255)
+ -o, --output FILE Save the created montage to FILE
+ -O, --output-only FILE Just save the created montage to FILE
+ WITHOUT displaying it
+ -e, --font FONT Set font for thumbnail information, in the form
+ fontname/pointsize
+
+INDEX MODE OPTIONS
+ -@, --title-font FONT Use FONT to print a title on the index, if no
+ font is specified, a title will not be printed
+
+FORMAT SPECIFIERS
+ %a information about slideshow state (playing/paused)
+ %f image path/filename
+ %F image path/filename (shell-escaped)
+ %g window dimensions (\"width,height\") in pixels
+ %h image height
+ %l total number of files in the filelist
+ %L path to temporary copy of filelist
+ %m current mode (slideshow, multiwindow...)
+ %n image name
+ %N image name (shell-escaped)
+ %o offset of top-left image corner to window (\"x,y\") in pixels
+ %p image pixel size
+ %P image pixel size in kilo-/megapixels
+ %r image rotation. half right turn == 3.1415 (pi)
+ %s image size in bytes
+ %S image size with appropriate unit (kB/MB)
+ %t image format
+ %u current file number
+ %w image width
+ %v " PACKAGE " version
+ %V process ID
+ %z current image zoom, rounded to two decimal places
+ %Z current image zoom, high precision
+ %% %
+ \\n newline
+
+DEFAULT KEYS
+ a Toggle action display (--draw-actions)
+ A Toggle anti-aliasing
+ c Enable caption entry mode
+ d Toggle filename display (--draw-filename)
+ e Toggle exif tag display (if compiled with exif=1)
+ f Toggle fullscreen
+ g Toggle fixed geometry mode
+ h pause/continue slideshow
+ i Toggle --info display
+ k Toggle zoom/viewport freeze when switching images
+ L Save current filelist to unique filename
+ m Show/hide menu
+ n, <SPACE>, <RIGHT> Go to next image
+ o Toggle pointer visibility
+ p, <BACKSPACE>, <LEFT> Go to previous image
+ q, <ESCAPE> Quit
+ r Reload image
+ R Render/anti-alias image
+ s Save current image to unique filename
+ w Resize window to current image dimensions
+ x Close current window
+ z Jump to a random position in the current filelist
+ Z Toggle auto-zoom
+ [, ] Jump to previous/next directory
+ <, > Rotate 90 degrees right/left
+ _ Vertical flip
+ | Horizontal flip
+ 0, <ENTER> Run action specified by --action option
+ 1-9 Run action 1-9 specified by --action[1-9] options
+ <HOME> Go to first slide
+ <END> Go to last slide
+ <PAGEUP> Go forward 5% of the filelist
+ <PAGEDOWN> Go backward 5% of the filelist
+ + Increase reload delay by 1 second
+ - Decrease reload delay by 1 second
+ <DELETE> Remove the currently viewed file from the filelist
+ <CTRL+DELETE> Like <DELETE>, but also removes the file from the
+ filesystem. Caution: Does not ask for confirmation
+ <KEYPAD LEFT> Move the image to the left
+ <KEYPAD RIGHT> Move the image to the right
+ <KEYPAD UP> Move the image up
+ <KEYPAD DOWN> Move the image down
+ <KEYPAD BEGIN> Antialias the image
+ <KEYPAD +>, <UP> Zoom in
+ <KEYPAD ->, <DOWN> Zoom out
+ <KEYPAD *> Zoom to 100%
+ <KEYPAD /> Zoom to fit the window
+
+This program is free software, see the file COPYING for licensing info.
+Copyright Tom Gilbert (and various contributors) 1999-2003.
+Copyright Birte Kristina Friesel (and various contributors) 2010-2020.
+
+Homepage: http://feh.finalrewind.org
+Report bugs to <derf+feh@finalrewind.org> or #feh on irc.oftc.net.