This attached patch relies on <https://github.com/rra/podlators/pull/21> to be featureful, but is pretty much a no-op without that PR merged so is not blocking.
Additionally, I haven't included the generated file changes in the patch since some extraneous changes were showing up as well. The docs use a few different ways to style man refs, this consolidates those & makes `pod2man`'s man-ref detection heuristic explicit. Combined with the podlator PR, fixes the wierd half-bolds on man references `urxvt-extensions(1)` & `urxvtperl(3)`. This does also modify the styling of the generated html files, by default it looks like `pod2xhtml` converts man links to `<cite>`s, which are italicized by default. If this is undesired, there are a few potential fixes, in order of potential impact: - modify `pod.css` to bold (or something else) `<cite>` elements - patch/upstream `pod2xhtml` to do something fancier with man references - migrate to `pod2html`* Currently, pod2html auto-links man page references links to <http://man.he.net/>, which is kind of slick but also 404s on `urxvt` refs. Anyways, a further rightup/exploratory log can be found here: https://sirabella.org/blog/rabbitholes -- Marco Sirabella
diff --git a/doc/extensions.pod.bot b/doc/extensions.pod.bot index baf6e855..fc5915a4 100644 --- a/doc/extensions.pod.bot +++ b/doc/extensions.pod.bot @@ -1,5 +1,5 @@ =head1 SEE ALSO -urxvt(1), urxvtperl(3) +L<urxvt(1)>, L<urxvtperl(3)> diff --git a/doc/rclock.1.pod b/doc/rclock.1.pod index 6d8355ed..3ad3cb95 100644 --- a/doc/rclock.1.pod +++ b/doc/rclock.1.pod @@ -9,7 +9,7 @@ urclock (oUR CLOCK) -- clock and appointment reminder for X11 =head1 DESCRIPTION B<urclock> -- version B<@@RXVT_VERSION@@> -- is an analog clock -for X intended as an I<xclock>(1) replacement that conserves memory and has +for X intended as an L<xclock(1)> replacement that conserves memory and has extra features: B<urclock> enters reverse video if there is mail waiting; an appointment reminder is also builtin. diff --git a/doc/rxvt.1.pod b/doc/rxvt.1.pod index 3f5fb218..fe78e0a7 100644 --- a/doc/rxvt.1.pod +++ b/doc/rxvt.1.pod @@ -9,7 +9,7 @@ B<@@RXVT_NAME@@> [options] [-e command [ args ]] =head1 DESCRIPTION B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal -emulator intended as an I<xterm>(1) replacement for users who do not +emulator intended as an L<xterm(1)> replacement for users who do not require features such as Tektronix 4014 emulation and toolkit-style configurability. As a result, B<rxvt-unicode> uses much less swap space -- a significant advantage on a machine serving many X sessions. @@ -19,7 +19,7 @@ L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>. =head1 FREQUENTLY ASKED QUESTIONS -See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of +See L<@@RXVT_NAME@@(7)> (try C<man 7 @@RXVT_NAME@@>) for a list of frequently asked questions and answer to them and some common problems. That document is also accessible on the World-Wide-Web at L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>. @@ -60,11 +60,11 @@ and nice on resources: for example, you can still configure rxvt-unicode without most of its features to get a lean binary. It also comes with a client/daemon pair that lets you open any number of terminal windows from within a single process, which makes startup time very fast and -drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and -@@RXVT_NAME@@c(1) (client). +drastically reduces memory usage. See L<@@RXVT_NAME@@d(1)> (daemon) and +L<@@RXVT_NAME@@c(1)> (client). It also makes technical information about escape sequences (which have -been extended) more accessible: see @@RXVT_NAME@@(7) for technical +been extended) more accessible: see L<@@RXVT_NAME@@(7)> for technical reference documentation (escape sequences etc.). =head1 OPTIONS @@ -193,7 +193,7 @@ e.g.: @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" See also the question "How does rxvt-unicode choose fonts?" in the FAQ -section of @@RXVT_NAME@@(7). +section of L<@@RXVT_NAME@@(7)>. =item B<-fb> I<fontlist> @@ -348,7 +348,7 @@ work around odd font metrics; resource B<letterSpace>. This option specifies the name of the terminal type to be set in the B<TERM> environment variable. This terminal type must exist in the -I<termcap(5)> database and should have I<li#> and I<co#> entries; +L<termcap(5)> database and should have I<li#> and I<co#> entries; resource B<termName>. =item B<-e> I<command [arguments]> @@ -359,7 +359,7 @@ the program being executed if neither I<-title> (I<-T>) nor I<-n> are given on the command line. If this option is used, it must be the last on the command-line. If there is no B<-e> option then the default is to run the program specified by the B<SHELL> environment variable or, -failing that, I<sh(1)>. +failing that, L<sh(1)>. Please note that you must specify a program with arguments. If you want to run shell commands, you have to specify the shell, like this: @@ -590,7 +590,7 @@ B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@> configurations. If no resources are specified, suitable defaults will be used. Command-line arguments can be used to override resource settings. The following resources are supported (you might want to -check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl +check the L<@@RXVT_NAME@@perl(3)> manpage for additional settings by perl extensions not documented here): =over @@ -632,7 +632,7 @@ colours. The canonical names are as follows: 0=black, 1=red, 2=green, names used are listed in the B<COLOURS AND GRAPHICS> section. Colours higher than 15 cannot be set using resources (yet), but can be -changed using an escape command (see @@RXVT_NAME@@(7)). +changed using an escape command (see L<@@RXVT_NAME@@(7)>). Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 88 colour support). Colours 80-87 are evenly spaces grey steps. @@ -861,7 +861,7 @@ option B<-ut>. B<False>: write record into the system log file B<utmp> =item B<print-pipe:> I<string> -Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use +Specify a command pipe for vt100 printer [default L<lpr(1)>]. Use B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or B<Shift-Print> to include the scrollback as well. @@ -1028,7 +1028,7 @@ The characters used as delimiters for double-click word selection (whitespace delimiting is added automatically if resource is given). When the perl selection extension is in use (the default if compiled -in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these +in, see the L<@@RXVT_NAME@@perl(3)> manpage), a suitable regex using these characters will be created (if the resource exists, otherwise, no regex will be created). In this mode, characters outside ISO-8859-1 can be used. @@ -1077,7 +1077,7 @@ Enable "insecure" mode. Rxvt-unicode offers some escape sequences that echo arbitrary strings like the icon name or the locale. This could be abused if somebody gets 8-bit-clean access to your display, whether through a mail client displaying mail bodies unfiltered or through -write(1) or any other means. Therefore, these sequences are disabled by +L<write(1)> or any other means. Therefore, these sequences are disabled by default. (Note that many other terminals, including xterm, have these sequences enabled by default, which doesn't make it safer, though). @@ -1176,7 +1176,7 @@ themselves. See the C<builtin:> action, below, for a way to work around this when this is a problem. The spelling of I<key> depends on your implementation of X. An easy way to -find a key name is to use the B<xev>(1) command. You can find a list by +find a key name is to use the L<xev(1)> command. You can find a list by looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym value (B<0x0000 - 0xFFFF>). @@ -1241,7 +1241,7 @@ font-switching at runtime: URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 -Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more +Other things are possible, e.g. resizing (see L<@@RXVT_NAME@@(7)> for more info): URxvt.keysym.M-C-3: command:\033[8;25;80t @@ -1295,12 +1295,12 @@ this: =item EXTENSION:STRING An action of this form invokes the action B<STRING>, if any, provided -by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will +by the L<@@RXVT_NAME@@perl(3)> extension B<EXTENSION>. The extension will be loaded automatically if necessary. Not all extensions define actions, but popular extensions that do include the I<selection> and I<matcher> extensions (documented in their -own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), +own manpages, L<@@RXVT_NAME@@-selection(1)> and L<@@RXVT_NAME@@-matcher(1)>, respectively). From the silly examples department, this will rot13-"encrypt" @@ -1358,7 +1358,7 @@ all instances, while B<perl-ext> is used for specific instances. =item B<perl-eval>: I<string> Perl code to be evaluated when all extensions have been registered. See -the @@RXVT_NAME@@perl(3) manpage. +the L<@@RXVT_NAME@@perl(3)> manpage. =item B<perl-lib>: I<path> @@ -1367,16 +1367,16 @@ scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>. -See the @@RXVT_NAME@@perl(3) manpage. +See the L<@@RXVT_NAME@@perl(3)> manpage. =item B<< selection.pattern-I<idx> >>: I<perl-regex> -Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for +Additional selection patterns, see the L<@@RXVT_NAME@@perl(3)> manpage for details. =item B<< selection-autotransform.I<idx> >>: I<perl-transform> -Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage +Selection auto-transform patterns, see the L<@@RXVT_NAME@@perl(3)> manpage for details. =item B<searchable-scrollback:> I<keysym> *DEPRECATED* @@ -1438,7 +1438,7 @@ respectively. =head1 THE SELECTION: SELECTING AND PASTING TEXT The behaviour of text selection and insertion/pasting mechanism is similar -to I<xterm>(1). +to L<xterm(1)>. =over @@ -1556,8 +1556,8 @@ both scenario A and B of ISO 14755, including part 5.2. =head1 LOGIN STAMP -B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that -it can be seen via the I<who(1)> command, and can accept messages. To +B<@@RXVT_NAME@@> tries to write an entry into the L<utmp(5)> file so that +it can be seen via the L<who(1)> command, and can accept messages. To allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root on some systems or setgid to root or to some other group on others. @@ -1629,12 +1629,12 @@ number and RGB values of all colours (yes, you can query this...). Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by always swapping the foreground/background colours. This is in contrast to -I<xterm>(1) where the colours are only swapped if they have not otherwise +L<xterm(1)> where the colours are only swapped if they have not otherwise been specified. For example, @@RXVT_NAME@@ -fg Black -bg White -rv -would yield White on Black, while on I<xterm>(1) it would yield Black on +would yield White on Black, while on L<xterm(1)> it would yield Black on White. =head2 ALPHA CHANNEL SUPPORT @@ -1734,8 +1734,8 @@ The shell to be used for command execution, defaults to C</bin/sh>. =item B<RXVT_SOCKET> [I<sic>] -The unix domain socket path used by @@RXVT_NAME@@c(1) and -@@RXVT_NAME@@d(1). +The unix domain socket path used by L<@@RXVT_NAME@@c(1)> and +L<@@RXVT_NAME@@d(1)>. Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. @@ -1747,7 +1747,7 @@ directory. =item B<URXVT_PERL_VERBOSITY> -See L<@@RXVT_NAME@@perl>(3). +See L<@@RXVT_NAME@@perl(3)>. =item B<HOME> @@ -1778,8 +1778,9 @@ Colour names. =head1 SEE ALSO -@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), -@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) +L<@@RXVT_NAME@@(7)>, L<@@RXVT_NAME@@c(1)>, L<@@RXVT_NAME@@d(1)>, +L<@@RXVT_NAME@@-extensions(1)>, L<@@RXVT_NAME@@perl(3)>, +L<xterm(1)>, L<sh(1)>, L<resize(1)>, L<X(1)>, L<pty(4)>, L<tty(4)>, L<utmp(5)> =head1 CURRENT PROJECT COORDINATOR diff --git a/doc/rxvt.7.pod b/doc/rxvt.7.pod index face1a91..fd8c665c 100644 --- a/doc/rxvt.7.pod +++ b/doc/rxvt.7.pod @@ -107,7 +107,7 @@ re-run the command. Subsequent invocations of the script will re-use the existing daemon. Another option is to use systemd socket-based activation (see -systemd.socket(5)). Here is an example of a service unit file and of a +L<systemd.socket(5)>). Here is an example of a service unit file and of a socket unit file for the default socket path: =over @@ -558,7 +558,7 @@ rxvt-unicode from initialising perl, saving memory. If you only want to disable specific features, you first have to identify which perl extension is responsible. For this, read the section -B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For +B<PREPACKAGED EXTENSIONS> in the L<@@URXVT_NAME@@perl(3)> manpage. For example, to disable the B<selection-popup> and B<option-popup>, specify this B<perl-ext-common> resource: @@ -2555,7 +2555,7 @@ It also enables some non-essential features otherwise disabled, such as: =item --enable-iso14755 (default: on) -Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)). +Enable extended ISO 14755 support (see L<@@RXVT_NAME@@(1)>). Basic support (section 5.1) is enabled by C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with this switch. @@ -2595,7 +2595,7 @@ Add support to have the pointer disappear when typing or inactive. =item --enable-perl (default: on) -Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> +Enable an embedded perl interpreter. See the L<@@RXVT_NAME@@perl(3)> manpage for more info on this feature, or the files in F<src/perl/> for the extensions that are installed by default. The perl interpreter that is used can be specified via the C<PERL> diff --git a/doc/rxvtc.1.pod b/doc/rxvtc.1.pod index 30054505..d9e646ac 100644 --- a/doc/rxvtc.1.pod +++ b/doc/rxvtc.1.pod @@ -62,5 +62,5 @@ specify the absolute path of the socket to create. =head1 SEE ALSO -@@RXVT_NAME@@(7), @@RXVT_NAME@@d(1) +L<@@RXVT_NAME@@(7)>, L<@@RXVT_NAME@@d(1)> diff --git a/doc/rxvtd.1.pod b/doc/rxvtd.1.pod index 70016448..edc4cf2c 100644 --- a/doc/rxvtd.1.pod +++ b/doc/rxvtd.1.pod @@ -56,7 +56,7 @@ socket. =item B<-m>, B<--mlock> -This makes B<@@RXVT_NAME@@d> call mlockall(2) on itself. This locks +This makes B<@@RXVT_NAME@@d> call L<mlockall(2)> on itself. This locks B<@@RXVT_NAME@@d> in RAM and prevents it from being swapped out to disk, at the cost of consuming a lot more memory on most operating systems. @@ -121,4 +121,4 @@ valid X display name. =head1 SEE ALSO -@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1) +L<@@RXVT_NAME@@(7)>, L<@@RXVT_NAME@@c(1)> diff --git a/src/urxvt.pm b/src/urxvt.pm index 3c20173e..6735f786 100644 --- a/src/urxvt.pm +++ b/src/urxvt.pm @@ -374,7 +374,7 @@ Called just after the screen gets redrawn. See C<on_refresh_begin>. Called whenever an action is invoked for the corresponding extension (e.g. via a C<extension:string> builtin action bound to a key, see -description of the B<keysym> resource in the urxvt(1) manpage). The +description of the B<keysym> resource in the L<urxvt(1)> manpage). The event is simply the action string. Note that an action event is always associated to a single extension. @@ -382,7 +382,7 @@ associated to a single extension. Called whenever a user-configured event is being activated (e.g. via a C<perl:string> action bound to a key, see description of the B<keysym> -resource in the urxvt(1) manpage). +resource in the L<urxvt(1)> manpage). The event is simply the action string. This interface is going away in preference to the C<on_action> hook. @@ -1497,7 +1497,7 @@ if a binding for it exists, and C<undef> otherwise. =item $success = $term->bind_action ($key, $action) Adds a key binding exactly as specified via a C<keysym> resource. See the -C<keysym> resource in the urxvt(1) manpage. +C<keysym> resource in the L<urxvt(1)> manpage. To add default bindings for actions, an extension should call C<< ->bind_action >> in its C<init> hook for every such binding. Doing it
_______________________________________________ rxvt-unicode mailing list rxvt-unicode@lists.schmorp.de http://lists.schmorp.de/mailman/listinfo/rxvt-unicode
