Krolyxon
Commit 7244e25

Branches

Refs →

nsxivnsxiv.1

490 lines · 9.5 KB · Groff/troff

Raw Blame History Download
1.TH NSXIV 1 nsxiv\-VERSION
2.SH NAME
3nsxiv \- Simple X Image Viewer
4.SH SYNOPSIS
5.B nsxiv
6.RB [ \-abcfhiopqrtvZ ]
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 [ \-T
18.IR TITLE ]
19.RB [ \-n
20.IR NUM ]
21.RB [ \-S
22.IR DELAY ]
23.RB [ \-s
24.IR MODE ]
25.RB [ \-z
26.IR ZOOM ]
27.IR FILE ...
28.SH DESCRIPTION
29nsxiv is a simple image viewer for X.
30.P
31It has two modes of operation: image and thumbnail mode. The default is image
32mode, in which only the current image is shown. In thumbnail mode a grid of
33small previews is displayed, making it easy to choose an image to open.
34.P
35Please note, that the fullscreen mode requires an EWMH/NetWM compliant window
36manager.
37.SH OPTIONS
38.TP
39.BI "\-A " FRAMERATE
40Play animations with a constant frame rate set to
41.IR FRAMERATE .
42.TP
43.B \-a
44Play animations of multi-frame images.
45.TP
46.B \-b
47Do not show info bar on bottom of window.
48.TP
49.B \-c
50Remove all orphaned cache files from the thumbnail cache directory and exit.
51.TP
52.BI "\-e " WID
53Embed nsxiv's window into window whose ID is
54.IR WID .
55.TP
56.B \-f
57Start in fullscreen mode.
58.TP
59.BI "\-G " GAMMA
60Set image gamma to GAMMA (\-32..32).
61.TP
62.BI "\-g " GEOMETRY
63Set window position and size. See section GEOMETRY SPECIFICATIONS of X(7) for
64more information on GEOMETRY argument.
65.TP
66.BI "\-N " NAME
67Set the resource name of nsxiv's X window to NAME.
68.TP
69.BI "\-T " TITLE
70Set the window title to TITLE. Use the format `prefix:suffixmode'. Any string
71literal is accepted for prefix, and the format of suffixmode is:
72
73.EX
74 Value Format
75 0 Empty
76 1 Basename of file
77 2 Full path to file
78.EE
79
80By defualt, prefix is set to "nsxiv - " and suffixmode is set to 1 (basename).
81.TP
82.BI "\-n " NUM
83Start at picture number NUM.
84.TP
85.B \-h
86Print brief usage information to standard output and exit.
87.TP
88.B \-i
89Read names of files to open from standard input. Also done if FILE is `-'.
90.TP
91.B \-o
92Write list of all marked files to standard output when quitting. In combination
93with
94.B \-i
95nsxiv can be used as a visual filter/pipe.
96.TP
97.B \-p
98Enable private mode, in which nsxiv does not write any cache or temporary files.
99.TP
100.B \-q
101Be quiet, disable warnings to standard error stream.
102.TP
103.B \-r
104Search the given directories recursively for images to view.
105.TP
106.BI "\-S " DELAY
107Start in slideshow mode. Set the delay between images to
108.I DELAY
109seconds.
110.I DELAY
111may be a floating point number.
112.TP
113.BI "\-s " MODE
114Set scale mode according to MODE character. Supported modes are: [d]own,
115[f]it, [F]ill, [w]idth, [h]eight.
116.TP
117.B \-t
118Start in thumbnail mode.
119.TP
120.B \-v
121Print version information to standard output and exit.
122.TP
123.B \-Z
124The same as `\-z 100'.
125.TP
126.BI "\-z " ZOOM
127Set zoom level to ZOOM percent.
128.SH KEYBOARD COMMANDS
129.SS General
130The following keyboard commands are available in both image and thumbnail mode:
131.TP
132.BR 0 \- 9
133Prefix the next command with a number (denoted via
134.IR count ).
135.TP
136.B q
137Quit nsxiv.
138.TP
139.B Return
140Switch to thumbnail mode / open selected image in image mode.
141.TP
142.B f
143Toggle fullscreen mode.
144.TP
145.B b
146Toggle visibility of info bar on bottom of window.
147.TP
148.B Ctrl-x
149Send the next key to the external key-handler. See section EXTERNAL KEY HANDLER
150for more information.
151.TP
152.B g
153Go to the first image.
154.TP
155.B G
156Go to the last image, or image number
157.IR count .
158.TP
159.B r
160Reload image.
161.TP
162.B D
163Remove current image from file list and go to next image.
164.TP
165.BR Ctrl-h ", " Ctrl-Left
166Scroll left one screen width.
167.TP
168.BR Ctrl-j ", " Ctrl-Down
169Scroll down one screen height.
170.TP
171.BR Ctrl-k ", " Ctrl-Up
172Scroll up one screen height.
173.TP
174.BR Ctrl-l ", " Ctrl-Right
175Scroll right one screen width.
176.TP
177.BR +
178Zoom in.
179.TP
180.B \-
181Zoom out.
182.TP
183.B m
184Mark/unmark the current image.
185.TP
186.B M
187Repeat last mark action on all images from the last marked/unmarked up to the
188current one.
189.TP
190.B Ctrl-m
191Reverse all image marks.
192.TP
193.B Ctrl-u
194Remove all image marks.
195.TP
196.B N
197Go
198.I count
199marked images forward.
200.TP
201.B P
202Go
203.I count
204marked images backward.
205.TP
206.B {
207Decrease gamma correction by
208.I count
209steps.
210.TP
211.B }
212Increase gamma correction by
213.I count
214steps.
215.TP
216.B Ctrl-g
217Reset gamma correction.
218.SS Thumbnail mode
219The following keyboard commands are only available in thumbnail mode:
220.TP
221.BR h ", " Left
222Move selection left
223.I count
224times.
225.TP
226.BR j ", " Down
227Move selection down
228.I count
229times.
230.TP
231.BR k ", " Up
232Move selection up
233.I count
234times.
235.TP
236.BR l ", " Right
237Move selection right
238.I count
239times.
240.TP
241.B R
242Reload all thumbnails.
243.SS Image mode
244The following keyboard commands are only available in image mode:
245.TP
246Navigate image list:
247.TP
248.BR n ", " Space
249Go
250.I count
251images forward.
252.TP
253.BR p ", " Backspace
254Go
255.I count
256images backward.
257.TP
258.B [
259Go
260.I count
261* 10 images backward.
262.TP
263.B ]
264Go
265.I count
266* 10 images forward.
267.TP
268Handle multi-frame images:
269.TP
270.B Ctrl-n
271Go
272.I count
273frames of a multi-frame image forward.
274.TP
275.B Ctrl-p
276Go
277.I count
278frames of a multi-frame image backward.
279.TP
280.BR Ctrl-a ", " Ctrl-Space
281Play/stop animations of multi-frame images.
282.TP
283Panning:
284.TP
285.BR h ", " Left
286Scroll image 1/5 of window width or
287.I count
288pixel left.
289.TP
290.BR j ", " Down
291Scroll image 1/5 of window height or
292.I count
293pixel down.
294.TP
295.BR k ", " Up
296Scroll image 1/5 of window height or
297.I count
298pixel up.
299.TP
300.BR l ", " Right
301Scroll image 1/5 of window width or
302.I count
303pixel right.
304.TP
305.B H
306Scroll to left image edge.
307.TP
308.B J
309Scroll to bottom image edge.
310.TP
311.B K
312Scroll to top image edge.
313.TP
314.B L
315Scroll to right image edge.
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
370The following mouse mappings are available in image mode:
371.TP
372General:
373.TP
374.B Button3
375Switch to thumbnail mode.
376.TP
377Navigate image list:
378.TP
379.B Button1
380Go to the next image if the mouse cursor is in the right part of the window or
381to the previous image if it is in the left part.
382.TP
383Panning:
384.TP
385.B Button2
386Pan the image according to the mouse cursor position in the window while
387keeping this button pressed down.
388.TP
389Zooming:
390.TP
391.B ScrollUp
392Zoom in.
393.TP
394.B ScrollDown
395Zoom out.
396.SH CONFIGURATION
397The following X resources are supported:
398.TP
399.B window.background
400Color of the window background
401.TP
402.B window.foreground
403Color of the window foreground
404.TP
405.B bar.font
406Name of Xft bar font
407.TP
408.B bar.background
409Color of the bar background. Defaults to window.foreground
410.TP
411.B bar.foreground
412Color of the bar foreground. Defaults to window.background
413.TP
414.B mark.foreground
415Color of the mark foreground. Defaults to window.foreground
416.TP
417Please see xrdb(1) on how to change them.
418.SH STATUS BAR
419The information displayed on the left side of the status bar can be replaced
420with the output of a user-provided script, which is called by nsxiv whenever an
421image gets loaded. The path of this script is
422.I $XDG_CONFIG_HOME/nsxiv/exec/image-info
423and the arguments given to it are: 1) path to image file, 2) image width,
4243) image height.
425.P
426There is also an example script installed together with nsxiv as
427.IR PREFIX/share/nsxiv/exec/image-info .
428.SH EXTERNAL KEY HANDLER
429Additional external keyboard commands can be defined using a handler program
430located in
431.IR $XDG_CONFIG_HOME/nsxiv/exec/key-handler .
432The handler is invoked by pressing
433.BR Ctrl-x .
434The next key combo is passed as its first argument. Passed via stdin are the
435images to act upon, one path per line: all marked images, if in thumbnail mode
436and at least one image has been marked, otherwise the current image.
437nsxiv(1) will block until the handler terminates. It then checks which images
438have been modified and reloads them.
439
440The key combo argument has the following form: "[C-][M-][S-]KEY",
441where C/M/S indicate Ctrl/Meta(Alt)/Shift modifier states and KEY is the X
442keysym as listed in /usr/include/X11/keysymdef.h without the "XK_" prefix.
443
444There is also an example script installed together with nsxiv as
445.IR PREFIX/share/nsxiv/exec/key-handler .
446.SH THUMBNAIL CACHING
447nsxiv stores all thumbnails under
448.IR $XDG_CACHE_HOME/nsxiv/ .
449.P
450Use the command line option
451.I \-c
452to remove all orphaned cache files. Additionally, run the following command
453afterwards inside the cache directory to remove empty subdirectories:
454.P
455.RS
456find . \-depth \-type d \-empty ! \-name '.' \-exec rmdir {} \\;
457.RE
458.SH ORIGINAL AUTHOR
459.EX
460Bert Muennich <ber.t at posteo.de>
461.EE
462.SH CURRENT MAINTAINERS
463.EX
464Anupam Ashish Minz
465Berke Kocaoğlu <berke.kocaoglu at metu.edu.tr>
466Guilherme Freire
467Kian Kasad <kian at kasad.com>
468N-R-K <nrk at disroot.org>
469Stein Gunnar Bakkeby <bakkeby at gmail.com>
470TAAPArthur <taaparthur at gmail.com>
471explosion-mental <explosion0mental at gmail.com>
472eylles <ed.ylles1997 at gmail.com>
473qsmodo
474.EE
475.SH CONTRIBUTORS
476.EX
477Bastien Dejean <nihilhill at gmail.com>
478Dave Reisner <d at falconindy.com>
479Fung SzeTat <sthorde at gmail.com>
480Max Voit <mvdev at with-eyes.net>
481
482For additional contributors, run `git shortlog -s` in the nsxiv repository.
483.EE
484.SH HOMEPAGE
485.EX
486https://github.com/nsxiv/nsxiv
487.EE
488.SH SEE ALSO
489.BR X (7),
490.BR xrdb (1)