.! This is the help file for FILE, just say RUNOFF FILE.RNH
.! be sure to look through this and make any site specific
.! changes - just look for the commented lines ".!"
.lm 0
.rm 75
1 FILE
.br
    FILE is a utility for modifying file attributes.
.blank
    FILE DOES NOT convert a file. FILE changes characteristics of
the file, and thus VMS' view of the file. FILE can be used simply to view
the current characteristics of a file, or it can be used to change any of
the changeable characteristics. This utility can be VERY dangerous, and
should only be used if you have a good understanding of RMS. Care should
be taken when using this utility. While it doesn't actually change the file
itself, you might consider using a backup copy of the file.
.blank
.! Modify dev:[dir] to point to where you have stored FILE.CLD
.! or comment out the following lines if you install it in the
.! system wide dcltables
.!You must issue the command SET COMMAND dev:[dir]FILE to use this utility.
.!You may include this line in your login.com file.
.!.blank
    The first thing you should do is to use FILE/OUTPUT=output
to generate a listing of the current characteristics of the file. In
this way, you will be able to return the file to its original state.
.break
2 Examples
.break
    One common use of FILE, is to 'coerce' a file into being a
    Fixed 512 byte file, to upload/download the file via kermit.
    For example, given a saveset A.SAV, you could do the following:
.blank
 FILE/OUTPUT=A.FIX/NOEXACT A.SAV/RECORD__SIZE=512/ORGANIZATION=FIXED
.blank
    You could then transfer the two files A.FIX and A.SAV
    using Kermit (it would take two transfers, A.FIX with
    'set file type text', and A.SAV using 'set file type fixed')
.blank
    To turn the file back into its original useable self, you could
    then do:
.break
.i+5;@A.FIX
.break
    Which would cause the originally saved characteristics to be put
    back on the file.
.blank
.blank
    Another common use is to set the Fortran carriage control attribute
    so that a file can be printed with fortran carriage control, this
    can be done as follows:
.blank
FILE/OUTPUT=OLD.TMP NETMONTH.*/ATTRIBUTES=(FORTRANCC,NOIMPLIEDCC,NOPRINTCC)
.break
2 parameters
.break
    FILE takes one parameter, a filename, or list of filenames.
    The filenames can be wildcarded.
.break
2 qualifiers
.break
/OUTPUT
.break
.i+5;/OUTPUT[=filename]
.blank
    This qualifier causes the characteristics of the file to
    be displayed. Note that if you are also changing characteristics
    the displayed characteristics are the original characteristics.
    You can have the output placed in a file, by specifying a file
    name in the OUTPUT clause. This is usefull for restoring a file
    to its original state.
.break
/EXACT
.break
.i+5;/[NO]EXACT
.blank
    When used with /OUTPUT, this qualifier determines wether a
  complete file spec is displayed (/EXACT) or wether only the filename and
  filetype will be displayed (/NOEXACT).
.blank
.i+5;/EXACT is the default.
.break
/ATTRIBUTES
.break
    This qualifier determines the record attributes.
    You may enter a list of (negatable) attributes.
    The following attributes are legal:
.break
.i+5;FORTRANCC - Fortran carriage control
.break
.i+5;IMPLIEDCC - implied carriage control
.break
.i+5;PRINTCC - print file carriage control
.break
.i+5;SPAN - records can span blocks
.break
/CHARACTERISTICS
.break
    This qualifier determines the file characteristics.
    You may enter a list of (negatable) items.
    The following items are legal:
.break
.i+5;ACL__CORRUPT - File's ACL is corrupt
.break
.i+5;BACKUP - File is to be backed up
.break
.i+5;BEST__TRY__CONTIGUOUS - Keep file as contiguous as possible
.break
.i+5;CHARGE - File space is charged against owner
.break
.i+5;CONTIGUOUS - File is contiguous
.break
.i+5;DIRECTORY - File is a directory
.break
.i+5;ERASE__ON__DELETE - Erase contents of file before deletion
.break
.i+5;FILE__CORRUPT - File contains bad blocks
.break
.i+5;LOCKED - File is deaccess-locked
.break
.i+5;MARKED__FOR__DELETE - File is marked for deletion
.break
.i+5;READ__VERIFY - Verify all read operations
.break
.i+5;SPOOL - File is an intermediate spool file
.break
.i+5;WRITE__BACK - File may be write-back cached
.break
.i+5;WRITE__VERIFY - Verify all write operations
.break
    Note that not all of these items are really changeable. They
    are merely included for completeness sake.
.break
/ORGANIZATION
.break
    This qualifier determines the file organization.
    you must enter one of:
.break
.i+5;DIRECT
.break
.i+5;INDEXED
.break
.i+5;RELATIVE
.break
.i+5;SEQUENTIAL
.break
/TYPE
.break
    This qualifier determines the record type.
    you must enter one of:
.break
.i+5;FIXED - fixed record type
.break
.i+5;VARIABLE - variable record type
.break
.i+5;VFC - variable + fixed control
.break
.i+5;STREAM - RMS-11 (DEC traditional) stream format
.break
.i+5;LFSTREAM - LF-terminated stream format
.break
.i+5;CRSTREAM - CR-terminated stream format
.break
.i+5;UNDEFINED - undefined record type
.break
/BUCKET__SIZE
.break
    This qualifier determines the bucket size.
.break
/DEFAULT__EXTEND__QUANTITY
.break
    This qualifier determines the default extend quantity.
.break
/END__OF__FILE__BLOCK
.break
    This qualifier determines the end of file block.
.break
/FIRST__FREE__BYTE
.break
    This qualifier determines the first free byte in the end
    of file block.
.break
/HIGHEST__ALLOCATED__BLOCK
.break
    This qualifier determines the highest allocated block.
.break
/GLOBAL__BUFFER__COUNT
.break
    This qualifier determines the global buffer count.
.break
/JOURNAL
.break
    This qulifier determines the type of journaling enabled on the file.
    you must enter one of:
.break
.i+5;JOURNAL - this is a journal file
.break
.i+5;AIJNL - enable after image journal
.break
.i+5;ATJNL - enable audit trail journal
.break
.i+5;BIJNL - enable before image journal
.break
.i+5;RUJNL - enable recovery unit journal
.break
.i+5;NEVER__RU - file is never accessible in recovery unit
.break
.i+5;ONLY__RU - file is only accessible in recovery unit
.break
/MAXIMUM__RECORD__SIZE
.break
    This qualifier determines the maximum record size.
.break
/RECORD__SIZE
.break
    This qualifier determines the record size.
.break
/DIRECTORY__VERSION__LIMIT
.break
    This qualifier allows you to set the default number of allowable
    versions of file. This is applicable only to directories. Note that
    32767 is equivalent to 0, or No Limit, so to say.
.blank
    This is equivalent to SET DIRECTORY/VERSION=n.
.break
/VERSION__LIMIT
.break
    This qualifier allows you to set the number of allowable versions
    of a file. Note that 32767 is equivalent to 0, or No Limit, so to say.
.blank
    This is equivalent to SET FILE/VERSION=n.
.break
/VFC__SIZE
.break
    This qualifier allows you to set the vcf size.
.break
/CREATION__DATE
.break
.i+2;/[NO]CREATION__DATE
.blank
    This qualifier allows you to set the creation date.
    /NOCREATION__DATE clears the creation date.
.break
/REVISION__DATE
.break
.i+2;/[NO]REVISION__DATE
.blank
    This qualifier allows you to set the revision date.
    /NOREVISION__DATE clears the revision date.
.break
/EXPIRATION__DATE
.break
.i+2;/[NO]EXPIRATION__DATE
.blank
    This qualifier allows you to set the expiration date.
    /NOEXPIRATION__DATE clears the expiration date.
.break
/BACKUP__DATE
.break
.i+2;/[NO]BACKUP__DATE
.blank
    This qualifier allows you to set the backup date.
    /NOBACKUP__DATE clears the backup date.
.break
/NUMBER__OF__REVISIONS
.break
    This qualifier allows you to set the number of revisions.
.break