summaryrefslogtreecommitdiffstats
path: root/docs-xml/manpages/smbcquotas.1.xml
blob: b5ce53ce31bef986007b9b56bf9d5a4e9bd9fbe0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smbcquotas.1">

<refmeta>
	<refentrytitle>smbcquotas</refentrytitle>
	<manvolnum>1</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">User Commands</refmiscinfo>
	<refmiscinfo class="version">&doc.version;</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>smbcquotas</refname>
	<refpurpose>Set or get QUOTAs of NTFS 5 shares</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>smbcquotas</command>
		<arg choice="req">//server/share</arg>
		<arg choice="opt">-u|--quota-user=USER</arg>
		<arg choice="opt">-L|--list</arg>
		<arg choice="opt">-F|--fs</arg>
		<arg choice="opt">-S|--set=SETSTRING</arg>
		<arg choice="opt">-n|--numeric</arg>
		<arg choice="opt">-v|--verbose</arg>
		<arg choice="opt">-t|--test-args</arg>
		<arg choice="opt">-?|--help</arg>
		<arg choice="opt">--usage</arg>
		<arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
		<arg choice="opt">--debug-stdout</arg>
		<arg choice="opt">--configfile=CONFIGFILE</arg>
		<arg choice="opt">--option=name=value</arg>
		<arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
		<arg choice="opt">--leak-report</arg>
		<arg choice="opt">--leak-report-full</arg>
		<arg choice="opt">-R|--name-resolve=NAME-RESOLVE-ORDER</arg>
		<arg choice="opt">-O|--socket-options=SOCKETOPTIONS</arg>
		<arg choice="opt">-m|--max-protocol=MAXPROTOCOL</arg>
		<arg choice="opt">-n|--netbiosname=NETBIOSNAME</arg>
		<arg choice="opt">--netbios-scope=SCOPE</arg>
		<arg choice="opt">-W|--workgroup=WORKGROUP</arg>
		<arg choice="opt">--realm=REALM</arg>
		<arg choice="opt">-U|--user=[DOMAIN/]USERNAME[%PASSWORD]</arg>
		<arg choice="opt">-N|--no-pass</arg>
		<arg choice="opt">--password=STRING</arg>
		<arg choice="opt">--pw-nt-hash</arg>
		<arg choice="opt">-A|--authentication-file=FILE</arg>
		<arg choice="opt">-P|--machine-pass</arg>
		<arg choice="opt">--simple-bind-dn=DN</arg>
		<arg choice="opt">--use-kerberos=desired|required|off</arg>
		<arg choice="opt">--use-krb5-ccache=CCACHE</arg>
		<arg choice="opt">--use-winbind-ccache</arg>
		<arg choice="opt">--client-protection=sign|encrypt|off</arg>
		<arg choice="opt">-V|--version</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para>The <command>smbcquotas</command> program manipulates NT Quotas on SMB file shares. </para>
</refsect1>


<refsect1>
	<title>OPTIONS</title>

	<para>The following options are available to the <command>smbcquotas</command> program. </para>


	<variablelist>
		<varlistentry>
		<term>-u|--quota-user user</term>
		<listitem><para> Specifies the user of whom the quotas are get or set.
		By default the current user's username will be used.</para></listitem>
		</varlistentry>
		
		
		
		<varlistentry>
		<term>-L|--list</term>
		<listitem><para>Lists all quota records of the share.</para></listitem>
		</varlistentry>

		
		
		<varlistentry>
		<term>-F|--fs</term>
		<listitem><para>Show the share quota status and default limits.</para></listitem>
		</varlistentry>
		
		
		
		<varlistentry>
		<term>-S|--set QUOTA_SET_COMMAND</term>
		<listitem><para>This command sets/modifies quotas for a user or on the share,
		depending on the QUOTA_SET_COMMAND parameter which is described later.</para></listitem>
		</varlistentry>

		
		<varlistentry>
		<term>-n|--numeric</term>
		<listitem><para>This option displays all QUOTA information in numeric 
		format.  The default is to convert SIDs to names and QUOTA limits 
		to a readable string format.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>-t|--test-args</term>
		<listitem><para>
		Don't actually do anything, only validate the correctness of the arguments.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>-v|--verbose</term>
		<listitem><para>
		Be verbose.
		</para></listitem>
		</varlistentry>

		&popt.autohelp;
		&cmdline.common.samba.client;
		&cmdline.common.connection;
		&cmdline.common.credentials;
	</variablelist>
</refsect1>


<refsect1>
	<title>QUOTA_SET_COMMAND</title>

	<para>The format of an the QUOTA_SET_COMMAND is an operation
	name followed by a set of parameters specific to that operation.
	</para>

	<para>To set user quotas for the user specified by -u or for the
	current username: </para>

	<para><userinput>
	UQLIM:&lt;username&gt;:&lt;softlimit&gt;/&lt;hardlimit&gt;
	</userinput></para>

	<para>To set the default quotas for a share:
	</para>

	<para><userinput>
	FSQLIM:&lt;softlimit&gt;/&lt;hardlimit&gt;
	</userinput></para>

	<para>
	To change the share quota settings:
	</para>

	<para><userinput>
	FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
	</userinput></para>

	<para>All limits are specified as a number of bytes.</para>
</refsect1>

<refsect1>
	<title>EXIT STATUS</title>

	<para>The <command>smbcquotas</command> program sets the exit status
	depending on the success or otherwise of the operations performed.
	The exit status may be one of the following values. </para>

	<para>If the operation succeeded, smbcquotas returns an exit
	status of 0.  If <command>smbcquotas</command> couldn't 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. </para>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is part of version &doc.version; of the Samba suite.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>

	<para>The 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.</para>

	<para><command>smbcquotas</command> was written by Stefan Metzmacher.</para>
</refsect1>

</refentry>