fanglingsu / vimb

Vimb - the vim like browser is a webkit based web browser that behaves like the vimperator plugin for the firefox and usage paradigms from the great editor vim. The goal of vimb is to build a completely keyboard-driven, efficient and pleasurable browsing-experience.
https://fanglingsu.github.io/vimb/
GNU General Public License v3.0
1.33k stars 99 forks source link

Issues in manpage #764

Closed mati75 closed 1 week ago

mati75 commented 1 month ago

Debian lintian software reports some issues in manpage:

N: 
N:   This manual page uses the \' groff sequence. Usually, the intent is to
N:   generate an apostrophe, but that sequence actually renders as an acute
N:   accent.
N:   
N:   For an apostrophe or a single closing quote, use plain '. For single
N:   opening quote, i.e. a straight downward line ' like the one used in shell
N:   commands, use '\(aq'.
N:   
N:   In case this tag was emitted for the second half of a '\\' sequence, this
N:   is indeed no acute accent, but still wrong: A literal backslash should be
N:   written \e in the groff format, i.e. a '\\' sequence needs to be changed
N:   to '\e' which also won't trigger this tag.
N: 
N:   Please refer to Bug#554897, Bug#507673, and Bug#966803 for details.
N: 
N:   Visibility: info
N:   Show-Always: no
N:   Check: documentation/manual
N:   Renamed from: acute-accent-in-manpage
N: 
N:
I: vimb: acute-accent-in-manual-page [usr/share/man/man1/vimb.1.gz:807]
I: vimb: typo-in-manual-page everytime every time [usr/share/man/man1/vimb.
1.gz:970]
N: 
N:   Lintian found a spelling error in a manual page. Lintian has a list of
N:   common misspellings that it looks for. It does not have a dictionary like
N:   a spelling checker does.
N:   
N:   If the string containing the spelling error is translated with the help 
of
N:   gettext (with the help of po4a, for example) or a similar tool, please fix
N:   the error in the translations as well as the English text to avoid making
N:   the translations fuzzy. With gettext, for example, this means you should
N:   also fix the spelling mistake in the corresponding msgids in the *.po
N:   files.
N: 
N:   Visibility: info
N:   Show-Always: no
N:   Check: documentation/manual
N:   Renamed from: spelling-error-in-manpage

Patch for that:

+++ b/doc/vimb.1
@@ -546,7 +546,7 @@ of key presses by another.
 .P
 Note that the \fIlhs\fP ends with the first found space.
 If you want to use space also in the {lhs} you have to escape this
-with a single `\\', as shown in the examples.
+with a single '\e', as shown in the examples.
 .sp
 The \fIrhs\fP starts with the first non-space char. If you want a \fIrhs\fP
 that starts with a space, you have to use "<Space>".
@@ -804,7 +804,7 @@ This includes also '/' in contrast to sh
 Matches any single character except of '/'.
 .IP "\fB{one,two}\fP"
 Matches 'one' or 'two'.
-Any '{', ',' and '}' within this pattern must be escaped by a '\\'.
+Any '{', ',' and '}' within this pattern must be escaped by a '\e'.
 \&'*' and '?' have no special meaning within the curly braces.
 .IP "\fB\e\fP"
 Use backslash to escape the special meaning of '?*{},' in the pattern or
@@ -967,7 +967,7 @@ A '\e' before these patterns disables th
 The following environment variables are set for called shell commands.
 .TP
 .B VIMB_URI
-This variable is set by Vimb everytime a new page is opened to the URI of the
+This variable is set by Vimb every time a new page is opened to the URI of the
 page.
 .TP
 .B VIMB_SELECTION
fanglingsu commented 3 weeks ago

@mati75 could you please provide a merge request for that?

mati75 commented 1 week ago

@fanglingsu yes, done https://github.com/fanglingsu/vimb/pull/765