From patchwork Tue Sep 24 05:01:39 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kenneth Dsouza X-Patchwork-Id: 11157907 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 876C413B1 for ; Tue, 24 Sep 2019 05:01:43 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 64102214AF for ; Tue, 24 Sep 2019 05:01:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2408741AbfIXFBm (ORCPT ); Tue, 24 Sep 2019 01:01:42 -0400 Received: from mx1.redhat.com ([209.132.183.28]:38700 "EHLO mx1.redhat.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2408653AbfIXFBm (ORCPT ); Tue, 24 Sep 2019 01:01:42 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 69724898108; Tue, 24 Sep 2019 05:01:42 +0000 (UTC) Received: from localhost.localdomain.com (unknown [10.76.1.145]) by smtp.corp.redhat.com (Postfix) with ESMTP id CF3CD5D9D5; Tue, 24 Sep 2019 05:01:40 +0000 (UTC) From: Kenneth D'souza To: linux-cifs@vger.kernel.org, piastryyy@gmail.com, smfrench@gmail.com Cc: lsahlber@redhat.com Subject: [PATCH] smb2quota.rst: Add man page for smb2quota.py Date: Tue, 24 Sep 2019 10:31:39 +0530 Message-Id: <20190924050139.22007-1-kdsouza@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.6.2 (mx1.redhat.com [10.5.110.67]); Tue, 24 Sep 2019 05:01:42 +0000 (UTC) Sender: linux-cifs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-cifs@vger.kernel.org Signed-off-by: Kenneth D'souza --- smb2quota.rst | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 smb2quota.rst diff --git a/smb2quota.rst b/smb2quota.rst new file mode 100644 index 0000000..acb34fc --- /dev/null +++ b/smb2quota.rst @@ -0,0 +1,68 @@ +============ +smb2quota +============ + +----------------------------------------------------------------------------------------------------- +Userspace helper to display quota information for the Linux SMB client file system (CIFS) +----------------------------------------------------------------------------------------------------- +:Manual section: 1 + +******** +SYNOPSIS +******** + + smb2quota [-h] {options} {file system object} + +*********** +DESCRIPTION +*********** + +This tool is part of the cifs-utils suite. + +`smb2quota` is a userspace helper program for the Linux SMB +client file system (CIFS). + +This tool works by making an CIFS_QUERY_INFO IOCTL call to the Linux +SMB client which in turn issues a SMB Query Info request and returns +the result. + +******* +OPTIONS +******* +`--help/-h`: Print help explaining the command line options. + +`-tabular/-t`: Print quota information for the volume in tabular format. +Amount Used | Quota Limit | Warning Level | SID + +`-csv/-c`: Print quota information for the volume in csv format. +SID,Amount Used,Quota Limit,Warning Level + +`-list/-l`: Print quota information for the volume in raw format. +- SID +- Quota Used +- Quota Threshold +- Quota Limit + +***** +NOTES +***** + +Kernel support for smb2quota requires the CIFS_QUERY_INFO +IOCTL which was initially introduced in the 4.20 kernel and is only +implemented for mount points using SMB2 or above (see mount.cifs(8) +`vers` option). + +******** +SEE ALSO +******** + +smbinfo(1) + +****** +AUTHOR +****** + +Kenneth D'souza + +The Linux CIFS Mailing list is the preferred place to ask questions +regarding these programs.