From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.4 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH, MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URI_NOVOWEL autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9D81EC433DF for ; Mon, 18 May 2020 14:11:02 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 747CD20829 for ; Mon, 18 May 2020 14:11:02 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="DU/gi4ld" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727954AbgEROLB (ORCPT ); Mon, 18 May 2020 10:11:01 -0400 Received: from us-smtp-delivery-1.mimecast.com ([207.211.31.120]:48471 "EHLO us-smtp-1.mimecast.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1727987AbgEROLB (ORCPT ); Mon, 18 May 2020 10:11:01 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1589811060; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=c3uZam5iX9juWhWt362dSk1fvtkA0w6B4I7xUDHcO3o=; b=DU/gi4ldHOnqT1pdnrWNP0VZFW9M/x9DcdHMNW+o8AxavM5dK56aBd0AJZh9fX95bi+KuJ EkpfVePcIA4lDI0oMJWpPsiS/DV750viZMdlZZi5gV5knP27maTnAvodeOPS0SgTdpG/n2 BqP6w53KrQ8qoYNVH7LxEO6j8EnFMlU= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-53-LBltpDgaOkKOTIBowTNCnQ-1; Mon, 18 May 2020 10:10:54 -0400 X-MC-Unique: LBltpDgaOkKOTIBowTNCnQ-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 24A061800D42 for ; Mon, 18 May 2020 14:10:53 +0000 (UTC) Received: from madhat.boston.devel.redhat.com (ovpn-113-189.phx2.redhat.com [10.3.113.189]) by smtp.corp.redhat.com (Postfix) with ESMTP id D7C6A38E for ; Mon, 18 May 2020 14:10:52 +0000 (UTC) From: Steve Dickson To: Linux NFS Mailing list Subject: [PATCH V2 2/2] nfsdclnts: add man page for tool nfsdclnts Date: Mon, 18 May 2020 10:10:50 -0400 Message-Id: <20200518141050.74702-2-steved@redhat.com> In-Reply-To: <20200518141050.74702-1-steved@redhat.com> References: <20200518141050.74702-1-steved@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Sender: linux-nfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-nfs@vger.kernel.org From: Achilles Gaikwad This patch adds man page for the tool nfsdclnts. Signed-off-by: Achilles Gaikwad Signed-off-by: Kenneth D'souza Signed-off-by: Steve Dickson --- tools/nfsdclnts/Makefile.am | 4 + tools/nfsdclnts/nfsdclnts.man | 156 ++++++++++++++++++++++++++++++++++ 2 files changed, 160 insertions(+) create mode 100644 tools/nfsdclnts/nfsdclnts.man v2: Renamed command to nfsdclnts diff --git a/tools/nfsdclnts/Makefile.am b/tools/nfsdclnts/Makefile.am index c1f12a0..d513edb 100644 --- a/tools/nfsdclnts/Makefile.am +++ b/tools/nfsdclnts/Makefile.am @@ -1,6 +1,10 @@ ## Process this file with automake to produce Makefile.in PYTHON_FILES = nfsdclnts.py +man8_MANS = nfsdclnts.man + +EXTRA_DIST = $(man8_MANS) $(PYTHON_FILES) + all-local: $(PYTHON_FILES) install-data-hook: diff --git a/tools/nfsdclnts/nfsdclnts.man b/tools/nfsdclnts/nfsdclnts.man new file mode 100644 index 0000000..3701de9 --- /dev/null +++ b/tools/nfsdclnts/nfsdclnts.man @@ -0,0 +1,156 @@ +.\" +.\" nfsdclnts(8) +.\" +.TH "NFSDCLTS" "8" "2020-05-09" "nfsdclnts" "nfsdclnts" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +nfsdclnts \- print various nfs client information for knfsd server. +.SH "SYNOPSIS" +.sp +\fBnfsdclnts\fP [\fI\-h\fP] [\fI\-t type\fP] [\fI\-\-clientinfo\fP] [\fI\-\-hostname\fP] [\fI\-q\fP] +.SH "DESCRIPTION" +.sp +The nfsdclnts(8) command parses the content present in /proc/fs/nfsd/clients/ directories. nfsdclnts(8) displays files which are open, locked, delegated by the nfs\-client. It also prints useful client information such as hostname, clientID, NFS version mounted by the nfs\-client. +.SH "OPTIONS" +.sp +\fB\-t, \-\-type\fP=TYPE +.RS 4 +Specify the type of file to be displayed. Takes only one TYPE at a time. +.sp +\fIopen\fP, \fIlock\fP, \fIdeleg\fP, \fIlayout\fP, or \fIall\fP +.sp +open: displays the open files by nfs\-client(s). +.sp +lock: displays the files locked by nfs\-client(s). +.sp +layout: displays the files for which layout is given. +.sp +deleg: displays delegated files information and delegation type. +.sp +all: prints all the above type. +.RE +.sp +\fB\-\-clientinfo\fP +.RS 4 +displays various nfs\-client info fields such as version of nfs mounted at nfs\-client and clientID. +.RE +.sp +\fB\-\-hostname\fP +.RS 4 +Print hostname of nfs\-client instead of ip-address. +.RE +.sp +\fB\-q, \-\-quiet\fP +.RS 4 +Hide the header information. +.RE +.sp +\fB\-h, \-\-help\fP +.RS 4 +Print help explaining the command line options. +.SH "EXAMPLES" +.sp +\fBnfsdclnts \-\-type open\fP +.RS 4 +List all files with open type only. +.RE +.sp +.if n .RS 4 +.nf +Inode number | Type | Access | Deny | ip address | Filename +33823232 | open | r\- | \-\- | [::1]:757 | testfile +.fi +.if n .RE +.sp +\fBnfsdclnts \-\-type deleg\fP +.RS 4 +List all files with deleg type only. +.RE +.sp +.if n .RS 4 +.nf +Inode number | Type | Access | ip address | Filename +33823232 | deleg | r | [::1]:757 | testfile +.fi +.if n .RE +.sp +\fBnfsdclnts \-\-hostname\fP +.RS 4 +Print hostname instead of ip\-address. +.RE +.sp +.if n .RS 4 +.nf +Inode number | Type | Access | Deny | Hostname | Filename +33823232 | open | r\- | \-\- | nfs\-server | testfile +33823232 | deleg | r | | nfs\-server | testfile +.fi +.if n .RE +.sp +\fBnfsdclnts \-\-clientinfo\fP +.RS 4 +Print client information. +.RE +.sp +.if n .RS 4 +.nf +Inode number | Type | Access | Deny | ip address | Client ID | vers | Filename +33823232 | open | r\- | \-\- | [::1]:757 | 0xc79a009f5eb65e84 | 4.2 | testfile +33823232 | deleg | r | | [::1]:757 | 0xc79a009f5eb65e84 | 4.2 | testfile +.fi +.if n .RE +.sp +\fBnfsdclnts.py \-\-quiet \-\-hostname\fP +.RS 4 +Hide the header information. +.RE +.sp +.if n .RS 4 +.nf +33823232 | open | r\- | \-\- | nfs\-server | testfile +33823232 | deleg | r | | nfs\-server | testfile +.fi +.if n .RE +.SH "FILES" +.sp +\fB/proc/fs/nfsd/clients/\fP +.sp +Displays basic information about each NFSv4 client. +.sp +\fB/proc/fs/nfsd/clients/#/info\fP +.sp +Displays information about all the opens held by the given client, including open modes, device numbers, inode numbers, and open owners. +.sp +\fB/proc/fs/nfsd/clients/#/states\fP +.SH "NOTES" +.sp +/proc/fs/nfsd/clients/ support was initially introduced in 5.3 kernel and is only implemented for mount points using NFSv4. +.SH "BUGS" +Please report any BUGs to \c +.MTO "linux\-nfs\(atvger.kernel.org" "" "" +.SH SEE ALSO +.BR nfsd (8), +.BR exportfs (8), +.BR idmapd (8), +.BR statd (8) +.SH "AUTHORS" +Achilles Gaikwad and +Kenneth D'souza -- 2.24.1