! Help file for SOFTDB
!     Created: 25-JUNE-1982 by Art Moorshead - Westinghouse Electric
!     Modified  9-Oct-1982  AAM For version 1.1
!     Modified 17-Apr-1984 by Marty Adkins, VSG - corrected levels, misc text.
!     Modified 13-Jan-1988 by Shari Dishop, VSG
!
1 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] [/PERM=n] [/OVER=n]
!
2 /HARDSAVE
 This field is used by the SOFTQUOTA program for storing a
 user's hardquota when it has been reduced because the
 softquota has been exceeded.  It defaults to zero and should
 not generally need to be disturbed.  In the event of a crash
 or other system anomally, it might be necessary to reset a
 user's hardquota field.

 EXAMPLE:
  ADD [11,17] /HARDSAVE=30000
!
2 /MESSAGE
 This field is used by the SOFTQUOTA program for storing the
 number of messages received 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.  The system manager may inspect and reset this
 field as desired.

 EXAMPLE:
  ADD [11,17] /MESSAGE=3
!
2 /OVER
 This field is used by the SOFTQUOTA program for setting the
 hard disk quota overdraft in the QUOTA.SYS file.  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] /OVER=1000
!
2 /PERM
 This field is used by the SOFTQUOTA program for setting the
 user's hard disk quota in the QUOTA.SYS file.  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] /PERM=10000
!
2 /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.
!
1 Cluster Support
!
 To start the listener on cluster nodes as a batch job, submit the
 file START_OTHER_NODE.COM to the system batch que in the system
 startup procedure.  (make sure this occurs after the batch queues
 are started!)

 To start the listener on cluster nodes as a detatched process,
 execute the procedure SOFTSTART.COM in the system startup procedure.
!
1 Command File
 It is possible to execute SOFTDB commands from a command file.
 The default file type is .COM.
	
 FORMAT:
  @ filename   (note the space is significant)
!
1 CREATE
!
  If no SOFTQUOTA.DAT file exists it will create a file of the
  proper format with no entries.

  If a SOFTQUOTA.DAT file exists but is of the old character format,
  this option will convert the file to the new binary format.

  If a SOFTQUOTA.DAT file exists and is of the proper format no
  action is taken.


  NOTE:  A SOFTQUOTA.DAT file of the old character format will
         be converted to the new binary format upon the first
         read of the data file.
!
1 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".
!
1 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
!
1 HELP
!
 SOFTDB is a maintenance utility for the SOFTQUOTA database.
 It is the tool with which suitably privileged users may
 limit the amount of space individual users may consume on
 public disk volumes.  The softquota value imposes a limit on
 how much space a user may have for PERMANENT storage of
 files whereas the regular (hard)quota restricts allocation
 dynamically during the life of a job.
!
1 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 [/USEHARD] <uic>

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

   LIST [200,*] lists all softquota records for users in group 200
!
2 /USEHARD
!
 Use the QUOTA.SYS file for the reference file in wildcard operations.
!
1 MODIFY
!
 Modify an existing soft quota record.  The UIC must be specified.

 FORMAT:
   MODIFY <uic> [/SOFTQUOTA=n] [/HARDSAVE=n] [/MESSAGE=n]
!
2 /HARDSAVE
 This field is used by the SOFTQUOTA program for storing a
 user's hardquota when it has been reduced because the
 softquota has been exceeded.  It defaults to zero and should
 not generally need to be disturbed.  In the event of a crash
 or other system anomally, it might be necessary to reset a
 user's hardquota field.


 EXAMPLE:
  MODIFY [11,17] /HARDSAVE=30000
!
2 /MESSAGE
 This field is used by the SOFTQUOTA program for storing the
 number of messages received 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.  The system manager may inspect and reset this
 field as desired.

 EXAMPLE:
  MODIFY [11,17] /MESSAGE=3
!
2 /OVER
 This field is used by the SOFTQUOTA program for setting the
 hard disk quota overdraft.  If this qualifier is not present
 or no value is specified, the field in the record is not modified.

 EXAMPLE:
  MODIFY [11,17] /OVER=1000
!
2 /PERM
 This field is used by the SOFTQUOTA program for setting the
 user's hard disk quota.  If this qualifier is not present or
 no value is specified, the field in the record is not modified.

 EXAMPLE:
  MODIFY [11,17] /PERM=10000
!
2 /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.
!
1 REMOVE
!
 Remove a soft quota record from a file.

 FORMAT:
  REMOVE <uic>

 EXAMPLE:
   REMOVE [322,3]
   REMOVE [120,*]

 NOTE:  Does not currently remove entry from QUOTA.SYS file.
!
1 SHOW
!
 Display the current quota values of the quota record
 of a given UIC or the entire file.

 FORMAT:
  SHOW [/USEHARD] <uic>  displays the soft quota record for this UIC.
  SHOW USER   displays the soft quota record for the USER default.
  SHOW DISK   displays the soft quota record for the DISK default.
  SHOW *      displays the entire soft quota file.

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

  SHOW [200,*]  displays the softquota records for
 		users in group 200
!
2 /USEHARD
!
 Use the QUOTA.SYS file for the reference file in wildcard operations.
!
1 Startup
 If the logical name SOFTDBINI is assigned to a command file,
 that file is executed by SOFTDB before the operator prompt.
!
1 uic
 The User Identification Code can be specified either as
 an identifier, a uic number, a wildcard for the group field
 and/or a wildcard for the member field.  The field values for
 UIC numbers are octal numbers.

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

 Illegal forms:
   [483,1]	Not an octal number
   [2*,3]	Partial wildcards not permitted
!
1 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
!
1 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
!
1 Support
 SOFTDB is supported on a time-available basis by Shari Dishop.
 Please forward specific problems, suggestions, etc. to:

       Shari Dishop
       Westinghouse VAX Support Group
       P.O. Box 746  MS 1615
       Baltimore, Md.  21203
