Krolyxon
Commit daee344

Branches

Refs →

nsxivetcnsxiv.1

570 lines · 12.0 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.SH KEYBOARD COMMANDS
123.SS General
124The following keyboard commands are available in both image and thumbnail modes:
125.TP
126.BR 0 \- 9
127Prefix the next command with a number (denoted via
128.IR count ).
129.TP
130.B q
131Quit nsxiv.
132.TP
133.B Return
134Switch to thumbnail mode / open selected image in image mode.
135.TP
136.B f
137Toggle fullscreen mode.
138.TP
139.B b
140Toggle visibility of statusbar at the bottom of the window.
141.TP
142.B Ctrl-x
143Send the next key to the external key-handler. See section EXTERNAL KEY HANDLER
144for more information.
145.TP
146.B g
147Go to the first image.
148.TP
149.B G
150Go to the last image, or image number
151.IR count .
152.TP
153.B r
154Reload image.
155.TP
156.B D
157Remove current image from file list and go to next image.
158.TP
159.BR Ctrl-h ", " Ctrl-Left
160Scroll left one screen width.
161.TP
162.BR Ctrl-j ", " Ctrl-Down
163Scroll down one screen height.
164.TP
165.BR Ctrl-k ", " Ctrl-Up
166Scroll up one screen height.
167.TP
168.BR Ctrl-l ", " Ctrl-Right
169Scroll right one screen width.
170.TP
171.BR +
172Zoom in.
173.TP
174.B \-
175Zoom out.
176.TP
177.B m
178Mark/unmark the current image.
179.TP
180.B M
181Mark/unmark all images starting from the last marked/unmarked image up to the
182current one.
183.TP
184.B Ctrl-m
185Reverse all image marks.
186.TP
187.B Ctrl-u
188Remove all image marks.
189.TP
190.B N
191Go
192.I count
193marked images forward.
194.TP
195.B P
196Go
197.I count
198marked images backward.
199.TP
200.B {
201Decrease gamma correction by
202.I count
203steps.
204.TP
205.B }
206Increase gamma correction by
207.I count
208steps.
209.TP
210.B Ctrl-g
211Reset gamma correction.
212.SS Thumbnail mode
213The following keyboard commands are only available in thumbnail mode:
214.TP
215.BR h ", " Left
216Move selection left
217.I count
218times.
219.TP
220.BR j ", " Down
221Move selection down
222.I count
223times.
224.TP
225.BR k ", " Up
226Move selection up
227.I count
228times.
229.TP
230.BR l ", " Right
231Move selection right
232.I count
233times.
234.TP
235.B R
236Reload all thumbnails.
237.SS Image mode
238The following keyboard commands are only available in image mode:
239.TP
240Navigate image list:
241.TP
242.BR n ", " Space
243Go
244.I count
245images forward.
246.TP
247.BR p ", " Backspace
248Go
249.I count
250images backward.
251.TP
252.B [
253Go
254.I count
255* 10 images backward.
256.TP
257.B ]
258Go
259.I count
260* 10 images forward.
261.TP
262.B Ctrl-6
263Go to the previously viewed image.
264.TP
265Handle multi-frame images:
266.TP
267.B Ctrl-n
268Go
269.I count
270frames of a multi-frame image forward.
271.TP
272.B Ctrl-p
273Go
274.I count
275frames of a multi-frame image backward.
276.TP
277.BR Ctrl-a ", " Ctrl-Space
278Play/stop animations of multi-frame images.
279.TP
280Panning:
281.TP
282.BR h ", " Left
283Scroll image 1/5 of window width or
284.I count
285pixels left.
286.TP
287.BR j ", " Down
288Scroll image 1/5 of window height or
289.I count
290pixels down.
291.TP
292.BR k ", " Up
293Scroll image 1/5 of window height or
294.I count
295pixels up.
296.TP
297.BR l ", " Right
298Scroll image 1/5 of window width or
299.I count
300pixels right.
301.TP
302.B H
303Scroll to left image edge.
304.TP
305.B J
306Scroll to bottom image edge.
307.TP
308.B K
309Scroll to top image edge.
310.TP
311.B L
312Scroll to right image edge.
313.TP
314.B z
315Scroll to image center.
316.TP
317Zooming:
318.TP
319.B =
320Set zoom level to 100%, or
321.IR count %.
322.TP
323.B w
324Set zoom level to 100%, but fit large images into window.
325.TP
326.B W
327Fit image to window.
328.TP
329.B F
330Fill image to window.
331.TP
332.B e
333Fit image to window width.
334.TP
335.B E
336Fit image to window height.
337.TP
338Rotation:
339.TP
340.B <
341Rotate image counter-clockwise by 90 degrees.
342.TP
343.B >
344Rotate image clockwise by 90 degrees.
345.TP
346.B ?
347Rotate image by 180 degrees.
348.TP
349Flipping:
350.TP
351.B |
352Flip image horizontally.
353.TP
354.B _
355Flip image vertically.
356.TP
357Miscellaneous:
358.TP
359.B a
360Toggle anti-aliasing.
361.TP
362.B A
363Toggle visibility of alpha-channel, i.e. image transparency.
364.TP
365.B s
366Toggle slideshow mode and/or set the delay between images to
367.I count
368seconds.
369.SH MOUSE COMMANDS
370.SS Thumbnail mode
371The following mouse mappings are available in thumbnail mode:
372.TP
373.B Button1
374Select the image. Goes into image mode if double\-clicked.
375.TP
376.B Button3
377Mark/unmark the image. Dragging while holding down Button3 will mark/unmark
378multiple images.
379.TP
380.B Button4
381Scroll up by one row.
382.TP
383.B Button5
384Scroll down by one row.
385.TP
386.B Ctrl-Button4
387Scroll up by one page.
388.TP
389.B Ctrl-Button5
390Scroll down by one page.
391.SS Image mode
392The following mouse mappings are available in image mode:
393.TP
394.B Button1
395Go to the next image if the mouse cursor is in the right part of the window or
396to the previous image if it is in the left part.
397.TP
398.B Ctrl-Button1
399Pan the image relative to the mouse cursor.
400.TP
401.B Button2
402Pan the image according to the mouse cursor position in the window while
403keeping this button pressed down.
404.TP
405.B Button3
406Switch to thumbnail mode.
407.TP
408.B Button4
409Zoom in.
410.TP
411.B Button5
412Zoom out.
413.SH CONFIGURATION
414The following X resources are supported:
415.TP
416.B window.background
417Color of the window background
418.TP
419.B window.foreground
420Color of the window foreground
421.TP
422.B bar.font
423Name of Xft bar font
424.TP
425.B bar.background
426Color of the bar background. Defaults to window.background
427.TP
428.B bar.foreground
429Color of the bar foreground. Defaults to window.foreground
430.TP
431.B mark.foreground
432Color of the mark foreground. Defaults to window.foreground
433.TP
434Please see xrdb(1) on how to change them.
435.SH WINDOW TITLE
436The window title can be replaced with the output of a user-provided script,
437which is called by nsxiv whenever any of the relevant information changes.
438The path of this script is
439.I $XDG_CONFIG_HOME/nsxiv/exec/win-title
440and the arguments given to it (where "Optional" arguments might be empty) are:
441.IP $1 4
442resolved absolute path of the current file
443.IP $2 4
444current file number
445.IP $3 4
446total file count
447.IP $4 4
448image width (Optional: Disabled on thumbnails mode)
449.IP $5 4
450image height (Optional: Disabled on thumbnails mode)
451.IP $6 4
452current zoom (Optional: Disabled on thumbnails mode)
453.P
454The term file is used rather than image as nsxiv does not precheck that the
455input files are valid images. Total file count may be different from the actual
456count of valid images.
457.P
458There is also an example script installed together with nsxiv as
459.IR EGPREFIX/win-title .
460.SH STATUS BAR
461The information displayed on the left side of the status bar can be replaced
462with the output of user-provided script.
463.P
464The script that is called by nsxiv whenever an image gets loaded is located at
465.I $XDG_CONFIG_HOME/nsxiv/exec/image-info
466and the arguments given to it are:
467.IP $1 4
468path to image file (as provided by the user)
469.IP $2 4
470image width
471.IP $3 4
472image height
473.IP $4 4
474fully resolved path to the image file
475.P
476In thumbnail mode, the script that is called is located at
477.I $XDG_CONFIG_HOME/nsxiv/exec/thumb-info
478and the arguments given to it are:
479.IP $1 4
480path to image file (as provided by the user)
481.IP $2 4
482empty
483.IP $3 4
484empty
485.IP $4 4
486fully resolved path to the image file
487.P
488There are also example scripts installed together with nsxiv as
489.IR EGPREFIX/image-info
490and
491.IR EGPREFIX/thumb-info .
492.SH EXTERNAL KEY HANDLER
493Additional external keyboard commands can be defined using a handler program
494located in
495.IR $XDG_CONFIG_HOME/nsxiv/exec/key-handler .
496The handler is invoked by pressing
497.BR Ctrl-x .
498The next key combo is passed as its first argument. Passed via stdin are the
499images to act upon: all marked images, if in thumbnail mode and at least one
500image has been marked, otherwise the current image. nsxiv(1) will block until
501the handler terminates. It then checks which images have been modified and
502reloads them.
503
504By default nsxiv(1) will send one image per-line to stdin, however when using
505\-0 the image list will be NULL separated and the environment variable
506"$NSXIV_USING_NULL" will be set to 1.
507
508The key combo argument has the following form: "[C-][M-][S-]KEY",
509where C/M/S indicate Ctrl/Meta(Alt)/Shift modifier states and KEY is the X
510keysym as listed in /usr/include/X11/keysymdef.h without the "XK_" prefix.
511If KEY has an uppercase equivalent, S-KEY is resolved into it. For instance,
512K replaces S-k and Scedilla replaces S-scedilla, but S-Delete is sent as-is.
513
514There is also an example script installed together with nsxiv as
515.IR EGPREFIX/key-handler .
516.SH THUMBNAIL CACHING
517nsxiv stores all thumbnails under
518.IR $XDG_CACHE_HOME/nsxiv/ .
519.P
520Use the command line option
521.I \-c
522to remove all orphaned cache files. Additionally, run the following command
523afterwards inside the cache directory to remove empty subdirectories:
524.P
525.RS
526find . \-depth \-type d \-empty ! \-name '.' \-exec rmdir {} \\;
527.RE
528.SH ORIGINAL AUTHOR
529.EX
530Bert Muennich <ber.t at posteo.de>
531.EE
532.SH CURRENT MAINTAINERS
533.EX
534NRK <nrk at disroot.org>
535Berke Kocaoğlu <berke.kocaoglu at metu.edu.tr>
536TAAPArthur <taaparthur at gmail.com>
537eylles <ed.ylles1997 at gmail.com>
538mamg22 <marcomonizg at gmail.com>
539LuXu
540explosion-mental <explosion0mental at gmail.com>
541Guilherme Freire
542Stein Gunnar Bakkeby <bakkeby at gmail.com>
543Anupam Ashish Minz
544Sam Whitehead
545Kian Kasad <kian at kasad.com>
546qsmodo
547.EE
548.SH CONTRIBUTORS
549.EX
550Bastien Dejean <nihilhill at gmail.com>
551Dave Reisner <d at falconindy.com>
552Fung SzeTat <sthorde at gmail.com>
553Max Voit <mvdev at with-eyes.net>
554
555For additional contributors, run `git shortlog -s` in the nsxiv repository.
556.EE
557.SH HOMEPAGE
558.TP
559Website:
560.EE
561https://nsxiv.codeberg.page/
562.EX
563.TP
564Source code:
565.EE
566https://codeberg.org/nsxiv/nsxiv
567.EX
568.SH SEE ALSO
569.BR X (7),
570.BR xrdb (1)