smb2quota.rst: Add man page for smb2quota.py
diff mbox series

Message ID 20190924050139.22007-1-kdsouza@redhat.com
State New
Headers show
Series
  • smb2quota.rst: Add man page for smb2quota.py
Related show

Commit Message

Kenneth Dsouza Sept. 24, 2019, 5:01 a.m. UTC
Signed-off-by: Kenneth D'souza <kdsouza@redhat.com>
---
 smb2quota.rst | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 smb2quota.rst

Patch
diff mbox series

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.