sxiv.1 (8570B)
1 .TH SXIV 1 sxiv\-VERSION 2 .SH NAME 3 sxiv \- Simple X Image Viewer 4 .SH SYNOPSIS 5 .B sxiv 6 .RB [ \-abcfhiopqrtvZ ] 7 .RB [ \-A 8 .IR FRAMERATE ] 9 .RB [ \-e 10 .IR WID ] 11 .RB [ \-G 12 .IR GAMMA ] 13 .RB [ \-g 14 .IR GEOMETRY ] 15 .RB [ \-N 16 .IR NAME ] 17 .RB [ \-n 18 .IR NUM ] 19 .RB [ \-S 20 .IR DELAY ] 21 .RB [ \-s 22 .IR MODE ] 23 .RB [ \-z 24 .IR ZOOM ] 25 .IR FILE ... 26 .SH DESCRIPTION 27 sxiv is a simple image viewer for X. 28 .P 29 It has two modes of operation: image and thumbnail mode. The default is image 30 mode, in which only the current image is shown. In thumbnail mode a grid of 31 small previews is displayed, making it easy to choose an image to open. 32 .P 33 Please note, that the fullscreen mode requires an EWMH/NetWM compliant window 34 manager. 35 .SH OPTIONS 36 .TP 37 .BI "\-A " FRAMERATE 38 Play animations with a constant frame rate set to 39 .IR FRAMERATE . 40 .TP 41 .B \-a 42 Play animations of multi-frame images. 43 .TP 44 .B \-b 45 Do not show info bar on bottom of window. 46 .TP 47 .B \-c 48 Remove all orphaned cache files from the thumbnail cache directory and exit. 49 .TP 50 .BI "\-e " WID 51 Embed sxiv's window into window whose ID is 52 .IR WID . 53 .TP 54 .B \-f 55 Start in fullscreen mode. 56 .TP 57 .BI "\-G " GAMMA 58 Set image gamma to GAMMA (-32..32). 59 .TP 60 .BI "\-g " GEOMETRY 61 Set window position and size. See section GEOMETRY SPECIFICATIONS of X(7) for 62 more information on GEOMETRY argument. 63 .TP 64 .BI "\-N " NAME 65 Set the resource name of sxiv's X window to NAME. 66 .TP 67 .BI "\-n " NUM 68 Start at picture number NUM. 69 .TP 70 .B \-h 71 Print brief usage information to standard output and exit. 72 .TP 73 .B \-i 74 Read names of files to open from standard input. Also done if FILE is `-'. 75 .TP 76 .B \-o 77 Write list of all marked files to standard output when quitting. In combination 78 with 79 .B \-i 80 sxiv can be used as a visual filter/pipe. 81 .TP 82 .B \-p 83 Enable private mode, in which sxiv does not write any cache or temporary files. 84 .TP 85 .B \-q 86 Be quiet, disable warnings to standard error stream. 87 .TP 88 .B \-r 89 Search the given directories recursively for images to view. 90 .TP 91 .BI "\-S " DELAY 92 Start in slideshow mode. Set the delay between images to 93 .I DELAY 94 seconds. 95 .I DELAY 96 may be a floating point number. 97 .TP 98 .BI "\-s " MODE 99 Set scale mode according to MODE character. Supported modes are: [d]own, 100 [f]it, [w]idth, [h]eight. 101 .TP 102 .B \-t 103 Start in thumbnail mode. 104 .TP 105 .B \-v 106 Print version information to standard output and exit. 107 .TP 108 .B \-Z 109 The same as `\-z 100'. 110 .TP 111 .BI "\-z " ZOOM 112 Set zoom level to ZOOM percent. 113 .SH KEYBOARD COMMANDS 114 .SS General 115 The following keyboard commands are available in both image and thumbnail mode: 116 .TP 117 .BR 0 \- 9 118 Prefix the next command with a number (denoted via 119 .IR count ). 120 .TP 121 .B q 122 Quit sxiv. 123 .TP 124 .B Return 125 Switch to thumbnail mode / open selected image in image mode. 126 .TP 127 .B f 128 Toggle fullscreen mode. 129 .TP 130 .B b 131 Toggle visibility of info bar on bottom of window. 132 .TP 133 .B Ctrl-x 134 Send the next key to the external key-handler. See section EXTERNAL KEY HANDLER 135 for more information. 136 .TP 137 .B g 138 Go to the first image. 139 .TP 140 .B G 141 Go to the last image, or image number 142 .IR count . 143 .TP 144 .B r 145 Reload image. 146 .TP 147 .B D 148 Remove current image from file list and go to next image. 149 .TP 150 .BR Ctrl-h ", " Ctrl-Left 151 Scroll left one screen width. 152 .TP 153 .BR Ctrl-j ", " Ctrl-Down 154 Scroll down one screen height. 155 .TP 156 .BR Ctrl-k ", " Ctrl-Up 157 Scroll up one screen height. 158 .TP 159 .BR Ctrl-l ", " Ctrl-Right 160 Scroll right one screen width. 161 .TP 162 .BR + 163 Zoom in. 164 .TP 165 .B \- 166 Zoom out. 167 .TP 168 .B m 169 Mark/unmark the current image. 170 .TP 171 .B M 172 Reverse all image marks. 173 .TP 174 .B Ctrl-M 175 Repeat last mark action on all images from the last marked/unmarked up to the 176 current one. 177 .TP 178 .B Ctrl-m 179 Remove all image marks. 180 .TP 181 .B N 182 Go 183 .I count 184 marked images forward. 185 .TP 186 .B P 187 Go 188 .I count 189 marked images backward. 190 .TP 191 .B { 192 Decrease gamma correction by 193 .I count 194 steps. 195 .TP 196 .B } 197 Increase gamma correction by 198 .I count 199 steps. 200 .TP 201 .B Ctrl-g 202 Reset gamma correction. 203 .SS Thumbnail mode 204 The following keyboard commands are only available in thumbnail mode: 205 .TP 206 .BR h ", " Left 207 Move selection left 208 .I count 209 times. 210 .TP 211 .BR j ", " Down 212 Move selection down 213 .I count 214 times. 215 .TP 216 .BR k ", " Up 217 Move selection up 218 .I count 219 times. 220 .TP 221 .BR l ", " Right 222 Move selection right 223 .I count 224 times. 225 .TP 226 .B R 227 Reload all thumbnails. 228 .SS Image mode 229 The following keyboard commands are only available in image mode: 230 .TP 231 Navigate image list: 232 .TP 233 .BR n ", " Space 234 Go 235 .I count 236 images forward. 237 .TP 238 .BR p ", " Backspace 239 Go 240 .I count 241 images backward. 242 .TP 243 .B [ 244 Go 245 .I count 246 * 10 images backward. 247 .TP 248 .B ] 249 Go 250 .I count 251 * 10 images forward. 252 .TP 253 Handle multi-frame images: 254 .TP 255 .B Ctrl-n 256 Go 257 .I count 258 frames of a multi-frame image forward. 259 .TP 260 .B Ctrl-p 261 Go 262 .I count 263 frames of a multi-frame image backward. 264 .TP 265 .B Ctrl-Space 266 Play/stop animations of multi-frame images. 267 .TP 268 Panning: 269 .TP 270 .BR h ", " Left 271 Scroll image 1/5 of window width or 272 .I count 273 pixel left. 274 .TP 275 .BR j ", " Down 276 Scroll image 1/5 of window height or 277 .I count 278 pixel down. 279 .TP 280 .BR k ", " Up 281 Scroll image 1/5 of window height or 282 .I count 283 pixel up. 284 .TP 285 .BR l ", " Right 286 Scroll image 1/5 of window width or 287 .I count 288 pixel right. 289 .TP 290 .B H 291 Scroll to left image edge. 292 .TP 293 .B J 294 Scroll to bottom image edge. 295 .TP 296 .B K 297 Scroll to top image edge. 298 .TP 299 .B L 300 Scroll to right image edge. 301 .TP 302 Zooming: 303 .TP 304 .B = 305 Set zoom level to 100%, or 306 .IR count %. 307 .TP 308 .B w 309 Set zoom level to 100%, but fit large images into window. 310 .TP 311 .B W 312 Fit image to window. 313 .TP 314 .B e 315 Fit image to window width. 316 .TP 317 .B E 318 Fit image to window height. 319 .TP 320 Rotation: 321 .TP 322 .B < 323 Rotate image counter-clockwise by 90 degrees. 324 .TP 325 .B > 326 Rotate image clockwise by 90 degrees. 327 .TP 328 .B ? 329 Rotate image by 180 degrees. 330 .TP 331 Flipping: 332 .TP 333 .B | 334 Flip image horizontally. 335 .TP 336 .B _ 337 Flip image vertically. 338 .TP 339 Miscellaneous: 340 .TP 341 .B a 342 Toggle anti-aliasing. 343 .TP 344 .B A 345 Toggle visibility of alpha-channel, i.e. image transparency. 346 .TP 347 .B s 348 Toggle slideshow mode and/or set the delay between images to 349 .I count 350 seconds. 351 .SH MOUSE COMMANDS 352 The following mouse mappings are available in image mode: 353 .TP 354 General: 355 .TP 356 .B Button3 357 Switch to thumbnail mode. 358 .TP 359 Navigate image list: 360 .TP 361 .B Button1 362 Go to the next image if the mouse cursor is in the right part of the window or 363 to the previous image if it is in the left part. 364 .TP 365 Panning: 366 .TP 367 .B Button2 368 Pan the image according to the mouse cursor position in the window while 369 keeping this button pressed down. 370 .TP 371 Zooming: 372 .TP 373 .B ScrollUp 374 Zoom in. 375 .TP 376 .B ScrollDown 377 Zoom out. 378 .SH CONFIGURATION 379 The following X resources are supported: 380 .TP 381 .B background 382 Color of the window background and bar foreground 383 .TP 384 .B foreground 385 Color of the window foreground and bar background 386 .TP 387 .B font 388 Name of Xft bar font 389 .TP 390 Please see xrdb(1) on how to change them. 391 .SH STATUS BAR 392 The information displayed on the left side of the status bar can be replaced 393 with the output of a user-provided script, which is called by sxiv whenever an 394 image gets loaded. The path of this script is 395 .I $XDG_CONFIG_HOME/sxiv/exec/image-info 396 and the arguments given to it are: 1) path to image file, 2) image width, 397 3) image height. 398 .P 399 There is also an example script installed together with sxiv as 400 .IR PREFIX/share/sxiv/exec/image-info . 401 .SH EXTERNAL KEY HANDLER 402 Additional external keyboard commands can be defined using a handler program 403 located in 404 .IR $XDG_CONFIG_HOME/sxiv/exec/key-handler . 405 The handler is invoked by pressing 406 .BR Ctrl-x . 407 The next key combo is passed as its first argument. Passed via stdin are the 408 images to act upon, one path per line: all marked images, if in thumbnail mode 409 and at least one image has been marked, otherwise the current image. 410 sxiv(1) will block until the handler terminates. It then checks which images 411 have been modified and reloads them. 412 413 The key combo argument has the following form: "[C-][M-][S-]KEY", 414 where C/M/S indicate Ctrl/Meta(Alt)/Shift modifier states and KEY is the X 415 keysym as listed in /usr/include/X11/keysymdef.h without the "XK_" prefix. 416 417 There is also an example script installed together with sxiv as 418 .IR PREFIX/share/sxiv/exec/key-handler . 419 .SH THUMBNAIL CACHING 420 sxiv stores all thumbnails under 421 .IR $XDG_CACHE_HOME/sxiv/ . 422 .P 423 Use the command line option 424 .I \-c 425 to remove all orphaned cache files. Additionally, run the following command 426 afterwards inside the cache directory to remove empty subdirectories: 427 .P 428 .RS 429 find . \-depth \-type d \-empty ! \-name '.' \-exec rmdir {} \\; 430 .RE 431 .SH AUTHOR 432 .EX 433 Bert Muennich <ber.t at posteo.de> 434 .EE 435 .SH CONTRIBUTORS 436 .EX 437 Bastien Dejean <nihilhill at gmail.com> 438 Dave Reisner <d at falconindy.com> 439 Fung SzeTat <sthorde at gmail.com> 440 Max Voit <mvdev at with-eyes.net> 441 .EE 442 .SH HOMEPAGE 443 .EX 444 https://github.com/muennich/sxiv 445 .EE 446 .SH SEE ALSO 447 .BR X (7), 448 .BR xrdb (1)