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