bugGNU nano - Bugs: bug #59064, some small issues in man pages

 
 

You are not allowed to post comments on this tracker with your current authentication level.

bug #59064: some small issues in man pages

Submitter:  Helge Kreutzmann <kreutzm>
Submitted:  Fri 04 Sep 2020 04:17:46 PM UTC
 
Severity:  2 - Minor Status:  Fixed
Assigned to:  bens Open/Closed:  Closed

Thu 08 Oct 2020 08:55:36 AM UTC, comment #3: 

Released in version 5.3.

Benno Schulenberg <bens>
Project Administrator
Sat 05 Sep 2020 05:49:24 PM UTC, comment #2: 

The "(1)" has been added in git, in six places, in commit 586a7d22.  Also some formatting has been harmonized.  Thanks for reporting.

Benno Schulenberg <bens>
Project Administrator
Sat 05 Sep 2020 05:14:10 PM UTC, comment #1: 

Hello Helge,

The "manpage-l10n project"?  You mean
https://manpages-l10n-team.pages.debian.net/manpages-l10n/index.html ?
(If yes, then: ouch!  That page hurts!  There is zero margin on the left.  :|  It hugs the edge so much that it's painful.)

> Issue: dash → minus sign


Will not fix.  I don't like "minus sign" because it doesn't have anything to do with being negative.  I don't like "hyphen" either because nothing is getting hyphenated.  I like "dash" much better, and what is meant with it is shown immediately between parentheses.

> Issue 1: B<hunspell> → B<hunspell>(1)
> Issue 2: B<spell> → B<spell>(1)


Will fix.

> Issue: »Byte« is confusing for people who are not familiar
> with the basics of keyboard shortcuts or the nature of
> characters in general.


People who are not familiar with shortcuts will not be trying to rebind anything.  And people who don't know what "byte" means will even less know what "meta" or "escape sequence" means.  The phrase is given as an explanation for those who have some knowledge.  Those without that knowledge can just skip it -- or they can search the internet for a clarification of the terms, if they are so inclined, no need for me to hold their hand -- or they can just accept what is said before the comma: "Rebinding Esc is not possible".

> Issue: "B<"')E<gt>]}>" → B<"')E<gt>]}>


Will not change.  All default values for strings are enclosed by double quotes -- I find that clearer.  Or do you mean that the embedded double quote (") ought to be escaped?

Your next two issues are duplicates of the above ones.  And the last two issues no longer exist.

Benno Schulenberg <bens>
Project Administrator
Fri 04 Sep 2020 04:17:46 PM UTC, original submission:  

Dear nano maintainer,
the manpage-l10n project maintains a large number of translations of
man pages both from a large variety of sources (including nano) as
well for a large variety of target languages.

During their work translators notice different possible issues in the
original (english) man pages. Sometimes this is a straightforward
typo, sometimes a hard to read sentence, sometimes this is a
convention not held up and sometimes we simply do not understand the
original.

We use several distributions as sources and update regularly (at
least every 2 month). This means we are fairly recent (some
distributions like archlinux also update frequently) but might miss
the latest upstream version once in a while, so the error might be
already fixed. We apologize and ask you to close the issue immediately
if this should be the case, but given the huge volume of projects and
the very limited number of volunteers we are not able to double check
each and every issue.

Secondly we translators see the manpages in the neutral po format,
i.e. converted and harmonized, but not the original source (be it man,
groff, xml or other). So we cannot provide a true patch (where
possible), but only an approximation which you need to convert into
your source format.

Finally the issues I'm reporting have accumulated over time and are
not always discovered by me, so sometimes my description of the
problem my be a bit limited - do not hesitate to ask so we can clarify
them.

I'm now reporting the errors for your project. If future reports
should use another channel, please let me know.

Man page: nano.1
Issue: dash → minus sign

"As a special case: if instead of a filename a dash (B<->) is given, B<nano> "
"will read data from standard input."
--
Man page: nanorc.5
Issue 1: B<hunspell> → B<hunspell>(1)
Issue 2: B<spell> → B<spell>(1)

"Use the given I<program> to do spell checking and correcting, instead of "
"using the built-in corrector that calls B<hunspell> or GNU B<spell>."

"Invokes a spell-checking program, either the default B<hunspell> or GNU "
"B<spell>, or the one defined by B<--speller> or B<set speller>."
--
Man page: nanorc.5
Issue: »Byte« is confusing for people who are not familiar with the basics of keyboard shortcuts or the nature of characters in general. Either add an explanation or a link to an appropriate man page.

"Rebinding B<^M> (Enter) or B<^I> (Tab) is probably not a good idea.  "
"Rebinding B<^[> (Esc) is not possible, because its keycode is the starter "
"byte of Meta keystrokes and escape sequences.  Rebinding any of the "
"dedicated cursor-moving keys (the arrows, Home, End, PageUp and PageDown) is "
"not possible.  On some terminals it's not possible to rebind B<^H> (unless "
"B<--raw> is used) because its keycode is identical to that of the Backspace "
"key."
--
Man page: nanorc.5
Issue: "B<"')E<gt>]}>" → B<"')E<gt>]}>

"Below, the I<string> parameters need to be enclosed in double quotes.  "
"Quotes inside these string parameters don't have to be escaped with "
"backslashes.  The last double quote in the string will be treated as its "
"end.  For example, for the B<brackets> option, \"B<\"')E<gt>]}>\" will match "
"B<\">, B<'>, B<)>, B<E<gt>>, B<]>, and B<}>."
--
Man page: nanorc.5
Issue: "B<^([\\ \\et]*([#:E<gt>|}]|//))+>" → B<^([\\ \\et]*([#:E<gt>|}]|//))+>

"The email-quote string, used to justify email-quoted paragraphs.  This is an "
"extended regular expression.  The default value is \"B<^([\\ \\et]*([#:"
"E<gt>|}]|//))+>\".  Note that B<\\et> stands for an actual Tab character."
--
Man page: nanorc.5
Issue: B<spell> → B<spell>(1)

"Use the given I<program> to do spell checking and correcting, instead of the "
"built-in corrector that calls B<spell>."
--
Man page: nanorc.5
Issue: nanorc → I<nanorc>

"If you use such a formatting command regularly, you could assign the "
"relevant series of keystrokes to a single key in your nanorc:"
--
Man page: nanorc.5
Issue: ^H → B<^H>

"Cuts from the cursor position to the beginning of the preceding word.  (This "
"function is not bound by default.  If your terminal produces B<^H> for "
"E<lt>Ctrl+BackspaceE<gt>, you can make E<lt>Ctrl+BackspaceE<gt> delete the "
"word to the left of the cursor by rebinding ^H to this function.)"

Helge Kreutzmann <kreutzm>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by bens (Posted a comment)
  • -email is unavailable- added by kreutzm (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

     

     

     

    Follow 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2020-10-08 bens Open/ClosedOpen Closed
    2020-09-05 bens StatusNone Fixed
    2020-09-05 bens Severity3 - Normal 2 - Minor
        Assigned toNone bens
        SummaryIssues in man pages some small issues in man pages

    Back to the top


    Powered by Savane 3.9