docs/docbook/manpages/smbcquotas.1.sgml

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