Updated doc

This commit is contained in:
Bert 2011-02-21 17:06:32 +01:00
parent ea80c73520
commit 280fcf6bf0
2 changed files with 27 additions and 16 deletions

View file

@ -52,7 +52,6 @@ Use the following keys to control the basic behaviour of sxiv:
q Quit sxiv q Quit sxiv
Escape Quit sxiv and return an exit value of 2 (useful for scripting) Escape Quit sxiv and return an exit value of 2 (useful for scripting)
Return Switch operation mode
f Toggle fullscreen mode (requires an EWMH/NetWM compliant f Toggle fullscreen mode (requires an EWMH/NetWM compliant
window manager) window manager)
@ -71,6 +70,7 @@ Inside image view mode, the following key mappings are available:
W Resize window to fit image W Resize window to fit image
a Toggle anti-aliasing a Toggle anti-aliasing
r Reload image r Reload image
Return Switch to thumbnail mode
Additionally, the image view offers the following mouse commands: Additionally, the image view offers the following mouse commands:
@ -88,6 +88,7 @@ In thumbnail mode, the following key and mouse mappings are available:
h,j,k,l Move selection left/down/up/right (also with arrow keys) h,j,k,l Move selection left/down/up/right (also with arrow keys)
g/G Move selection to first/last image g/G Move selection to first/last image
Return Open selected image
Button1 Select image/open image if it is already selected Button1 Select image/open image if it is already selected
ScrollUp Scroll up one row ScrollUp Scroll up one row

40
sxiv.1
View file

@ -3,7 +3,7 @@
sxiv \- Simple (or small or suckless) X Image Viewer sxiv \- Simple (or small or suckless) X Image Viewer
.SH SYNOPSIS .SH SYNOPSIS
.B sxiv .B sxiv
.RB [ \-dFfhpqrsvZ ] .RB [ \-dFfhpqrstvZ ]
.RB [ \-g .RB [ \-g
.IR GEOMETRY ] .IR GEOMETRY ]
.RB [ \-z .RB [ \-z
@ -20,6 +20,10 @@ hyphen\-minus
.RB ( \- ) .RB ( \- )
is given. is given.
.P .P
sxiv has two modes of operation: image and thumbnail mode. The default is image
mode, in which only the current image is shown. In thumbnail mode a grid of
small previews is displayed, making it easy to choose an image to open.
.P
Please note, that the fullscreen mode requires an EWMH/NetWM compliant window Please note, that the fullscreen mode requires an EWMH/NetWM compliant window
manager. manager.
.SH OPTIONS .SH OPTIONS
@ -54,6 +58,9 @@ Search the given directories recursively for images to view.
.B \-s .B \-s
Scale all images to fit into window. Scale all images to fit into window.
.TP .TP
.B \-t
Start in thumbnail mode.
.TP
.B \-v .B \-v
Print version information to standard output and exit. Print version information to standard output and exit.
.TP .TP
@ -72,6 +79,9 @@ Quit sxiv.
.TP .TP
.B Escape .B Escape
Quit sxiv and return an exit value of 2. Quit sxiv and return an exit value of 2.
.TP
.B Return
Switch to thumbnail mode; in thumbnail mode: open selected image.
.SS Navigate image list .SS Navigate image list
.TP .TP
.BR n ", " Space .BR n ", " Space
@ -104,19 +114,19 @@ Set zoom level to 100%.
.TP .TP
.B w .B w
Set zoom level to fit image into window. Set zoom level to fit image into window.
.SS Panning .SS Panning/Moving
.TP .TP
.BR h ", " Left .BR h ", " Left
Pan left. Pan image left; in thumbnail mode: move selection left.
.TP .TP
.BR j ", " Down .BR j ", " Down
Pan down. Pan image down; in thumbnail mode: move selection down.
.TP .TP
.BR k ", " Up .BR k ", " Up
Pan up. Pan image up; in thumbnail mode: move selection up.
.TP .TP
.BR l ", " Right .BR l ", " Right
Pan right. Pan image right; in thumbnail mode: move selection right.
.SS Rotation .SS Rotation
.TP .TP
.B < .B <
@ -142,10 +152,7 @@ Reload image.
.SS Navigate image list .SS Navigate image list
.TP .TP
.B Button1 .B Button1
Go to the next image. Go to the next image; in thumbnail mode: select/open image.
.TP
.B Button2
Drag the image with the mouse while keeping this button pressed down.
.TP .TP
.B Button3 .B Button3
Go to the previous image. Go to the previous image.
@ -156,19 +163,22 @@ Zoom in.
.TP .TP
.B Ctrl+ScrollDown .B Ctrl+ScrollDown
Zoom out. Zoom out.
.SS Panning .SS Panning/Moving
.TP
.B Button2
Drag the image with the mouse while keeping this button pressed down.
.TP .TP
.B ScrollUp .B ScrollUp
Pan up. Pan image up; in thumbnail mode: Scroll one row up.
.TP .TP
.B ScrollDown .B ScrollDown
Pan down. Pan image down; in thumbnail mode: Scroll one row down.
.TP .TP
.B Shift+ScrollUp .B Shift+ScrollUp
Pan left. Pan image left.
.TP .TP
.B Shift+ScrollDown .B Shift+ScrollDown
Pan right. Pan image right.
.SH AUTHORS .SH AUTHORS
.EX .EX
Bert Muennich <ber.t at gmx.com> Bert Muennich <ber.t at gmx.com>