docs/docbook/manpages/smbcquotas.1.xml

   1 <?xml version="1.0" encoding="iso8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3                   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4
   5 <!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
   6 ]>
   7 <refentry id="smbcquotas.1">
   8
   9 <refmeta>
  10         <refentrytitle>smbcquotas</refentrytitle>
  11         <manvolnum>1</manvolnum>
  12 </refmeta>
  13
  14
  15 <refnamediv>
  16         <refname>smbcquotas</refname>
  17         <refpurpose>Set or get QUOTAs of NTFS 5 shares</refpurpose>
  18 </refnamediv>
  19
  20 <refsynopsisdiv>
  21         <cmdsynopsis>
  22                 <command>smbcquotas</command>
  23                 <arg choice="req">//server/share</arg>
  24                 <arg choice="opt">-u user</arg>
  25                 <arg choice="opt">-L</arg>
  26                 <arg choice="opt">-F</arg>
  27                 <arg choice="opt">-S QUOTA_SET_COMMAND</arg>
  28                 <arg choice="opt">-n</arg>
  29                 <arg choice="opt">-t</arg>
  30                 <arg choice="opt">-v</arg>
  31
  32                 <arg choice="opt">-d debuglevel</arg>
  33                 <arg choice="opt">-s configfile</arg>
  34                 <arg choice="opt">-l logfilebase</arg>
  35                 <arg choice="opt">-V</arg>
  36
  37                 <arg choice="opt">-U username</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</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</term>
  73                 <listitem><para>Lists all quota records of the share.</para></listitem>
  74                 </varlistentry>
  75
  76
  77
  78                 <varlistentry>
  79                 <term>-F</term>
  80                 <listitem><para>Show the share quota status and default limits.</para></listitem>
  81                 </varlistentry>
  82
  83
  84
  85                 <varlistentry>
  86                 <term>-S QUOTA_SET_COMMAND</term>
  87                 <listitem><para>This command set/modify quotas for a user or on the share,
  88                 depending on the QUOTA_SET_COMMAND parameter witch is described later</para></listitem>
  89                 </varlistentry>
  90
  91
  92                 <varlistentry>
  93                 <term>-n</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>-t</term>
 101                 <listitem><para>
 102                 Don't actually do anything, only validate the correctness of
 103                 the arguments.
 104                 </para></listitem>
 105                 </varlistentry>
 106
 107                 <varlistentry>
 108                 <term>-v</term>
 109                 <listitem><para>
 110                 Be verbose.
 111                 </para></listitem>
 112                 </varlistentry>
 113
 114                 &stdarg.help;
 115                 &popt.common.samba;
 116                 &popt.common.credentials;
 117         </variablelist>
 118 </refsect1>
 119
 120
 121 <refsect1>
 122         <title>QUOTA_SET_COMAND</title>
 123
 124         <para>The format of an ACL is one or more ACL entries separated by
 125         either commas or newlines.  An ACL entry is one of the following: </para>
 126
 127         <para>
 128         for user setting quotas for the specified by -u or the current username:
 129         </para>
 130
 131         <para><userinput>
 132         UQLIM:&lt;username&gt;&lt;softlimit&gt;&lt;hardlimit&gt;
 133         </userinput></para>
 134
 135         <para>
 136         for setting the share quota defaults limits:
 137         </para>
 138
 139         <para><userinput>
 140         FSQLIM:&lt;softlimit&gt;&lt;hardlimit&gt;
 141         </userinput></para>
 142
 143         <para>
 144         for changing the share quota settings:
 145         </para>
 146
 147         <para><userinput>
 148         FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
 149         </userinput></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.0 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>smbcacls</command> was written by Stefan Metzmacher.</para>
 181 </refsect1>
 182
 183 </refentry>