samba-mirror/docs-xml/manpages-3/smbcquotas.1.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smbcquotas.1">

<refmeta>
	<refentrytitle>smbcquotas</refentrytitle>
	<manvolnum>1</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">User Commands</refmiscinfo>
	<refmiscinfo class="version">3.6</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>smbcquotas</refname>
	<refpurpose>Set or get QUOTAs of NTFS 5 shares</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>smbcquotas</command>
		<arg choice="req">//server/share</arg>
		<arg choice="opt">-u user</arg>
		<arg choice="opt">-L</arg>
		<arg choice="opt">-F</arg>
		<arg choice="opt">-S QUOTA_SET_COMMAND</arg>
		<arg choice="opt">-n</arg>
		<arg choice="opt">-t</arg>
		<arg choice="opt">-v</arg>

		<arg choice="opt">-d debuglevel</arg>
		<arg choice="opt">-s configfile</arg>
		<arg choice="opt">-l logdir</arg>
		<arg choice="opt">-V</arg>

		<arg choice="opt">-U username</arg>
		<arg choice="opt">-N</arg>
		<arg choice="opt">-k</arg>
		<arg choice="opt">-A</arg>


	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para>The <command>smbcquotas</command> program manipulates NT Quotas on SMB file shares. </para>
</refsect1>


<refsect1>
	<title>OPTIONS</title>

	<para>The following options are available to the <command>smbcquotas</command> program. </para>


	<variablelist>
		<varlistentry>
		<term>-u user</term>
		<listitem><para> Specifies the user of whom the quotas are get or set.
		By default the current user's username will be used.</para></listitem>
		</varlistentry>
		
		
		
		<varlistentry>
		<term>-L</term>
		<listitem><para>Lists all quota records of the share.</para></listitem>
		</varlistentry>

		
		
		<varlistentry>
		<term>-F</term>
		<listitem><para>Show the share quota status and default limits.</para></listitem>
		</varlistentry>
		
		
		
		<varlistentry>
		<term>-S QUOTA_SET_COMMAND</term>
		<listitem><para>This command sets/modifies quotas for a user or on the share,
		depending on the QUOTA_SET_COMMAND parameter which is described later.</para></listitem>
		</varlistentry>

		
		<varlistentry>
		<term>-n</term>
		<listitem><para>This option displays all QUOTA information in numeric 
		format.  The default is to convert SIDs to names and QUOTA limits 
		to a readable string format.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>-t</term>
		<listitem><para>
		Don't actually do anything, only validate the correctness of the arguments.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>-v</term>
		<listitem><para>
		Be verbose.
		</para></listitem>
		</varlistentry>
				
		&stdarg.help;
		&stdarg.server.debug;
		&popt.common.samba;
		&popt.common.credentials;
	</variablelist>
</refsect1>


<refsect1>
	<title>QUOTA_SET_COMAND</title>

	<para>The format of an the QUOTA_SET_COMMAND is an operation
	name followed by a set of parameters specific to that operation.
	</para>

	<para>To set user quotas for the user specified by -u or for the
	current username: </para>

	<para><userinput>
	UQLIM:&lt;username&gt;:&lt;softlimit&gt;/&lt;hardlimit&gt;
	</userinput></para>

	<para>To set the default quotas for a share:
	</para>

	<para><userinput>
	FSQLIM:&lt;softlimit&gt;/&lt;hardlimit&gt;
	</userinput></para>

	<para>
	To change the share quota settings:
	</para>

	<para><userinput>
	FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
	</userinput></para>

	<para>All limits are specified as a number of bytes.</para>
</refsect1>

<refsect1>
	<title>EXIT STATUS</title>

	<para>The <command>smbcquotas</command> program sets the exit status
	depending on the success or otherwise of the operations performed.
	The exit status may be one of the following values. </para>

	<para>If the operation succeeded, smbcquotas returns an exit
	status of 0.  If <command>smbcquotas</command> couldn't connect to the specified server,
	or when there was an error getting or setting the quota(s), an exit status
	of 1 is returned.  If there was an error parsing any command line
	arguments, an exit status of 2 is returned. </para>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 3 of the Samba suite.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>

	<para>The original Samba software and related utilities
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar
	to the way the Linux kernel is developed.</para>

	<para><command>smbcquotas</command> was written by Stefan Metzmacher.</para>
</refsect1>

</refentry>