Krolyxon
Commit f288efc

Branches

Refs →

nsxivetcnsxiv.1

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