docs/docbook/manpages/smbcquotas.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   3
   4 <!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
   5 ]>
   6 <refentry id="smbcquotas.1">
   7
   8 <refmeta>
   9         <refentrytitle>smbcquotas</refentrytitle>
  10         <manvolnum>1</manvolnum>
  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 logfilebase</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 set/modify quotas for a user or on the share,
  87                 depending on the QUOTA_SET_COMMAND parameter witch 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
 102                 the arguments.
 103                 </para></listitem>
 104                 </varlistentry>
 105
 106                 <varlistentry>
 107                 <term>-v</term>
 108                 <listitem><para>
 109                 Be verbose.
 110                 </para></listitem>
 111                 </varlistentry>
 112
 113                 &stdarg.help;
 114                 &popt.common.samba;
 115                 &popt.common.credentials;
 116         </variablelist>
 117 </refsect1>
 118
 119
 120 <refsect1>
 121         <title>QUOTA_SET_COMAND</title>
 122
 123         <para>The format of an ACL is one or more ACL entries separated by
 124         either commas or newlines.  An ACL entry is one of the following: </para>
 125
 126         <para>
 127         for user setting quotas for the specified by -u or the current username:
 128         </para>
 129
 130         <para><userinput>
 131         UQLIM:&lt;username&gt;&lt;softlimit&gt;&lt;hardlimit&gt;
 132         </userinput></para>
 133
 134         <para>
 135         for setting the share quota defaults limits:
 136         </para>
 137
 138         <para><userinput>
 139         FSQLIM:&lt;softlimit&gt;&lt;hardlimit&gt;
 140         </userinput></para>
 141
 142         <para>
 143         for changing the share quota settings:
 144         </para>
 145
 146         <para><userinput>
 147         FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
 148         </userinput></para>
 149 </refsect1>
 150
 151 <refsect1>
 152         <title>EXIT STATUS</title>
 153
 154         <para>The <command>smbcquotas</command> program sets the exit status
 155         depending on the success or otherwise of the operations performed.
 156         The exit status may be one of the following values. </para>
 157
 158         <para>If the operation succeeded, smbcquotas returns an exit
 159         status of 0.  If <command>smbcquotas</command> couldn't connect to the specified server,
 160         or when there was an error getting or setting the quota(s), an exit status
 161         of 1 is returned.  If there was an error parsing any command line
 162         arguments, an exit status of 2 is returned. </para>
 163 </refsect1>
 164
 165 <refsect1>
 166         <title>VERSION</title>
 167
 168         <para>This man page is correct for version 3.0 of the Samba suite.</para>
 169 </refsect1>
 170
 171 <refsect1>
 172         <title>AUTHOR</title>
 173
 174         <para>The original Samba software and related utilities
 175         were created by Andrew Tridgell. Samba is now developed
 176         by the Samba Team as an Open Source project similar
 177         to the way the Linux kernel is developed.</para>
 178
 179         <para><command>smbcquotas</command> was written by Stefan Metzmacher.</para>
 180 </refsect1>
 181
 182 </refentry>