docs: put `<>` within backticks in titles

To render better markdown. Make managen warn if present "unticked" and
unescaped.

Closes #18498

diff --git a/docs/cmdline-opts/_ENVIRONMENT.md b/docs/cmdline-opts/_ENVIRONMENT.md
index a37e074d0541af810d14df35f3948d17dc6da316..9562c630a1acd497273c36e554aeb486f98246b5 100644 (file)
--- a/docs/cmdline-opts/_ENVIRONMENT.md
+++ b/docs/cmdline-opts/_ENVIRONMENT.md
@@ -8,21 +8,21 @@ available in lower case.
 Using an environment variable to set the proxy has the same effect as using
 the --proxy option.
 
-## `http_proxy` [protocol://]<host>[:port]
+## `http_proxy [protocol://]<host>[:port]`
 Sets the proxy server to use for HTTP.
 
-## `HTTPS_PROXY` [protocol://]<host>[:port]
+## `HTTPS_PROXY [protocol://]<host>[:port]`
 Sets the proxy server to use for HTTPS.
 
-## `[url-protocol]_PROXY` [protocol://]<host>[:port]
+## `[url-protocol]_PROXY [protocol://]<host>[:port]`
 Sets the proxy server to use for [url-protocol], where the protocol is a
 protocol that curl supports and as specified in a URL. FTP, FTPS, POP3, IMAP,
 SMTP, LDAP, etc.
 
-## `ALL_PROXY` [protocol://]<host>[:port]
+## `ALL_PROXY [protocol://]<host>[:port]`
 Sets the proxy server to use if no protocol-specific proxy is set.
 
-## `NO_PROXY` <comma-separated list of hosts/domains>
+## `NO_PROXY <comma-separated list of hosts/domains>`
 list of hostnames that should not go through any proxy. If set to an asterisk
 '*' only, it matches all hosts. Each name in this list is matched as either a
 domain name which contains the hostname, or the hostname itself.
@@ -48,24 +48,24 @@ number specifies the number of "network bits" out of the address to use in the
 comparison (added in 7.86.0). For example "192.168.0.0/16" would match all
 addresses starting with "192.168".
 
-## `APPDATA` <dir>
+## `APPDATA <dir>`
 On Windows, this variable is used when trying to find the home directory. If
 the primary home variables are all unset.
 
-## `COLUMNS` <terminal width>
+## `COLUMNS <terminal width>`
 If set, the specified number of characters is used as the terminal width when
 the alternative progress-bar is shown. If not set, curl tries to figure it out
 using other ways.
 
-## `CURL_CA_BUNDLE` <file>
+## `CURL_CA_BUNDLE <file>`
 If set, it is used as the --cacert value. This environment variable is ignored
 if Schannel is used as the TLS backend.
 
-## `CURL_HOME` <dir>
+## `CURL_HOME <dir>`
 If set, is the first variable curl checks when trying to find its home
 directory. If not set, it continues to check *XDG_CONFIG_HOME*
 
-## `CURL_SSL_BACKEND` <TLS backend>
+## `CURL_SSL_BACKEND <TLS backend>`
 If curl was built with support for "MultiSSL", meaning that it has built-in
 support for more than one TLS backend, this environment variable can be set to
 the case insensitive name of the particular backend to use when curl is
@@ -75,12 +75,12 @@ with the default.
 SSL backend names (case-insensitive): **gnutls**, **mbedtls**, **openssl**,
 **rustls**, **schannel**, **wolfssl**
 
-## `HOME` <dir>
+## `HOME <directory>`
 If set, this is used to find the home directory when that is needed. Like when
 looking for the default .curlrc. *CURL_HOME* and *XDG_CONFIG_HOME*
 have preference.
 
-## `QLOGDIR` <directory name>
+## `QLOGDIR <directory>`
 If curl was built with HTTP/3 support, setting this environment variable to a
 local directory makes curl produce **qlogs** in that directory, using file
 names named after the destination connection id (in hex). Do note that these
@@ -89,26 +89,26 @@ files can become rather large. Works with the ngtcp2 and quiche QUIC backends.
 ## `SHELL`
 Used on VMS when trying to detect if using a **DCL** or a **Unix** shell.
 
-## `SSL_CERT_DIR` <dir>
+## `SSL_CERT_DIR <directory>`
 If set, it is used as the --capath value. This environment variable is ignored
 if Schannel is used as the TLS backend.
 
-## `SSL_CERT_FILE` <path>
+## `SSL_CERT_FILE <path>`
 If set, it is used as the --cacert value. This environment variable is ignored
 if Schannel is used as the TLS backend.
 
-## `SSLKEYLOGFILE` <filename>
+## `SSLKEYLOGFILE <path>`
 If you set this environment variable to a filename, curl stores TLS secrets
 from its connections in that file when invoked to enable you to analyze the
 TLS traffic in real time using network analyzing tools such as Wireshark. This
 works with the following TLS backends: OpenSSL, LibreSSL (TLS 1.2 max),
 BoringSSL, GnuTLS, wolfSSL and Rustls.
 
-## `USERPROFILE` <dir>
+## `USERPROFILE <directory>`
 On Windows, this variable is used when trying to find the home directory. If
 the other, primary, variables are all unset. If set, curl uses the path
 **"$USERPROFILE\Application Data"**.
 
-## `XDG_CONFIG_HOME` <dir>
+## `XDG_CONFIG_HOME <directory>`
 If *CURL_HOME* is not set, this variable is checked when looking for a
 default .curlrc file.

diff --git a/docs/cmdline-opts/interface.md b/docs/cmdline-opts/interface.md
index 539e39272b0368419eaba0e41014037529a26bd2..1609cc35d3d3bbdce9836ac4834a318858265d74 100644 (file)
--- a/docs/cmdline-opts/interface.md
+++ b/docs/cmdline-opts/interface.md
@@ -21,16 +21,16 @@ Perform the operation using a specified interface. You can enter interface
 name, IP address or hostname. If you prefer to be specific, you can use the
 following special syntax:
 
-## if!<name>
+## `if!<name>`
 
 Interface name. If the provided name does not match an existing interface,
 curl returns with error 45.
 
-## host!<name>
+## `host!<name>`
 
 IP address or hostname.
 
-## ifhost!<interface>!<host>
+## `ifhost!<interface>!<host>`
 
 Interface name and IP address or hostname. This syntax requires libcurl 8.9.0
 or later.

diff --git a/scripts/managen b/scripts/managen
index d565246b87e0806fa769631ace93b29765bafb53..459b651240a6d17d7a67e5442160eec59a0d58f4 100755 (executable)
--- a/scripts/managen
+++ b/scripts/managen
@@ -373,12 +373,19 @@ sub render {
         }
         elsif(/^## (.*)/) {
             my $word = $1;
+            my $nontick = $word;
             # if there are enclosing quotes, remove them first
             $word =~ s/[\"\'](.*)[\"\']\z/$1/;
 
             # remove backticks from headers
             $word =~ s/\`//g;
 
+            # remove backticked sections
+            $nontick =~ s/\`[^\`]*\`//g;
+            if($nontick =~ /[^\\][\<\>]/) {
+                print STDERR "$f:$line:1:WARN: un-escaped < or > used: $nontick\n";
+            }
+
             # if there is a space, it needs quotes for manpage
             if(($word =~ / /) && $manpage) {
                 $word = "\"$word\"";