Krolyxon
Commit 2ac4470

Branches

Refs →

nsxivnsxiv.1

530 lines · 10.6 KB · Groff/troff

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