From: Kenneth D'souza <kdsouza@redhat.com>
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 [thread overview]
Message-ID: <20190924050139.22007-1-kdsouza@redhat.com> (raw)
Signed-off-by: Kenneth D'souza <kdsouza@redhat.com>
---
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 <kdsouza@redhat.com>
+
+The Linux CIFS Mailing list is the preferred place to ask questions
+regarding these programs.
--
2.21.0
reply other threads:[~2019-09-24 5:01 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20190924050139.22007-1-kdsouza@redhat.com \
--to=kdsouza@redhat.com \
--cc=linux-cifs@vger.kernel.org \
--cc=lsahlber@redhat.com \
--cc=piastryyy@gmail.com \
--cc=smfrench@gmail.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).