suckless-desktop/sxiv
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated doc

Browse Source
This commit is contained in:
Bert Münnich 2011-10-16 20:33:23 +02:00
parent 4e8dabd6ac
commit 55da6fb8dd
2 changed files with 125 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@ -81,48 +81,63 @@ sxiv supports the following command-line options:
-Z Same as `-z 100' -Z Same as `-z 100'
-z ZOOM Scale all images to current zoom level, use ZOOM at startup -z ZOOM Scale all images to current zoom level, use ZOOM at startup
The following key mappings are available; differences between image view and The following general key commands are available:
thumbnail mode are denoted via brackets:
q Quit sxiv 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 0-9 Prefix the next command with a number (denoted via [count])
p,Backspace Go to the previous image
g,G Go to [select] first/last image g Go to first image
[,] Go 10 images backward/forward 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-n,p Go to the next/previous frame of a multi-frame image
Ctrl-Space Play/pause animation of a multi-frame image Ctrl-Space Play/pause animation of a multi-frame image
+,= Zoom in + Zoom in
- Zoom out - Zoom out
0 Set zoom level to 100% = Set zoom level to 100%, or [count]%
w Fit image into window w Fit image into window
h,j,k,l Pan image [move selection] left/down/up/right h,j,k,l Pan image 1/5 of window width/height or [count] pixels
(also with arrow keys) left/down/up/right (also with arrow keys)
H,J,K,L Pan to left/bottom/top/right image edge 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 Ctrl-h,j,k,l Pan image one window width/height left/down/up/right
(also with Ctrl-arrow keys) (also with Ctrl-arrow keys)
<,> Rotate image (counter-)clockwise by 90 degrees <,> Rotate image (counter-)clockwise by 90 degrees
W Resize window to fit image s Toggle slideshow
f Toggle fullscreen mode (requires an EWMH/NetWM compliant Ctrl-'-' Decrease slideshow delay
window manager) Ctrl-'+' Increase slideshow delay
Ctrl-'=' Reset slideshow delay, or set it to [count] seconds
a Toggle anti-aliasing a Toggle anti-aliasing
A Toggle visibility of alpha-channel, i.e. transparency W Resize window to fit image
D Remove image from file list and go to [select] next image
r Reload image
Additionally, the following mouse mappings are available: Additionally, the following mouse commands are available in *image mode*:
Button1 Go to the next image Button1 Go to the next image
[select image/open image if it is already selected]
Button2 Drag image with mouse while keeping it pressed Button2 Drag image with mouse while keeping it pressed
Button3 Go to the previous image 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 Shift+Scroll Pan image left/right
Ctrl+Scroll Zoom in/out Ctrl+Scroll Zoom in/out

131
sxiv.1
View File

@ -82,35 +82,74 @@ The same as `\-z 100'.
Scale all images to the current zoom level, use a zoom level of Scale all images to the current zoom level, use a zoom level of
.I ZOOM .I ZOOM
at startup. at startup.
.SH KEYBOARD COMMANDS .SH GENERAL KEYBOARD COMMANDS
The differences of the following key mappings between image view and thumbnail The following keyboard commands are available in both image and thumbnail mode:
mode are denoted via brackets.
.SS General
.TP .TP
.B q .B q
Quit sxiv. Quit sxiv.
.TP .TP
.B Return .B Return
Switch to thumbnail mode [open selected image]. Switch to thumbnail mode / open selected image in image mode.
.TP
.BR 0 \- 9
Prefix the next command with a number (denoted via
.IR count ).
.TP
.B g
Go to the first image.
.TP
.B G
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 .SS Navigate image list
.TP .TP
.BR n ", " Space .BR n ", " Space
Go to the next image. Go
.I count
images forward.
.TP .TP
.BR p ", " Backspace .BR p ", " Backspace
Go to the previous image. Go
.TP .I count
.B g images backward.
Go to [select] the first image.
.TP
.B G
Go to [select] the last image.
.TP .TP
.B [ .B [
Go 10 images backward. Go
.I count
* 10 images backward.
.TP .TP
.B ] .B ]
Go 10 images forward. Go
.I count
* 10 images forward.
.SS Handle multi-frame images .SS Handle multi-frame images
.TP .TP
.B Ctrl-n .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. Play/pause animation of a multi-frame image.
.SS Zooming .SS Zooming
.TP .TP
.BR + ", " = .BR +
Zoom in. Zoom in.
.TP .TP
.B \- .B \-
Zoom out. Zoom out.
.TP .TP
.B 0 .B =
Set zoom level to 100%. Set zoom level to 100%, or
.IR count %.
.TP .TP
.B w .B w
Set zoom level to fit image into window. Set zoom level to fit image into window.
.SS Panning/Moving .SS Panning
.TP .TP
.BR h ", " Left .BR h ", " Left
Pan image [move selection] left. Pan image 1/5 of window width or
.I count
pixel left.
.TP .TP
.BR j ", " Down .BR j ", " Down
Pan image [move selection] down. Pan image 1/5 of window height or
.I count
pixel down.
.TP .TP
.BR k ", " Up .BR k ", " Up
Pan image [move selection] up. Pan image 1/5 of window height or
.I count
pixel up.
.TP .TP
.BR l ", " Right .BR l ", " Right
Pan image [move selection] right. Pan image 1/5 of window width or
.I count
pixel right.
.TP .TP
.B H .B H
Pan to left image edge. Pan to left image edge.
@ -178,33 +226,34 @@ Rotate image counter-clockwise by 90 degrees.
.TP .TP
.B > .B >
Rotate image clockwise by 90 degrees. Rotate image clockwise by 90 degrees.
.SS Control window .SS Slideshow
.TP .TP
.B W .B s
Resize window to fit image. Toggle slideshow.
.TP .TP
.B f .B Ctrl\-'\-'
Toggle fullscreen mode. 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 .SS Miscellaneous
.TP .TP
.B a .B a
Toggle anti-aliasing. Toggle anti-aliasing.
.TP .TP
.B A .B W
Toggle visibility of alpha-channel, i.e. image transparency. Resize window to fit image.
.TP
.B D
Remove current [selected] image from file list and go to [select] next image.
.TP
.B r
Reload image.
.SH MOUSE COMMANDS .SH MOUSE COMMANDS
The differences of the following mouse mappings between image view and The following mouse mappings are available in image mode:
thumbnail mode are denoted via brackets.
.SS Navigate image list .SS Navigate image list
.TP .TP
.B Button1 .B Button1
Go to [select/open] next image. Go to next image.
.TP .TP
.B Button3 .B Button3
Go to the previous image. Go to the previous image.
@ -221,10 +270,10 @@ Zoom out.
Drag the image with the mouse while keeping this button pressed down. Drag the image with the mouse while keeping this button pressed down.
.TP .TP
.B ScrollUp .B ScrollUp
Pan image up [scroll up one thumbnail row]. Pan image up.
.TP .TP
.B ScrollDown .B ScrollDown
Pan image down [scroll down one thumbnail row]. Pan image down.
.TP .TP
.B Shift+ScrollUp .B Shift+ScrollUp
Pan image left. Pan image left.