Krolyxon
Commit 68ddbe2

Branches

Refs →

nsxivnsxiv.1

503 lines · 10.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 [ \-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.TP
129.B \-0
130Use NULL-separator. With this option output of \-o and file-list sent to the
131key-handler and the input of \-i will be seperated by a NULL character.
132.SH KEYBOARD COMMANDS
133.SS General
134The following keyboard commands are available in both image and thumbnail mode:
135.TP
136.BR 0 \- 9
137Prefix the next command with a number (denoted via
138.IR count ).
139.TP
140.B q
141Quit nsxiv.
142.TP
143.B Return
144Switch to thumbnail mode / open selected image in image mode.
145.TP
146.B f
147Toggle fullscreen mode.
148.TP
149.B b
150Toggle visibility of info bar on bottom of window.
151.TP
152.B Ctrl-x
153Send the next key to the external key-handler. See section EXTERNAL KEY HANDLER
154for more information.
155.TP
156.B g
157Go to the first image.
158.TP
159.B G
160Go to the last image, or image number
161.IR count .
162.TP
163.B r
164Reload image.
165.TP
166.B D
167Remove current image from file list and go to next image.
168.TP
169.BR Ctrl-h ", " Ctrl-Left
170Scroll left one screen width.
171.TP
172.BR Ctrl-j ", " Ctrl-Down
173Scroll down one screen height.
174.TP
175.BR Ctrl-k ", " Ctrl-Up
176Scroll up one screen height.
177.TP
178.BR Ctrl-l ", " Ctrl-Right
179Scroll right one screen width.
180.TP
181.BR +
182Zoom in.
183.TP
184.B \-
185Zoom out.
186.TP
187.B m
188Mark/unmark the current image.
189.TP
190.B M
191Repeat last mark action on all images from the last marked/unmarked up to the
192current one.
193.TP
194.B Ctrl-m
195Reverse all image marks.
196.TP
197.B Ctrl-u
198Remove all image marks.
199.TP
200.B N
201Go
202.I count
203marked images forward.
204.TP
205.B P
206Go
207.I count
208marked images backward.
209.TP
210.B {
211Decrease gamma correction by
212.I count
213steps.
214.TP
215.B }
216Increase gamma correction by
217.I count
218steps.
219.TP
220.B Ctrl-g
221Reset gamma correction.
222.SS Thumbnail mode
223The following keyboard commands are only available in thumbnail mode:
224.TP
225.BR h ", " Left
226Move selection left
227.I count
228times.
229.TP
230.BR j ", " Down
231Move selection down
232.I count
233times.
234.TP
235.BR k ", " Up
236Move selection up
237.I count
238times.
239.TP
240.BR l ", " Right
241Move selection right
242.I count
243times.
244.TP
245.B R
246Reload all thumbnails.
247.SS Image mode
248The following keyboard commands are only available in image mode:
249.TP
250Navigate image list:
251.TP
252.BR n ", " Space
253Go
254.I count
255images forward.
256.TP
257.BR p ", " Backspace
258Go
259.I count
260images backward.
261.TP
262.B [
263Go
264.I count
265* 10 images backward.
266.TP
267.B ]
268Go
269.I count
270* 10 images forward.
271.TP
272Handle multi-frame images:
273.TP
274.B Ctrl-n
275Go
276.I count
277frames of a multi-frame image forward.
278.TP
279.B Ctrl-p
280Go
281.I count
282frames of a multi-frame image backward.
283.TP
284.BR Ctrl-a ", " Ctrl-Space
285Play/stop animations of multi-frame images.
286.TP
287Panning:
288.TP
289.BR h ", " Left
290Scroll image 1/5 of window width or
291.I count
292pixel left.
293.TP
294.BR j ", " Down
295Scroll image 1/5 of window height or
296.I count
297pixel down.
298.TP
299.BR k ", " Up
300Scroll image 1/5 of window height or
301.I count
302pixel up.
303.TP
304.BR l ", " Right
305Scroll image 1/5 of window width or
306.I count
307pixel right.
308.TP
309.B H
310Scroll to left image edge.
311.TP
312.B J
313Scroll to bottom image edge.
314.TP
315.B K
316Scroll to top image edge.
317.TP
318.B L
319Scroll to right image edge.
320.TP
321Zooming:
322.TP
323.B =
324Set zoom level to 100%, or
325.IR count %.
326.TP
327.B w
328Set zoom level to 100%, but fit large images into window.
329.TP
330.B W
331Fit image to window.
332.TP
333.B F
334Fill image to window.
335.TP
336.B e
337Fit image to window width.
338.TP
339.B E
340Fit image to window height.
341.TP
342Rotation:
343.TP
344.B <
345Rotate image counter-clockwise by 90 degrees.
346.TP
347.B >
348Rotate image clockwise by 90 degrees.
349.TP
350.B ?
351Rotate image by 180 degrees.
352.TP
353Flipping:
354.TP
355.B |
356Flip image horizontally.
357.TP
358.B _
359Flip image vertically.
360.TP
361Miscellaneous:
362.TP
363.B a
364Toggle anti-aliasing.
365.TP
366.B A
367Toggle visibility of alpha-channel, i.e. image transparency.
368.TP
369.B s
370Toggle slideshow mode and/or set the delay between images to
371.I count
372seconds.
373.SH MOUSE COMMANDS
374The following mouse mappings are available in image mode:
375.TP
376General:
377.TP
378.B Button3
379Switch to thumbnail mode.
380.TP
381Navigate image list:
382.TP
383.B Button1
384Go to the next image if the mouse cursor is in the right part of the window or
385to the previous image if it is in the left part.
386.TP
387Panning:
388.TP
389.B Button2
390Pan the image according to the mouse cursor position in the window while
391keeping this button pressed down.
392.TP
393.B Ctrl-Button1
394Pan the image relative to the mouse cursor.
395.TP
396Zooming:
397.TP
398.B ScrollUp
399Zoom in.
400.TP
401.B ScrollDown
402Zoom out.
403.SH CONFIGURATION
404The following X resources are supported:
405.TP
406.B window.background
407Color of the window background
408.TP
409.B window.foreground
410Color of the window foreground
411.TP
412.B bar.font
413Name of Xft bar font
414.TP
415.B bar.background
416Color of the bar background. Defaults to window.background
417.TP
418.B bar.foreground
419Color of the bar foreground. Defaults to window.foreground
420.TP
421.B mark.foreground
422Color of the mark foreground. Defaults to window.foreground
423.TP
424Please see xrdb(1) on how to change them.
425.SH STATUS BAR
426The information displayed on the left side of the status bar can be replaced
427with the output of a user-provided script, which is called by nsxiv whenever an
428image gets loaded. The path of this script is
429.I $XDG_CONFIG_HOME/nsxiv/exec/image-info
430and the arguments given to it are: 1) path to image file, 2) image width,
4313) image height.
432.P
433There is also an example script installed together with nsxiv as
434.IR EGPREFIX/image-info .
435.SH EXTERNAL KEY HANDLER
436Additional external keyboard commands can be defined using a handler program
437located in
438.IR $XDG_CONFIG_HOME/nsxiv/exec/key-handler .
439The handler is invoked by pressing
440.BR Ctrl-x .
441The next key combo is passed as its first argument. Passed via stdin are the
442images to act upon: all marked images, if in thumbnail mode and at least one
443image has been marked, otherwise the current image. nsxiv(1) will block until
444the handler terminates. It then checks which images have been modified and
445reloads them.
446
447By default nsxiv(1) will send one image per-line to stdin, however when using
448\-0 the image list will be NULL separated and the enviornment variable
449"$NSXIV_USING_NULL" will be set to 1.
450
451The key combo argument has the following form: "[C-][M-][S-]KEY",
452where C/M/S indicate Ctrl/Meta(Alt)/Shift modifier states and KEY is the X
453keysym as listed in /usr/include/X11/keysymdef.h without the "XK_" prefix.
454If KEY has an uppercase equivalent, S-KEY is resolved into it. For instance,
455K replaces S-k and Scedilla replaces S-scedilla, but S-Delete is sent as-is.
456
457There is also an example script installed together with nsxiv as
458.IR EGPREFIX/key-handler .
459.SH THUMBNAIL CACHING
460nsxiv stores all thumbnails under
461.IR $XDG_CACHE_HOME/nsxiv/ .
462.P
463Use the command line option
464.I \-c
465to remove all orphaned cache files. Additionally, run the following command
466afterwards inside the cache directory to remove empty subdirectories:
467.P
468.RS
469find . \-depth \-type d \-empty ! \-name '.' \-exec rmdir {} \\;
470.RE
471.SH ORIGINAL AUTHOR
472.EX
473Bert Muennich <ber.t at posteo.de>
474.EE
475.SH CURRENT MAINTAINERS
476.EX
477Anupam Ashish Minz
478Berke Kocaoğlu <berke.kocaoglu at metu.edu.tr>
479Guilherme Freire
480Kian Kasad <kian at kasad.com>
481N-R-K <nrk at disroot.org>
482Stein Gunnar Bakkeby <bakkeby at gmail.com>
483TAAPArthur <taaparthur at gmail.com>
484explosion-mental <explosion0mental at gmail.com>
485eylles <ed.ylles1997 at gmail.com>
486qsmodo
487.EE
488.SH CONTRIBUTORS
489.EX
490Bastien Dejean <nihilhill at gmail.com>
491Dave Reisner <d at falconindy.com>
492Fung SzeTat <sthorde at gmail.com>
493Max Voit <mvdev at with-eyes.net>
494
495For additional contributors, run `git shortlog -s` in the nsxiv repository.
496.EE
497.SH HOMEPAGE
498.EX
499https://github.com/nsxiv/nsxiv
500.EE
501.SH SEE ALSO
502.BR X (7),
503.BR xrdb (1)