DOCUMENT

Purpose

Begins a block of documentation in a command file.

Syntax

DOC[UMENT]

Usage Notes

For information on the current method of inserting comments in a command file, refer to the section "Placing Comments in Command Files" under "Saving Commands for Later Use" in Chapter 3 and to the REMARK command in the "Command Reference" in Chapter 8.

After you type DOCUMENT and enter [Return], SQL*Plus displays the prompt DOC> in place of SQL> until you end the documentation. The "pound" character (#) on a line by itself ends the documentation.

If you have set DOCUMENT to OFF, SQL*Plus suppresses the display of the block of documentation created by the DOCUMENT command. (See "SET DOCUMENT" later in this appendix.)