sam
/
nsxiv
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Co-authored-by: NRK <nrk@disroot.org>
This commit is contained in:
mamg22 2021-12-23 19:25:49 -04:00 committed by GitHub
parent ff88908531
commit 2e2942d926
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 66 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
nsxiv.1
View File

@ -14,14 +14,14 @@ nsxiv \- Neo Simple X Image Viewer
.IR GEOMETRY ] .IR GEOMETRY ]
.RB [ \-N .RB [ \-N
.IR NAME ] .IR NAME ]
.RB [ \-T
.IR TITLE ]
.RB [ \-n .RB [ \-n
.IR NUM ] .IR NUM ]
.RB [ \-S .RB [ \-S
.IR DELAY ] .IR DELAY ]
.RB [ \-s .RB [ \-s
.IR MODE ] .IR MODE ]
.RB [ \-T
.IR TITLE ]
.RB [ \-z .RB [ \-z
.IR ZOOM ] .IR ZOOM ]
.IR FILE ... .IR FILE ...
@ -44,7 +44,7 @@ Play animations with a constant frame rate set to
Play animations of multi-frame images. Play animations of multi-frame images.
.TP .TP
.B \-b .B \-b
Do not show info bar on bottom of window. Do not show statusbar at the bottom of the window.
.TP .TP
.B \-c .B \-c
Remove all orphaned cache files from the thumbnail cache directory and exit. Remove all orphaned cache files from the thumbnail cache directory and exit.
@ -66,19 +66,6 @@ more information on GEOMETRY argument.
.BI "\-N " NAME .BI "\-N " NAME
Set the resource name of nsxiv's X window to NAME. Set the resource name of nsxiv's X window to NAME.
.TP .TP
.BI "\-T " TITLE
Set the window title to TITLE. Use the format `prefix:suffixmode'. Any string
literal is accepted for prefix, and the format of suffixmode is:
.EX
Value Format
0 Empty
1 Basename of file
2 Full path to file
.EE
By defualt, prefix is set to "nsxiv - " and suffixmode is set to 1 (basename).
.TP
.BI "\-n " NUM .BI "\-n " NUM
Start at picture number NUM. Start at picture number NUM.
.TP .TP
@ -114,6 +101,19 @@ may be a floating point number.
Set scale mode according to MODE character. Supported modes are: [d]own, Set scale mode according to MODE character. Supported modes are: [d]own,
[f]it, [F]ill, [w]idth, [h]eight. [f]it, [F]ill, [w]idth, [h]eight.
.TP .TP
.BI "\-T " TITLE
Set the window title to TITLE. Use the format `prefix:suffixmode'. Any string
literal is accepted for prefix, and the format of suffixmode is:
.EX
Value Format
0 Empty
1 Basename of file
2 Full path to file
.EE
By default, prefix is set to "nsxiv - " and suffixmode is set to 1 (basename).
.TP
.B \-t .B \-t
Start in thumbnail mode. Start in thumbnail mode.
.TP .TP
@ -128,7 +128,7 @@ Set zoom level to ZOOM percent.
.TP .TP
.B \-0 .B \-0
Use NULL-separator. With this option output of \-o and file-list sent to the Use NULL-separator. With this option output of \-o and file-list sent to the
key-handler and the input of \-i will be seperated by a NULL character. key-handler and the input of \-i will be separated by a NULL character.
.SH KEYBOARD COMMANDS .SH KEYBOARD COMMANDS
.SS General .SS General
The following keyboard commands are available in both image and thumbnail mode: 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.
Toggle fullscreen mode. Toggle fullscreen mode.
.TP .TP
.B b .B b
Toggle visibility of info bar on bottom of window. Toggle visibility of statusbar at the bottom of the window.
.TP .TP
.B Ctrl-x .B Ctrl-x
Send the next key to the external key-handler. See section EXTERNAL KEY HANDLER Send the next key to the external key-handler. See section EXTERNAL KEY HANDLER
@ -188,7 +188,7 @@ Zoom out.
Mark/unmark the current image. Mark/unmark the current image.
.TP .TP
.B M .B M
Repeat last mark action on all images from the last marked/unmarked up to the Mark/unmark all images starting from the last marked/unmarked image up to the
current one. current one.
.TP .TP
.B Ctrl-m .B Ctrl-m
@ -289,22 +289,22 @@ Panning:
.BR h ", " Left .BR h ", " Left
Scroll image 1/5 of window width or Scroll image 1/5 of window width or
.I count .I count
pixel left. pixels left.
.TP .TP
.BR j ", " Down .BR j ", " Down
Scroll image 1/5 of window height or Scroll image 1/5 of window height or
.I count .I count
pixel down. pixels down.
.TP .TP
.BR k ", " Up .BR k ", " Up
Scroll image 1/5 of window height or Scroll image 1/5 of window height or
.I count .I count
pixel up. pixels up.
.TP .TP
.BR l ", " Right .BR l ", " Right
Scroll image 1/5 of window width or Scroll image 1/5 of window width or
.I count .I count
pixel right. pixels right.
.TP .TP
.B H .B H
Scroll to left image edge. Scroll to left image edge.
@ -371,34 +371,48 @@ Toggle slideshow mode and/or set the delay between images to
.I count .I count
seconds. seconds.
.SH MOUSE COMMANDS .SH MOUSE COMMANDS
The following mouse mappings are available in image mode: .SS Thumbnail mode
The following mouse mappings are available in thumbnail mode:
.TP .TP
General: .B Button1
Select the image. Goes into image mode if double\-clicked.
.TP .TP
.B Button3 .B Button3
Switch to thumbnail mode. Mark/unmark the image. Dragging while holding Button3 down will mark/unmark
multiple images.
.TP .TP
Navigate image list: .B Button4
Scroll up by one row.
.TP
.B Button5
Scroll down by one row.
.TP
.B Ctrl-Button4
Scroll up by one page.
.TP
.B Ctrl-Button5
Scroll down by one page.
.SS Image mode
The following mouse mappings are available in image mode:
.TP .TP
.B Button1 .B Button1
Go to the next image if the mouse cursor is in the right part of the window or Go to the next image if the mouse cursor is in the right part of the window or
to the previous image if it is in the left part. to the previous image if it is in the left part.
.TP .TP
Panning: .B Ctrl-Button1
Pan the image relative to the mouse cursor.
.TP .TP
.B Button2 .B Button2
Pan the image according to the mouse cursor position in the window while Pan the image according to the mouse cursor position in the window while
keeping this button pressed down. keeping this button pressed down.
.TP .TP
.B Ctrl-Button1 .B Button3
Pan the image relative to the mouse cursor. Switch to thumbnail mode.
.TP .TP
Zooming: .B Button4
.TP
.B ScrollUp
Zoom in. Zoom in.
.TP .TP
.B ScrollDown .B Button5
Zoom out. Zoom out.
.SH CONFIGURATION .SH CONFIGURATION
The following X resources are supported: The following X resources are supported:
@ -474,15 +488,18 @@ Bert Muennich <ber.t at posteo.de>
.EE .EE
.SH CURRENT MAINTAINERS .SH CURRENT MAINTAINERS
.EX .EX
Anupam Ashish Minz
Berke Kocaoğlu <berke.kocaoglu at metu.edu.tr>
Guilherme Freire
Kian Kasad <kian at kasad.com>
N-R-K <nrk at disroot.org> N-R-K <nrk at disroot.org>
Stein Gunnar Bakkeby <bakkeby at gmail.com> Berke Kocaoğlu <berke.kocaoglu at metu.edu.tr>
TAAPArthur <taaparthur at gmail.com> TAAPArthur <taaparthur at gmail.com>
explosion-mental <explosion0mental at gmail.com>
eylles <ed.ylles1997 at gmail.com> eylles <ed.ylles1997 at gmail.com>
mamg22 <marcomonizg at gmail.com>
LuXu
explosion-mental <explosion0mental at gmail.com>
Guilherme Freire
Stein Gunnar Bakkeby <bakkeby at gmail.com>
Anupam Ashish Minz
Sam Whitehead
Kian Kasad <kian at kasad.com>
qsmodo qsmodo
.EE .EE
.SH CONTRIBUTORS .SH CONTRIBUTORS
@ -495,9 +512,16 @@ Max Voit <mvdev at with-eyes.net>
For additional contributors, run `git shortlog -s` in the nsxiv repository. For additional contributors, run `git shortlog -s` in the nsxiv repository.
.EE .EE
.SH HOMEPAGE .SH HOMEPAGE
.EX .TP
https://github.com/nsxiv/nsxiv Website:
.EE .EE
https://nsxiv.github.io/nsxiv/
.EX
.TP
Source code:
.EE
https://github.com/nsxiv/nsxiv
.EX
.SH SEE ALSO .SH SEE ALSO
.BR X (7), .BR X (7),
.BR xrdb (1) .BR xrdb (1)