Commit 2e2942d

nsxiv2e2942d

Cleanup manpage (#186)

* Move `-T` option in manpage

The `-T` option breaks the alphabetical order of options in both the
SYNOPSIS and OPTION sections

* Reword "on bottom of" in manpage

* Pluralize "count pixel"

* Fix typos

* Reword `M` keyboard binding description

* rename info bar -> statusbar for consistency

* document all the thumbnail bindings

* Add website to HOMEPAGE section

* Add missing maintainers

* Sort maintainers by activity

Author: mamg22
Date: 2021-12-23 19:25 -0400
Committer: GitHub · 2021-12-24 05:25 +0600
Parent: ff88908
Commit: 2e2942d926087b1131ab6b453486d93cef97458e

+65 −41

1 file changed

Browse files Patch

−Context 3+

M nsxiv.1 +65 −41

M nsxiv.1 View

		@@ -14,14 +14,14 @@ nsxiv \- Neo Simple X Image Viewer
14	14		.IR GEOMETRY ]
15	15		.RB [ \-N
16	16		.IR NAME ]
17		−	.RB [ \-T
18		−	.IR TITLE ]
19	17		.RB [ \-n
20	18		.IR NUM ]
21	19		.RB [ \-S
22	20		.IR DELAY ]
23	21		.RB [ \-s
24	22		.IR MODE ]
	23	+	.RB [ \-T
	24	+	.IR TITLE ]
25	25		.RB [ \-z
26	26		.IR ZOOM ]
27	27		.IR FILE ...
		@@ -44,7 +44,7 @@ Play animations with a constant frame rate set to
44	44		Play animations of multi-frame images.
45	45		.TP
46	46		.B \-b
47		−	Do not show info bar on bottom of window.
	47	+	Do not show statusbar at the bottom of the window.
48	48		.TP
49	49		.B \-c
50	50		Remove all orphaned cache files from the thumbnail cache directory and exit.
		@@ -66,19 +66,6 @@ more information on GEOMETRY argument.
66	66		.BI "\-N " NAME
67	67		Set the resource name of nsxiv's X window to NAME.
68	68		.TP
69		−	.BI "\-T " TITLE
70		−	Set the window title to TITLE. Use the format `prefix:suffixmode'. Any string
71		−	literal 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		−
80		−	By defualt, prefix is set to "nsxiv - " and suffixmode is set to 1 (basename).
81		−	.TP
82	69		.BI "\-n " NUM
83	70		Start at picture number NUM.
84	71		.TP
		@@ -114,6 +101,19 @@ may be a floating point number.
114	101		Set scale mode according to MODE character. Supported modes are: [d]own,
115	102		[f]it, [F]ill, [w]idth, [h]eight.
116	103		.TP
	104	+	.BI "\-T " TITLE
	105	+	Set the window title to TITLE. Use the format `prefix:suffixmode'. Any string
	106	+	literal is accepted for prefix, and the format of suffixmode is:
	107	+
	108	+	.EX
	109	+	Value Format
	110	+	0 Empty
	111	+	1 Basename of file
	112	+	2 Full path to file
	113	+	.EE
	114	+
	115	+	By default, prefix is set to "nsxiv - " and suffixmode is set to 1 (basename).
	116	+	.TP
117	117		.B \-t
118	118		Start in thumbnail mode.
119	119		.TP
		@@ -128,7 +128,7 @@ Set zoom level to ZOOM percent.
128	128		.TP
129	129		.B \-0
130	130		Use NULL-separator. With this option output of \-o and file-list sent to the
131		−	key-handler and the input of \-i will be seperated by a NULL character.
	131	+	key-handler and the input of \-i will be separated by a NULL character.
132	132		.SH KEYBOARD COMMANDS
133	133		.SS General
134	134		The following keyboard commands are available in both image and thumbnail mode:
		@@ -147,7 +147,7 @@ Switch to thumbnail mode / open selected image in image mode.
147	147		Toggle fullscreen mode.
148	148		.TP
149	149		.B b
150		−	Toggle visibility of info bar on bottom of window.
	150	+	Toggle visibility of statusbar at the bottom of the window.
151	151		.TP
152	152		.B Ctrl-x
153	153		Send the next key to the external key-handler. See section EXTERNAL KEY HANDLER
		@@ -188,7 +188,7 @@ Zoom out.
188	188		Mark/unmark the current image.
189	189		.TP
190	190		.B M
191		−	Repeat last mark action on all images from the last marked/unmarked up to the
	191	+	Mark/unmark all images starting from the last marked/unmarked image up to the
192	192		current one.
193	193		.TP
194	194		.B Ctrl-m
		@@ -289,22 +289,22 @@ Panning:
289	289		.BR h ", " Left
290	290		Scroll image 1/5 of window width or
291	291		.I count
292		−	pixel left.
	292	+	pixels left.
293	293		.TP
294	294		.BR j ", " Down
295	295		Scroll image 1/5 of window height or
296	296		.I count
297		−	pixel down.
	297	+	pixels down.
298	298		.TP
299	299		.BR k ", " Up
300	300		Scroll image 1/5 of window height or
301	301		.I count
302		−	pixel up.
	302	+	pixels up.
303	303		.TP
304	304		.BR l ", " Right
305	305		Scroll image 1/5 of window width or
306	306		.I count
307		−	pixel right.
	307	+	pixels right.
308	308		.TP
309	309		.B H
310	310		Scroll to left image edge.
		@@ -371,34 +371,48 @@ Toggle slideshow mode and/or set the delay between images to
371	371		.I count
372	372		seconds.
373	373		.SH MOUSE COMMANDS
374		−	The following mouse mappings are available in image mode:
	374	+	.SS Thumbnail mode
	375	+	The following mouse mappings are available in thumbnail mode:
375	376		.TP
376		−	General:
	377	+	.B Button1
	378	+	Select the image. Goes into image mode if double\-clicked.
377	379		.TP
378	380		.B Button3
379		−	Switch to thumbnail mode.
	381	+	Mark/unmark the image. Dragging while holding Button3 down will mark/unmark
	382	+	multiple images.
380	383		.TP
381		−	Navigate image list:
	384	+	.B Button4
	385	+	Scroll up by one row.
	386	+	.TP
	387	+	.B Button5
	388	+	Scroll down by one row.
	389	+	.TP
	390	+	.B Ctrl-Button4
	391	+	Scroll up by one page.
	392	+	.TP
	393	+	.B Ctrl-Button5
	394	+	Scroll down by one page.
	395	+	.SS Image mode
	396	+	The following mouse mappings are available in image mode:
382	397		.TP
383	398		.B Button1
384	399		Go to the next image if the mouse cursor is in the right part of the window or
385	400		to the previous image if it is in the left part.
386	401		.TP
387		−	Panning:
	402	+	.B Ctrl-Button1
	403	+	Pan the image relative to the mouse cursor.
388	404		.TP
389	405		.B Button2
390	406		Pan the image according to the mouse cursor position in the window while
391	407		keeping this button pressed down.
392	408		.TP
393		−	.B Ctrl-Button1
394		−	Pan the image relative to the mouse cursor.
395		−	.TP
396		−	Zooming:
	409	+	.B Button3
	410	+	Switch to thumbnail mode.
397	411		.TP
398		−	.B ScrollUp
	412	+	.B Button4
399	413		Zoom in.
400	414		.TP
401		−	.B ScrollDown
	415	+	.B Button5
402	416		Zoom out.
403	417		.SH CONFIGURATION
404	418		The following X resources are supported:
		@@ -474,15 +488,18 @@ Bert Muennich <ber.t at posteo.de>
474	488		.EE
475	489		.SH CURRENT MAINTAINERS
476	490		.EX
477		−	Anupam Ashish Minz
478		−	Berke Kocaoğlu <berke.kocaoglu at metu.edu.tr>
479		−	Guilherme Freire
480		−	Kian Kasad <kian at kasad.com>
481	491		N-R-K <nrk at disroot.org>
482		−	Stein Gunnar Bakkeby <bakkeby at gmail.com>
	492	+	Berke Kocaoğlu <berke.kocaoglu at metu.edu.tr>
483	493		TAAPArthur <taaparthur at gmail.com>
484		−	explosion-mental <explosion0mental at gmail.com>
485	494		eylles <ed.ylles1997 at gmail.com>
	495	+	mamg22 <marcomonizg at gmail.com>
	496	+	LuXu
	497	+	explosion-mental <explosion0mental at gmail.com>
	498	+	Guilherme Freire
	499	+	Stein Gunnar Bakkeby <bakkeby at gmail.com>
	500	+	Anupam Ashish Minz
	501	+	Sam Whitehead
	502	+	Kian Kasad <kian at kasad.com>
486	503		qsmodo
487	504		.EE
488	505		.SH CONTRIBUTORS
		@@ -495,9 +512,16 @@ Max Voit <mvdev at with-eyes.net>
495	512		For additional contributors, run `git shortlog -s` in the nsxiv repository.
496	513		.EE
497	514		.SH HOMEPAGE
	515	+	.TP
	516	+	Website:
	517	+	.EE
	518	+	https://nsxiv.github.io/nsxiv/
498	519		.EX
499		−	https://github.com/nsxiv/nsxiv
	520	+	.TP
	521	+	Source code:
500	522		.EE
	523	+	https://github.com/nsxiv/nsxiv
	524	+	.EX
501	525		.SH SEE ALSO
502	526		.BR X (7),
503	527		.BR xrdb (1)

nsxiv/2e2942d

Cleanup manpage (#186)

nsxiv2e2942d