Krolyxon
Commit fb9686c

Branches

Refs →

nsxivetcnsxiv.1

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