Krolyxon
Commit 16b966b

Branches

Refs →

nsxivetcnsxiv.1

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