source: trunk/samba/docs/htmldocs/manpages/smbcquotas.1.html @ 26

Last change on this file since 26 was 26, checked in by Paul Smedley, 14 years ago

Updated source to 3.0.25rc1

File size: 8.4 KB
Line 
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbcquotas</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbcquotas.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbcquotas &#8212; Set or get QUOTAs of NTFS 5 shares</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">smbcquotas</code>  {//server/share} [-u user] [-L] [-F] [-S QUOTA_SET_COMMAND] [-n] [-t] [-v] [-d debuglevel] [-s configfile] [-l logdir] [-V] [-U username] [-N] [-k] [-A]</p></div></div><div class="refsect1" lang="en"><a name="id231408"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <span><strong class="command">smbcquotas</strong></span> program manipulates NT Quotas on SMB file shares. </p></div><div class="refsect1" lang="en"><a name="id231435"></a><h2>OPTIONS</h2><p>The following options are available to the <span><strong class="command">smbcquotas</strong></span> program. </p><div class="variablelist"><dl><dt><span class="term">-u user</span></dt><dd><p> Specifies the user of whom the quotas are get or set.
2                By default the current user's username will be used.</p></dd><dt><span class="term">-L</span></dt><dd><p>Lists all quota records of the share.</p></dd><dt><span class="term">-F</span></dt><dd><p>Show the share quota status and default limits.</p></dd><dt><span class="term">-S QUOTA_SET_COMMAND</span></dt><dd><p>This command sets/modifies quotas for a user or on the share,
3                depending on the QUOTA_SET_COMMAND parameter which is described later.</p></dd><dt><span class="term">-n</span></dt><dd><p>This option displays all QUOTA information in numeric
4                format.  The default is to convert SIDs to names and QUOTA limits
5                to a readable string format.</p></dd><dt><span class="term">-t</span></dt><dd><p>
6                Don't actually do anything, only validate the correctness of the arguments.
7                </p></dd><dt><span class="term">-v</span></dt><dd><p>
8                Be verbose.
9                </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
10</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number.
11</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
12configuration details required by the server.  The
13information in this file includes server-specific
14information such as what printcap file to use, as well
15as descriptions of all the services that the server is
16to provide. See <code class="filename">smb.conf</code> for more information.
17The default configuration file name is determined at
18compile time.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer
19from 0 to 10.  The default value if this parameter is
20not specified is zero.</p><p>The higher this value, the more detail will be
21logged to the log files about the activities of the
22server. At level 0, only critical errors and serious
23warnings will be logged. Level 1 is a reasonable level for
24day-to-day running - it generates a small amount of
25information about operations carried out.</p><p>Levels above 1 will generate considerable
26amounts of log data, and should only be used when
27investigating a problem. Levels above 3 are designed for
28use only by developers and generate HUGE amounts of log
29data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
30override the <a class="indexterm" name="id230549"></a> parameter
31in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-l|--logfile=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension
32<code class="constant">".progname"</code> will be appended (e.g. log.smbclient,
33log.smbd, etc...). The log file is never removed by the client.
34</p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal
35password prompt from the client to the user. This is useful when
36accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or
37this parameter is specified, the client will request a
38password.</p><p>If a password is specified on the command line and this
39option is also defined the password on the command line will
40be silently ingnored and no password will be used.</p></dd><dt><span class="term">-k</span></dt><dd><p>
41Try to authenticate with kerberos. Only useful in
42an Active Directory environment.
43</p></dd><dt><span class="term">-A|--authentication-file=filename</span></dt><dd><p>This option allows
44you to specify a file from which to read the username and
45password used in the connection.  The format of the file is
46</p><pre class="programlisting">
47username = &lt;value&gt;
48password = &lt;value&gt;
49domain   = &lt;value&gt;
50</pre><p>Make certain that the permissions on the file restrict
51access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The
52client will first check the <code class="envar">USER</code> environment variable, then the
53<code class="envar">LOGNAME</code> variable and if either exists, the
54string is uppercased. If these environmental variables are not
55found, the username <code class="constant">GUEST</code> is used. </p><p>A third option is to use a credentials file which
56contains the plaintext of the username and password.  This
57option is mainly provided for scripts where the admin does not
58wish to pass the credentials on the command line or via environment
59variables. If this method is used, make certain that the permissions
60on the file restrict access from unwanted users.  See the
61<em class="parameter"><code>-A</code></em> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
62many systems the command line of a running process may be seen
63via the <span><strong class="command">ps</strong></span> command.  To be safe always allow
64<span><strong class="command">rpcclient</strong></span> to prompt for a password and type
65it in directly. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id271793"></a><h2>QUOTA_SET_COMAND</h2><p>The format of an the QUOTA_SET_COMMAND is an operation
66        name followed by a set of parameters specific to that operation.
67        </p><p>To set user quotas for the user specified by -u or for the
68        current username: </p><p><strong class="userinput"><code>
69        UQLIM:&lt;username&gt;:&lt;softlimit&gt;/&lt;hardlimit&gt;
70        </code></strong></p><p>To set the default quotas for a share:
71        </p><p><strong class="userinput"><code>
72        FSQLIM:&lt;softlimit&gt;/&lt;hardlimit&gt;
73        </code></strong></p><p>
74        To change the share quota settings:
75        </p><p><strong class="userinput"><code>
76        FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
77        </code></strong></p><p>All limits are specified as a number of bytes.</p></div><div class="refsect1" lang="en"><a name="id271841"></a><h2>EXIT STATUS</h2><p>The <span><strong class="command">smbcquotas</strong></span> program sets the exit status
78        depending on the success or otherwise of the operations performed.
79        The exit status may be one of the following values. </p><p>If the operation succeeded, smbcquotas returns an exit
80        status of 0.  If <span><strong class="command">smbcquotas</strong></span> couldn't connect to the specified server,
81        or when there was an error getting or setting the quota(s), an exit status
82        of 1 is returned.  If there was an error parsing any command line
83        arguments, an exit status of 2 is returned. </p></div><div class="refsect1" lang="en"><a name="id271870"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id271880"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
84        were created by Andrew Tridgell. Samba is now developed
85        by the Samba Team as an Open Source project similar
86        to the way the Linux kernel is developed.</p><p><span><strong class="command">smbcquotas</strong></span> was written by Stefan Metzmacher.</p></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.