Changeset 134 for branches/samba-3.0/docs/manpages/smbcquotas.1
- Timestamp:
- May 23, 2008, 6:56:41 AM (17 years ago)
- File:
-
- 1 edited
-
branches/samba-3.0/docs/manpages/smbcquotas.1 (modified) (2 diffs)
Legend:
- Unmodified
- Added
- Removed
-
branches/samba-3.0/docs/manpages/smbcquotas.1
r44 r134 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 "" "" "" 1 .\" Title: smbcquotas 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBCQUOTAS" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbcquotas - Set or get QUOTAs of NTFS 5 shares 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbcquotas {//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]17 smbcquotas {//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] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 smbcquotas 34 program manipulates NT Quotas on SMB file shares .26 program manipulates NT Quotas on SMB file shares\. 35 27 .SH "OPTIONS" 36 28 .PP 37 29 The following options are available to the 38 30 smbcquotas 39 program .31 program\. 40 32 .PP 41 -u user42 .RS 3n43 Specifies the user of whom the quotas are get or set . By default the current user's username will be used.33 \-u user 34 .RS 4 35 Specifies the user of whom the quotas are get or set\. By default the current user\'s username will be used\. 44 36 .RE 45 37 .PP 46 -L47 .RS 3n48 Lists all quota records of the share .38 \-L 39 .RS 4 40 Lists all quota records of the share\. 49 41 .RE 50 42 .PP 51 -F52 .RS 3n53 Show the share quota status and default limits .43 \-F 44 .RS 4 45 Show the share quota status and default limits\. 54 46 .RE 55 47 .PP 56 -S QUOTA_SET_COMMAND57 .RS 3n58 This command sets/modifies quotas for a user or on the share, depending on the QUOTA_SET_COMMAND parameter which is described later .48 \-S QUOTA_SET_COMMAND 49 .RS 4 50 This command sets/modifies quotas for a user or on the share, depending on the QUOTA_SET_COMMAND parameter which is described later\. 59 51 .RE 60 52 .PP 61 -n62 .RS 3n63 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.53 \-n 54 .RS 4 55 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\. 64 56 .RE 65 57 .PP 66 -t67 .RS 3n68 Don 't actually do anything, only validate the correctness of the arguments.58 \-t 59 .RS 4 60 Don\'t actually do anything, only validate the correctness of the arguments\. 69 61 .RE 70 62 .PP 71 -v72 .RS 3n73 Be verbose .63 \-v 64 .RS 4 65 Be verbose\. 74 66 .RE 75 67 .PP 76 -h|--help77 .RS 3n78 Print a summary of command line options .68 \-h|\-\-help 69 .RS 4 70 Print a summary of command line options\. 79 71 .RE 80 72 .PP 81 -V 82 .RS 3n 83 Prints the program version number. 73 \-d|\-\-debuglevel=level 74 .RS 4 75 \fIlevel\fR 76 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 77 .sp 78 The 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\. 79 .sp 80 Levels 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\. 81 .sp 82 Note that specifying this parameter here will override the 83 \fIlog level\fR 84 parameter in the 85 \fIsmb\.conf\fR 86 file\. 84 87 .RE 85 88 .PP 86 -s <configuration file> 87 .RS 3n 88 The 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 89 \fIsmb.conf\fR 90 for more information. The default configuration file name is determined at compile time. 89 \-V 90 .RS 4 91 Prints the program version number\. 91 92 .RE 92 93 .PP 93 -d|--debuglevel=level 94 .RS 3n 95 \fIlevel\fR 96 is an integer from 0 to 10. The default value if this parameter is not specified is zero. 97 .sp 98 The 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. 99 .sp 100 Levels 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. 101 .sp 102 Note that specifying this parameter here will override the 103 104 parameter in the 105 \fIsmb.conf\fR 106 file. 94 \-s <configuration file> 95 .RS 4 96 The 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 97 \fIsmb\.conf\fR 98 for more information\. The default configuration file name is determined at compile time\. 107 99 .RE 108 100 .PP 109 -l|--logfile=logdirectory110 .RS 3n111 Base directory name for log/debug files . The extension112 \fB" .progname"\fR113 will be appended (e .g. log.smbclient, log.smbd, etc...). The log file is never removed by the client.101 \-l|\-\-log\-basename=logdirectory 102 .RS 4 103 Base directory name for log/debug files\. The extension 104 \fB"\.progname"\fR 105 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 114 106 .RE 115 107 .PP 116 -N117 .RS 3n118 If 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.108 \-N 109 .RS 4 110 If 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\. 119 111 .sp 120 Unless a password is specified on the command line or this parameter is specified, the client will request a password .112 Unless a password is specified on the command line or this parameter is specified, the client will request a password\. 121 113 .sp 122 If 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 .114 If 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\. 123 115 .RE 124 116 .PP 125 -k126 .RS 3n127 Try to authenticate with kerberos . Only useful in an Active Directory environment.117 \-k 118 .RS 4 119 Try to authenticate with kerberos\. Only useful in an Active Directory environment\. 128 120 .RE 129 121 .PP 130 -A|--authentication-file=filename131 .RS 3n132 This option allows you to specify a file from which to read the username and password used in the connection . The format of the file is122 \-A|\-\-authentication\-file=filename 123 .RS 4 124 This 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 133 125 .sp 134 135 126 .sp 136 127 .RS 4 137 128 .nf 138 139 129 username = <value> 140 130 password = <value> 141 131 domain = <value> 142 143 132 .fi 144 133 .RE 145 134 .sp 146 Make certain that the permissions on the file restrict access from unwanted users .135 Make certain that the permissions on the file restrict access from unwanted users\. 147 136 .RE 148 137 .PP 149 -U|--user=username[%password]150 .RS 3n151 Sets the SMB username or username and password .138 \-U|\-\-user=username[%password] 139 .RS 4 140 Sets the SMB username or username and password\. 152 141 .sp 153 If %password is not specified, the user will be prompted . The client will first check the142 If %password is not specified, the user will be prompted\. The client will first check the 154 143 \fBUSER\fR 155 144 environment variable, then the 156 145 \fBLOGNAME\fR 157 variable and if either exists, the string is uppercased . If these environmental variables are not found, the username146 variable and if either exists, the string is uppercased\. If these environmental variables are not found, the username 158 147 \fBGUEST\fR 159 is used .148 is used\. 160 149 .sp 161 A 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 the162 \fI -A\fR163 for more details .150 A 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 151 \fI\-A\fR 152 for more details\. 164 153 .sp 165 Be cautious about including passwords in scripts . Also, on many systems the command line of a running process may be seen via the154 Be cautious about including passwords in scripts\. Also, on many systems the command line of a running process may be seen via the 166 155 ps 167 command . To be safe always allow156 command\. To be safe always allow 168 157 rpcclient 169 to prompt for a password and type it in directly .158 to prompt for a password and type it in directly\. 170 159 .RE 171 160 .SH "QUOTA_SET_COMAND" 172 161 .PP 173 The format of an the QUOTA_SET_COMMAND is an operation name followed by a set of parameters specific to that operation .162 The format of an the QUOTA_SET_COMMAND is an operation name followed by a set of parameters specific to that operation\. 174 163 .PP 175 To set user quotas for the user specified by -u or for the current username:164 To set user quotas for the user specified by \-u or for the current username: 176 165 .PP 177 166 \fB UQLIM:<username>:<softlimit>/<hardlimit> \fR … … 185 174 \fB FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT \fR 186 175 .PP 187 All limits are specified as a number of bytes .176 All limits are specified as a number of bytes\. 188 177 .SH "EXIT STATUS" 189 178 .PP 190 179 The 191 180 smbcquotas 192 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.181 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\. 193 182 .PP 194 If the operation succeeded, smbcquotas returns an exit status of 0 . If183 If the operation succeeded, smbcquotas returns an exit status of 0\. If 195 184 smbcquotas 196 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.185 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\. 197 186 .SH "VERSION" 198 187 .PP 199 This man page is correct for version 3 .0 of the Samba suite.188 This man page is correct for version 3\.0 of the Samba suite\. 200 189 .SH "AUTHOR" 201 190 .PP 202 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.191 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\. 203 192 .PP 204 193 smbcquotas 205 was written by Stefan Metzmacher. 206 194 was written by Stefan Metzmacher\.
Note:
See TracChangeset
for help on using the changeset viewer.
