Documentation Utilities › System Documentation › General Considerations for System Documentation › Toolkit File Documenter

Toolkit File Documenter

The Toolkit Document File utility (YDOCF) provides a compact listing of all the relevant information about a file. The utility works on database files, device files, or both. Included in the listing generated by the utility are the following items of information:

• Object information
• Access path information, including key fields
• Join file information, including join fields
• Source member information
• Format information
• Database dependency information
• Field information, optionally including offsets, and definition references
• Additional field explanation comments, extracted from the field dictionary

Examples of the output of the YDOCF command are shown in the following two illustrations.

Two levels of list detail are allowed: a basic level (80 characters per line), suitable for inclusion in system specifications, and a detailed level (132 characters per line), suitable as a reference document for programmers.

The command may be run on a file, a generic file name, or on a list of files. For instance, the following command would document all of the physical files in a library:

YBLDOBJLST OBJ(QGPL/*ALL)  OBJTYPE(*FILE) /* build list  */
YDOCF FILE(*OBJLST) FILEATR(*PHY) /* Document it */