debian/patches/19-exports.man-Fix-comment-syntax.patch

   1 From: Ben Hutchings <ben@decadent.org.uk>
   2 Subject: [PATCH] exports.man: Fix comment syntax
   3
   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.
   7
   8 Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
   9
  10 --- a/utils/exportfs/exports.man
  11 +++ b/utils/exportfs/exports.man
  12 @@ -80,25 +80,25 @@ For example, either `/255.255.252.0' or `/22' appended
  13  character (not to be confused with the
  14  .I wildcard
  15  entry above) and will match all clients.
  16 -'''.TP
  17 -'''.B =public
  18 -'''This is a special ``hostname'' that identifies the given directory name
  19 -'''as the public root directory (see the section on WebNFS in
  20 -'''.BR nfsd (8)
  21 -'''for a discussion of WebNFS and the public root handle). When using this
  22 -'''convention,
  23 -'''.B =public
  24 -'''must be the only entry on this line, and must have no export options
  25 -'''associated with it. Note that this does
  26 -'''.I not
  27 -'''actually export the named directory; you still have to set the exports
  28 -'''options in a separate entry.
  29 -'''.PP
  30 -'''The public root path can also be specified by invoking
  31 -'''.I nfsd
  32 -'''with the
  33 -'''.B \-\-public\-root
  34 -'''option. Multiple specifications of a public root will be ignored.
  35 +.\".TP
  36 +.\".B =public
  37 +.\"This is a special ``hostname'' that identifies the given directory name
  38 +.\"as the public root directory (see the section on WebNFS in
  39 +.\".BR nfsd (8)
  40 +.\"for a discussion of WebNFS and the public root handle). When using this
  41 +.\"convention,
  42 +.\".B =public
  43 +.\"must be the only entry on this line, and must have no export options
  44 +.\"associated with it. Note that this does
  45 +.\".I not
  46 +.\"actually export the named directory; you still have to set the exports
  47 +.\"options in a separate entry.
  48 +.\".PP
  49 +.\"The public root path can also be specified by invoking
  50 +.\".I nfsd
  51 +.\"with the
  52 +.\".B \-\-public\-root
  53 +.\"option. Multiple specifications of a public root will be ignored.
  54  .PP
  55  If a client matches more than one of the specifications above, then
  56  the first match from the above list order takes precedence - regardless of
  57 @@ -311,24 +311,24 @@ with ACL support (i.e. by default,
  58  .I no_acl
  59  is off).
  60
  61 -'''.TP
  62 -'''.I noaccess
  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.
  69 -'''.TP
  70 -'''.IR link_relative
  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.
  76 -'''.TP
  77 -'''.IR link_absolute
  78 -'''Leave all symbolic link as they are. This is the default operation.
  79 +.\".TP
  80 +.\".I noaccess
  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.
  87 +.\".TP
  88 +.\".IR link_relative
  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.
  94 +.\".TP
  95 +.\".IR link_absolute
  96 +.\"Leave all symbolic link as they are. This is the default operation.
  97
  98  .TP
  99  .IR mountpoint= path
 100 @@ -411,21 +411,21 @@ and can be turned off with
 101  .IR no_root_squash .
 102  .PP
 103  By default,
 104 -'''.B nfsd
 105 -'''tries to obtain the anonymous uid and gid by looking up user
 106 -'''.I nobody
 107 -'''in the password file at startup time. If it isn't found, a uid and gid
 108 +.\".B nfsd
 109 +.\"tries to obtain the anonymous uid and gid by looking up user
 110 +.\".I nobody
 111 +.\"in the password file at startup time. If it isn't found, a uid and gid
 112  .B exportfs
 113  chooses a uid and gid
 114  of 65534 for squashed access. These values can also be overridden by
 115  the
 116  .IR anonuid " and " anongid
 117  options.
 118 -'''.PP
 119 -'''In addition to this,
 120 -'''.B nfsd
 121 -'''lets you specify arbitrary uids and gids that should be mapped to user
 122 -'''nobody as well.
 123 +.\".PP
 124 +.\"In addition to this,
 125 +.\".B nfsd
 126 +.\"lets you specify arbitrary uids and gids that should be mapped to user
 127 +.\"nobody as well.
 128  Finally, you can map all user requests to the
 129  anonymous uid by specifying the
 130  .IR all_squash " option.
 131 @@ -490,7 +490,7 @@ is supposedly that of user joe).
 132  /srv/www        \-sync,rw server @trusted @external(ro)
 133  /foo            2001:db8:9:e54::/64(rw) 192.0.2.0/24(rw)
 134  /build          buildhost[0-9].local.domain(rw)
 135 -'''/pub/private    (noaccess)
 136 +.\"/pub/private    (noaccess)
 137  .fi
 138  .PP
 139  The first line exports the entire filesystem to machines master and trusty.
 140 @@ -508,21 +508,21 @@
 141  all three mounts with the `sync' option enabled. The seventh line exports
 142  a directory to both an IPv6 and an IPv4 subnet. The eighth line demonstrates
 143  a character class wildcard match.
 144 -''' The last line denies all NFS clients
 145 -'''access to the private directory.
 146 -'''.SH CAVEATS
 147 -'''Unlike other NFS server implementations, this
 148 -'''.B nfsd
 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
 154 -'''.IR /usr/X11R6 ,
 155 -'''the mount options given in the
 156 -'''.I /usr/X11R6
 157 -'''entry apply. This is also true when the latter is a wildcard or netgroup
 158 -'''entry.
 159 +.\" The last line denies all NFS clients
 160 +.\"access to the private directory.
 161 +.\".SH CAVEATS
 162 +.\"Unlike other NFS server implementations, this
 163 +.\".B nfsd
 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
 169 +.\".IR /usr/X11R6 ,
 170 +.\"the mount options given in the
 171 +.\".I /usr/X11R6
 172 +.\"entry apply. This is also true when the latter is a wildcard or netgroup
 173 +.\"entry.
 174  .SH FILES
 175  /etc/exports
 176  /etc/exports.d
 177 @@ -532,17 +532,17 @@ all three mounts with the `sync' option enabled.
 178  .BR mountd (8),
 179  .BR nfsd (8),
 180  .BR showmount (8).
 181 -'''.SH DIAGNOSTICS
 182 -'''An error parsing the file is reported using syslogd(8) as level NOTICE from
 183 -'''a DAEMON whenever
 184 -'''.BR nfsd (8)
 185 -'''or
 186 -'''.BR mountd (8)
 187 -'''is started up.  Any unknown
 188 -'''host is reported at that time, but often not all hosts are not yet known
 189 -'''to
 190 -'''.BR named (8)
 191 -'''at boot time, thus as hosts are found they are reported
 192 -'''with the same
 193 -'''.BR syslogd (8)
 194 -'''parameters.
 195 +.\".SH DIAGNOSTICS
 196 +.\"An error parsing the file is reported using syslogd(8) as level NOTICE from
 197 +.\"a DAEMON whenever
 198 +.\".BR nfsd (8)
 199 +.\"or
 200 +.\".BR mountd (8)
 201 +.\"is started up.  Any unknown
 202 +.\"host is reported at that time, but often not all hosts are not yet known
 203 +.\"to
 204 +.\".BR named (8)
 205 +.\"at boot time, thus as hosts are found they are reported
 206 +.\"with the same
 207 +.\".BR syslogd (8)
 208 +.\"parameters.