Changeset 231 for branches/samba-3.2.x/docs/manpages/smbcquotas.1
- Timestamp:
- May 27, 2009, 9:08:03 AM (16 years ago)
- File:
-
- 1 edited
-
branches/samba-3.2.x/docs/manpages/smbcquotas.1 (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
branches/samba-3.2.x/docs/manpages/smbcquotas.1
r229 r231 1 1 .\" Title: smbcquotas 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.7 3.1<http://docbook.sf.net/>4 .\" Date: 12/19/20082 .\" Author: [see the "AUTHOR" section] 3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> 4 .\" Date: 02/03/2009 5 5 .\" Manual: User Commands 6 6 .\" Source: Samba 3.2 7 .\" Language: English 7 8 .\" 8 .TH "SMBCQUOTAS" "1" "12/19/2008" "Samba 3\.2" "User Commands" 9 .TH "SMBCQUOTAS" "1" "02/03/2009" "Samba 3\&.2" "User Commands" 10 .\" ----------------------------------------------------------------- 11 .\" * (re)Define some macros 12 .\" ----------------------------------------------------------------- 13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 14 .\" toupper - uppercase a string (locale-aware) 15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 16 .de toupper 17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ 18 \\$* 19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz 20 .. 21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 22 .\" SH-xref - format a cross-reference to an SH section 23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 24 .de SH-xref 25 .ie n \{\ 26 .\} 27 .toupper \\$* 28 .el \{\ 29 \\$* 30 .\} 31 .. 32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 33 .\" SH - level-one heading that works better for non-TTY output 34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 35 .de1 SH 36 .\" put an extra blank line of space above the head in non-TTY output 37 .if t \{\ 38 .sp 1 39 .\} 40 .sp \\n[PD]u 41 .nr an-level 1 42 .set-an-margin 43 .nr an-prevailing-indent \\n[IN] 44 .fi 45 .in \\n[an-margin]u 46 .ti 0 47 .HTML-TAG ".NH \\n[an-level]" 48 .it 1 an-trap 49 .nr an-no-space-flag 1 50 .nr an-break-flag 1 51 \." make the size of the head bigger 52 .ps +3 53 .ft B 54 .ne (2v + 1u) 55 .ie n \{\ 56 .\" if n (TTY output), use uppercase 57 .toupper \\$* 58 .\} 59 .el \{\ 60 .nr an-break-flag 0 61 .\" if not n (not TTY), use normal case (not uppercase) 62 \\$1 63 .in \\n[an-margin]u 64 .ti 0 65 .\" if not n (not TTY), put a border/line under subheading 66 .sp -.6 67 \l'\n(.lu' 68 .\} 69 .. 70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 71 .\" SS - level-two heading that works better for non-TTY output 72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 73 .de1 SS 74 .sp \\n[PD]u 75 .nr an-level 1 76 .set-an-margin 77 .nr an-prevailing-indent \\n[IN] 78 .fi 79 .in \\n[IN]u 80 .ti \\n[SN]u 81 .it 1 an-trap 82 .nr an-no-space-flag 1 83 .nr an-break-flag 1 84 .ps \\n[PS-SS]u 85 \." make the size of the head bigger 86 .ps +2 87 .ft B 88 .ne (2v + 1u) 89 .if \\n[.$] \&\\$* 90 .. 91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 92 .\" BB/BE - put background/screen (filled box) around block of text 93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 94 .de BB 95 .if t \{\ 96 .sp -.5 97 .br 98 .in +2n 99 .ll -2n 100 .gcolor red 101 .di BX 102 .\} 103 .. 104 .de EB 105 .if t \{\ 106 .if "\\$2"adjust-for-leading-newline" \{\ 107 .sp -1 108 .\} 109 .br 110 .di 111 .in 112 .ll 113 .gcolor 114 .nr BW \\n(.lu-\\n(.i 115 .nr BH \\n(dn+.5v 116 .ne \\n(BHu+.5v 117 .ie "\\$2"adjust-for-leading-newline" \{\ 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] 119 .\} 120 .el \{\ 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] 122 .\} 123 .in 0 124 .sp -.5v 125 .nf 126 .BX 127 .in 128 .sp .5v 129 .fi 130 .\} 131 .. 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 133 .\" BM/EM - put colored marker in margin next to block of text 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 135 .de BM 136 .if t \{\ 137 .br 138 .ll -2n 139 .gcolor red 140 .di BX 141 .\} 142 .. 143 .de EM 144 .if t \{\ 145 .br 146 .di 147 .ll 148 .gcolor 149 .nr BH \\n(dn 150 .ne \\n(BHu 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] 152 .in 0 153 .nf 154 .BX 155 .in 156 .fi 157 .\} 158 .. 159 .\" ----------------------------------------------------------------- 160 .\" * set default formatting 161 .\" ----------------------------------------------------------------- 9 162 .\" disable hyphenation 10 163 .nh 11 164 .\" disable justification (adjust text to left margin only) 12 165 .ad l 13 .SH "NAME" 14 smbcquotas - Set or get QUOTAs of NTFS 5 shares 15 .SH "SYNOPSIS" 16 .HP 1 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] 166 .\" ----------------------------------------------------------------- 167 .\" * MAIN CONTENT STARTS HERE * 168 .\" ----------------------------------------------------------------- 169 .SH "Name" 170 smbcquotas \- Set or get QUOTAs of NTFS 5 shares 171 .SH "Synopsis" 172 .fam C 173 .HP \w'\ 'u 174 \FCsmbcquotas\F[] {//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] 175 .fam 18 176 .SH "DESCRIPTION" 19 177 .PP 20 178 This tool is part of the 21 179 \fBsamba\fR(7) 22 suite\ .180 suite\&. 23 181 .PP 24 182 The 25 smbcquotas 26 program manipulates NT Quotas on SMB file shares\ .183 \FCsmbcquotas\F[] 184 program manipulates NT Quotas on SMB file shares\&. 27 185 .SH "OPTIONS" 28 186 .PP 29 187 The following options are available to the 30 smbcquotas 31 program\ .188 \FCsmbcquotas\F[] 189 program\&. 32 190 .PP 33 191 \-u user 34 192 .RS 4 35 Specifies the user of whom the quotas are get or set\ . By default the current user\'s username will be used\.193 Specifies the user of whom the quotas are get or set\&. By default the current user\'s username will be used\&. 36 194 .RE 37 195 .PP 38 196 \-L 39 197 .RS 4 40 Lists all quota records of the share\ .198 Lists all quota records of the share\&. 41 199 .RE 42 200 .PP 43 201 \-F 44 202 .RS 4 45 Show the share quota status and default limits\ .203 Show the share quota status and default limits\&. 46 204 .RE 47 205 .PP 48 206 \-S QUOTA_SET_COMMAND 49 207 .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\ .208 This command sets/modifies quotas for a user or on the share, depending on the QUOTA_SET_COMMAND parameter which is described later\&. 51 209 .RE 52 210 .PP 53 211 \-n 54 212 .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\.213 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\&. 56 214 .RE 57 215 .PP 58 216 \-t 59 217 .RS 4 60 Don\'t actually do anything, only validate the correctness of the arguments\ .218 Don\'t actually do anything, only validate the correctness of the arguments\&. 61 219 .RE 62 220 .PP 63 221 \-v 64 222 .RS 4 65 Be verbose\ .223 Be verbose\&. 66 224 .RE 67 225 .PP 68 226 \-h|\-\-help 69 227 .RS 4 70 Print a summary of command line options\ .228 Print a summary of command line options\&. 71 229 .RE 72 230 .PP … … 74 232 .RS 4 75 233 \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\.234 is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&. 235 .sp 236 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\&. 237 .sp 238 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 239 .sp 82 240 Note that specifying this parameter here will override the 83 \ fIlog level\fR241 \m[blue]\fBlog level\fR\m[] 84 242 parameter in the 85 \ fIsmb\.conf\fR86 file\ .243 \FCsmb\&.conf\F[] 244 file\&. 87 245 .RE 88 246 .PP 89 247 \-V 90 248 .RS 4 91 Prints the program version number\ .249 Prints the program version number\&. 92 250 .RE 93 251 .PP 94 252 \-s <configuration file> 95 253 .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\. See97 \ fIsmb\.conf\fR98 for more information\ . The default configuration file name is determined at compile time\.254 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 255 \FCsmb\&.conf\F[] 256 for more information\&. The default configuration file name is determined at compile time\&. 99 257 .RE 100 258 .PP 101 259 \-l|\-\-log\-basename=logdirectory 102 260 .RS 4 103 Base directory name for log/debug files\ . The extension104 \fB"\ .progname"\fR105 will be appended (e\ .g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\.261 Base directory name for log/debug files\&. The extension 262 \fB"\&.progname"\fR 263 will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&. 106 264 .RE 107 265 .PP 108 266 \-N 109 267 .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\.111 .sp 112 Unless a password is specified on the command line or this parameter is specified, the client will request a password\ .113 .sp 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\ .268 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\&. 269 .sp 270 Unless a password is specified on the command line or this parameter is specified, the client will request a password\&. 271 .sp 272 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\&. 115 273 .RE 116 274 .PP 117 275 \-k 118 276 .RS 4 119 Try to authenticate with kerberos\ . Only useful in an Active Directory environment\.277 Try to authenticate with kerberos\&. Only useful in an Active Directory environment\&. 120 278 .RE 121 279 .PP 122 280 \-A|\-\-authentication\-file=filename 123 281 .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 125 .sp 126 .sp 127 .RS 4 282 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 283 .sp 284 .if n \{\ 285 .RS 4 286 .\} 287 .fam C 288 .ps -1 128 289 .nf 290 .if t \{\ 291 .sp -1 292 .\} 293 .BB lightgray adjust-for-leading-newline 294 .sp -1 295 129 296 username = <value> 130 297 password = <value> 131 298 domain = <value> 132 .fi 133 .RE 134 .sp 135 Make certain that the permissions on the file restrict access from unwanted users\. 299 .EB lightgray adjust-for-leading-newline 300 .if t \{\ 301 .sp 1 302 .\} 303 .fi 304 .fam 305 .ps +1 306 .if n \{\ 307 .RE 308 .\} 309 .sp 310 Make certain that the permissions on the file restrict access from unwanted users\&. 136 311 .RE 137 312 .PP 138 313 \-U|\-\-user=username[%password] 139 314 .RS 4 140 Sets the SMB username or username and password\ .141 .sp 142 If %password is not specified, the user will be prompted\ . The client will first check the315 Sets the SMB username or username and password\&. 316 .sp 317 If %password is not specified, the user will be prompted\&. The client will first check the 143 318 \fBUSER\fR 144 319 environment variable, then the 145 320 \fBLOGNAME\fR 146 variable and if either exists, the string is uppercased\ . If these environmental variables are not found, the username321 variable and if either exists, the string is uppercased\&. If these environmental variables are not found, the username 147 322 \fBGUEST\fR 148 is used\ .149 .sp 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 the323 is used\&. 324 .sp 325 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 326 \fI\-A\fR 152 for more details\ .153 .sp 154 Be cautious about including passwords in scripts\ . Also, on many systems the command line of a running process may be seen via the155 ps 156 command\ . To be safe always allow157 rpcclient 158 to prompt for a password and type it in directly\ .327 for more details\&. 328 .sp 329 Be cautious about including passwords in scripts\&. Also, on many systems the command line of a running process may be seen via the 330 \FCps\F[] 331 command\&. To be safe always allow 332 \FCrpcclient\F[] 333 to prompt for a password and type it in directly\&. 159 334 .RE 160 335 .SH "QUOTA_SET_COMAND" 161 336 .PP 162 The format of an the QUOTA_SET_COMMAND is an operation name followed by a set of parameters specific to that operation\ .337 The format of an the QUOTA_SET_COMMAND is an operation name followed by a set of parameters specific to that operation\&. 163 338 .PP 164 339 To set user quotas for the user specified by \-u or for the current username: … … 174 349 \fB FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT \fR 175 350 .PP 176 All limits are specified as a number of bytes\ .351 All limits are specified as a number of bytes\&. 177 352 .SH "EXIT STATUS" 178 353 .PP 179 354 The 180 smbcquotas 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\.182 .PP 183 If the operation succeeded, smbcquotas returns an exit status of 0\ . If184 smbcquotas 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\.355 \FCsmbcquotas\F[] 356 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\&. 357 .PP 358 If the operation succeeded, smbcquotas returns an exit status of 0\&. If 359 \FCsmbcquotas\F[] 360 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\&. 186 361 .SH "VERSION" 187 362 .PP 188 This man page is correct for version 3 of the Samba suite\ .363 This man page is correct for version 3 of the Samba suite\&. 189 364 .SH "AUTHOR" 190 365 .PP 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\.192 .PP 193 smbcquotas 194 was written by Stefan Metzmacher\ .366 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\&. 367 .PP 368 \FCsmbcquotas\F[] 369 was written by Stefan Metzmacher\&.
Note:
See TracChangeset
for help on using the changeset viewer.
