coreutils/man/help2man, branch master

doc: help2man: handle leading '+' in options

2026-01-22T12:45:13Z

* man/help2man: Fix indentation of options with leading '+'.

doc: help2man: account for undisplayed markup in indenting calculations

2026-01-21T13:51:39Z

* man/help2man: This is significant with the indented line following the dd bs=BYTES "option" at least.

doc: help2man: convert all hyperlinks, not just ones in --options

2026-01-21T13:51:39Z

* man/help2man: Make the (--?) part of the match optional. Note we still extract the dashes, to support the existing option matching logic in help2man.

doc: help2man: support alternate format OSC hyperlinks

2026-01-21T13:51:39Z

* man/help2man: The BEL terminator format was already supported. Add support for ESC + backslash terminator. Also split out and document the regular expression.

doc: help2man: convert OSC hyperlinks

2026-01-21T13:51:39Z

* man/help2man: Convert OSC hyperlinks to roff \X escapes, which will be converted back to OSC hyperlinks when the man page is displayed on the terminal. Note formatting is removed from hyperlinked text by default, thus relying on how the terminal highlights hyperlinks, but --bold-refs is honored in this case, in which hyperlinked text will be marked up as bold, which matches the default markup used for non hyperlinked options.

doc: help2man: recognise option description with smaller indent

2026-01-21T13:51:39Z

* man/help2man: Allow for a smaller indented option description. This smaller indentation is present in timeout --help output, so now the line spacing in timeout.1 is more consistent. Also having the description on a separate line with a smaller indentation, is a more general way to present option descriptions (and what the man page formatting uses already). We'll be changing many utilities, especially with longer multi-line descriptions to this new format.

doc: help2man: strip ANSI codes

2026-01-21T13:51:39Z

* man/help2man: With these ANSI codes, output is corrupted, so it's best to strip these, which allows --help to outputting formatting and hyperlinks by default.

maint: spelling fixes

2026-01-16T21:22:28Z

doc: man: consistently format -X[OPTIONAL] form

2025-10-02T09:14:16Z

This is significant for the date, od, and pr commands which have options of the form -X[OPTIONAL], which change like: diff -r man.orig/date.1 man/date.1 < \fB\-I[FMT]\fR, \fB\-\-iso\-8601\fR[=\fI\,FMT\/\fR] > \fB\-I\fR[\fI\,FMT\/\fR], \fB\-\-iso\-8601\fR[=\fI\,FMT\/\fR] diff -r man.orig/od.1 man/od.1 < \fB\-w[BYTES]\fR, \fB\-\-width\fR[=\fI\,BYTES\/\fR] > \fB\-w\fR[\fI\,BYTES\/\fR], \fB\-\-width\fR[=\fI\,BYTES\/\fR] * man/help2man (convert_options): Support options of the form -X[PARAM], so that we now consistently format them (in italics).

doc: man: consistently italicize --option parameters

2025-10-02T09:13:53Z

This changes a few pages, but the changes in tail.1 concisely illustrate the resulting man page changes: $ diff -r man.orig/tail.1 man/tail.1 < \fB\-c\fR, \fB\-\-bytes\fR=\fI\,[\/\fR+]NUM > \fB\-c\fR, \fB\-\-bytes\fR=\fI\,[+]NUM\/\fR < \fB\-f\fR, \fB\-\-follow[=\fR{name|descriptor}] > \fB\-f\fR, \fB\-\-follow\fR[=\fI\,{name|descriptor}\/\fR] < \fB\-n\fR, \fB\-\-lines\fR=\fI\,[\/\fR+]NUM > \fB\-n\fR, \fB\-\-lines\fR=\fI\,[+]NUM\/\fR * man/help2man: Relax the option match so more --option variations are supported, and passed through to convert_option(). Specifically more variations after '=' are now supported. Also split and document the regular expression. Reported at https://github.com/coreutils/coreutils/issues/84