Return-Path: linux-nfs-owner@vger.kernel.org Received: from cantor2.suse.de ([195.135.220.15]:57658 "EHLO mx2.suse.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750895Ab3KNDDE (ORCPT ); Wed, 13 Nov 2013 22:03:04 -0500 Date: Thu, 14 Nov 2013 14:02:44 +1100 From: NeilBrown To: "Linux NFS Mailing List" Cc: Charles Edward Lever Subject: please proof-read: updates to nfs.man for some missing options. Message-ID: <20131114140244.6f7c0094@notabene.brown> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=PGP-SHA1; boundary="Sig_/lEMYaQG6oIxhBjRIdNT+F2J"; protocol="application/pgp-signature" Sender: linux-nfs-owner@vger.kernel.org List-ID: --Sig_/lEMYaQG6oIxhBjRIdNT+F2J Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: quoted-printable Hi, I recently noticed that "man nfs" doesn't mention the "bsize" option. So I looked more closely and found a few other options that the kernel supports but the man page doesn't mention. I've added documentation for most of them - leaving off "posix" and "nopos= ix" as it looks like they are not used and never have been. Possibly I should have left out "sloppy" too as it is (I think) just an "internal" form of the "-s" flag. Opinions on that are welcome. The others I've researched and documented to the best of my ability, but I would appreciate review (just to make sure I never typed 'now' where I mea= nt 'not' as I usually do). In particular I made up some details for the "migration" option and hope Chuck will set me straight if I'm leading the reader astray - thanks Chuck. (Obviously I work with RAID too much .. I typed "chunk" twice above and had to correct both of them. You see what I mean about needing proof-readers). Thanks in advance, NeilBrown diff --git a/utils/mount/nfs.man b/utils/mount/nfs.man index 2a42b9340905..7786e6fd3d0d 100644 --- a/utils/mount/nfs.man +++ b/utils/mount/nfs.man @@ -90,7 +90,14 @@ If the server does not support the requested version, th= e mount request fails. If this option is not specified, the client negotiates a suitable version= =20 with -the server, trying version 4 first, version 3 second, and version 2 last. +the server, trying version 4.0, then version 3. Version 2 is never +attempted unless explicitly requested. +.IP +NFS version 4 has multiple sub-versions which can be requested using a +suffix such as 4.1 or 4.2 if the kernel is Linux 3.4 or later, or by +using the +.B minorversion +option for earlier kernels. .TP 1.5i .BI vers=3D n This option is an alternative to the @@ -248,6 +255,17 @@ value negotiated by the client and server is reported = in the .I /proc/mounts file. .TP 1.5i +.BI bsize=3D n +The block size that NFS should report. This particularly affects the +numbers reported by +.IR statfs (2) +and +.IR df (1). +If not specified, the +.B wsize +value will be used, but will be clamped to a minimum of 1K and a +maximum of 1M. +.TP 1.5i .BR ac " / " noac Selects whether the client may cache file attributes. If neither option is specified (or if @@ -489,6 +507,23 @@ using the FS-Cache facility. See cachefilesd(8) and /Documentation/filesystems/caching for detail on how to configure the FS-Cache facility. Default value is nofsc. +.TP 1.5i +.BR fsc=3D "unique string" +When the +.B nosharecache +option is used, only one of several mounts that aren't sharing a cache +will usually be permitted to use FS-Cache as there is no mechanism to +locate distinct disk caches for each mount. This restriction can be +over come by providing an arbitrary "unique string" to each mount +which uses +.BR nosharecache . +.TP 1.5i +.B sloppy +This is equivalent to the +.B -s +option to +.IR mount (8) +and causes unexpected options to be ignored without error. .SS "Options for NFS versions 2 and 3 only" Use these options, along with the options in the above subsection, for NFS versions 2 and 3 only. @@ -552,6 +587,10 @@ The option is an alternative to specifying .BR proto=3Drdma. .TP 1.5i +.BR addr=3D ip-address +This option is rarely used but can provide an explicit IP address of +the NFS server in cases where the server is multi-homed. +.TP 1.5i .BI port=3D n The numeric value of the server's NFS service port. If the server's NFS service is not available on the specified port, @@ -617,6 +656,10 @@ If this option is not specified, the command assumes that the mountd service runs on the same host as the NFS service. .TP 1.5i +.BI mountaddr=3D ip-address +The IP address of the host running mountd. This can be useful to +avoid ambiguity if the server running mountd has multiple addresses. +.TP 1.5i .BI mountvers=3D n The RPC version number used to contact the server's mountd. If this option is not specified, the client uses a version number @@ -780,6 +823,10 @@ so if this mount option is not specified, the NFS vers= ion 4 client uses the TCP protocol. Refer to the TRANSPORT METHODS section for more details. .TP 1.5i +.BR addr=3D ip-address +This option is rarely used but can provide an explicit IP address of +the NFS server in cases where the server is multi-homed. +.TP 1.5i .BI port=3D n The numeric value of the server's NFS service port. If the server's NFS service is not available on the specified port, @@ -855,6 +902,26 @@ In the presence of multiple client network interfaces, special routing policies, or atypical network topologies, the exact address to use for callbacks may be nontrivial to determine. +.TP 1.5i +.BR minorversion=3D number +This option was deprecated in Linux 3.4, but may be needed for older +kernels. It specifies which minor version of the NFSv4 protocol to +use. The preferred syntax for specifying a minor version is to use a +suffix with the +.B nfsvers +or +.B vers +options. +.TP 1.5i +.BR migration " / " nomigration +This should be used with an NFSv4.0 server if migration support is +required. It is not necessary or permitted for NFSv4.1 or later. +.IP +In order to support migration the NFS client must provide a +.I "uniform client string" +to the server. This confuses some older NFSv4.0 servers so it is not +sent by default. Servers that support migration must also support the +.IR "uniform client string" . .SH nfs4 FILE SYSTEM TYPE The .BR nfs4 --Sig_/lEMYaQG6oIxhBjRIdNT+F2J Content-Type: application/pgp-signature; name=signature.asc Content-Disposition: attachment; filename=signature.asc -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.19 (GNU/Linux) iQIVAwUBUoQ9VDnsnt1WYoG5AQIYmg//TIB2XZ1pHnAaR5v2Av/mDNWuvH1/r5Qf VEP4UhFM1Rl1tLtjOp/3DDmDEt62v/Fu/NKYTD6MLGdauuL3e9CveZRQBoAINCR8 aEzlbmDKxomCjCXK4ZwUUYKL2TFWuVnCXW7ZsQFklDawqWg0Pq0LvNI97EsAupiE uUovsaKWiVwP7kj+JMAoywHltSCQMruw7IM/TN7UHyfyW3uwWKDJr+trw9uoVyme aU77TnRmp3OeuEOsMetTWKwI0tBgG2X7iH3QqdqIk2U1qdvAMqT0VoE+OlxU6ibr owDSO62kTxp286qebkrVITuqIu0P+9E45xNDwVDwe9gMOhilX/PjYuC1n2R2Wakb WQz7AjbJ4ZrhcAxXajRBZLx0WdqIK21yrxhQLv7FymcO4HqRhnmNc4R/UK9er6rU g8XcAd+jNzMNPdEwo2jyJ8GmGdCsyifSiGpBwbC10V6B9Xt9cO25r+seDxpFApZn 6duxc2w0R+zGGL+j0y9A+HuW2EQxP5t5uLE1QI/3Se6I+Z0dGZ12mWdhvHptl1Jf saSuQvWEyH8KsuyTeUfyz9UmiSP3KJ/36iPC+GctVVoFEeHL+GzYpcLQupbBdWVU PP068/TRDSmM4y4xHsFlZzRS2VVgZjPfh16fMDA6V/LaC9OqxRSS95f1vb0Wq3It zJQgqj/jsqQ= =ARFf -----END PGP SIGNATURE----- --Sig_/lEMYaQG6oIxhBjRIdNT+F2J--