git.maemo.org Git - samba/blob - docs/manpages/smbcquotas.1

   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
  22 smbcquotas \- 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
  34 This tool is part of the \fBsamba\fR(7) suite\&.
  35
  36 .PP
  37 The \fBsmbcquotas\fR program manipulates NT Quotas on SMB file shares\&.
  38
  39 .SH "OPTIONS"
  40
  41 .PP
  42 The following options are available to the \fBsmbcquotas\fR program\&.
  43
  44 .TP
  45 \-u user
  46 Specifies 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
  50 Lists all quota records of the share\&.
  51
  52 .TP
  53 \-F
  54 Show the share quota status and default limits\&.
  55
  56 .TP
  57 \-S QUOTA_SET_COMMAND
  58 This 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
  62 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\&.
  63
  64 .TP
  65 \-t
  66 Don't actually do anything, only validate the correctness of the arguments\&.
  67
  68 .TP
  69 \-v
  70 Be verbose\&.
  71
  72 .TP
  73 \-h|\-\-help
  74 Print a summary of command line options\&.
  75
  76 .TP
  77 \-V
  78 Prints the program version number\&.
  79
  80 .TP
  81 \-s <configuration file>
  82 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 \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
  88 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\&.
  89
  90 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\&.
  91
  92 Note that specifying this parameter here will override the  parameter in the \fIsmb\&.conf\fR file\&.
  93
  94 .TP
  95 \-l|\-\-logfile=logdirectory
  96 Base 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
 100 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\&.
 101
 102 Unless a password is specified on the command line or this parameter is specified, the client will request a password\&.
 103
 104 .TP
 105 \-k
 106 Try to authenticate with kerberos\&. Only useful in an Active Directory environment\&.
 107
 108 .TP
 109 \-A|\-\-authentication\-file=filename
 110 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
 111
 112
 113 .nf
 114
 115 username = <value>
 116 password = <value>
 117 domain   = <value>
 118 .fi
 119
 120
 121 Make certain that the permissions on the file restrict access from unwanted users\&.
 122
 123 .TP
 124 \-U|\-\-user=username[%password]
 125 Sets the SMB username or username and password\&.
 126
 127 If %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\&.
 128
 129 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 \fI\-A\fR for more details\&.
 130
 131 Be 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\&.
 132
 133 .SH "QUOTA_SET_COMAND"
 134
 135 .PP
 136 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:
 137
 138 .PP
 139 for setting user quotas for the user specified by \-u or the current username:
 140
 141 .PP
 142 \fB UQLIM:<username>:<softlimit>/<hardlimit> \fR
 143
 144 .PP
 145 for setting the default quotas for a share:
 146
 147 .PP
 148 \fB FSQLIM:<softlimit>/<hardlimit> \fR
 149
 150 .PP
 151 for changing the share quota settings:
 152
 153 .PP
 154 \fB FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT \fR
 155
 156 .SH "EXIT STATUS"
 157
 158 .PP
 159 The \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\&.
 160
 161 .PP
 162 If 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\&.
 163
 164 .SH "VERSION"
 165
 166 .PP
 167 This man page is correct for version 3\&.0 of the Samba suite\&.
 168
 169 .SH "AUTHOR"
 170
 171 .PP
 172 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\&.
 173
 174 .PP
 175 \fBsmbcquotas\fR was written by Stefan Metzmacher\&.
 176