aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBert Münnich <ber.t@gmx.com>2011-10-16 20:33:23 +0200
committerBert Münnich <ber.t@gmx.com>2011-10-16 20:33:23 +0200
commit55da6fb8dd58829555172b57a0237d6c3381e573 (patch)
treee4f1b5d9624cc2b98784eeea756ad45cde1b163b
parent4e8dabd6ac47185697744621b3ee638fc34e473a (diff)
Updated doc
-rw-r--r--README.md55
-rw-r--r--sxiv.1131
2 files changed, 125 insertions, 61 deletions
diff --git a/README.md b/README.md
index 013a096..854343f 100644
--- a/README.md
+++ b/README.md
@@ -81,48 +81,63 @@ sxiv supports the following command-line options:
-Z Same as `-z 100'
-z ZOOM Scale all images to current zoom level, use ZOOM at startup
-The following key mappings are available; differences between image view and
-thumbnail mode are denoted via brackets:
+The following general key commands are available:
q Quit sxiv
- Return Switch to thumbnail mode [open selected image]
+ Return Switch to thumbnail mode / open selected image
- n,Space Go to the next image
- p,Backspace Go to the previous image
- g,G Go to [select] first/last image
- [,] Go 10 images backward/forward
+ 0-9 Prefix the next command with a number (denoted via [count])
+
+ g Go to first image
+ G Go to the last image, or image number [count]
+
+ f Toggle fullscreen mode (requires an EWMH/NetWM compliant
+ window manager)
+ A Toggle visibility of alpha-channel, i.e. transparency
+
+ r Reload image
+ D Remove image from file list and go to next image
+
+
+The following additional key commands are available in *thumbnail mode*:
+
+ h,j,k,l Move selection left/down/up/right
+
+The following additional key commands are available in *image mode*:
+
+ n,Space Go [count] images forward
+ p,Backspace Go [count] images backward
+ [,] Go [count] * 10 images backward/forward
Ctrl-n,p Go to the next/previous frame of a multi-frame image
Ctrl-Space Play/pause animation of a multi-frame image
- +,= Zoom in
+ + Zoom in
- Zoom out
- 0 Set zoom level to 100%
+ = Set zoom level to 100%, or [count]%
w Fit image into window
- h,j,k,l Pan image [move selection] left/down/up/right
- (also with arrow keys)
+ h,j,k,l Pan image 1/5 of window width/height or [count] pixels
+ left/down/up/right (also with arrow keys)
H,J,K,L Pan to left/bottom/top/right image edge
Ctrl-h,j,k,l Pan image one window width/height left/down/up/right
(also with Ctrl-arrow keys)
<,> Rotate image (counter-)clockwise by 90 degrees
- W Resize window to fit image
- f Toggle fullscreen mode (requires an EWMH/NetWM compliant
- window manager)
+ s Toggle slideshow
+ Ctrl-'-' Decrease slideshow delay
+ Ctrl-'+' Increase slideshow delay
+ Ctrl-'=' Reset slideshow delay, or set it to [count] seconds
a Toggle anti-aliasing
- A Toggle visibility of alpha-channel, i.e. transparency
- D Remove image from file list and go to [select] next image
- r Reload image
+ W Resize window to fit image
-Additionally, the following mouse mappings are available:
+Additionally, the following mouse commands are available in *image mode*:
Button1 Go to the next image
- [select image/open image if it is already selected]
Button2 Drag image with mouse while keeping it pressed
Button3 Go to the previous image
- Scroll Pan image up/down [scroll up/down one thumbnail row]
+ Scroll Pan image up/down
Shift+Scroll Pan image left/right
Ctrl+Scroll Zoom in/out
diff --git a/sxiv.1 b/sxiv.1
index 0b96827..69ee9c4 100644
--- a/sxiv.1
+++ b/sxiv.1
@@ -82,35 +82,74 @@ The same as `\-z 100'.
Scale all images to the current zoom level, use a zoom level of
.I ZOOM
at startup.
-.SH KEYBOARD COMMANDS
-The differences of the following key mappings between image view and thumbnail
-mode are denoted via brackets.
-.SS General
+.SH GENERAL KEYBOARD COMMANDS
+The following keyboard commands are available in both image and thumbnail mode:
.TP
.B q
Quit sxiv.
.TP
.B Return
-Switch to thumbnail mode [open selected image].
-.SS Navigate image list
-.TP
-.BR n ", " Space
-Go to the next image.
+Switch to thumbnail mode / open selected image in image mode.
.TP
-.BR p ", " Backspace
-Go to the previous image.
+.BR 0 \- 9
+Prefix the next command with a number (denoted via
+.IR count ).
.TP
.B g
-Go to [select] the first image.
+Go to the first image.
.TP
.B G
-Go to [select] the last image.
+Go to the last image, or image number
+.IR count .
+.TP
+.B f
+Toggle fullscreen mode.
+.TP
+.B A
+Toggle visibility of alpha-channel, i.e. image transparency.
+.TP
+.B r
+Reload image.
+.TP
+.B D
+Remove current image from file list and go to next image.
+.SH THUMBNAIL KEYBOARD COMMANDS
+The following keyboard commands are only available in thumbnail mode:
+.TP
+.BR h ", " Left
+Move selection left.
+.TP
+.BR j ", " Down
+Move selection down.
+.TP
+.BR k ", " Up
+Move selection up.
+.TP
+.BR l ", " Right
+Move selection right.
+.SH IMAGE KEYBOARD COMMANDS
+The following keyboard commands are only available in image mode:
+.SS Navigate image list
+.TP
+.BR n ", " Space
+Go
+.I count
+images forward.
+.TP
+.BR p ", " Backspace
+Go
+.I count
+images backward.
.TP
.B [
-Go 10 images backward.
+Go
+.I count
+* 10 images backward.
.TP
.B ]
-Go 10 images forward.
+Go
+.I count
+* 10 images forward.
.SS Handle multi-frame images
.TP
.B Ctrl-n
@@ -123,30 +162,39 @@ Go to the previous frame of a multi-frame image.
Play/pause animation of a multi-frame image.
.SS Zooming
.TP
-.BR + ", " =
+.BR +
Zoom in.
.TP
.B \-
Zoom out.
.TP
-.B 0
-Set zoom level to 100%.
+.B =
+Set zoom level to 100%, or
+.IR count %.
.TP
.B w
Set zoom level to fit image into window.
-.SS Panning/Moving
+.SS Panning
.TP
.BR h ", " Left
-Pan image [move selection] left.
+Pan image 1/5 of window width or
+.I count
+pixel left.
.TP
.BR j ", " Down
-Pan image [move selection] down.
+Pan image 1/5 of window height or
+.I count
+pixel down.
.TP
.BR k ", " Up
-Pan image [move selection] up.
+Pan image 1/5 of window height or
+.I count
+pixel up.
.TP
.BR l ", " Right
-Pan image [move selection] right.
+Pan image 1/5 of window width or
+.I count
+pixel right.
.TP
.B H
Pan to left image edge.
@@ -178,33 +226,34 @@ Rotate image counter-clockwise by 90 degrees.
.TP
.B >
Rotate image clockwise by 90 degrees.
-.SS Control window
+.SS Slideshow
.TP
-.B W
-Resize window to fit image.
+.B s
+Toggle slideshow.
.TP
-.B f
-Toggle fullscreen mode.
+.B Ctrl\-'\-'
+Decrease slideshow delay.
+.TP
+.B Ctrl-'+'
+Increase slideshow delay.
+.TP
+.B Ctrl-'='
+Reset slideshow delay to default value, or set it to
+.I count
+seconds.
.SS Miscellaneous
.TP
.B a
Toggle anti-aliasing.
.TP
-.B A
-Toggle visibility of alpha-channel, i.e. image transparency.
-.TP
-.B D
-Remove current [selected] image from file list and go to [select] next image.
-.TP
-.B r
-Reload image.
+.B W
+Resize window to fit image.
.SH MOUSE COMMANDS
-The differences of the following mouse mappings between image view and
-thumbnail mode are denoted via brackets.
+The following mouse mappings are available in image mode:
.SS Navigate image list
.TP
.B Button1
-Go to [select/open] next image.
+Go to next image.
.TP
.B Button3
Go to the previous image.
@@ -221,10 +270,10 @@ Zoom out.
Drag the image with the mouse while keeping this button pressed down.
.TP
.B ScrollUp
-Pan image up [scroll up one thumbnail row].
+Pan image up.
.TP
.B ScrollDown
-Pan image down [scroll down one thumbnail row].
+Pan image down.
.TP
.B Shift+ScrollUp
Pan image left.