docs-xml: mention that the man pages are "part of" version x
[sfrench/samba-autobuild/.git] / docs-xml / manpages / smbcquotas.1.xml
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">&doc.version;</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">-m|--max-protocol LEVEL</arg>
38                 <arg choice="opt">-N</arg>
39                 <arg choice="opt">-k</arg>
40                 <arg choice="opt">-A</arg>
41
42
43         </cmdsynopsis>
44 </refsynopsisdiv>
45
46 <refsect1>
47         <title>DESCRIPTION</title>
48
49         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
50         <manvolnum>7</manvolnum></citerefentry> suite.</para>
51
52         <para>The <command>smbcquotas</command> program manipulates NT Quotas on SMB file shares. </para>
53 </refsect1>
54
55
56 <refsect1>
57         <title>OPTIONS</title>
58
59         <para>The following options are available to the <command>smbcquotas</command> program. </para>
60
61
62         <variablelist>
63                 <varlistentry>
64                 <term>-u|--user user</term>
65                 <listitem><para> Specifies the user of whom the quotas are get or set.
66                 By default the current user's username will be used.</para></listitem>
67                 </varlistentry>
68                 
69                 
70                 
71                 <varlistentry>
72                 <term>-L|--list</term>
73                 <listitem><para>Lists all quota records of the share.</para></listitem>
74                 </varlistentry>
75
76                 
77                 
78                 <varlistentry>
79                 <term>-F|--fs</term>
80                 <listitem><para>Show the share quota status and default limits.</para></listitem>
81                 </varlistentry>
82                 
83                 
84                 
85                 <varlistentry>
86                 <term>-S|--set QUOTA_SET_COMMAND</term>
87                 <listitem><para>This command sets/modifies quotas for a user or on the share,
88                 depending on the QUOTA_SET_COMMAND parameter which is described later.</para></listitem>
89                 </varlistentry>
90
91                 
92                 <varlistentry>
93                 <term>-n|--numeric</term>
94                 <listitem><para>This option displays all QUOTA information in numeric 
95                 format.  The default is to convert SIDs to names and QUOTA limits 
96                 to a readable string format.</para></listitem>
97                 </varlistentry>
98
99                 <varlistentry>
100                 <term>-m|--max-protocol PROTOCOL_NAME</term>
101                 <listitem><para>This allows the user to select the
102                 highest SMB protocol level that smbcquotas will use to
103                 connect to the server. By default this is set to
104                 NT1, which is the highest available SMB1 protocol.
105                 To connect using SMB2 or SMB3 protocol, use the
106                 strings SMB2 or SMB3 respectively.
107                 </para></listitem>
108                 </varlistentry>
109
110                 <varlistentry>
111                 <term>-t|--test-args</term>
112                 <listitem><para>
113                 Don't actually do anything, only validate the correctness of the arguments.
114                 </para></listitem>
115                 </varlistentry>
116
117                 <varlistentry>
118                 <term>-v|--verbose</term>
119                 <listitem><para>
120                 Be verbose.
121                 </para></listitem>
122                 </varlistentry>
123                                 
124
125                 &stdarg.server.debug;
126                 &popt.common.samba;
127                 &popt.common.credentials;
128                 &popt.autohelp;
129
130         </variablelist>
131 </refsect1>
132
133
134 <refsect1>
135         <title>QUOTA_SET_COMMAND</title>
136
137         <para>The format of an the QUOTA_SET_COMMAND is an operation
138         name followed by a set of parameters specific to that operation.
139         </para>
140
141         <para>To set user quotas for the user specified by -u or for the
142         current username: </para>
143
144         <para><userinput>
145         UQLIM:&lt;username&gt;:&lt;softlimit&gt;/&lt;hardlimit&gt;
146         </userinput></para>
147
148         <para>To set the default quotas for a share:
149         </para>
150
151         <para><userinput>
152         FSQLIM:&lt;softlimit&gt;/&lt;hardlimit&gt;
153         </userinput></para>
154
155         <para>
156         To change the share quota settings:
157         </para>
158
159         <para><userinput>
160         FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
161         </userinput></para>
162
163         <para>All limits are specified as a number of bytes.</para>
164 </refsect1>
165
166 <refsect1>
167         <title>EXIT STATUS</title>
168
169         <para>The <command>smbcquotas</command> program sets the exit status
170         depending on the success or otherwise of the operations performed.
171         The exit status may be one of the following values. </para>
172
173         <para>If the operation succeeded, smbcquotas returns an exit
174         status of 0.  If <command>smbcquotas</command> couldn't connect to the specified server,
175         or when there was an error getting or setting the quota(s), an exit status
176         of 1 is returned.  If there was an error parsing any command line
177         arguments, an exit status of 2 is returned. </para>
178 </refsect1>
179
180 <refsect1>
181         <title>VERSION</title>
182
183         <para>This man page is part of version &doc.version; of the Samba suite.</para>
184 </refsect1>
185
186 <refsect1>
187         <title>AUTHOR</title>
188
189         <para>The original Samba software and related utilities
190         were created by Andrew Tridgell. Samba is now developed
191         by the Samba Team as an Open Source project similar
192         to the way the Linux kernel is developed.</para>
193
194         <para><command>smbcquotas</command> was written by Stefan Metzmacher.</para>
195 </refsect1>
196
197 </refentry>