Krolyxon
Commit 55da6fb

Branches

Refs →

nsxiv55da6fb

Updated doc

Author
Bert Münnich
Date
2011-10-16 20:33 +0200
Parent
4e8dabd
Commit
55da6fb8dd58829555172b57a0237d6c3381e573

+125 −61

2 files changed

Browse files Patch
−Context 3+
  1. M README.md +35 −20
  2. M sxiv.1 +90 −41
M README.md View
@@ -81,48 +81,63 @@ sxiv supports the following command-line options:
8181 -Z Same as `-z 100'
8282 -z ZOOM Scale all images to current zoom level, use ZOOM at startup
8383
84−The following key mappings are available; differences between image view and
85−thumbnail mode are denoted via brackets:
84+The following general key commands are available:
8685
8786 q Quit sxiv
88− Return Switch to thumbnail mode [open selected image]
87+ Return Switch to thumbnail mode / open selected image
8988
90− n,Space Go to the next image
91− p,Backspace Go to the previous image
92− g,G Go to [select] first/last image
93− [,] Go 10 images backward/forward
89+ 0-9 Prefix the next command with a number (denoted via [count])
90+
91+ g Go to first image
92+ G Go to the last image, or image number [count]
93+
94+ f Toggle fullscreen mode (requires an EWMH/NetWM compliant
95+ window manager)
96+ A Toggle visibility of alpha-channel, i.e. transparency
97+
98+ r Reload image
99+ D Remove image from file list and go to next image
100+
101+
102+The following additional key commands are available in *thumbnail mode*:
103+
104+ h,j,k,l Move selection left/down/up/right
105+
106+The following additional key commands are available in *image mode*:
107+
108+ n,Space Go [count] images forward
109+ p,Backspace Go [count] images backward
110+ [,] Go [count] * 10 images backward/forward
94111
95112 Ctrl-n,p Go to the next/previous frame of a multi-frame image
96113 Ctrl-Space Play/pause animation of a multi-frame image
97114
98− +,= Zoom in
115+ + Zoom in
99116 - Zoom out
100− 0 Set zoom level to 100%
117+ = Set zoom level to 100%, or [count]%
101118 w Fit image into window
102119
103− h,j,k,l Pan image [move selection] left/down/up/right
104− (also with arrow keys)
120+ h,j,k,l Pan image 1/5 of window width/height or [count] pixels
121+ left/down/up/right (also with arrow keys)
105122 H,J,K,L Pan to left/bottom/top/right image edge
106123 Ctrl-h,j,k,l Pan image one window width/height left/down/up/right
107124 (also with Ctrl-arrow keys)
108125
109126 <,> Rotate image (counter-)clockwise by 90 degrees
110127
111− W Resize window to fit image
112− f Toggle fullscreen mode (requires an EWMH/NetWM compliant
113− window manager)
128+ s Toggle slideshow
129+ Ctrl-'-' Decrease slideshow delay
130+ Ctrl-'+' Increase slideshow delay
131+ Ctrl-'=' Reset slideshow delay, or set it to [count] seconds
114132
115133 a Toggle anti-aliasing
116− A Toggle visibility of alpha-channel, i.e. transparency
117− D Remove image from file list and go to [select] next image
118− r Reload image
134+ W Resize window to fit image
119135
120−Additionally, the following mouse mappings are available:
136+Additionally, the following mouse commands are available in *image mode*:
121137
122138 Button1 Go to the next image
123− [select image/open image if it is already selected]
124139 Button2 Drag image with mouse while keeping it pressed
125140 Button3 Go to the previous image
126− Scroll Pan image up/down [scroll up/down one thumbnail row]
141+ Scroll Pan image up/down
127142 Shift+Scroll Pan image left/right
128143 Ctrl+Scroll Zoom in/out
M sxiv.1 View
@@ -82,35 +82,74 @@ The same as `\-z 100'.
8282 Scale all images to the current zoom level, use a zoom level of
8383 .I ZOOM
8484 at startup.
85−.SH KEYBOARD COMMANDS
86−The differences of the following key mappings between image view and thumbnail
87−mode are denoted via brackets.
88−.SS General
85+.SH GENERAL KEYBOARD COMMANDS
86+The following keyboard commands are available in both image and thumbnail mode:
8987 .TP
9088 .B q
9189 Quit sxiv.
9290 .TP
9391 .B Return
94−Switch to thumbnail mode [open selected image].
95−.SS Navigate image list
96−.TP
97−.BR n ", " Space
98−Go to the next image.
92+Switch to thumbnail mode / open selected image in image mode.
9993 .TP
100−.BR p ", " Backspace
101−Go to the previous image.
94+.BR 0 \- 9
95+Prefix the next command with a number (denoted via
96+.IR count ).
10297 .TP
10398 .B g
104−Go to [select] the first image.
99+Go to the first image.
105100 .TP
106101 .B G
107−Go to [select] the last image.
102+Go to the last image, or image number
103+.IR count .
104+.TP
105+.B f
106+Toggle fullscreen mode.
107+.TP
108+.B A
109+Toggle visibility of alpha-channel, i.e. image transparency.
110+.TP
111+.B r
112+Reload image.
113+.TP
114+.B D
115+Remove current image from file list and go to next image.
116+.SH THUMBNAIL KEYBOARD COMMANDS
117+The following keyboard commands are only available in thumbnail mode:
118+.TP
119+.BR h ", " Left
120+Move selection left.
121+.TP
122+.BR j ", " Down
123+Move selection down.
124+.TP
125+.BR k ", " Up
126+Move selection up.
127+.TP
128+.BR l ", " Right
129+Move selection right.
130+.SH IMAGE KEYBOARD COMMANDS
131+The following keyboard commands are only available in image mode:
132+.SS Navigate image list
133+.TP
134+.BR n ", " Space
135+Go
136+.I count
137+images forward.
138+.TP
139+.BR p ", " Backspace
140+Go
141+.I count
142+images backward.
108143 .TP
109144 .B [
110−Go 10 images backward.
145+Go
146+.I count
147+* 10 images backward.
111148 .TP
112149 .B ]
113−Go 10 images forward.
150+Go
151+.I count
152+* 10 images forward.
114153 .SS Handle multi-frame images
115154 .TP
116155 .B Ctrl-n
@@ -123,30 +162,39 @@ Go to the previous frame of a multi-frame image.
123162 Play/pause animation of a multi-frame image.
124163 .SS Zooming
125164 .TP
126−.BR + ", " =
165+.BR +
127166 Zoom in.
128167 .TP
129168 .B \-
130169 Zoom out.
131170 .TP
132−.B 0
133−Set zoom level to 100%.
171+.B =
172+Set zoom level to 100%, or
173+.IR count %.
134174 .TP
135175 .B w
136176 Set zoom level to fit image into window.
137−.SS Panning/Moving
177+.SS Panning
138178 .TP
139179 .BR h ", " Left
140−Pan image [move selection] left.
180+Pan image 1/5 of window width or
181+.I count
182+pixel left.
141183 .TP
142184 .BR j ", " Down
143−Pan image [move selection] down.
185+Pan image 1/5 of window height or
186+.I count
187+pixel down.
144188 .TP
145189 .BR k ", " Up
146−Pan image [move selection] up.
190+Pan image 1/5 of window height or
191+.I count
192+pixel up.
147193 .TP
148194 .BR l ", " Right
149−Pan image [move selection] right.
195+Pan image 1/5 of window width or
196+.I count
197+pixel right.
150198 .TP
151199 .B H
152200 Pan to left image edge.
@@ -178,33 +226,34 @@ Rotate image counter-clockwise by 90 degrees.
178226 .TP
179227 .B >
180228 Rotate image clockwise by 90 degrees.
181−.SS Control window
229+.SS Slideshow
182230 .TP
183−.B W
184−Resize window to fit image.
231+.B s
232+Toggle slideshow.
185233 .TP
186−.B f
187−Toggle fullscreen mode.
234+.B Ctrl\-'\-'
235+Decrease slideshow delay.
236+.TP
237+.B Ctrl-'+'
238+Increase slideshow delay.
239+.TP
240+.B Ctrl-'='
241+Reset slideshow delay to default value, or set it to
242+.I count
243+seconds.
188244 .SS Miscellaneous
189245 .TP
190246 .B a
191247 Toggle anti-aliasing.
192248 .TP
193−.B A
194−Toggle visibility of alpha-channel, i.e. image transparency.
195−.TP
196−.B D
197−Remove current [selected] image from file list and go to [select] next image.
198−.TP
199−.B r
200−Reload image.
249+.B W
250+Resize window to fit image.
201251 .SH MOUSE COMMANDS
202−The differences of the following mouse mappings between image view and
203−thumbnail mode are denoted via brackets.
252+The following mouse mappings are available in image mode:
204253 .SS Navigate image list
205254 .TP
206255 .B Button1
207−Go to [select/open] next image.
256+Go to next image.
208257 .TP
209258 .B Button3
210259 Go to the previous image.
@@ -221,10 +270,10 @@ Zoom out.
221270 Drag the image with the mouse while keeping this button pressed down.
222271 .TP
223272 .B ScrollUp
224−Pan image up [scroll up one thumbnail row].
273+Pan image up.
225274 .TP
226275 .B ScrollDown
227−Pan image down [scroll down one thumbnail row].
276+Pan image down.
228277 .TP
229278 .B Shift+ScrollUp
230279 Pan image left.