uri.7: ffix
PATCH v2 1/1 uri.7: ffix
Reported-by groff(1) (`make build-catman-troff`)
Cc "G. Branden Robinson" <[email protected]>
Signed-off-by Alejandro Colomar <[email protected]>
---
This time, it's a bit more properly formatted, with I and B where appropriate.
man7/uri.7 | 83 +++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 63 insertions(+), 20 deletions(-)
man7/uri.7 +63 -20
@@ -29,25 +29,68 @@ .SH NAME uri, url, urn \- uniform resource identifier (URI), including a URL or URN .SH SYNOPSIS -.nf -.HP 0.2i -URI = [ absoluteURI | relativeURI ] [ "#" fragment ] -.HP -absoluteURI = scheme ":" ( hierarchical_part | opaque_part ) -.HP -relativeURI = ( net_path | absolute_path | relative_path ) [ "?" query ] -.HP -scheme = "http" | "ftp" | "gopher" | "mailto" | "news" | "telnet" | - "file" | "man" | "info" | "whatis" | "ldap" | "wais" | \&... -.HP -hierarchical_part = ( net_path | absolute_path ) [ "?" query ] -.HP -net_path = "//" authority [ absolute_path ] -.HP -absolute_path = "/" path_segments -.HP -relative_path = relative_segment [ absolute_path ] -.fi +.SY "\fIURI\fP \fR=\fP" +.RI "[ " absoluteURI " | " relativeURI " ]" +.RI "[ \[dq]\fB#\fP\[dq] " fragment " ]" +.YS +.PP +.SY "\fIabsoluteURI\fP \fR=\fP" +.IR scheme " \[dq]\fB:\fP\[dq]" +.RI "( " hierarchical_part " | " opaque_part " )" +.YS +.PP +.SY "\fIrelativeURI\fP \fR=\fP" +.RI "( " net_path " | " absolute_path " | " relative_path " )" +.RI "[ \[dq]\fB?\fP\[dq] " query " ]" +.YS +.PP +.SY "\fIscheme\fP \fR=\fP" +.RB \[dq] http \[dq] +| +.RB \[dq] ftp \[dq] +| +.RB \[dq] gopher \[dq] +| +.RB \[dq] mailto \[dq] +| +.RB \[dq] news \[dq] +| +.RB \[dq] telnet \[dq] +| +.RB \[dq] file \[dq] +| +.RB \[dq] ftp \[dq] +| +.RB \[dq] man \[dq] +| +.RB \[dq] info \[dq] +| +.RB \[dq] whatis \[dq] +| +.RB \[dq] ldap \[dq] +| +.RB \[dq] wais \[dq] +| \&... +.YS +.PP +.SY "\fIhierarchical_part\fP \fR=\fP" +.RI "( " net_path " | " absolute_path " )" +.RI "[ \[dq]\fB?\fP\[dq] " query " ]" +.YS +.PP +.SY "\fInet_path\fP \fR=\fP" +.RI "\[dq]\fB//\fP\[dq] " authority +.RI "[ " absolute_path " ]" +.YS +.PP +.SY "\fIabsolute_path\fP \fR=\fP" +.RI "\[dq]\fB/\fP\[dq] " path_segments +.YS +.PP +.SY "\fIrelative_path\fP \fR=\fP" +.I relative_segment +.RI "[ " absolute_path " ]" +.YS .SH DESCRIPTION A Uniform Resource Identifier (URI) is a short string of characters identifying an abstract or physical resource (for example, a web page).
@@ -96,7 +139,7 @@ .SS Usage permit the authority to be the following format, called here an .I ip_server (square brackets show what's optional): -.HP +.PP .IR "ip_server = " [ user " [ : " password " ] @ ] " host " [ : " port ] .PP This format allows you to optionally insert a username,
Signature · 1 line
2.40.1
Hi Alex,
Quoted 3 lines · Alejandro Colomar
+.SY "\fIURI\fP \fR=\fP"
+.RI "[ " absoluteURI " | " relativeURI " ]"
+.RI "[ \[dq]\fB#\fP\[dq] " fragment " ]"
It's not _necessary_ to bust into font selection escape sequences in the RI line here and similar ones later, not quoted, whereas it is for the SY argument. You can use the \c output line continuation escape sequence to chain several font selection requests together without intervening space.
.RB "[ \[dq]" # \[dq]\~c
.IR fragment \~]
But if you think the source is more readable the way you have it, keep it.
Regards,
Branden
PATCH 1/1 uri.7: ffix
Reported-by groff(1) (`make build-catman-troff`)
Cowritten-by "G. Branden Robinson" <[email protected]>
Signed-off-by Alejandro Colomar <[email protected]>
---
Hi Branden,
Quoted 11 lines · G. Branden Robinson
It's not _necessary_ to bust into font selection escape sequences in the
RIline here and similar ones later, not quoted, whereas it is for theSYargument. You can use the\coutput line continuation escape sequence to chain several font selection requests together without intervening space..RB "[ \[dq]" # \[dq]\~c
.IR fragment \~]But if you think the source is more readable the way you have it, keep it.
I initially thought it would be less readable, but after seeing it in your email, I reconsidered. With that, and help of \~, I can remove all quotes (except in SY). And now, unbreakable spaces make the formatting even better.
Cheers,
Alex
man7/uri.7 | 99 +++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 79 insertions(+), 20 deletions(-)
man7/uri.7 +79 -20
@@ -29,25 +29,84 @@ .SH NAME uri, url, urn \- uniform resource identifier (URI), including a URL or URN .SH SYNOPSIS -.nf -.HP 0.2i -URI = [ absoluteURI | relativeURI ] [ "#" fragment ] -.HP -absoluteURI = scheme ":" ( hierarchical_part | opaque_part ) -.HP -relativeURI = ( net_path | absolute_path | relative_path ) [ "?" query ] -.HP -scheme = "http" | "ftp" | "gopher" | "mailto" | "news" | "telnet" | - "file" | "man" | "info" | "whatis" | "ldap" | "wais" | \&... -.HP -hierarchical_part = ( net_path | absolute_path ) [ "?" query ] -.HP -net_path = "//" authority [ absolute_path ] -.HP -absolute_path = "/" path_segments -.HP -relative_path = relative_segment [ absolute_path ] -.fi +.SY "\fIURI\fP \fR=\fP" +.RI [\~ absoluteURI +| +.IR relativeURI \~] +.RB [\~\[dq] # \[dq]\~\c +.IR fragment \~] +.YS +.PP +.SY "\fIabsoluteURI\fP \fR=\fP" +.I scheme\~\c +.RB \[dq] : \[dq] +.RI (\~ hierarchical_part +| +.IR opaque_part \~) +.YS +.PP +.SY "\fIrelativeURI\fP \fR=\fP" +.RI (\~ net_path +| +.I absolute_path +| +.IR relative_path \~) +.RB [\~\[dq] ? \[dq]\~\c +.IR query \~] +.YS +.PP +.SY "\fIscheme\fP \fR=\fP" +.RB \[dq] http \[dq] +| +.RB \[dq] ftp \[dq] +| +.RB \[dq] gopher \[dq] +| +.RB \[dq] mailto \[dq] +| +.RB \[dq] news \[dq] +| +.RB \[dq] telnet \[dq] +| +.RB \[dq] file \[dq] +| +.RB \[dq] ftp \[dq] +| +.RB \[dq] man \[dq] +| +.RB \[dq] info \[dq] +| +.RB \[dq] whatis \[dq] +| +.RB \[dq] ldap \[dq] +| +.RB \[dq] wais \[dq] +| \&... +.YS +.PP +.SY "\fIhierarchical_part\fP \fR=\fP" +.RI (\~ net_path +| +.IR absolute_path \~) +.RB [\~\[dq] ? \[dq]\~\c +.IR query \~] +.YS +.PP +.SY "\fInet_path\fP \fR=\fP" +.RB \[dq] // \[dq]\~\c +.I authority +.RI [\~ absolute_path \~] +.YS +.PP +.SY "\fIabsolute_path\fP \fR=\fP" +.RB \[dq] / \[dq]\~\c +.I path_segments +.YS +.PP +.SY "\fIrelative_path\fP \fR=\fP" +.I relative_segment +.RI [\~ absolute_path \~] +.YS .SH DESCRIPTION A Uniform Resource Identifier (URI) is a short string of characters identifying an abstract or physical resource (for example, a web page).
@@ -96,7 +155,7 @@ .SS Usage permit the authority to be the following format, called here an .I ip_server (square brackets show what's optional): -.HP +.PP .IR "ip_server = " [ user " [ : " password " ] @ ] " host " [ : " port ] .PP This format allows you to optionally insert a username,
Signature · 1 line
2.40.1