Ignore:
Timestamp:
May 26, 2007, 10:26:26 PM (14 years ago)
Author:
Paul Smedley
Message:

Upgrade source to 3.0.25a

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/samba/docs/manpages/smbcquotas.1

    r26 r39  
    1919..
    2020.TH "SMBCQUOTAS" 1 "" "" ""
    21 .SH NAME
    22 smbcquotas \- Set or get QUOTAs of NTFS 5 shares
     21.SH "NAME"
     22smbcquotas - Set or get QUOTAs of NTFS 5 shares
    2323.SH "SYNOPSIS"
    24 .ad l
    25 .hy 0
    2624.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 
     25\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]
    3126.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 
     27.PP
     28This tool is part of the
     29\fBsamba\fR(7)
     30suite.
     31.PP
     32The
     33\fBsmbcquotas\fR
     34program manipulates NT Quotas on SMB file shares.
    3935.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 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\&.
    105 
    106 .TP
    107 \-k
    108 Try to authenticate with kerberos\&. Only useful in an Active Directory environment\&.
    109 
    110 .TP
    111 \-A|\-\-authentication\-file=filename
    112 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
    113 
    114 
     36.PP
     37The following options are available to the
     38\fBsmbcquotas\fR
     39program.
     40.PP
     41-u user
     42.RS 3n
     43Specifies the user of whom the quotas are get or set. By default the current user's username will be used.
     44.RE
     45.PP
     46-L
     47.RS 3n
     48Lists all quota records of the share.
     49.RE
     50.PP
     51-F
     52.RS 3n
     53Show the share quota status and default limits.
     54.RE
     55.PP
     56-S QUOTA_SET_COMMAND
     57.RS 3n
     58This command sets/modifies quotas for a user or on the share, depending on the QUOTA_SET_COMMAND parameter which is described later.
     59.RE
     60.PP
     61-n
     62.RS 3n
     63This 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.RE
     65.PP
     66-t
     67.RS 3n
     68Don't actually do anything, only validate the correctness of the arguments.
     69.RE
     70.PP
     71-v
     72.RS 3n
     73Be verbose.
     74.RE
     75.PP
     76-h|--help
     77.RS 3n
     78Print a summary of command line options.
     79.RE
     80.PP
     81-V
     82.RS 3n
     83Prints the program version number.
     84.RE
     85.PP
     86-s <configuration file>
     87.RS 3n
     88The 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
     90for more information. The default configuration file name is determined at compile time.
     91.RE
     92.PP
     93-d|--debuglevel=level
     94.RS 3n
     95\fIlevel\fR
     96is an integer from 0 to 10. The default value if this parameter is not specified is zero.
     97.sp
     98The 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
     100Levels 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
     102Note that specifying this parameter here will override the
     103
     104parameter in the
     105\fIsmb.conf\fR
     106file.
     107.RE
     108.PP
     109-l|--logfile=logdirectory
     110.RS 3n
     111Base directory name for log/debug files. The extension
     112\fB".progname"\fR
     113will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client.
     114.RE
     115.PP
     116-N
     117.RS 3n
     118If 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.sp
     120Unless a password is specified on the command line or this parameter is specified, the client will request a password.
     121.sp
     122If 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.RE
     124.PP
     125-k
     126.RS 3n
     127Try to authenticate with kerberos. Only useful in an Active Directory environment.
     128.RE
     129.PP
     130-A|--authentication-file=filename
     131.RS 3n
     132This 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.sp
     134
     135.sp
    115136
    116137.nf
    … …  
    122143.fi
    123144
    124 
    125 Make certain that the permissions on the file restrict access from unwanted users\&.
    126 
    127 .TP
    128 \-U|\-\-user=username[%password]
    129 Sets the SMB username or username and password\&.
    130 
    131 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\&.
    132 
    133 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\&.
    134 
    135 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\&.
    136 
     145.sp
     146Make certain that the permissions on the file restrict access from unwanted users.
     147.RE
     148.PP
     149-U|--user=username[%password]
     150.RS 3n
     151Sets the SMB username or username and password.
     152.sp
     153If %password is not specified, the user will be prompted. The client will first check the
     154\fBUSER\fR
     155environment variable, then the
     156\fBLOGNAME\fR
     157variable and if either exists, the string is uppercased. If these environmental variables are not found, the username
     158\fBGUEST\fR
     159is used.
     160.sp
     161A 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
     162\fI-A\fR
     163for more details.
     164.sp
     165Be cautious about including passwords in scripts. Also, on many systems the command line of a running process may be seen via the
     166\fBps\fR
     167command. To be safe always allow
     168\fBrpcclient\fR
     169to prompt for a password and type it in directly.
     170.RE
    137171.SH "QUOTA_SET_COMAND"
    138 
    139 .PP
    140 The format of an the QUOTA_SET_COMMAND is an operation name followed by a set of parameters specific to that operation\&.
    141 
    142 .PP
    143 To set user quotas for the user specified by \-u or for the current username:
    144 
     172.PP
     173The format of an the QUOTA_SET_COMMAND is an operation name followed by a set of parameters specific to that operation.
     174.PP
     175To set user quotas for the user specified by -u or for the current username:
    145176.PP
    146177\fB UQLIM:<username>:<softlimit>/<hardlimit> \fR
    147 
    148178.PP
    149179To set the default quotas for a share:
    150 
    151180.PP
    152181\fB FSQLIM:<softlimit>/<hardlimit> \fR
    153 
    154182.PP
    155183To change the share quota settings:
    156 
    157184.PP
    158185\fB FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT \fR
    159 
    160 .PP
    161 All limits are specified as a number of bytes\&.
    162 
     186.PP
     187All limits are specified as a number of bytes.
    163188.SH "EXIT STATUS"
    164 
    165 .PP
    166 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\&.
    167 
    168 .PP
    169 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\&.
    170 
     189.PP
     190The
     191\fBsmbcquotas\fR
     192program 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.PP
     194If the operation succeeded, smbcquotas returns an exit status of 0. If
     195\fBsmbcquotas\fR
     196couldn'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.
    171197.SH "VERSION"
    172 
    173 .PP
    174 This man page is correct for version 3\&.0 of the Samba suite\&.
    175 
     198.PP
     199This man page is correct for version 3.0 of the Samba suite.
    176200.SH "AUTHOR"
    177 
    178 .PP
    179 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\&.
    180 
    181 .PP
    182 \fBsmbcquotas\fR was written by Stefan Metzmacher\&.
    183 
     201.PP
     202The 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.PP
     204\fBsmbcquotas\fR
     205was written by Stefan Metzmacher.
     206
Note: See TracChangeset for help on using the changeset viewer.