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|--quota-user=USER</arg>
  24                 <arg choice="opt">-L|--list</arg>
  25                 <arg choice="opt">-F|--fs</arg>
  26                 <arg choice="opt">-S|--set=SETSTRING</arg>
  27                 <arg choice="opt">-n|--numeric</arg>
  28                 <arg choice="opt">-v|--verbose</arg>
  29                 <arg choice="opt">-t|--test-args</arg>
  30                 <arg choice="opt">-?|--help</arg>
  31                 <arg choice="opt">--usage</arg>
  32                 <arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
  33                 <arg choice="opt">--debug-stdout</arg>
  34                 <arg choice="opt">--configfile=CONFIGFILE</arg>
  35                 <arg choice="opt">--option=name=value</arg>
  36                 <arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
  37                 <arg choice="opt">--leak-report</arg>
  38                 <arg choice="opt">--leak-report-full</arg>
  39                 <arg choice="opt">-R|--name-resolve=NAME-RESOLVE-ORDER</arg>
  40                 <arg choice="opt">-O|--socket-options=SOCKETOPTIONS</arg>
  41                 <arg choice="opt">-m|--max-protocol=MAXPROTOCOL</arg>
  42                 <arg choice="opt">-n|--netbiosname=NETBIOSNAME</arg>
  43                 <arg choice="opt">--netbios-scope=SCOPE</arg>
  44                 <arg choice="opt">-W|--workgroup=WORKGROUP</arg>
  45                 <arg choice="opt">--realm=REALM</arg>
  46                 <arg choice="opt">-U|--user=[DOMAIN/]USERNAME[%PASSWORD]</arg>
  47                 <arg choice="opt">-N|--no-pass</arg>
  48                 <arg choice="opt">--password=STRING</arg>
  49                 <arg choice="opt">--pw-nt-hash</arg>
  50                 <arg choice="opt">-A|--authentication-file=FILE</arg>
  51                 <arg choice="opt">-P|--machine-pass</arg>
  52                 <arg choice="opt">--simple-bind-dn=DN</arg>
  53                 <arg choice="opt">--use-kerberos=desired|required|off</arg>
  54                 <arg choice="opt">--use-krb5-ccache=CCACHE</arg>
  55                 <arg choice="opt">--use-winbind-ccache</arg>
  56                 <arg choice="opt">--client-protection=sign|encrypt|off</arg>
  57                 <arg choice="opt">-V|--version</arg>
  58         </cmdsynopsis>
  59 </refsynopsisdiv>
  60
  61 <refsect1>
  62         <title>DESCRIPTION</title>
  63
  64         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  65         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  66
  67         <para>The <command>smbcquotas</command> program manipulates NT Quotas on SMB file shares. </para>
  68 </refsect1>
  69
  70
  71 <refsect1>
  72         <title>OPTIONS</title>
  73
  74         <para>The following options are available to the <command>smbcquotas</command> program. </para>
  75
  76
  77         <variablelist>
  78                 <varlistentry>
  79                 <term>-u|--quota-user user</term>
  80                 <listitem><para> Specifies the user of whom the quotas are get or set.
  81                 By default the current user's username will be used.</para></listitem>
  82                 </varlistentry>
  83
  84
  85
  86                 <varlistentry>
  87                 <term>-L|--list</term>
  88                 <listitem><para>Lists all quota records of the share.</para></listitem>
  89                 </varlistentry>
  90
  91
  92
  93                 <varlistentry>
  94                 <term>-F|--fs</term>
  95                 <listitem><para>Show the share quota status and default limits.</para></listitem>
  96                 </varlistentry>
  97
  98
  99
 100                 <varlistentry>
 101                 <term>-S|--set QUOTA_SET_COMMAND</term>
 102                 <listitem><para>This command sets/modifies quotas for a user or on the share,
 103                 depending on the QUOTA_SET_COMMAND parameter which is described later.</para></listitem>
 104                 </varlistentry>
 105
 106
 107                 <varlistentry>
 108                 <term>-n|--numeric</term>
 109                 <listitem><para>This option displays all QUOTA information in numeric
 110                 format.  The default is to convert SIDs to names and QUOTA limits
 111                 to a readable string format.</para></listitem>
 112                 </varlistentry>
 113
 114                 <varlistentry>
 115                 <term>-t|--test-args</term>
 116                 <listitem><para>
 117                 Don't actually do anything, only validate the correctness of the arguments.
 118                 </para></listitem>
 119                 </varlistentry>
 120
 121                 <varlistentry>
 122                 <term>-v|--verbose</term>
 123                 <listitem><para>
 124                 Be verbose.
 125                 </para></listitem>
 126                 </varlistentry>
 127
 128                 &popt.autohelp;
 129                 &cmdline.common.samba.client;
 130                 &cmdline.common.connection;
 131                 &cmdline.common.credentials;
 132         </variablelist>
 133 </refsect1>
 134
 135
 136 <refsect1>
 137         <title>QUOTA_SET_COMMAND</title>
 138
 139         <para>The format of an the QUOTA_SET_COMMAND is an operation
 140         name followed by a set of parameters specific to that operation.
 141         </para>
 142
 143         <para>To set user quotas for the user specified by -u or for the
 144         current username: </para>
 145
 146         <para><userinput>
 147         UQLIM:&lt;username&gt;:&lt;softlimit&gt;/&lt;hardlimit&gt;
 148         </userinput></para>
 149
 150         <para>To set the default quotas for a share:
 151         </para>
 152
 153         <para><userinput>
 154         FSQLIM:&lt;softlimit&gt;/&lt;hardlimit&gt;
 155         </userinput></para>
 156
 157         <para>
 158         To change the share quota settings:
 159         </para>
 160
 161         <para><userinput>
 162         FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
 163         </userinput></para>
 164
 165         <para>All limits are specified as a number of bytes.</para>
 166 </refsect1>
 167
 168 <refsect1>
 169         <title>EXIT STATUS</title>
 170
 171         <para>The <command>smbcquotas</command> program sets the exit status
 172         depending on the success or otherwise of the operations performed.
 173         The exit status may be one of the following values. </para>
 174
 175         <para>If the operation succeeded, smbcquotas returns an exit
 176         status of 0.  If <command>smbcquotas</command> couldn't connect to the specified server,
 177         or when there was an error getting or setting the quota(s), an exit status
 178         of 1 is returned.  If there was an error parsing any command line
 179         arguments, an exit status of 2 is returned. </para>
 180 </refsect1>
 181
 182 <refsect1>
 183         <title>VERSION</title>
 184
 185         <para>This man page is part of version &doc.version; of the Samba suite.</para>
 186 </refsect1>
 187
 188 <refsect1>
 189         <title>AUTHOR</title>
 190
 191         <para>The original Samba software and related utilities
 192         were created by Andrew Tridgell. Samba is now developed
 193         by the Samba Team as an Open Source project similar
 194         to the way the Linux kernel is developed.</para>
 195
 196         <para><command>smbcquotas</command> was written by Stefan Metzmacher.</para>
 197 </refsect1>
 198
 199 </refentry>