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

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

Samba Server: update vendor to version 4.4.3
File size: 4.9 KB
Line 
1<?xml version="1.0" encoding="iso-8859-1"?>
2<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3<refentry id="smbcquotas.1">
4
5<refmeta>
6 <refentrytitle>smbcquotas</refentrytitle>
7 <manvolnum>1</manvolnum>
8 <refmiscinfo class="source">Samba</refmiscinfo>
9 <refmiscinfo class="manual">User Commands</refmiscinfo>
10 <refmiscinfo class="version">4.4</refmiscinfo>
11</refmeta>
12
13
14<refnamediv>
15 <refname>smbcquotas</refname>
16 <refpurpose>Set or get QUOTAs of NTFS 5 shares</refpurpose>
17</refnamediv>
18
19<refsynopsisdiv>
20 <cmdsynopsis>
21 <command>smbcquotas</command>
22 <arg choice="req">//server/share</arg>
23 <arg choice="opt">-u|--user user</arg>
24 <arg choice="opt">-L|--list</arg>
25 <arg choice="opt">-F|--fs</arg>
26 <arg choice="opt">-S|--set QUOTA_SET_COMMAND</arg>
27 <arg choice="opt">-n|--numeric</arg>
28 <arg choice="opt">-t|--test-args</arg>
29 <arg choice="opt">-v|--verbose</arg>
30
31 <arg choice="opt">-d debuglevel</arg>
32 <arg choice="opt">-s configfile</arg>
33 <arg choice="opt">-l logdir</arg>
34 <arg choice="opt">-V</arg>
35
36 <arg choice="opt">-U username</arg>
37 <arg choice="opt">-N</arg>
38 <arg choice="opt">-k</arg>
39 <arg choice="opt">-A</arg>
40
41
42 </cmdsynopsis>
43</refsynopsisdiv>
44
45<refsect1>
46 <title>DESCRIPTION</title>
47
48 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
49 <manvolnum>7</manvolnum></citerefentry> suite.</para>
50
51 <para>The <command>smbcquotas</command> program manipulates NT Quotas on SMB file shares. </para>
52</refsect1>
53
54
55<refsect1>
56 <title>OPTIONS</title>
57
58 <para>The following options are available to the <command>smbcquotas</command> program. </para>
59
60
61 <variablelist>
62 <varlistentry>
63 <term>-u|--user user</term>
64 <listitem><para> Specifies the user of whom the quotas are get or set.
65 By default the current user's username will be used.</para></listitem>
66 </varlistentry>
67
68
69
70 <varlistentry>
71 <term>-L|--list</term>
72 <listitem><para>Lists all quota records of the share.</para></listitem>
73 </varlistentry>
74
75
76
77 <varlistentry>
78 <term>-F|--fs</term>
79 <listitem><para>Show the share quota status and default limits.</para></listitem>
80 </varlistentry>
81
82
83
84 <varlistentry>
85 <term>-S|--set QUOTA_SET_COMMAND</term>
86 <listitem><para>This command sets/modifies quotas for a user or on the share,
87 depending on the QUOTA_SET_COMMAND parameter which is described later.</para></listitem>
88 </varlistentry>
89
90
91 <varlistentry>
92 <term>-n|--numeric</term>
93 <listitem><para>This option displays all QUOTA information in numeric
94 format. The default is to convert SIDs to names and QUOTA limits
95 to a readable string format.</para></listitem>
96 </varlistentry>
97
98 <varlistentry>
99 <term>-t|--test-args</term>
100 <listitem><para>
101 Don't actually do anything, only validate the correctness of the arguments.
102 </para></listitem>
103 </varlistentry>
104
105 <varlistentry>
106 <term>-v|--verbose</term>
107 <listitem><para>
108 Be verbose.
109 </para></listitem>
110 </varlistentry>
111
112
113 &stdarg.server.debug;
114 &popt.common.samba;
115 &popt.common.credentials;
116 &popt.autohelp;
117
118 </variablelist>
119</refsect1>
120
121
122<refsect1>
123 <title>QUOTA_SET_COMMAND</title>
124
125 <para>The format of an the QUOTA_SET_COMMAND is an operation
126 name followed by a set of parameters specific to that operation.
127 </para>
128
129 <para>To set user quotas for the user specified by -u or for the
130 current username: </para>
131
132 <para><userinput>
133 UQLIM:&lt;username&gt;:&lt;softlimit&gt;/&lt;hardlimit&gt;
134 </userinput></para>
135
136 <para>To set the default quotas for a share:
137 </para>
138
139 <para><userinput>
140 FSQLIM:&lt;softlimit&gt;/&lt;hardlimit&gt;
141 </userinput></para>
142
143 <para>
144 To change the share quota settings:
145 </para>
146
147 <para><userinput>
148 FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
149 </userinput></para>
150
151 <para>All limits are specified as a number of bytes.</para>
152</refsect1>
153
154<refsect1>
155 <title>EXIT STATUS</title>
156
157 <para>The <command>smbcquotas</command> program sets the exit status
158 depending on the success or otherwise of the operations performed.
159 The exit status may be one of the following values. </para>
160
161 <para>If the operation succeeded, smbcquotas returns an exit
162 status of 0. If <command>smbcquotas</command> couldn't connect to the specified server,
163 or when there was an error getting or setting the quota(s), an exit status
164 of 1 is returned. If there was an error parsing any command line
165 arguments, an exit status of 2 is returned. </para>
166</refsect1>
167
168<refsect1>
169 <title>VERSION</title>
170
171 <para>This man page is correct for version 3 of the Samba suite.</para>
172</refsect1>
173
174<refsect1>
175 <title>AUTHOR</title>
176
177 <para>The original Samba software and related utilities
178 were created by Andrew Tridgell. Samba is now developed
179 by the Samba Team as an Open Source project similar
180 to the way the Linux kernel is developed.</para>
181
182 <para><command>smbcquotas</command> was written by Stefan Metzmacher.</para>
183</refsect1>
184
185</refentry>
Note: See TracBrowser for help on using the repository browser.