Received-SPF: pass (google.com: domain of linux-nfs-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1:18;
MIME-Version: 1.0
References: <20220127194952.63033-1-Anna.Schumaker@Netapp.com>
 <20220127194952.63033-9-Anna.Schumaker@Netapp.com> <c416e70b-35c6-6b8c-df04-ed496e9a978d@redhat.com>
In-Reply-To: <c416e70b-35c6-6b8c-df04-ed496e9a978d@redhat.com>
From:   Anna Schumaker <schumaker.anna@gmail.com>
Date:   Mon, 7 Feb 2022 15:32:42 -0500
Message-ID: <CAFX2Jfmg-B-KHmeUkBPV0ohxPAmJOw4ioYoLVVLpFOQ_OWLE=w@mail.gmail.com>
Subject: Re: [PATCH v7 8/9] rpcctl: Add a man page
To:     Steve Dickson <steved@redhat.com>
Cc:     Linux NFS Mailing List <linux-nfs@vger.kernel.org>,
        Schumaker Anna <Anna.Schumaker@netapp.com>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Mon, Feb 7, 2022 at 2:58 PM Steve Dickson <steved@redhat.com> wrote:
>
> Hey Anna!
>
> On 1/27/22 2:49 PM, schumaker.anna@gmail.com wrote:
> > From: Anna Schumaker <Anna.Schumaker@Netapp.com>
> >
> > Signed-off-by: Anna Schumaker <Anna.Schumaker@Netapp.com>
> > ---
> >   tools/rpcctl/rpcctl.man | 88 +++++++++++++++++++++++++++++++++++++++++
> >   1 file changed, 88 insertions(+)
> >   create mode 100644 tools/rpcctl/rpcctl.man
> >
> > diff --git a/tools/rpcctl/rpcctl.man b/tools/rpcctl/rpcctl.man
> > new file mode 100644
> > index 000000000000..e4dd53ac8531
> > --- /dev/null
> > +++ b/tools/rpcctl/rpcctl.man
> > @@ -0,0 +1,88 @@
> > +.\"
> > +.\" rpcctl(8)
> > +.\"
> > +.TH rpcctl 8 "25 Jan 2022"
> > +.SH NAME
> > +rpcctl \- Displays SunRPC connection information
> > +.SH SYNOPSIS
> > +.B rpcctl
> > +.RB [ \-h | \-\-help ]
> > +.P
> > +.B rpcctl client
> > +.RB [ \-h | \-\-help ]
> > +.RB [ \--id
> > +.IR ID ]
> > +.P
> > +.B rpcctl switch
> > +.RB [ \-h | \-\-help ]
> > +.RB [ \--id
> > +.IR ID ]
> > +.P
> > +.B rpcctl switch set
> > +.RB [ \-h | \-\-help ]
> > +.RB [ \--id
> > +.IR ID ]
> > +.RB [ \--dstaddr
> > +.IR dstaddr]
> > +.P
> > +.B rpcctl xprt
> > +.RB [ \-h | \-\-help ]
> > +.RB [ \--id
> > +.IR ID ]
> > +.P
> > +.B rpcctl xprt set
> > +.RB [ \-h | \-\-help ]
> > +.RB [ \--id
> > +.IR ID ]
> > +.RB [ \--dstaddr
> > +.IR dstaddr]
> > +.RB [ --offline ]
> > +.RB [ --online ]
> > +.RB [ --remove ]
> > +.P
> > +.SH DESCRIPTION
> > +.RB "The " rpcctl " command displays information collected in the SunRPC sysfs files about the system's SunRPC objects.
> > +.P
> > +.SS Objects
> > +Valid
> > +.BR rpcctl (8)
> > +objects are:
> > +.IP "\fBclient\fP"
> > +Display information about this system's RPC clients.
> > +.IP "\fBswitch\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 `switch set` sub-command
> > +.TP
> > +.B \-\-dstaddr \fIdstaddr
> > +Change the destination address of all transports in the 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 switch. Note that "main" transports cannot be removed.
> I got some feed back on this manpage....
>
> They said would be useful to have examples on how to use
> the objects... esp the switch set and xprt set ones.
> I kinda agree...

Okay, I can add that. I'll send out a new version with that and
anything Rahul finds once he checks back in after trying the tool with
the sysfs kernel fixes.

Anna

>
> steved.
> > +.SH DIRECTORY
> > +.TP
> > +.B /sys/kernel/sunrpc/
> > +.SH AUTHOR
> > +Anna Schumaker <Anna.Schumaker@Netapp.com>
>