1 From: Ben Hutchings <ben@decadent.org.uk>
2 Subject: [PATCH] exports.man: Fix comment syntax
4 Using three single-quotes for a comment sort of works because it
5 results in invoking a nonexistent macro, but it results in a huge
6 number of warnings when trying to validate the man page.
8 Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
10 --- a/utils/exportfs/exports.man
11 +++ b/utils/exportfs/exports.man
12 @@ -72,25 +72,25 @@ For example, either `/255.255.252.0' or `/22' appended
13 to the network base IPv4 address results in identical subnetworks with 10 bits of
14 host. Wildcard characters generally do not work on IP addresses, though they
15 may work by accident when reverse DNS lookups fail.
18 -'''This is a special ``hostname'' that identifies the given directory name
19 -'''as the public root directory (see the section on WebNFS in
21 -'''for a discussion of WebNFS and the public root handle). When using this
24 -'''must be the only entry on this line, and must have no export options
25 -'''associated with it. Note that this does
27 -'''actually export the named directory; you still have to set the exports
28 -'''options in a separate entry.
30 -'''The public root path can also be specified by invoking
33 -'''.B \-\-public\-root
34 -'''option. Multiple specifications of a public root will be ignored.
37 +.\"This is a special ``hostname'' that identifies the given directory name
38 +.\"as the public root directory (see the section on WebNFS in
40 +.\"for a discussion of WebNFS and the public root handle). When using this
43 +.\"must be the only entry on this line, and must have no export options
44 +.\"associated with it. Note that this does
46 +.\"actually export the named directory; you still have to set the exports
47 +.\"options in a separate entry.
49 +.\"The public root path can also be specified by invoking
52 +.\".B \-\-public\-root
53 +.\"option. Multiple specifications of a public root will be ignored.
55 .SS RPCSEC_GSS security
56 You may use the special strings "gss/krb5", "gss/krb5i", or "gss/krb5p"
57 @@ -295,24 +295,24 @@ with ACL support (i.e. by default,
63 -'''This makes everything below the directory inaccessible for the named
64 -'''client. This is useful when you want to export a directory hierarchy to
65 -'''a client, but exclude certain subdirectories. The client's view of a
66 -'''directory flagged with noaccess is very limited; it is allowed to read
67 -'''its attributes, and lookup `.' and `..'. These are also the only entries
68 -'''returned by a readdir.
71 -'''Convert absolute symbolic links (where the link contents start with a
72 -'''slash) into relative links by prepending the necessary number of ../'s
73 -'''to get from the directory containing the link to the root on the
74 -'''server. This has subtle, perhaps questionable, semantics when the file
75 -'''hierarchy is not mounted at its root.
78 -'''Leave all symbolic link as they are. This is the default operation.
81 +.\"This makes everything below the directory inaccessible for the named
82 +.\"client. This is useful when you want to export a directory hierarchy to
83 +.\"a client, but exclude certain subdirectories. The client's view of a
84 +.\"directory flagged with noaccess is very limited; it is allowed to read
85 +.\"its attributes, and lookup `.' and `..'. These are also the only entries
86 +.\"returned by a readdir.
89 +.\"Convert absolute symbolic links (where the link contents start with a
90 +.\"slash) into relative links by prepending the necessary number of ../'s
91 +.\"to get from the directory containing the link to the root on the
92 +.\"server. This has subtle, perhaps questionable, semantics when the file
93 +.\"hierarchy is not mounted at its root.
96 +.\"Leave all symbolic link as they are. This is the default operation.
100 @@ -409,21 +409,21 @@ and can be turned off with
105 -'''tries to obtain the anonymous uid and gid by looking up user
107 -'''in the password file at startup time. If it isn't found, a uid and gid
109 +.\"tries to obtain the anonymous uid and gid by looking up user
111 +.\"in the password file at startup time. If it isn't found, a uid and gid
113 chooses a uid and gid
114 of 65534 for squashed access. These values can also be overridden by
116 .IR anonuid " and " anongid
119 -'''In addition to this,
121 -'''lets you specify arbitrary uids and gids that should be mapped to user
124 +.\"In addition to this,
126 +.\"lets you specify arbitrary uids and gids that should be mapped to user
128 Finally, you can map all user requests to the
129 anonymous uid by specifying the
130 .IR all_squash " option.
131 @@ -468,7 +468,7 @@ is supposedly that of user joe).
132 /home/joe pc001(rw,all_squash,anonuid=150,anongid=100)
133 /pub *(ro,insecure,all_squash)
134 /srv/www \-sync,rw server @trusted @external(ro)
135 -'''/pub/private (noaccess)
136 +.\"/pub/private (noaccess)
139 The first line exports the entire filesystem to machines master and trusty.
140 @@ -484,21 +484,21 @@ don't use a reserved port for NFS.
141 The sixth line exports a directory read-write to the machine 'server'
142 as well as the `@trusted' netgroup, and read-only to netgroup `@external',
143 all three mounts with the `sync' option enabled.
144 -''' The last line denies all NFS clients
145 -'''access to the private directory.
147 -'''Unlike other NFS server implementations, this
149 -'''allows you to export both a directory and a subdirectory thereof to
150 -'''the same host, for instance
151 -'''.IR /usr " and " /usr/X11R6 .
152 -'''In this case, the mount options of the most specific entry apply. For
153 -'''instance, when a user on the client host accesses a file in
155 -'''the mount options given in the
157 -'''entry apply. This is also true when the latter is a wildcard or netgroup
159 +.\" The last line denies all NFS clients
160 +.\"access to the private directory.
162 +.\"Unlike other NFS server implementations, this
164 +.\"allows you to export both a directory and a subdirectory thereof to
165 +.\"the same host, for instance
166 +.\".IR /usr " and " /usr/X11R6 .
167 +.\"In this case, the mount options of the most specific entry apply. For
168 +.\"instance, when a user on the client host accesses a file in
170 +.\"the mount options given in the
172 +.\"entry apply. This is also true when the latter is a wildcard or netgroup
177 @@ -507,17 +507,17 @@ all three mounts with the `sync' option enabled.
182 -'''An error parsing the file is reported using syslogd(8) as level NOTICE from
183 -'''a DAEMON whenever
187 -'''is started up. Any unknown
188 -'''host is reported at that time, but often not all hosts are not yet known
191 -'''at boot time, thus as hosts are found they are reported
196 +.\"An error parsing the file is reported using syslogd(8) as level NOTICE from
197 +.\"a DAEMON whenever
201 +.\"is started up. Any unknown
202 +.\"host is reported at that time, but often not all hosts are not yet known
205 +.\"at boot time, thus as hosts are found they are reported