Linux-CIFS Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] smb2quota.rst: Add man page for smb2quota.py
@ 2019-09-24  5:01 Kenneth D'souza
  0 siblings, 0 replies; only message in thread
From: Kenneth D'souza @ 2019-09-24  5:01 UTC (permalink / raw)
  To: linux-cifs, piastryyy, smfrench; +Cc: lsahlber

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


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, back to index

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-09-24  5:01 [PATCH] smb2quota.rst: Add man page for smb2quota.py Kenneth D'souza

Linux-CIFS Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-cifs/0 linux-cifs/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-cifs linux-cifs/ https://lore.kernel.org/linux-cifs \
		linux-cifs@vger.kernel.org
	public-inbox-index linux-cifs

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-cifs


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git