nfs-utils: Fix man page syntax errors
Subsystems (2)
PATCH 1/1 nfs-utils: Fix man page syntax errors
From: Ben Hutchings <[email protected]>
In idmapd.conf.5, there is a line of what should be literal text beginning with ".", which makes it an (invalid) command. It can be escaped, but then there will be a space before it. Instead, Move it to the previous line and use the .BR macro so there's no space.
In idmapd.man, the .I (italic) macro is used. However, this manual page uses the mdoc macro package that does not include it. Use the .Em (emphasis) macro instead.
In nfsmount.conf.man, the first line should be a comment but it is actually an invalid command. Fix it to be a comment.
--- support/nfsidmap/idmapd.conf.5 | 4 ++-- utils/idmapd/idmapd.man | 4 ++-- utils/mount/nfsmount.conf.man | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-)
support/nfsidmap/idmapd.conf.5 +2 -2
@@ -198,8 +198,8 @@ With this group names of a central directory can be shortened for an isolated or .TP .B Group-Name-No-Prefix-Regex Case-insensitive regular expression to exclude groups from adding and removing the prefix set by -.B Group-Name-Prefix -. The regular expression must match both the remote and local group names. Multiple expressions may be concatenated with '|'. +.BR Group-Name-Prefix . +The regular expression must match both the remote and local group names. Multiple expressions may be concatenated with '|'. (Default: none) .\" .\" -------------------------------------------------------------------
utils/idmapd/idmapd.man +2 -2
@@ -24,13 +24,13 @@ the NFSv4 kernel client and server, to which it communicates via upcalls, by translating user and group IDs to names, and vice versa. .Pp The system derives the -.I user +.Em user part of the string by performing a password or group lookup. The lookup mechanism is configured in .Pa /etc/idmapd.conf .Pp By default, the -.I domain +.Em domain part of the string is the system's DNS domain name. It can also be specified in .Pa /etc/idmapd.conf
utils/mount/nfsmount.conf.man +1 -1
@@ -1,4 +1,4 @@ -."@(#)nfsmount.conf.5" +.\" @(#)nfsmount.conf.5" .TH NFSMOUNT.CONF 5 "16 December 2020" .SH NAME nfsmount.conf - Configuration file for NFS mounts
Signature · 1 line
2.34.1
Quoted 11 lines · Salvatore Bonaccorso
From: Ben Hutchings <[email protected]>
In idmapd.conf.5, there is a line of what should be literal text beginning with ".", which makes it an (invalid) command. It can be escaped, but then there will be a space before it. Instead, Move it to the previous line and use the .BR macro so there's no space.
In idmapd.man, the .I (italic) macro is used. However, this manual page uses the mdoc macro package that does not include it. Use the .Em (emphasis) macro instead.
Quoted 5 lines
In nfsmount.conf.man, the first line should be a comment but it is actually an invalid command. Fix it to be a comment.
Signed-off-by Ben Hutchings <[email protected]>Signed-off-by Salvatore Bonaccorso <[email protected]>
Committed... (tag: nfs-utils-2-6-2-rc1)
steved.
Quoted 51 lines
--- support/nfsidmap/idmapd.conf.5 | 4 ++-- utils/idmapd/idmapd.man | 4 ++-- utils/mount/nfsmount.conf.man | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-)support/nfsidmap/idmapd.conf.5 +2
-2@@ -198,8 +198,8 @@ With this group names of a central directory can be shortened for an isolated or .TP .B Group-Name-No-Prefix-Regex Case-insensitive regular expression to exclude groups from adding and removing the prefix set by -.B Group-Name-Prefix -. The regular expression must match both the remote and local group names. Multiple expressions may be concatenated with '|'. +.BR Group-Name-Prefix . +The regular expression must match both the remote and local group names. Multiple expressions may be concatenated with '|'. (Default: none) .\" .\" -------------------------------------------------------------------utils/idmapd/idmapd.man +2
-2@@ -24,13 +24,13 @@ the NFSv4 kernel client and server, to which it communicates via upcalls, by translating user and group IDs to names, and vice versa. .Pp The system derives the -.I user +.Em user part of the string by performing a password or group lookup. The lookup mechanism is configured in .Pa /etc/idmapd.conf .Pp By default, the -.I domain +.Em domain part of the string is the system's DNS domain name. It can also be specified in .Pa /etc/idmapd.confutils/mount/nfsmount.conf.man +1
-1@@ -1,4 +1,4 @@ -."@(#)nfsmount.conf.5" +.\" @(#)nfsmount.conf.5" .TH NFSMOUNT.CONF 5 "16 December 2020" .SH NAME nfsmount.conf - Configuration file for NFS mounts