mirror/coreutils
1
0
Fork 0
mirror of https://https.git.savannah.gnu.org/git/coreutils.git synced 2026-01-27 01:44:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: help2man: convert OSC hyperlinks

Browse Source 
* 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.
This commit is contained in:
Pádraig Brady 2025-12-29 20:58:30 +00:00
parent d06a666429
commit e2fdbea10a
1 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
man/help2man
View File

@ -724,6 +724,19 @@ my @post = (_('ENVIRONMENT'), _('FILES'), _('AUTHOR'),
_('REPORTING BUGS'), _('COPYRIGHT'), _('SEE ALSO'));
my %filter = map { $_ => 1 } @pre, @post;
# Global storage for OSC 8 hyperlink URLs
our @hyperlink_urls;
# Helper to convert hyperlink markers to roff \X escapes
sub convert_hyperlink {
my ($dashes, $idx, $text) = @_;
my $url = $hyperlink_urls[$idx];
my $full = $dashes . $text;
$full =~ s/\\f[BIRP]//g;
$full = "\\fB$full\\fP" if $opt_bold_refs;
return "\\X'tty: link $url'$full\\X'tty: link'";
}
# Output content.
my %done;
for my $sect (@pre, (grep !$filter{$_}, @sections), @post)
@ -751,6 +764,10 @@ for my $sect (@pre, (grep !$filter{$_}, @sections), @post)
s/\x82/\\e/g;
s/\x83/\\-/g;
# Convert hyperlink markers to roff \X escape sequences
s{((?:\\f.)?\\-(?:\\-)?(?:\\f.)?)\x01(\d+)\x02(.*?)\x03}
{convert_hyperlink($1, $2, $3)}gse;
# Convert some latin1 chars to troff equivalents.
s/\xa0/\\ /g; # non-breaking space
@ -796,9 +813,13 @@ sub get_option_value
# Strip ANSI SGR formatting codes (colors, bold, etc.)
$value =~ s/\x1b\[[0-9;]*m//g;
# Strip OSC 8 hyperlinks (keep just the display text)
# TODO: Convert to roff \X escapes while preserving help2man's formatting
$value =~ s/\x1b\]8;;[^\x07]*\x07(.*?)\x1b\]8;;\x07/$1/gs;
# Convert OSC 8 hyperlinks to markers placed after leading dashes
# This preserves help2man's option detection (which looks for /^ +[-+]/)
$value =~ s/\x1b\]8;;([^\x07]*)\x07(--?)(.*?)\x1b\]8;;\x07/{
my $idx = scalar @hyperlink_urls;
push @hyperlink_urls, $1;
"$2\x01$idx\x02$3\x03";
}/gse;
$value;
}