summaryrefslogtreecommitdiff
path: root/docs/manpages/smbcquotas.1.xml
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2004-04-07 10:15:11 +0000
committerGerald W. Carter <jerry@samba.org>2008-04-23 08:45:43 -0500
commit992f1e6b8f86b346fddd266b04d29cde69585633 (patch)
tree878573999a6831aa14cd6b8072263eb5d5910aa4 /docs/manpages/smbcquotas.1.xml
parent65c0fd59203a3d9c4cb685e3a739f29f6f0c4fd6 (diff)
downloadsamba-992f1e6b8f86b346fddd266b04d29cde69585633.tar.gz
samba-992f1e6b8f86b346fddd266b04d29cde69585633.tar.bz2
samba-992f1e6b8f86b346fddd266b04d29cde69585633.zip
Add all the source files from the old CVS tree,
add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
Diffstat (limited to 'docs/manpages/smbcquotas.1.xml')
-rw-r--r--docs/manpages/smbcquotas.1.xml181
1 files changed, 181 insertions, 0 deletions
diff --git a/docs/manpages/smbcquotas.1.xml b/docs/manpages/smbcquotas.1.xml
new file mode 100644
index 0000000000..280d1b6364
--- /dev/null
+++ b/docs/manpages/smbcquotas.1.xml
@@ -0,0 +1,181 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
+<refentry id="smbcquotas.1">
+
+<refmeta>
+ <refentrytitle>smbcquotas</refentrytitle>
+ <manvolnum>1</manvolnum>
+</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;
+ &popt.common.samba;
+ &popt.common.credentials;
+ </variablelist>
+</refsect1>
+
+
+<refsect1>
+ <title>QUOTA_SET_COMAND</title>
+
+ <para>The format of an ACL is one or more ACL entries separated by
+ either commas or newlines. An ACL entry is one of the following: </para>
+
+ <para>
+ for setting user quotas for the user specified by -u or the current username:
+ </para>
+
+ <para><userinput>
+ UQLIM:&lt;username&gt;:&lt;softlimit&gt;/&lt;hardlimit&gt;
+ </userinput></para>
+
+ <para>
+ for setting the default quotas for a share:
+ </para>
+
+ <para><userinput>
+ FSQLIM:&lt;softlimit&gt;/&lt;hardlimit&gt;
+ </userinput></para>
+
+ <para>
+ for changing the share quota settings:
+ </para>
+
+ <para><userinput>
+ FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
+ </userinput></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.0 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>