! Help file for SOFTDB
!     Created: 25-JUNE-1982 by Art Moorshead - Westinghouse Electric
!     Modified  9-Oct-1982  AAM For version 1.1
!
1 HELP
!
The SOFTDB utility allows suitably privileged users 
to limit the amount of space individual users may take 
on public disk volumes by maintaining quota files on those
volumes.  The soft quota limit imposes a limit on how much
space a user may use for permanent storage of files with out
restricting his usage of disk space during a working session.
!
2 ADD
!
Adds a record to a soft quota file.

The ADD command uses the default values from the USER 
default record.  These default values can be explicitly 
overwritten.

The USER default record must already exist in the SOFTQUOTA 
file before any new users can be added. It can be added by
issueing the command  "ADD USER".

Wildcards are not permitted in the UIC spec.

FORMAT:
  ADD <uic> </SOFTQUOTA=n> </HARDSAVE=n> </MESSAGE=n>
!
3 /HARDSAVE
 This field is used by the SOFTQUOTA program for storing a
 user's hardquota when it has been reduced due to an overdraft
 of the softquota.  It defaults to zero and should not generally
 need to be disturbed.  However, due to occasional strange
 behavior of the Softquota program, it is occasionally 
 necessary to fix a user's hardquota field.
 
 EXAMPLE:
  ADD [11,17] /HARDSAVE=30000
!
3 /MESSAGE
 This field is used by the SOFTQUOTA program for storing the
 number of messages recieved by a user when their hardquota
 has been reduced due to an overdraft of the softquota.  
 It defaults to zero and should not generally need to be 
 disturbed.  However, due to occasional strange behavior of 
 the Softquota program, it is occasionally necessary to fix 
 a user's message field.
 
 EXAMPLE:
  ADD [11,17] /MESSAGE=3
!
3 /SOFTQUOTA
 This qualifier allows the user to specify how many blocks
 (decimal) that a user with a given UIC may keep on given 
 volume.  If this qualifier is not present or no value is 
 specified, the default value from the USER default record
 is used.

 EXAMPLE:
  ADD [11,17] /SOFTQUOTA=25000

 This will add a quota record to a volume allowing the user with 
 UIC = [11,17] 25000 blocks of permanent storage.
!
2 Command File
It is possible to execute SOFTDB commands from a command file.
The default file type is .COM.
	
FORMAT:
 @ filename
!
2 DISK DEFAULT
The DISK default record is used by the SOFTQUOTA program in the
case of a user with no soft quota record.  The value of the
disk default is used for him.  This value should be kept low.
A disk default record can be added by issueing the command
"ADD DISK/SOFTQUOTA=n" if none exists.  An existing disk default
value can be modified by issueing the command 
"MODIFY DISK/SOFTQUOTA=n".
!
2 EXIT
EXIT causes the SOFTQUOTA utility to exit, and return 
the user to the previous command level.  CNTRL-Z has 
the same effect.

FORMAT:
 EXIT
!
2 HELP
HELP provides this documentation.
!
2 LIST
LIST commands list output to SOFTQUOTA.LIS.
It is possible to direct the output elsewhere by assigning a filename
to the logical name FOR$PRINT.

FORMAT 
  LIST <uic>

EXAMPLE
  LIST [*,*]   lists all softquota records for the current device

  LIST [200,*] lists all softquota records for users in group 200
!
2 MODIFY 
!
Modify an exiting soft quota record.  The UIC must be specified.

 FORMAT:
  MODIFY <uic> </SOFTQUOTA=n> </HARDSAVE=n> </MESSAGE=n>
!
3 /HARDSAVE
 This field is used by the SOFTQUOTA program for storing a
 user's hardquota when it has been reduced due to an overdraft
 of the softquota.  It is usually zero and should not generally
 need to be disturbed.  However, due to occasional strange
 behavior of the Softquota program, it is occasionally 
 necessary to overide the value in the hardquota field.  If 
 this qualifier is not present or no value is specified, the
 field in the record is not modified.

 
 EXAMPLE:
  MODIFY [11,17] /HARDSAVE=30000
!
3 /MESSAGE
 This field is used by the SOFTQUOTA program for storing the
 number of messages recieved by a user when their hardquota
 has been reduced due to an overdraft of the softquota.  
 It is usually zero and should not generally need to be 
 disturbed.  However, due to occasional strange behavior of 
 the Softquota program, it is occasionally necessary to overide
 the value in the message field.  If this qualifier is not 
 present or no value is specified, the field in the record 
 is not modified.

 
 EXAMPLE:
  MODIFY [11,17] /MESSAGE=3
!
3 /SOFTQUOTA
 This qualifier allows the user to specify how many blocks
 (decimal) that a user with a given UIC may keep on given 
 volume.  If this qualifier is not present or no value is 
 specified, the field in the record is not modified.

 EXAMPLE:
  MODIFY [11,17] /SOFTQUOTA=25000

 This will change the quota record allowing the user with 
 UIC = [11,17] 25000 blocks of permanent storage.

  MODIFY [122,*]/SOFTQUOTA=5000

 This will change the softquota's for all members of group
 122 to 5000 blocks.
!
2 REMOVE 
!
Remove a soft quota record from a file.

FORMAT:
 REMOVE <uic>

EXAMPLE:
  REMOVE [322,3]
  REMOVE [120,*]
!
2 SHOW
!
Display the current quota values of the quota record
of a given UIC or the entire file.

FORMAT:
 SHOW <uic>  will display the soft quota record for this UIC.
 SHOW USER   will display the soft quota record for the USER default.
 SHOW DISK   will display the soft quota record for the DISK default.
 SHOW *      will display the entire soft quota file.

EXAMPLE
 SHOW [200,3]  will display the softquota records for user [200,3]

 SHOW [200,*]  will display the softquota records for 
		users in group 200
!
2 Startup
If the logical name SOFTDBINI is defined as a command file, 
that file is executed by SOFTDB before the operator prompt.
!
2 uic
The User Identification Code can be specified either as
a uic number, a wildcard for the group field and/or a 
wildcard for the member field.  The field values are
octal numbers.

EXAMPLE:
  [122,3]
  [122,*]
  [*,2]
  [*,*]

Illegal forms:
  [483,1]	Not an octal number
  [2*,3]	Partial wildcards not permitted
!
2 USE
Specifies a volume to be used as the default volume for all
succeeding commands.  If the USE command is not used, then
the default volume is SYS$DISK.

FORMAT:
 USE <volume>

Where <volume> is some device spec. or a logical name that
translates to a device spec.  The device must have some
media MOUNTed on it.

EXAMPLE:
 USE DBA1
!
2 USER DEFAULT
The USER default record in the SOFTQUOTA file is used as a
template when new users are added.  The values in this record
are copied to the user record unless explicitly overwritten.
A USER default record is needed before any new users can be
added.  It can be added by issueing the command "ADD USER".
A new USER default record has a default softquota value
of 2000 blocks.  This can be changed by issueing the command
"MODIFY USER/SOFTQUOTA=n".
!
!       This section shows support responsibility
!
2 Support
SOFTQUOTA is supported on a time-available basis by Art Moorshead
Please forward specific problems, suggestions, etc. to:
 
       Art Moorshead
       Westinghouse Electric Corp
       P.O. Box 746  MS 432
       Baltimore, Md.  21203
