Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issues in less man pages #74

Closed
hmartink opened this issue Jul 5, 2020 · 1 comment
Closed

Issues in less man pages #74

hmartink opened this issue Jul 5, 2020 · 1 comment

Comments

@hmartink
Copy link

hmartink commented Jul 5, 2020

`Dear less maintainer,
the manpage-l10n project maintains a large number of translations of
man pages both from a large variety of sources (including less) 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: less.1
Issue: B<[-b >IB<] → B<[-b >IB<]

"B<[-b >I<space\/>B<] [-h >I<lines\/>B<] [-j >I<line\/>B<] [-k >I<keyfile"
"\/>B<]>"

Man page: less.1
Issue: For → . For

"where the "...\&" is zero or more color specification characters For the "
"purpose of keeping track of screen appearance, ANSI color escape sequences "
"are assumed to not move the cursor. You can make I think that "
"characters other than "m" can end ANSI color escape sequences by setting "
"the environment variable LESSANSIENDCHARS to the list of characters which "
"can end a color escape sequence. And you can make I think that "
"characters other than the standard ones may appear between the ESC and the m "
"by setting the environment variable LESSANSIMIDCHARS to the list of "
"characters which can appear."

Man page: less.1
Issue 1: Markup of --wheel-lines
Issue 2:I → B

"Enables mouse input: scrolling the mouse wheel down moves forward in the "
"file, scrolling the mouse wheel up moves backwards in the file, and clicking "
"the mouse sets the "#" mark to the line where the mouse is clicked. The "
"number of lines to scroll when the wheel is moved can be set by the --wheel-"
"lines option. Mouse input works only on terminals which support X11 mouse "
"reporting, and on the Windows version of I."

Man page: less.1
Issue:I → B

"Save marks in the history file, so marks are retained across different "
"invocations of I."

Man page: less.1
Issue: I (1) → I(1)

"Name of the command used by the -t option to find global tags. Normally "
"should be set to "global" if your system has the I (1) command. "
"If not set, global tags are not used."

Man page: less.1
Issue: I (1) → I(1)

"Name of the command used by the -t option to find global tags. Normally "
"should be set to "global" if your system has the I(1) command. "
"If not set, global tags are not used."

Man page: lessecho.1
Issue: I → B

"I is a program that simply echos its arguments on standard "
"output. But any metacharacter in the output is preceded by an "escape" "
"character, which by default is a backslash."

Man page: lessecho.1
Issue: Markup of options

"Specifies "x", rather than double-quote, to be the open quote character, "
"which is used if the -e- option is specified."

Man page: lessecho.1
Issue: Missing full stop

"Specifies that all arguments are to be quoted. The default is that only "
"arguments containing metacharacters are quoted"

Man page: lesskey.1
Issue: Markup of file names missing

"I is used to specify a set of key bindings to be used by I<less.> "
"The input file is a text file which describes the key bindings. If the "
"input file is "-", standard input is read. If no input file is specified, "
"a standard filename is used as the name of the input file, which depends on "
"the system being used: On Unix systems, $HOME/.lesskey is used; on MS-DOS "
"systems, $HOME/_lesskey is used; and on OS/2 systems $HOME/lesskey.ini is "
"used, or $INIT/lesskey.ini if $HOME is undefined. The output file is a "
"binary file which is used by I<less.> If no output file is specified, and "
"the environment variable LESSKEY is set, the value of LESSKEY is used as the "
"name of the output file. Otherwise, a standard filename is used as the name "
"of the output file, which depends on the system being used: On Unix and OS-9 "
"systems, $HOME/.less is used; on MS-DOS systems, $HOME/_less is used; and on "
"OS/2 systems, $HOME/less.ini is used, or $INIT/less.ini if $HOME is "
"undefined. If the output file already exists, I will overwrite it."

Man page: lesskey.1
Issue: Markup of options missing

"The -V or --version option causes I to print its version number and "
"immediately exit. If -V or --version is present, other options and "
"arguments are ignored."

Man page: lesskey.1
Issue: There's no such list below in the page

"Whitespace is any sequence of one or more spaces and/or tabs. The I "
"is the command key(s) which invoke the action. The I may be a "
"single command key, or a sequence of up to 15 keys. The I is the "
"name of the less action, from the list below. The characters in the "
"I may appear literally, or be prefixed by a caret to indicate a "
"control key. A backslash followed by one to three octal digits may be used "
"to specify a character by its octal value. A backslash followed by certain "
"characters specifies input characters as follows:"

Man page: lesskey.1
Issue: Use proper markup instead of quotes?

"An action may be followed by an "extra" string. When such a command is "
"entered while running I<less,> the action is performed, and then the extra "
"string is parsed, just as if it were typed in to I<less.> This feature can "
"be used in certain cases to extend the functionality of a command. For "
"example, see the "{" and ":t" commands in the example below. The extra "
"string has a special meaning for the "quit" action: when I quits, "
"first character of the extra string is used as its exit status."

"Commands specified by I take precedence over the default commands. "
"A default command key may be disabled by including it in the input file with "
"the action "invalid". Alternatively, a key may be defined to do nothing "
"by using the action "noaction". "noaction" is similar to "invalid", "
"but I will give an error beep for an "invalid" command, but not for "
"a "noaction" command. In addition, ALL default commands may be disabled "
"by adding this control line to the input file:"

Man page: lesskey.1
Issue: Missing markup: less → B

"The following input file describes the set of default command keys used by "
"less:"

Man page: lesskey.1
Issue: The values need an explanation, then a translation would be possible

"\t#command\n"
"\t\er\t\tforw-line \n"
"\t\en\t\tforw-line \n"
"\te\t\tforw-line \n"
"\tj\t\tforw-line \n"
"\t\ekd\t\tforw-line\n"

Man page: lesskey.1
Issue 1: Missing markup of "-i"
Issue 2: I → B

"The following input file sets the -i option whenever I is run, and "
"specifies the character set to be "latin1":"

Man page: lesspipe.1
Issue: First full stop (first line) is missing

"Usually B<lesspipe.sh> is called as an input filter to B With the help "
"of that filter B will display the uncompressed contents of compressed "
"(gzip, bzip2, compress, rar, 7-zip, lzip, xz or lzma) files. For files "
"containing archives and directories, a table of contents will be displayed "
"(e.g tar, ar, rar, jar, rpm and deb formats). Other supported formats "
"include nroff, pdf, ps, dvi, shared library, MS word, OASIS (e.g. "
"Openoffice), NetCDF, html, mp3, jpg, png, iso images, MacOSX bom, plist and "
"archive formats, perl storable data and gpg encrypted files. This does "
"require additional helper programs being installed."

Man page: lesspipe.1
Issue: file command → command B

"In a few rare cases the file command does not recognize the correct format "
"(especially with nroff). In such cases filtering can be suppressed by a "
"trailing colon on the file name."

Man page: lesspipe.1
Issue 1: Missing markup of "iconv"
Issue 2: file command → command B

"If the file command reports text with UTF-8, ISO-8859-1 or UTF-16 encoded "
"characters then the text will be transformed using iconv into the default "
"encoding. This does assume iconv has the right default which can be wrong in "
"some situations."

Man page: lesspipe.1
Issue: Missing markup of "lesspipe.sh"

"If the ENV variable LESS_ADVANCED_PREPROCESSOR is respected by lesspipe.sh "
"then files containing mostly ASCII text get displayed unmodified. To "
"activate filtering for such formats the contents of "
"B<LESS_ADVANCED_PREPROCESSOR> has to be set to an non empty value."

Man page: lesspipe.1
Issue: Missing markup of code2color and pygmentize

"The filter is able to do syntax highlighting for the languages ada, asm, "
"awk, c, c++, groff, html, xml, java, javascript, lisp, m4, make, pascal, "
"patch, perl, povray, python, ruby shellscript and sql by using code2color as "
"the colorizing program. A different colorizer can be called within "
"code2color by setting the ENV variable B to the name of an "
"alternative (currently only pygmentize allowed). Therefore code2color is "
"always needed for syntax highlighting."

Man page: lesspipe.1
Issue: Missing markup of less

"Sometimes, less does not display the contents file you want to view but "
"output that is produced by your login scripts (~/.bashrc or ~/."
"bash_profile). This happens because less uses your current shell to run the "
"lesspipe filter. Bash first looks for the variable $BASH_ENV in the "
"environment expands its value and uses the expanded value as the name of a "
"file to read and execute. If this file produces any output less will display "
"this. A way to solve this problem is to put the following lines on the top "
"of your login script that produces output:"
`

@gwsw
Copy link
Owner

gwsw commented Oct 22, 2020

I believe all issues related to files in this package have been fixed since 46fe29a.
Several of the reports are for a file called lesspipe.1, which is not part of the less distribution, so those reports should be sent to whomever you received that file from.

@gwsw gwsw closed this as completed Oct 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants