Krolyxon
Commit d7e149d

Branches

Refs →

nsxivetcnsxiv.1

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