All of lore.kernel.org
 help / color / mirror / Atom feed
From: schumaker.anna@gmail.com
To: steved@redhat.com, linux-nfs@vger.kernel.org
Cc: Anna.Schumaker@Netapp.com
Subject: [PATCH v2 8/9] nfs-sysfs: Add a man page
Date: Fri,  6 Aug 2021 16:17:38 -0400	[thread overview]
Message-ID: <20210806201739.472806-9-Anna.Schumaker@Netapp.com> (raw)
In-Reply-To: <20210806201739.472806-1-Anna.Schumaker@Netapp.com>

From: Anna Schumaker <Anna.Schumaker@Netapp.com>

Signed-off-by: Anna Schumaker <Anna.Schumaker@Netapp.com>
---
 tools/nfs-sysfs/nfs-sysfs.man | 88 +++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 tools/nfs-sysfs/nfs-sysfs.man

diff --git a/tools/nfs-sysfs/nfs-sysfs.man b/tools/nfs-sysfs/nfs-sysfs.man
new file mode 100644
index 000000000000..3ebbeaf93eaa
--- /dev/null
+++ b/tools/nfs-sysfs/nfs-sysfs.man
@@ -0,0 +1,88 @@
+.\"
+.\" nfs-sysfs(8)
+.\"
+.TH nfs-sysfs 8 "05 Aug 2021"
+.SH NAME
+nfs-sysfs \- Displays NFS & SunRPC connection information
+.SH SYNOPSIS
+.B nfs-sysfs
+.RB [ \-h | \-\-help ]
+.P
+.B nfs-sysfs rpc-client
+.RB [ \-h | \-\-help ]
+.RB [ \--id
+.IR ID ]
+.P
+.B nfs-sysfs xprt-switch
+.RB [ \-h | \-\-help ]
+.RB [ \--id
+.IR ID ]
+.P
+.B nfs-sysfs xprt-switch set
+.RB [ \-h | \-\-help ]
+.RB [ \--id
+.IR ID ]
+.RB [ \--dstaddr
+.IR dstaddr]
+.P
+.B nfs-sysfs xprt
+.RB [ \-h | \-\-help ]
+.RB [ \--id
+.IR ID ]
+.P
+.B nfs-sysfs xprt set
+.RB [ \-h | \-\-help ]
+.RB [ \--id
+.IR ID ]
+.RB [ \--dstaddr
+.IR dstaddr]
+.RB [ --offline ]
+.RB [ --online ]
+.RB [ --remove ]
+.P
+.SH DESCRIPTION
+.RB "The " nfs-sysfs " command displays information collected in the SunRPC sysfs files about the system's SunRPC objects.
+.P
+.SS Objects
+Valid
+.BR nfs-sysfs (8)
+objects are:
+.IP "\fBrpc-client\fP"
+Display information about this system's RPC clients.
+.IP "\fBxprt-switch\fP"
+Display information about groups of transports.
+.IP "\fBxprt\fP"
+Display detailed information about each transport that exists on the system.
+.SH OPTIONS
+.SS Options valid for all objects
+.TP
+.B \-h, \-\-help
+Show the help message and exit
+.TP
+.B \-\-id \fIID
+Set or display properties for the object with the given
+.IR ID.
+This option is mandatory for setting properties.
+.SS Options specific to the `xprt-switch set` sub-command
+.TP
+.B \-\-dstaddr \fIdstaddr
+Change the destination address of all transports in the xprt-switch to
+.IR dstaddr
+.SS Options specific to the `xprt set` sub-command
+.TP
+.B \-\-dstaddr \fIdstaddr
+Change the destination address of this specific transport to
+.TP
+.B \-\-offline
+Change the transport state from online to offline
+.TP
+.B \-\-online
+Change the transport state from offline to online
+.TP
+.B \-\-remove
+Removes the transport from the xprt-switch. Note that "main" transports cannot be removed.
+.SH DIRECTORY
+.TP
+.B /sys/kernel/sunrpc/
+.SH AUTHOR
+Anna Schumaker <Anna.Schumaker@Netapp.com>
-- 
2.32.0


  parent reply	other threads:[~2021-08-06 20:17 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-06 20:17 [PATCH v2 0/9] Add a tool for using the new sysfs files schumaker.anna
2021-08-06 20:17 ` [PATCH v2 1/9] nfs-sysfs: Add an nfs-sysfs.py tool schumaker.anna
2021-08-17 16:57   ` Mora, Jorge
2021-08-23 21:41     ` Anna Schumaker
2021-08-06 20:17 ` [PATCH v2 2/9] nfs-sysfs.py: Add a command for printing xprt switch information schumaker.anna
2021-08-06 20:17 ` [PATCH v2 3/9] nfs-sysfs.py: Add a command for printing individual xprts schumaker.anna
2021-08-06 20:17 ` [PATCH v2 4/9] nfs-sysfs.py: Add a command for printing rpc-client information schumaker.anna
2021-08-06 20:17 ` [PATCH v2 5/9] nfs-sysfs.py: Add a command for changing xprt dstaddr schumaker.anna
2021-08-06 20:17 ` [PATCH v2 6/9] nfs-sysfs.py: Add a command for changing xprt-switch dstaddrs schumaker.anna
2021-08-06 20:17 ` [PATCH v2 7/9] nfs-sysfs.py: Add a command for changing xprt state schumaker.anna
2021-08-17 17:00   ` Mora, Jorge
2021-08-06 20:17 ` schumaker.anna [this message]
2021-08-06 20:17 ` [PATCH v2 9/9] nfs-sysfs: Add installation to the Makefile schumaker.anna
2021-08-08 16:30 ` [PATCH v2 0/9] Add a tool for using the new sysfs files Steve Dickson
2021-08-08 19:00   ` Anna Schumaker

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=20210806201739.472806-9-Anna.Schumaker@Netapp.com \
    --to=schumaker.anna@gmail.com \
    --cc=Anna.Schumaker@Netapp.com \
    --cc=linux-nfs@vger.kernel.org \
    --cc=steved@redhat.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.