Krolyxon
Commit bdd9521

Branches

Refs →

nsxivnsxiv.1

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