gwsw / less

Less - text pager
http://greenwoodsoftware.com/less
Other
552 stars 87 forks source link

Issue in less man pages #564

Open hmartink opened 1 month ago

hmartink commented 1 month ago

'''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: --intr → B<--intr>

"When the \"Waiting for data\" message is displayed, such as while in the F " "command, pressing \(haX will stop B from waiting and return to a " "prompt. This may cause B to think that the file ends at the current " "position, so it may be necessary to use the R or F command to see more " "data. The --intr option can be used to specify a different character to use " "instead of \(haX. This command works only on systems that support the " "B(2) function. On systems without B(2), the interrupt " "character (usually \(haC) can be used instead."

Man page: less.1 Issue: Remove closing bracket and full stop

"https://en.wikipedia.org/wiki/ANSI_escape_code#SGR)."

Man page: less.1 Issue: less → B

"Causes less to interpret the specified text as the contents of a " "B(1) source file. In the text, B lines may be separated " "by either newlines as usual, or by semicolons. A literal semicolon may be " "represented by a backslash followed by a semicolon."

Man page: less.1 Issue 1: -U option → B<-U> option Issue 2: -r option → B<-r> option

"Causes \"raw\" control characters to be displayed. The default is to " "display control characters using the caret notation; for example, a control-" "A (octal 001) is displayed as \"\(haA\" (with some exceptions as described " "under the -U option). Warning: when the -r option is used, B cannot " "keep track of the actual appearance of the screen (since this depends on how " "the screen responds to each type of control character). Thus, various " "display problems may result, such as long lines being split in the wrong " "place."

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

"Causes consecutive blank lines to be squeezed into a single blank line. " "This is useful when viewing B output."

Man page: less.1 Issue: --wordwrap → B<--wordwrap>

"Causes lines longer than the screen width to be chopped (truncated) rather " "than wrapped. That is, the portion of a long line that does not fit in the " "screen width is not displayed until you press RIGHT-ARROW. The default is " "to wrap long lines; that is, display the remainder on the next line. See " "also the --wordwrap option."

Man page: less.1 Issue: specifying -t → specifying B<-t>

"The -t option may also be specified from within B (using the - " "command) as a way of examining a new file. The command \":t\" is equivalent " "to specifying -t from within B."

Man page: less.1 Issue: --file-size → B<--file-size>

"If --file-size is specified, B will determine the size of the file " "immediately after opening the file. Then the \"=\" command will display the " "number of lines in the file. Normally this is not done, because it can be " "slow if the input file is non-seekable (such as a pipe) and is large."

Man page: less.1 Issue: ASCII → B(7)

"Use the character I instead of \(haX to interrupt a read when the " "\"Waiting for data\" message is displayed. I must be an ASCII character; " "that is, one with a value between 1 and 127 inclusive. A caret followed by " "a single character can be used to specify a control character."

Man page: less.1 Issue: the -N option → the option B<-N>

"Sets the minimum width of the line number field when the -N option is in " "effect to I characters. The default is 7."

Man page: less.1 Issue: --tabs → B<--tabs>

"A modeline contains, anywhere in the line, a program name (\"vi\", \"vim\", " "\"ex\", or \"less\"), followed by a colon, possibly followed by the word " "\"set\", and finally followed by zero or more option settings. If the word " "\"set\" is used, option settings are separated by spaces, and end at the " "first colon. If the word \"set\" is not used, option settings may be " "separated by either spaces or colons. The word \"set\" is required if the " "program name is \"less\" but optional if any of the other three names are " "used. If any option setting is of the form \"tabstop=I\" or \"ts=I\", " "then tab stops are automatically set as if --tabs=I had been given. See " "the --tabs description for acceptable values of I."

Man page: less.1 Issue 1: markup of --wheel-lines Issue 2: as if by the \(haO\(haN command → as if the \(haO\(haN command had been issued Issue 3: as if by the \(haO\(haO command. → as if the \(haO\(haO command had been issued.

"Enables mouse input: scrolling the mouse wheel down moves forward in the " "file, scrolling the mouse wheel up moves backwards in the file, left-click " "sets the \"#\" mark to the line where the mouse is clicked, and right-click " "(or any other) returns to the \"#\" mark position. If a left-click is " "performed with the mouse cursor on an OSC 8 hyperlink, the hyperlink is " "selected as if by the \(haO\(haN command. If a left-click is performed " "with the mouse cursor on an OSC 8 hyperlink which is already selected, the " "hyperlink is opened as if by the \(haO\(haO command. 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 B."

Man page: less.1 Issue 1: -u → B<-u> Issue 2: -U → B<-U>

"If set, backspaces are handled as if neither the -u option nor the -U option " "were set. That is, a backspace adjacent to an underscore causes text to be " "displayed in underline mode, and a backspace between identical characters " "cause text to be displayed in boldface mode. This option overrides the -u " "and -U options, so that display of backspaces can be controlled separate " "from tabs and carriage returns. If not set, backspace display is controlled " "by the -u and -U options."

"If set, carriage returns are handled as if neither the -u option nor the -U " "option were set. That is, a carriage return immediately before a newline is " "deleted. This option overrides the -u and -U options, so that display of " "carriage returns can be controlled separate from that of backspaces and " "tabs. If not set, carriage return display is controlled by the -u and -U " "options."

Man page: less.1 Issue: -U → B<-U>

"If set, backspaces are handled as if the -U option were set; that is " "backspaces are treated as control characters."

"If set, carriage returns are handled as if the -U option were set; that is " "carriage returns are treated as control characters."

"If set, tabs are handled as if the -U option were set; that is tabs are " "treated as control characters."

Man page: less.1 Issue 1: -U → B<-U> Issue 2: options. → option.

"If set, tabs are handled as if the -U option were not set. That is, tabs " "are expanded to spaces. This option overrides the -U option, so that " "display of tabs can be controlled separate from that of backspaces and " "carriage returns. If not set, tab display is controlled by the -U options."

Man page: less.1 Issue: --search-options=W → B<--search-options>=I

"Sets default search modifiers. The value is a string of one or more of the " "characters E, F, K, N, R or W. Setting any of these has the same effect as " "typing that control character at the beginning of every search pattern. For " "example, setting --search-options=W is the same as typing \(haW at the " "beginning of every pattern. The value may also contain a digit between 1 " "and 5, which has the same effect as typing \(haS followed by that digit at " "the beginning of every search pattern. The value \"-\" disables all default " "search modifiers."

Man page: less.1 Issue: B → B(3)

"If that string is not found, but your system supports the B " "interface, B will use setlocale to determine the character set. " "setlocale is controlled by setting the LANG or LC_CTYPE environment " "variables."

Man page: less.1 Issue 1: -e → B<-e> Issue 2: -E → B<-E>

"The -e option works differently. If the -e option is not set, B " "behaves as if the -e option were set. If the -e option is set, B " "behaves as if the -E option were set."

Man page: less.1 Issue: -p → B<-p>

"The parameter to the -p option is taken to be a B command rather than " "a search pattern."

Man page: less.1 Issue: -t → B<-t>

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

-- Man page: less.1 Issue: sets → which sets

"Where \"xxx\" is a URI scheme such as \"http\" or \"file\", sets an OSC 8 " "handler for opening OSC 8 links containing a URI with that scheme."

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

"Options which are passed to B automatically when running in B-" "compatible mode."

Man page: less.1 Issue: B → I

msgid "Possible location of the B file; see the KEY BINDINGS section."

Man page: lessecho.1 Issue: B → B(1)

"B 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. B is invoked " "internally by B, and is not intended to be used directly by humans."

Man page: lessecho.1 Issue: -e- → B<-e->

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

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

"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: B → B(1)

"The following input file describes the set of default command keys used by " "B. Documentation on each command can be found in the B man " "page, under the key sequence which invokes the command."

Man page: lesskey.1 Issue 1: -i → B<-i> Issue 2: -S → B<-S> Issue 3: B → B(1) Issue 4: --color → B<--color>

"The following input file sets the -i and -S options when B is run and, " "on version 595 and higher, adds a --color option."

Man page: lesspipe.1 Issue 1: file → B(1) Issue 2: I → B(1) Issue 3: I → B(1)

"If the file utility reports text with an encoding different from the one " "used in the terminal then the text will be transformed using I into " "the default encoding. This does assume the I command gets the file " "encoding right, which can be wrong in some situations. An appended colon to " "the file name does suppress the conversion."

Man page: lesspipe.1 Issue: less → B(1)

"The filter is normally not called if input is piped to less as in"

Man page: lesspipe.1 Issue 1: less → B(1) Issue 2: B is a variable, how to start it…? Should be »by prepending I<|-> to the B environment variable«

"As described in the man page of less, the filtering in a pipe can however be " "forced by starting B with the characters I<|->." msgstr "" "Wie in der Handbuchseite zu B beschrieben, können Sie die Filterung in " "einer Pipe dennoch aktivieren, wenn Sie der Variable B die Zeichen " "I<|-> voranstellen."

Man page: lesspipe.1 Issue: lesspipe.sh → B

"B starting with the two characters I<||> to handle empty files and " "command errors is implemented only partly, usually on failures of commands " "within B the error messages get displayed."

Man page: lesspipe.1 Issue: pygmentize → B(1)

"Among the colorizers a preferred one can be forced for coloring by setting " "the ENV variable B to the name of the colorizer. For " "I and I/I restricted option settings are allowed as " "follows:"

Man page: lesspipe.1 Issue 1: less → B(1) Issue 2: syslog → I</var/log/syslog> (to match the file name in the example)

"As soon as B calls a program to convert the input the ability " "to watch growing files (using the F command within less) is lost. This is " "usually wanted for log files like syslog. To temporarily disengage " "B a colon as the last argument for B needs to be added as " "e.g in"

Man page: lesspipe.1 Issue: +F → B<+F>

"or B can be called with the +F argument, which is equivalent to F " "within the pager:"

Man page: lesspipe.1 Issue 1: cat → B(1) Issue 2: B → B(1)

"Appending a colon to the file name does not work, as then the filter has to " "be engaged to at least remove that colon and use cat for the original file. " "On the other hand non growing log files can be colorized using B. Its " "recognition as a log file is difficult if not ending in I<.log> but can be " "forced appending B<:.log> to the file name as e.g in"

Man page: lesspipe.1 Issue: in the chain raw format → in the chain in a raw format

"To display the last file in the chain raw format, a colon (I<:>) has to be " "appended to the file name. If it does contain a colon, then the alternate " "separator character equal sign (I<=>) has to be used."

Man page: lesspipe.1 Issue 1: B and B → B(1) and B(1) Issue 2: less_completion → I

"With the provided I (for B and B), I<_less> (for " "B) and I (for B) files a tab completion for " "files in archives can be accomplished. Entering a colon (:) or an equal " "sign (=) after an archive file name and then pressing the tab key triggers " "the completion mechanism. This also works in chained archives. The files " "I and I have to be in one of the directories " "listed in B<$PATH> and the function I<_less> for B in a directory " "listed by I<$fpath>. The less_completion script has to be sourced within a " "bash initialization script, e.g. in I<~/.bashrc>. New directories such as " "I<~/scripts> and I<~/.fpath> can be added using the commands" '''

gwsw commented 4 weeks ago

I have fixed 3 of these issues in 6d60a4a16760c721bed3435752a41952a6ea4221.

Most of the others are requests to format command line options in bold. This is a common convention but is not universal. For example, the man pages for the widely used programs git, find, vim, curl and magick don't format options as bold. I will consider changing less to format options as bold but currently I don't consider it to be an error.

Also, as I've mentioned twice before (in #74 and #253), lesspipe is not part of the less distribution, so there's nothing I can do about issues in the lesspipe man page. You'll have to send those issues to whoever provided your lesspipe program.