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

Fix typo and manpage improvement (#249)

Browse Source 
* Fixes some typo and adds some consistency to the manpage

Typo detected automatically whilst packaging nsxiv for Debian

Co-authored-by: NRK <nrk@disroot.org>
This commit is contained in:
Nick Morrott 2022-03-26 10:02:22 +00:00 committed by GitHub
parent 1ef0c1f152
commit 590d9fe0a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
examples/key-handler
View File

@ -9,7 +9,7 @@
# reloads them. # reloads them.
# By default nsxiv(1) will send one image per-line to stdin, however when using # By default nsxiv(1) will send one image per-line to stdin, however when using
# -0 the image list will be NULL separated and the enviornment variable # -0 the image list will be NULL separated and the environment variable
# "$NSXIV_USING_NULL" will be set to 1. # "$NSXIV_USING_NULL" will be set to 1.
# The key combo argument has the following form: "[C-][M-][S-]KEY", # The key combo argument has the following form: "[C-][M-][S-]KEY",

41
nsxiv.1
View File

@ -30,7 +30,7 @@ It has two modes of operation: image and thumbnail mode. The default is image
mode, in which only the current image is shown. In thumbnail mode a grid of mode, in which only the current image is shown. In thumbnail mode a grid of
small previews is displayed, making it easy to choose an image to open. small previews is displayed, making it easy to choose an image to open.
.P .P
Please note, that the fullscreen mode requires an EWMH/NetWM compliant window Please note, that the fullscreen mode requires an EWMH/NetWM-compliant window
manager. manager.
.SH OPTIONS .SH OPTIONS
.TP .TP
@ -83,7 +83,7 @@ nsxiv can be used as a visual filter/pipe.
Enable private mode, in which nsxiv does not write any cache or temporary files. Enable private mode, in which nsxiv does not write any cache or temporary files.
.TP .TP
.B \-q .B \-q
Be quiet, disable warnings to standard error stream. Be quiet, and disable warnings to standard error stream.
.TP .TP
.B \-r .B \-r
Search the given directories recursively for images to view. Search the given directories recursively for images to view.
@ -93,7 +93,7 @@ Start in slideshow mode. Set the delay between images to
.I DELAY .I DELAY
seconds. seconds.
.I DELAY .I DELAY
may be a floating point number. may be a floating-point number.
.TP .TP
.BI "\-s " MODE .BI "\-s " MODE
Set scale mode according to MODE character. Supported modes are: [d]own, Set scale mode according to MODE character. Supported modes are: [d]own,
@ -112,11 +112,11 @@ The same as `\-z 100'.
Set zoom level to ZOOM percent. 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 separated 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 modes:
.TP .TP
.BR 0 \- 9 .BR 0 \- 9
Prefix the next command with a number (denoted via Prefix the next command with a number (denoted via
@ -366,7 +366,7 @@ The following mouse mappings are available in thumbnail mode:
Select the image. Goes into image mode if double\-clicked. Select the image. Goes into image mode if double\-clicked.
.TP .TP
.B Button3 .B Button3
Mark/unmark the image. Dragging while holding Button3 down will mark/unmark Mark/unmark the image. Dragging while holding down Button3 will mark/unmark
multiple images. multiple images.
.TP .TP
.B Button4 .B Button4
@ -429,12 +429,18 @@ The window title can be replaced with the output of a user-provided script,
which is called by nsxiv whenever there's a redraw. The path of this script is which is called by nsxiv whenever there's a redraw. The path of this script is
.I $XDG_CONFIG_HOME/nsxiv/exec/win-title .I $XDG_CONFIG_HOME/nsxiv/exec/win-title
and the arguments given to it (where "Optional" arguments might be empty) are: and the arguments given to it (where "Optional" arguments might be empty) are:
1) resolved absolute path of the current file, .IP $1 4
2) current file number, resolved absolute path of the current file
3) total file count, .IP $2 4
4) image width (Optional: Disabled on thumbnails mode), current file number
5) image height (Optional: Disabled on thumbnails mode), .IP $3 4
6) current zoom (Optional: Disabled on thumbnails mode). total file count
.IP $4 4
image width (Optional: Disabled on thumbnails mode)
.IP $5 4
image height (Optional: Disabled on thumbnails mode)
.IP $6 4
current zoom (Optional: Disabled on thumbnails mode)
.P .P
The term file is used rather than image as nsxiv does not precheck that the The term file is used rather than image as nsxiv does not precheck that the
input files are valid images. Total file count may be different from the actual input files are valid images. Total file count may be different from the actual
@ -447,8 +453,13 @@ The information displayed on the left side of the status bar can be replaced
with the output of a user-provided script, which is called by nsxiv whenever an with the output of a user-provided script, which is called by nsxiv whenever an
image gets loaded. The path of this script is image gets loaded. The path of this script is
.I $XDG_CONFIG_HOME/nsxiv/exec/image-info .I $XDG_CONFIG_HOME/nsxiv/exec/image-info
and the arguments given to it are: 1) path to image file, 2) image width, and the arguments given to it are:
3) image height. .IP $1 4
path to image file
.IP $2 4
image width
.IP $3 4
image height
.P .P
There is also an example script installed together with nsxiv as There is also an example script installed together with nsxiv as
.IR EGPREFIX/image-info . .IR EGPREFIX/image-info .
@ -465,7 +476,7 @@ the handler terminates. It then checks which images have been modified and
reloads them. reloads them.
By default nsxiv(1) will send one image per-line to stdin, however when using By default nsxiv(1) will send one image per-line to stdin, however when using
\-0 the image list will be NULL separated and the enviornment variable \-0 the image list will be NULL separated and the environment variable
"$NSXIV_USING_NULL" will be set to 1. "$NSXIV_USING_NULL" will be set to 1.
The key combo argument has the following form: "[C-][M-][S-]KEY", The key combo argument has the following form: "[C-][M-][S-]KEY",