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">4.0</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</arg>
  24                 <arg choice="opt">-L</arg>
  25                 <arg choice="opt">-F</arg>
  26                 <arg choice="opt">-S QUOTA_SET_COMMAND</arg>
  27                 <arg choice="opt">-n</arg>
  28                 <arg choice="opt">-t</arg>
  29                 <arg choice="opt">-v</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</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</term>
  72                 <listitem><para>Lists all quota records of the share.</para></listitem>
  73                 </varlistentry>
  74
  75
  76
  77                 <varlistentry>
  78                 <term>-F</term>
  79                 <listitem><para>Show the share quota status and default limits.</para></listitem>
  80                 </varlistentry>
  81
  82
  83
  84                 <varlistentry>
  85                 <term>-S 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</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</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</term>
 107                 <listitem><para>
 108                 Be verbose.
 109                 </para></listitem>
 110                 </varlistentry>
 111
 112                 &stdarg.help;
 113                 &stdarg.server.debug;
 114                 &popt.common.samba;
 115                 &popt.common.credentials;
 116         </variablelist>
 117 </refsect1>
 118
 119
 120 <refsect1>
 121         <title>QUOTA_SET_COMMAND</title>
 122
 123         <para>The format of an the QUOTA_SET_COMMAND is an operation
 124         name followed by a set of parameters specific to that operation.
 125         </para>
 126
 127         <para>To set user quotas for the user specified by -u or for the
 128         current username: </para>
 129
 130         <para><userinput>
 131         UQLIM:&lt;username&gt;:&lt;softlimit&gt;/&lt;hardlimit&gt;
 132         </userinput></para>
 133
 134         <para>To set the default quotas for a share:
 135         </para>
 136
 137         <para><userinput>
 138         FSQLIM:&lt;softlimit&gt;/&lt;hardlimit&gt;
 139         </userinput></para>
 140
 141         <para>
 142         To change the share quota settings:
 143         </para>
 144
 145         <para><userinput>
 146         FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
 147         </userinput></para>
 148
 149         <para>All limits are specified as a number of bytes.</para>
 150 </refsect1>
 151
 152 <refsect1>
 153         <title>EXIT STATUS</title>
 154
 155         <para>The <command>smbcquotas</command> program sets the exit status
 156         depending on the success or otherwise of the operations performed.
 157         The exit status may be one of the following values. </para>
 158
 159         <para>If the operation succeeded, smbcquotas returns an exit
 160         status of 0.  If <command>smbcquotas</command> couldn't connect to the specified server,
 161         or when there was an error getting or setting the quota(s), an exit status
 162         of 1 is returned.  If there was an error parsing any command line
 163         arguments, an exit status of 2 is returned. </para>
 164 </refsect1>
 165
 166 <refsect1>
 167         <title>VERSION</title>
 168
 169         <para>This man page is correct for version 3 of the Samba suite.</para>
 170 </refsect1>
 171
 172 <refsect1>
 173         <title>AUTHOR</title>
 174
 175         <para>The original Samba software and related utilities
 176         were created by Andrew Tridgell. Samba is now developed
 177         by the Samba Team as an Open Source project similar
 178         to the way the Linux kernel is developed.</para>
 179
 180         <para><command>smbcquotas</command> was written by Stefan Metzmacher.</para>
 181 </refsect1>
 182
 183 </refentry>