Linux NFS development
 help / color / mirror / Atom feed
From: NeilBrown <neilb@suse.com>
To: "J. Bruce Fields" <bfields@redhat.com>,
	Steve Dickson <SteveD@redhat.com>
Cc: linux-nfs@vger.kernel.org
Subject: [PATCH 01/15] Add man-page describing /etc/nfs.conf
Date: Fri, 02 Dec 2016 14:58:28 +1100	[thread overview]
Message-ID: <148065110794.28046.7740199040148300941.stgit@noble> (raw)
In-Reply-To: <148065078775.28046.5506130555300891075.stgit@noble>

It may seem a little odd placing this in the "systemd" directory,
but it is a conveninent place, and /etc/nfs.conf was added in
part to help with systemd integration.

Signed-off-by: NeilBrown <neilb@suse.com>
---
 systemd/Makefile.am  |    4 ++-
 systemd/nfs.conf.man |   67 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 70 insertions(+), 1 deletion(-)
 create mode 100644 systemd/nfs.conf.man

diff --git a/systemd/Makefile.am b/systemd/Makefile.am
index 49c9b8d3b459..b647ef00a0d1 100644
--- a/systemd/Makefile.am
+++ b/systemd/Makefile.am
@@ -36,7 +36,9 @@ unit_files += \
 endif
 endif
 
-EXTRA_DIST = $(unit_files)
+man5_MANS	= nfs.conf.man
+
+EXTRA_DIST = $(unit_files) $(man5_MANS)
 
 unit_dir = /usr/lib/systemd/system
 generator_dir = /usr/lib/systemd/system-generators
diff --git a/systemd/nfs.conf.man b/systemd/nfs.conf.man
new file mode 100644
index 000000000000..3dd56f735de2
--- /dev/null
+++ b/systemd/nfs.conf.man
@@ -0,0 +1,67 @@
+.TH NFS.CONF 5
+.SH NAME
+nfs.conf \- general configuration for NFS daemons and tools
+.SH SYNOPSIS
+.I /etc/nfs.conf
+.SH DESCRIPTION
+.PP
+This file contains site-specific configuration for various NFS daemons
+and other processes.  Most configuration can also be passed to
+processes via command line arguments, but it can be more convenient to
+have a central file.  In particular, this encourages consistent
+configuration across different processes.
+.PP
+When command line options are provided, they override values set in
+this file.  When this file does not specify a particular parameter,
+and no command line option is provided, each tool provides its own
+default values.
+.PP
+The file format supports multiple sections, each of which can contain
+multiple value assignments.  A section is introduced by a line
+containing the section name enclosed in square brackets, so
+.RS
+.B [global]
+.RE
+would introduce a section called
+.BR global .
+A value assignment is a single line that has the name of the value, an
+equals sign, and a setting for the value, so
+.RS
+.B threads = 4
+.RE
+would set the value named
+.B threads
+in the current section to
+.BR 4 .
+Leading and trailing spaces and tab
+are ignored, as are spaces and tabs surrounding the equals sign.
+.PP
+Any line starting with
+.RB \*(lq # \*(rq
+or
+.RB \*(lq ; \*(rq
+is ignored, as is any blank line.
+.PP
+Lookup of section and value names is case-insensitive.
+
+.SH SECTIONS
+The following sections are known to various programs, and can contain
+the given named values.
+.TP
+.B nfsdcltrack
+Recognized values:
+.BR storagedir .
+
+The
+.B nfsdcltrack
+program is run directly by the Linux kernel and there is no
+opportunity to provide command line arguments, so the configuration
+file is the only way to configure this program.  See
+.BR nfsdcltrack (8)
+for details.
+
+.SH FILES
+.I /etc/nfs.conf
+.SH SEE ALSO
+.BR nfsdcltrack (8),
+.BR nfsmount.conf (5).



  parent reply	other threads:[~2016-12-02  3:58 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-12-02  3:58 [RFC PATCH 00/15] Enhance /etc/nfs.conf usage and remove nfs-config.service NeilBrown
2016-12-02  3:58 ` [PATCH 03/15] Add /etc/nfs.conf support to rpc.nfsd NeilBrown
2016-12-05 22:27   ` J. Bruce Fields
2016-12-05 22:42     ` NeilBrown
2016-12-06 17:52   ` Steve Dickson
2016-12-06 22:30     ` NeilBrown
2016-12-07 14:34       ` Steve Dickson
2016-12-06 18:51   ` Steve Dickson
2016-12-06 22:36     ` NeilBrown
2016-12-07 14:44       ` Steve Dickson
2016-12-07 18:08         ` J. Bruce Fields
2016-12-07 23:14           ` NeilBrown
2016-12-08  0:38             ` Steve Dickson
2016-12-09 22:43             ` J. Bruce Fields
2016-12-20 23:22       ` NeilBrown
2016-12-21  1:55         ` J. Bruce Fields
2016-12-02  3:58 ` [PATCH 02/15] conffile: add bool support NeilBrown
2016-12-02  3:58 ` NeilBrown [this message]
2016-12-02  3:58 ` [PATCH 04/15] Add /etc/nfs.conf support for mountd NeilBrown
2016-12-02  3:58 ` [PATCH 05/15] Add /etc/nfs.conf support for statd NeilBrown
2016-12-02  3:58 ` [PATCH 08/15] conffile: split loading of file into a separate function NeilBrown
2016-12-02  3:58 ` [PATCH 11/15] conffile: ignore setting of empty string NeilBrown
2016-12-02  3:58 ` [PATCH 06/15] Add /etc/nfs.conf support for sm-notify NeilBrown
2016-12-02  3:58 ` [PATCH 10/15] conffile: strip "quotes" from values in conf file NeilBrown
2016-12-02  3:58 ` [PATCH 09/15] conffile: add support for include files NeilBrown
2016-12-02  3:58 ` [PATCH 07/15] conffile: free image of config file after parsing NeilBrown
2016-12-02  3:58 ` [PATCH 14/15] systemd: Remove the nfs-config.service NeilBrown
2016-12-02  3:58 ` [PATCH 13/15] statd: allow --no-notify to be passed via environment variable NeilBrown
2016-12-02  3:58 ` [PATCH 15/15] Add nfs.systemd man page NeilBrown
2016-12-02  3:58 ` [PATCH 12/15] conffile: allow $name expansion of tag values NeilBrown
2016-12-02 15:56 ` [RFC PATCH 00/15] Enhance /etc/nfs.conf usage and remove nfs-config.service J. Bruce Fields
2016-12-06 16:55 ` Steve Dickson
2016-12-06 22:38   ` NeilBrown
2016-12-07 14:24     ` Steve Dickson
2016-12-06 17:26 ` J. Bruce Fields
2016-12-06 22:47   ` NeilBrown
2016-12-07 14:19     ` J. Bruce Fields
2016-12-06 19:25 ` Steve Dickson
2016-12-06 22:51   ` NeilBrown
2016-12-07 14:21     ` Steve Dickson
2016-12-20 18:33 ` Steve Dickson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=148065110794.28046.7740199040148300941.stgit@noble \
    --to=neilb@suse.com \
    --cc=SteveD@redhat.com \
    --cc=bfields@redhat.com \
    --cc=linux-nfs@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox