From 2e424897218eac66c8e9e326cc07641eacf1a810 Mon Sep 17 00:00:00 2001 From: Harry Jeffery Date: Wed, 7 Aug 2019 23:50:21 +0100 Subject: Update man pages --- doc/imv.1.txt | 40 +++++++++++------ doc/imv.5.txt | 142 +++++----------------------------------------------------- src/imv.c | 2 +- 3 files changed, 38 insertions(+), 146 deletions(-) diff --git a/doc/imv.1.txt b/doc/imv.1.txt index 4a3fdaf..dd6c19a 100644 --- a/doc/imv.1.txt +++ b/doc/imv.1.txt @@ -63,12 +63,6 @@ Options *-u* :: Set upscaling method used by imv. -*-w*:: - Enable automatic resizing of the window to fit each image. - -*-W*:: - Enable automatic resizing and recentering of the window to fit each image. - *-x*:: Disable looping of input paths. @@ -78,25 +72,31 @@ Commands Commands can be entered by pressing *:*. imv supports the following commands: *quit*:: - Quit imv. + Quit imv. Aliased to 'q'. *pan* :: Pan the view by the given amounts. -*select_rel* :: - Select a different image. '1' is the next one, '-1' is the previous. +*next* :: + Move forwards by a given number of images. Aliased to 'n' + +*prev* :: + Move backwards by a given number of images. Aliased to 'p' -*select_abs* :: +*goto* :: Select an image by index. '1' is the first image, '2' the second, etc. The last image can be indexed as '-1', the second last as '-2'. + Aliased to 'g'. *zoom* :: Zoom into the image by the given amount. Negative values zoom out. 'actual' resets the zoom to 100%, showing the image at its actual size. + Aliased to 'z'. *open* [-r] :: Add the given paths to the list of open images. If the '-r' option is specified, do so recursively. Shell expansions may be used. + Aliased to 'o'. *close*:: Close the currently selected image. @@ -125,12 +125,17 @@ Commands can be entered by pressing *:*. imv supports the following commands: *toggle_playing*:: Toggle playback of the current image if it is an animated gif. -*scaling_mode* :: +*scaling* :: Set the current scaling mode. Setting the mode to 'next' advances it to the next mode in the list. -*slideshow_duration* :: - Change the slideshow duration by the given amount in seconds. +*slideshow* <+amount|-amount|duration>:: + Increase or decrease the slideshow duration by the given amount in seconds, + or set its duration directly. Aliased to 'ss'. + +*background* :: + Set the background color. 'checks' for a chequerboard pattern, or specify + a 6-digit hexadecimal color code. Aliased to 'bg'. Configuration ------------- @@ -186,10 +191,17 @@ customising the window's title, or the overlay text. *$imv_slideshow_elapsed*:: How long the current image has been shown for. +IPC +--- + +imv can accept commands from another process over a unix socket. Each instance +of imv will open a unix socket named '$XDG_RUNTIME_DIR/imv-$PID.sock'. If +$XDG_RUNTIME_DIR is undefined, the socket is placed into '/tmp/' instead. + Authors ------- -imv is written and maintained by Harry Jeffery +imv is written and maintained by Harry Jeffery with contributions from other developers. Full source code and other information can be found at diff --git a/doc/imv.5.txt b/doc/imv.5.txt index e323995..8eccc15 100644 --- a/doc/imv.5.txt +++ b/doc/imv.5.txt @@ -73,9 +73,6 @@ The *[options]* section accepts the following settings: Start imv in slideshow mode, and set the amount of time to show each image for in seconds. Defaults to '0', i.e. no slideshow. -*stay_fullscreen_on_focus_loss* = :: - Stay full screen even when imv loses focus. Defaults to 'false'. - *suppress_default_binds* = :: Disable imv's built-in binds so they don't conflict with custom ones. Defaults to 'false'. @@ -91,9 +88,10 @@ The *[options]* section accepts the following settings: Aliases ------- -The *[aliases]* section allows imv's commands to be aliases. For example: -'q = quit' would add a 'q' command that simply executes the 'quit' command. -And 'next = select_rel 1' would add a 'next' command to imv. +The *[aliases]* section allows aliases to be added for imv's build in commands. +For example, 'x = close' would add a 'x' command that simply executes the +'close' command. Any arguments provided to an alias are appended to the +command configured by the alias. Binds ----- @@ -110,139 +108,21 @@ Single keys such as 'q' are just that: 'q = quit' will bind the 'q' key to the 'quit' command. Modifier keys can be specified by prefixing them: 'Ctrl+q', 'Meta+f', -'Shift+g'. If multiple modifier keys are desired, they are specified in the +'Shift+G'. If multiple modifier keys are desired, they are specified in the order 'Ctrl+Meta+Shift'. When a key's name is more than a single character, or a modifier is used it must be wrapped in '<' and '>', for example: ''. Multiple keys in succession can be specified by listing them in order: -'gg = select_abs 0' will bind two presses of the 'g' key to jump to the first +'gg = goto 0' will bind two presses of the 'g' key to jump to the first image, and 'p = exec echo hi' will bind the key sequence of 'Ctrl+a' followed by 'p' to executing the shell command 'echo hi'. -N.B. Special characters such as '!' are not named directly, and are accessed -by their regular key, combined with the shift modifier: 'Shift+1'. - -Some keys, such as '<', and '>' have special names, to avoid conflits with -the bind syntax, or the config file format. Other keys with no character -associated with them, such as the 'Return' key or the arrow keys also have -special names. These are as follows: - -*Application*:: - The Application / Compose / Context Menu / Alt Gr key. - -*AudioMute*:: - The mute volume key. - -*AudioNext*:: - The next track media key. - -*AudioPlay*:: - The play media key. - -*AudioPrev*:: - The previous track media key. - -*AudioStop*:: - The stop media key. - -*Backspace*:: - The backspace key. - -*BrightnessDown*:: - The brightness down key. - -*BrightnessUp*:: - The brightness up key. - -*Cancel*:: - The cancel key. - -*Clear*:: - The clear key. - -*Delete*:: - The delete key. - -*Down*:: - The down arrow key. - -*Eject*:: - The eject key. - -*End*:: - The end key. - -*Escape*:: - The Esc / escape key. - -*Equals*:: - The = key. - -*F<1-24>*:: - The F keys. - -*Home*:: - The home key. - -*Keypad <00|000|0-9>*:: - The numeric keypad number keys. - -*Keypad Backspace*:: - The numeric keypad backspace key. - -*Keypad Clear*:: - The numeric keypad clear key. - -*Keypad Enter*:: - The numeric keypad enter key. - -*Keypad -*:: - The numeric keypad subtract key. - -*Keypad +*:: - The numeric keypad add key. - -*Left*:: - The left arrow key. - -*LeftSquareBracket*:: - The [ key. - -*Mute*:: - The mute key. - -*PageDown*:: - The page down key. - -*PageUp*:: - The page down key. - -*Pause*:: - The pause key. - -*Return*:: - The return / enter key. - -*Right*:: - The right arrow key. - -*RightSquareBracket*:: - The ] key. - -*Space*:: - The space bar. - -*Up*:: - The up arrow key. - -*VolumeDown*:: - The volume down key. - -*VolumeUp*:: - The volume up key. +Many keys, such as '<', and '>' have special names. On X11, these can be easily +found with the xev(1) command. For example, '!' is called 'exclam', '<' is +called 'less', '>' is called 'greater'. -See Also --------- +A complete list of keysyms can also be found on most systems with the +'dumpkeys -l' command. **imv**(1) diff --git a/src/imv.c b/src/imv.c index 363d95a..9b12a79 100644 --- a/src/imv.c +++ b/src/imv.c @@ -752,7 +752,7 @@ bool imv_parse_args(struct imv *imv, int argc, char **argv) int o; /* TODO getopt_long */ - while ((o = getopt(argc, argv, "frdwWxhvlu:s:n:b:t:")) != -1) { + while ((o = getopt(argc, argv, "frdxhvlu:s:n:b:t:")) != -1) { switch(o) { case 'f': imv->start_fullscreen = true; break; case 'r': imv->recursive_load = true; break; -- cgit v1.2.3