The FMS/DESCRIPTION command creates printable versions of FMS forms.
The form descriptions are created in various formats depending on
the qualifier used. The qualifiers are mutually exclusive.
Example: FMS/DESCRIPTION/FULL LIBNAME/FORM_NAME=FORMA
A full form description is created giving the form data
structures in the syntax of the FMS Form Language for the form
FORMA in the file LIBNAME.FLB. The output file can be used with
the FMS/TRANSLATE command. The output goes to the file
LIBNAME.FLG by default.
1 /BRIEF
Outputs only essential information about the specified form (field names, Named Data, essential attributes). Does not output the form image. The default input file type is FRM and the default output is sent to the device SYS$OUTPUT.
1.1 – Qualifiers
1.1.1 /FORM_NAME
library_spec/FORM_NAME=(form_name,...) Output descriptions for the forms specified after the /FORM_NAME qualifier. The qualifier applies only to the immediately preceding form library. If the /FORM_NAME qualifier is omitted, the entire library is output. To name more than one form, enclose the list in parentheses.
1.1.2 /LOG
/LOG /NOLOG (D) The /LOG qualifier causes a log of all forms for which descriptions are generated to be output to the device SYS$OUTPUT. The /NOLOG form which is the default disables logging.
1.1.3 /OUTPUT
/OUTPUT=file_spec (D) /NOOUTPUT The /OUTPUT qualifier allows you to supply a name for the output description file. If the file specification is omitted the output defaults to SYS$OUTPUT. The /NOOUTPUT qualifier causes output to be discarded.
2 /DECLARATIONS
Outputs a data structure declaration template for the forms
specified. These declarations are used by applications to provide a
convenient data interface with the FMS Form Driver. Forms with
irregular use of indexed fields or with scrolled areas are not
directly supported. The default input file type is FRM. The default
output goes to a file with the same name as the input file with the
file type TXT.
Example: FMS/DESCRIPTION/DECLARATIONS LIBNAME.FLB/OUTPUT=FILENAME
In this example a series of data declarations are produced for
each of the forms in the form library LIBNAME.FLB. The output is
directed to the file FILENAME.TXT. The file must be edited into
the proper format for use by COBOL or DATATRIEVE.
2.1 – Qualifiers
2.1.1 /FORM_NAME
library_spec/FORM_NAME=(form_name,...) Output descriptions for the forms specified after the /FORM_NAME qualifier. The qualifier applies only to the immediately preceding form library. If the /FORM_NAME qualifier is omitted, the entire library is output. To name more than one form, enclose the list in parentheses.
2.1.2 /LOG
/LOG /NOLOG (D) The /LOG qualifier causes a log of all forms for which descriptions are generated to be output to the device SYS$OUTPUT. The /NOLOG form which is the default disables logging.
2.1.3 /OUTPUT
/OUTPUT=file_spec (D) /NOOUTPUT The /OUTPUT qualifier allows you to supply a name for the output description file. If the file specification is omitted the output defaults to the same name as the input file with the file type TXT. The /NOOUTPUT qualifier form causes output to be discarded.
3 /DISPLAY_IMAGE
Outputs an image of a form as it would appear when displayed. The
argument specifies the type of output device. The legal values
are NOESCAPE_SEQUENCE, ESCAPE_SEQUENCE, VT100_ESCAPE_SEQUENCE and
LN03_ESCAPE_SEQUENCE. NOESCAPE_SEQUENCE, the default, produces output
for ordinary printers. ESCAPE_SEQUENCE produces output for devices
that support VT100 ANSI Escape Sequences. VT100_ESCAPE_SEQUENCE
produces output for devices that support VT100 ANSI Escape Sequences.
LN03_ESCAPE_SEQUENCE produces output for devices that support LN03
Escape Sequences. The default input file type is FRM, and the default
output file type is LIS.
FMS/DESCRIPTION/DISPLAY_IMAGE replaces FMS/DESCRIPTION/IMAGE.
Example: FMS/DESCRIPTION/DISPLAY_IMAGE=ESCAPE_SEQUENCE FORMLIB1-
/FORM=FORM1
The output image file will contain escape sequences so that when
the form is displayed on a VT100 or VT100 compatible terminal,
the video attributes can be seen as defined.
3.1 – Qualifiers
3.1.1 /FORM_NAME
library_spec/FORM_NAME=(form_name,...) Output descriptions for the forms specified after the /FORM_NAME qualifier. The qualifier applies only to the immediately preceding form library. If the /FORM_NAME qualifier is omitted, the entire library is output. To name more than one form, enclose the list in parentheses.
3.1.2 /LOG
/LOG /NOLOG (D) The /LOG qualifier causes a log of all forms for which descriptions are generated to be output to the device SYS$OUTPUT. The /NOLOG form which is the default disables logging.
3.1.3 /OUTPUT
/OUTPUT=file_spec (D) /NOOUTPUT The /OUTPUT qualifier allows you to supply a name for the output description file. If the file specification is omitted the output file name defaults to the same as the input file with the type LIS. The /NOOUTPUT qualifier causes output to be discarded.
4 /FULL (D)
Outputs a complete description of the specified form in the syntax of the FMS Form Language. The default input file type is FRM. The default output file type is FLG. This is the default qualifier for the FMS/DESCRIPTION Command.
4.1 – Qualifiers
4.1.1 /FORM_NAME
library_spec/FORM_NAME=(form_name,...) Output descriptions for the forms specified after the /FORM_NAME qualifier. The qualifier applies only to the immediately preceding form library. If the /FORM_NAME qualifier is omitted, the entire library is output. To name more than one form, enclose the list in parentheses.
4.1.2 /LOG
/LOG /NOLOG (D) The /LOG qualifier causes a log of all forms for which descriptions are generated to be output to the device SYS$OUTPUT. The /NOLOG form which is the default disables logging.
4.1.3 /OUTPUT
/OUTPUT=file_spec (D) /NOOUTPUT The /OUTPUT qualifier allows you to supply a name for the output description file. If the file specification is omitted the output defaults to the same name as the input file with the file type FLG. The /NOOUTPUT qualifier causes output to be discarded.
5 /IMAGE
Use FMS/DESCRIPTION/DISPLAY_IMAGE instead of FMS/DESCRIPTION/IMAGE. See FMS/DESCRIPTION/DISPLAY_IMAGE for help.