source: vendor/current/docs/manpages/smbcquotas.1

Last change on this file was 989, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.7

File size: 3.9 KB
Line 
1'\" t
2.\" Title: smbcquotas
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 10/25/2016
6.\" Manual: User Commands
7.\" Source: Samba 4.4
8.\" Language: English
9.\"
10.TH "SMBCQUOTAS" "1" "10/25/2016" "Samba 4\&.4" "User Commands"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31smbcquotas \- Set or get QUOTAs of NTFS 5 shares
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34smbcquotas {//server/share} [\-u|\-\-user\ user] [\-L|\-\-list] [\-F|\-\-fs] [\-S|\-\-set\ QUOTA_SET_COMMAND] [\-n|\-\-numeric] [\-t|\-\-test\-args] [\-v|\-\-verbose] [\-d\ debuglevel] [\-s\ configfile] [\-l\ logdir] [\-V] [\-U\ username] [\-N] [\-k] [\-A]
35.SH "DESCRIPTION"
36.PP
37This tool is part of the
38\fBsamba\fR(7)
39suite\&.
40.PP
41The
42smbcquotas
43program manipulates NT Quotas on SMB file shares\&.
44.SH "OPTIONS"
45.PP
46The following options are available to the
47smbcquotas
48program\&.
49.PP
50\-u|\-\-user user
51.RS 4
52Specifies the user of whom the quotas are get or set\&. By default the current user\*(Aqs username will be used\&.
53.RE
54.PP
55\-L|\-\-list
56.RS 4
57Lists all quota records of the share\&.
58.RE
59.PP
60\-F|\-\-fs
61.RS 4
62Show the share quota status and default limits\&.
63.RE
64.PP
65\-S|\-\-set QUOTA_SET_COMMAND
66.RS 4
67This command sets/modifies quotas for a user or on the share, depending on the QUOTA_SET_COMMAND parameter which is described later\&.
68.RE
69.PP
70\-n|\-\-numeric
71.RS 4
72This option displays all QUOTA information in numeric format\&. The default is to convert SIDs to names and QUOTA limits to a readable string format\&.
73.RE
74.PP
75\-t|\-\-test\-args
76.RS 4
77Don\*(Aqt actually do anything, only validate the correctness of the arguments\&.
78.RE
79.PP
80\-v|\-\-verbose
81.RS 4
82Be verbose\&.
83.RE
84.SH "QUOTA_SET_COMMAND"
85.PP
86The format of an the QUOTA_SET_COMMAND is an operation name followed by a set of parameters specific to that operation\&.
87.PP
88To set user quotas for the user specified by \-u or for the current username:
89.PP
90\fB UQLIM:<username>:<softlimit>/<hardlimit> \fR
91.PP
92To set the default quotas for a share:
93.PP
94\fB FSQLIM:<softlimit>/<hardlimit> \fR
95.PP
96To change the share quota settings:
97.PP
98\fB FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT \fR
99.PP
100All limits are specified as a number of bytes\&.
101.SH "EXIT STATUS"
102.PP
103The
104smbcquotas
105program sets the exit status depending on the success or otherwise of the operations performed\&. The exit status may be one of the following values\&.
106.PP
107If the operation succeeded, smbcquotas returns an exit status of 0\&. If
108smbcquotas
109couldn\*(Aqt connect to the specified server, or when there was an error getting or setting the quota(s), an exit status of 1 is returned\&. If there was an error parsing any command line arguments, an exit status of 2 is returned\&.
110.SH "VERSION"
111.PP
112This man page is correct for version 3 of the Samba suite\&.
113.SH "AUTHOR"
114.PP
115The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
116.PP
117smbcquotas
118was written by Stefan Metzmacher\&.
Note: See TracBrowser for help on using the repository browser.