(options and commands (in red) are clickable links)
Quick links: input.conf, input.conf syntax, Special key names, Commands, COPYRIGHT
Generate a html viewer file htmlviewer [-a|-A] [-n] [-s] [-S] [-c <command>] [-e <html>] [-f <filename>] [-i <filename>] [-m {normal|double|normal_or_doube|webtoon|all}] [-t <title>] [-x <pixel_distance>] directory... htmlviewer -p htmlviewer -K htmlviewer -h -a Builds a web page that can open images from the viewer. -A Builds a web page that lists the shortcuts available for the current configuration. -c <command> Add a command. See input.conf syntax. -e <html> Specify content of html header. By default its contains the html style. -f <filename> Read directories from <filename>. If - is specified as filename, directories are read from the standard input. find -type d | fzf | htmlviewer -f- > view.html -i <filename> Specify configuration file. See input.conf. -h Show this help. -K Generates a html file which displays the name of the keys and mouse buttons. -m {normal|double|normal_or_double|webtoon|all} Specify default mode. -n Do not load default configuration files. -p Print the default input.conf file. -s Sort input directories (default). -S Do not sort input directories. -t <title> Specify title page. -x <pixel_distance> Specify default value for bottom_pixel command. input.conf By default load ${XDG_CONFIG_DIRS}/htmlviewer/input.conf with $HOME/.config as default value when XDG_CONFIG_DIRS is unset. Currently /home/runner/.config/htmlviewer/input.conf The input.conf file consists of a list of mouse and key bindings, for example: n next # go to the next image with the n key m rotate 90 # rotates images 90 degrees Each line maps a key to an input command. In general, keys can be combined with Shift, Ctrl, Alt, Meta and AltGr (Modifiers are case insensitive): shift+Space pgup_or_prev AltGr and Shift are optional. # the following 2 commands are equivalent shift+y newtab Y newtab input.conf syntax <key> <command> [<args>...] Newlines always start a new binding. # starts a comment. To bind commands to the # key, SHARP can be used. <key> is either the literal character the key produces (ASCII, Unicode character or Javascript KeyEvent.key). See -K flag. <command> is the command itself. It consists of the command name and multiple (or none) arguments, all separated by whitespace. Special key names space sharp for # plus alias for + pgup alias for PageUp pgdown alias for PageDown up alias for ArrowUp down alias for ArrowDown left alias for ArrowLeft right alias for ArrowRight left_click for click0 middle_click for click1 right_click for click2 Note: special names are case insensitive. Commands next [n=1] Advance n images. A negative number goes back n images. prev [n=1] Equivalent to next -n. next_chap [n=1] Advance n directories. A negative number goes back n directories. prev_chap [n=1] Equivalent to next_chap -n. pgup [percent=100] pgdown [percent=100] pgdown_or_next [percent=100] [pixel_distance=$bottom_pixel] Next image when at the bottom of the page, otherwise scroll down. pgup_or_prev [percent=100] Previous image when at the top of the page, otherwise scroll up. goto [image_position] Opens a page selection window. When 'image_position' is specified, the nth image is opened directly. A negative number begins at the end and too large a number selects the last frame. rotate <deg> Rotate an images. newtab [{background|foreground|window}] Open the current image in a background tab (default), foreground tab or new window. Keyboard shortcuts containing ctrl or alt may malfunction with this option. No problem with mouse shortcuts. window depends on browser options and may open a foreground tab. mode {normal|double|normal_or_double|webtoon|all} [image_limit=0] - normal: One image at a time. - double: Once on 2, the commands pgdown_or_next/pgup_or_prev go to top/bottom of the page rather than go to the next/prev image. - normal_or_double: Use double page mode for images whose width is greater than the height, otherwise use the normal mode. - webtoon: All images in a chapter are displayed one below the other. - all: All images are displayed one below the other. 'image_limit' specifies the maximum number of images displayed per page. 0 for no limit. info Show current image position. auto_scroll [ms_delay=800] Start auto scroll with specific delay. toggle_auto_scroll [ms_delay=800] Resume or stop auto scroll. Equivalent to auto_scroll when not started. add_interval <ms_delay> Add delay of auto scroll. Delay can be negative. set_bottom_pixel <pixel_distance> Number of pixels at the bottom of the page that can be skipped for so that pgdown_or_next, auto_scroll and toggle_auto_scroll goes to the next image. Default is 20. add_bottom_pixel <pixel_distance> Add pixel_distance. See set_bottom_pixel. trigger [ms_delay=0] <command> Allows to trigger <command> when opening the page after <ms_delay>. The keyboard shortcut is associated with <command>. You can put a key that does not exist to make no association: nokey trigger 200 auto_scroll 600 h trigger mode webtoon # is equivalent to nokey trigger mode webtoon h mode webtoon mouse {top|bottom|left|right|top_left|top_right|bottom_left|bottom_right} <command> Execute <command> only when the mouse pointer is in a certain area. Note: Only works with mouse shortcuts. mouse_assistance Enable or disable the display of mouse area. restrict {normal|double|normal_or_double|webtoon|all} <command> Enable a shortcut for a specific mode. shortcuts Show shortcuts. open Open directories. search [{chapter|image|chapter_then_image} |{case_sensitive|case_insensitive|uppercase_only} |{accent_sensitive|accent_insensitive|accent_only} |{word|fuzzy|text|regex} ]... Show a finder. In the input field, use the up/down arrow and page up/down to navigate the search list. Enter validates selection. The default options are chapter_then_image, uppercase_only, accent_only and word. - chapter, image, chapter_then_image: Indicates on which part of the url the search is performed. chapter and image can be abbreviated to chap and img. - case_sensitive, case_insensitive, uppercase_only: Indicates whether upper and lower case letters should be considered the same. 'uppercase_only' searches case insensitive for lowercase letters and case sensitive for uppercase letters. Does not work with regex mode. - accent_sensitive, accent_insensitive, accent_only: Indicates whether accents should be ignored. 'accent_only' ignore accent for unaccented letters and match accent for accented letters. Does not work with regex mode. - word, fuzzy, text, regex: Algorithm used for the filter. save Save position and mode. load Load saved position and mode. COPYRIGHT By Jonathan Poelen MIT License https://github.com/jonathanpoelen/manga-viewer