1SXIV(1)                     General Commands Manual                    SXIV(1)
2
3
4

NAME

6       sxiv - Simple X Image Viewer
7

SYNOPSIS

9       sxiv  [-abcfhiopqrtvZ] [-A FRAMERATE] [-e WID] [-G GAMMA] [-g GEOMETRY]
10       [-N NAME] [-n NUM] [-S DELAY] [-s MODE] [-z ZOOM] FILE...
11

DESCRIPTION

13       sxiv is a simple image viewer for X.
14
15       It has two modes of operation: image and thumbnail mode. The default is
16       image mode, in which only the current image is shown. In thumbnail mode
17       a grid of small previews is displayed, making  it  easy  to  choose  an
18       image to open.
19
20       Please  note, that the fullscreen mode requires an EWMH/NetWM compliant
21       window manager.
22

OPTIONS

24       -A FRAMERATE
25              Play animations with a constant frame rate set to FRAMERATE.
26
27       -a     Play animations of multi-frame images.
28
29       -b     Do not show info bar on bottom of window.
30
31       -c     Remove all orphaned cache files from the thumbnail cache  direc‐
32              tory and exit.
33
34       -e WID Embed sxiv's window into window whose ID is WID.
35
36       -f     Start in fullscreen mode.
37
38       -G GAMMA
39              Set image gamma to GAMMA (-32..32).
40
41       -g GEOMETRY
42              Set  window  position  and size. See section GEOMETRY SPECIFICA‐
43              TIONS of X(7) for more information on GEOMETRY argument.
44
45       -N NAME
46              Set the resource name of sxiv's X window to NAME.
47
48       -n NUM Start at picture number NUM.
49
50       -h     Print brief usage information to standard output and exit.
51
52       -i     Read names of files to open from standard input.  Also  done  if
53              FILE is `-'.
54
55       -o     Write list of all marked files to standard output when quitting.
56              In combination with -i sxiv can be used as a visual filter/pipe.
57
58       -p     Enable private mode, in which sxiv does not write any  cache  or
59              temporary files.
60
61       -q     Be quiet, disable warnings to standard error stream.
62
63       -r     Search the given directories recursively for images to view.
64
65       -S DELAY
66              Start  in  slideshow mode. Set the delay between images to DELAY
67              seconds.  DELAY may be a floating point number.
68
69       -s MODE
70              Set scale mode according to MODE character. Supported modes are:
71              [d]own, [f]it, [w]idth, [h]eight.
72
73       -t     Start in thumbnail mode.
74
75       -v     Print version information to standard output and exit.
76
77       -Z     The same as `-z 100'.
78
79       -z ZOOM
80              Set zoom level to ZOOM percent.
81

KEYBOARD COMMANDS

83   General
84       The  following keyboard commands are available in both image and thumb‐
85       nail mode:
86
87       0-9    Prefix the next command with a number (denoted via count).
88
89       q      Quit sxiv.
90
91       Return Switch to thumbnail mode / open selected image in image mode.
92
93       f      Toggle fullscreen mode.
94
95       b      Toggle visibility of info bar on bottom of window.
96
97       Ctrl-x Send the next key  to  the  external  key-handler.  See  section
98              EXTERNAL KEY HANDLER for more information.
99
100       g      Go to the first image.
101
102       G      Go to the last image, or image number count.
103
104       r      Reload image.
105
106       D      Remove current image from file list and go to next image.
107
108       Ctrl-h, Ctrl-Left
109              Scroll left one screen width.
110
111       Ctrl-j, Ctrl-Down
112              Scroll down one screen height.
113
114       Ctrl-k, Ctrl-Up
115              Scroll up one screen height.
116
117       Ctrl-l, Ctrl-Right
118              Scroll right one screen width.
119
120       +      Zoom in.
121
122       -      Zoom out.
123
124       m      Mark/unmark the current image.
125
126       M      Reverse all image marks.
127
128       Ctrl-M Repeat   last   mark   action   on  all  images  from  the  last
129              marked/unmarked up to the current one.
130
131       Ctrl-m Remove all image marks.
132
133       N      Go count marked images forward.
134
135       P      Go count marked images backward.
136
137       {      Decrease gamma correction by count steps.
138
139       }      Increase gamma correction by count steps.
140
141       Ctrl-g Reset gamma correction.
142
143   Thumbnail mode
144       The following keyboard commands are only available in thumbnail mode:
145
146       h, Left
147              Move selection left count times.
148
149       j, Down
150              Move selection down count times.
151
152       k, Up  Move selection up count times.
153
154       l, Right
155              Move selection right count times.
156
157       R      Reload all thumbnails.
158
159   Image mode
160       The following keyboard commands are only available in image mode:
161
162       Navigate image list:
163
164       n, Space
165              Go count images forward.
166
167       p, Backspace
168              Go count images backward.
169
170       [      Go count * 10 images backward.
171
172       ]      Go count * 10 images forward.
173
174       Handle multi-frame images:
175
176       Ctrl-n Go count frames of a multi-frame image forward.
177
178       Ctrl-p Go count frames of a multi-frame image backward.
179
180       Ctrl-Space
181              Play/stop animations of multi-frame images.
182
183       Panning:
184
185       h, Left
186              Scroll image 1/5 of window width or count pixel left.
187
188       j, Down
189              Scroll image 1/5 of window height or count pixel down.
190
191       k, Up  Scroll image 1/5 of window height or count pixel up.
192
193       l, Right
194              Scroll image 1/5 of window width or count pixel right.
195
196       H      Scroll to left image edge.
197
198       J      Scroll to bottom image edge.
199
200       K      Scroll to top image edge.
201
202       L      Scroll to right image edge.
203
204       Zooming:
205
206       =      Set zoom level to 100%, or count%.
207
208       w      Set zoom level to 100%, but fit large images into window.
209
210       W      Fit image to window.
211
212       e      Fit image to window width.
213
214       E      Fit image to window height.
215
216       Rotation:
217
218       <      Rotate image counter-clockwise by 90 degrees.
219
220       >      Rotate image clockwise by 90 degrees.
221
222       ?      Rotate image by 180 degrees.
223
224       Flipping:
225
226       |      Flip image horizontally.
227
228       _      Flip image vertically.
229
230       Miscellaneous:
231
232       a      Toggle anti-aliasing.
233
234       A      Toggle visibility of alpha-channel, i.e. image transparency.
235
236       s      Toggle slideshow mode and/or set the  delay  between  images  to
237              count seconds.
238

MOUSE COMMANDS

240       The following mouse mappings are available in image mode:
241
242       General:
243
244       Button3
245              Switch to thumbnail mode.
246
247       Navigate image list:
248
249       Button1
250              Go to the next image if the mouse cursor is in the right part of
251              the window or to the previous image if it is in the left part.
252
253       Panning:
254
255       Button2
256              Pan the image according to the mouse cursor position in the win‐
257              dow while keeping this button pressed down.
258
259       Zooming:
260
261       ScrollUp
262              Zoom in.
263
264       ScrollDown
265              Zoom out.
266

CONFIGURATION

268       The following X resources are supported:
269
270       background
271              Color of the window background and bar foreground
272
273       foreground
274              Color of the window foreground and bar background
275
276       font   Name of Xft bar font
277
278       Please see xrdb(1) on how to change them.
279

STATUS BAR

281       The  information  displayed  on  the left side of the status bar can be
282       replaced with the output of a user-provided script, which is called  by
283       sxiv  whenever  an  image  gets  loaded.  The  path  of  this script is
284       $XDG_CONFIG_HOME/sxiv/exec/image-info and the  arguments  given  to  it
285       are: 1) path to image file, 2) image width, 3) image height.
286
287       There  is  also  an  example  script  installed  together  with sxiv as
288       /usr/share/sxiv/exec/image-info.
289

EXTERNAL KEY HANDLER

291       Additional external keyboard commands can be defined  using  a  handler
292       program located in $XDG_CONFIG_HOME/sxiv/exec/key-handler.  The handler
293       is invoked by pressing Ctrl-x.  The next key combo  is  passed  as  its
294       first  argument.  Passed via stdin are the images to act upon, one path
295       per line: all marked images, if in thumbnail  mode  and  at  least  one
296       image has been marked, otherwise the current image.  sxiv(1) will block
297       until the handler terminates. It then checks  which  images  have  been
298       modified and reloads them.
299
300       The key combo argument has the following form: "[C-][M-][S-]KEY", where
301       C/M/S indicate Ctrl/Meta(Alt)/Shift modifier states and KEY  is  the  X
302       keysym as listed in /usr/include/X11/keysymdef.h without the "XK_" pre‐
303       fix.
304
305       There is also  an  example  script  installed  together  with  sxiv  as
306       /usr/share/sxiv/exec/key-handler.
307

THUMBNAIL CACHING

309       sxiv stores all thumbnails under $XDG_CACHE_HOME/sxiv/.
310
311       Use  the  command  line  option  -c to remove all orphaned cache files.
312       Additionally, run the following command  afterwards  inside  the  cache
313       directory to remove empty subdirectories:
314
315              find . -depth -type d -empty ! -name '.' -exec rmdir {} \;
316

AUTHOR

318       Bert Muennich   <ber.t at posteo.de>
319

CONTRIBUTORS

321       Bastien Dejean  <nihilhill at gmail.com>
322       Dave Reisner    <d at falconindy.com>
323       Fung SzeTat     <sthorde at gmail.com>
324       Max Voit        <mvdev at with-eyes.net>
325

HOMEPAGE

327       https://github.com/muennich/sxiv
328

SEE ALSO

330       X(7), xrdb(1)
331
332
333
334                                    sxiv-26                            SXIV(1)
Impressum