source: trunk/samba/docs/manpages/smbcquotas.1 @ 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: 6.5 KB
Line 
1.\"Generated by db2man.xsl. Don't modify this, modify the source.
2.de Sh \" Subsection
3.br
4.if t .Sp
5.ne 5
6.PP
7\fB\\$1\fR
8.PP
9..
10.de Sp \" Vertical space (when we can't use .PP)
11.if t .sp .5v
12.if n .sp
13..
14.de Ip \" List item
15.br
16.ie \\n(.$>=3 .ne \\$3
17.el .ne 3
18.IP "\\$1" \\$2
19..
20.TH "SMBCQUOTAS" 1 "" "" ""
21.SH NAME
22smbcquotas \- Set or get QUOTAs of NTFS 5 shares
23.SH "SYNOPSIS"
24.ad l
25.hy 0
26.HP 11
27\fBsmbcquotas\fR {//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]
28.ad
29.hy
30
31.SH "DESCRIPTION"
32
33.PP
34This tool is part of the \fBsamba\fR(7) suite\&.
35
36.PP
37The \fBsmbcquotas\fR program manipulates NT Quotas on SMB file shares\&.
38
39.SH "OPTIONS"
40
41.PP
42The following options are available to the \fBsmbcquotas\fR program\&.
43
44.TP
45\-u user
46Specifies the user of whom the quotas are get or set\&. By default the current user's username will be used\&.
47
48.TP
49\-L
50Lists all quota records of the share\&.
51
52.TP
53\-F
54Show the share quota status and default limits\&.
55
56.TP
57\-S QUOTA_SET_COMMAND
58This command sets/modifies quotas for a user or on the share, depending on the QUOTA_SET_COMMAND parameter which is described later\&.
59
60.TP
61\-n
62This option displays all QUOTA information in numeric format\&. The default is to convert SIDs to names and QUOTA limits to a readable string format\&.
63
64.TP
65\-t
66Don't actually do anything, only validate the correctness of the arguments\&.
67
68.TP
69\-v
70Be verbose\&.
71
72.TP
73\-h|\-\-help
74Print a summary of command line options\&.
75
76.TP
77\-V
78Prints the program version number\&.
79
80.TP
81\-s <configuration file>
82The file specified contains the configuration details required by the server\&. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See \fIsmb\&.conf\fR for more information\&. The default configuration file name is determined at compile time\&.
83
84.TP
85\-d|\-\-debuglevel=level
86\fIlevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
87
88The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
89
90Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
91
92Note that specifying this parameter here will override the  parameter in the \fIsmb\&.conf\fR file\&.
93
94.TP
95\-l|\-\-logfile=logdirectory
96Base directory name for log/debug files\&. The extension \fB"\&.progname"\fR will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
97
98.TP
99\-N
100If specified, this parameter suppresses the normal password prompt from the client to the user\&. This is useful when accessing a service that does not require a password\&.
101
102Unless a password is specified on the command line or this parameter is specified, the client will request a password\&.
103
104If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used\&.
105
106.TP
107\-k
108Try to authenticate with kerberos\&. Only useful in an Active Directory environment\&.
109
110.TP
111\-A|\-\-authentication\-file=filename
112This option allows you to specify a file from which to read the username and password used in the connection\&. The format of the file is
113
114
115
116.nf
117
118username = <value>
119password = <value>
120domain   = <value>
121
122.fi
123
124
125Make certain that the permissions on the file restrict access from unwanted users\&.
126
127.TP
128\-U|\-\-user=username[%password]
129Sets the SMB username or username and password\&.
130
131If %password is not specified, the user will be prompted\&. The client will first check the \fBUSER\fR environment variable, then the \fBLOGNAME\fR variable and if either exists, the string is uppercased\&. If these environmental variables are not found, the username \fBGUEST\fR is used\&.
132
133A third option is to use a credentials file which contains the plaintext of the username and password\&. This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables\&. If this method is used, make certain that the permissions on the file restrict access from unwanted users\&. See the \fI\-A\fR for more details\&.
134
135Be cautious about including passwords in scripts\&. Also, on many systems the command line of a running process may be seen via the \fBps\fR command\&. To be safe always allow \fBrpcclient\fR to prompt for a password and type it in directly\&.
136
137.SH "QUOTA_SET_COMAND"
138
139.PP
140The format of an the QUOTA_SET_COMMAND is an operation name followed by a set of parameters specific to that operation\&.
141
142.PP
143To set user quotas for the user specified by \-u or for the current username:
144
145.PP
146\fB UQLIM:<username>:<softlimit>/<hardlimit> \fR
147
148.PP
149To set the default quotas for a share:
150
151.PP
152\fB FSQLIM:<softlimit>/<hardlimit> \fR
153
154.PP
155To change the share quota settings:
156
157.PP
158\fB FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT \fR
159
160.PP
161All limits are specified as a number of bytes\&.
162
163.SH "EXIT STATUS"
164
165.PP
166The \fBsmbcquotas\fR 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\&.
167
168.PP
169If the operation succeeded, smbcquotas returns an exit status of 0\&. If \fBsmbcquotas\fR 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\&.
170
171.SH "VERSION"
172
173.PP
174This man page is correct for version 3\&.0 of the Samba suite\&.
175
176.SH "AUTHOR"
177
178.PP
179The 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\&.
180
181.PP
182\fBsmbcquotas\fR was written by Stefan Metzmacher\&.
183
Note: See TracBrowser for help on using the repository browser.