XPLAIN

3-117. Purpose.

The XPLAIN command displays summary descriptions of selected EDIT/3000 commands or all EDIT/3000 commands.

3-118. Form.

The form of the XPLAIN command is

   X[PLAIN]  [ [ALL] [,A[DD] ] [,B[EGIN] ] [,C[HANGE] ] [,CO[PY] ] [,D[ELETE] ]



   [,E[ND] ] [,F[IND] ] [,G[ATHER] ] [,H [OLD] ] [,I[NSERT] ]



   [,J[OIN] ] [,K[EEP] ] [,L[IST] ] [,M[ODIFY] ] [,N[OT] ] [,O[R] ]



   [,P] ROCEDURE] ] [,Q] [,R[EPLACE] ] [,S[ET] ] [,T[EXT] ]



   [,U[SE] ] [,V[ERIFY] ] [,W[HILE] ] [,X[PLAIN] ]



   [,Y[ES] ] [,Z:: =]



   [,OFFLINE]  

3-119. Description.

The XPLAIN command displays a brief description of each command included as a parameter with the XPLAIN command or all commands if the parameter ALL is included. Note that the parameters ALL and OFFLINE must be spelled completely, the parameter for COPY must be CO (or [,cop], [,copy]), but all other parameters may be abbreviated to the first letter only (or the first letter plus any additional letters of the command; for example, [,LIST] may also appear as [,L], [,LI], and [,LIS]). If OFFLINE is specified, the descriptions are sent to the listfile as specified in the MPE/3000 :FILE command that defined listfile. (See paragraph 3-121, EXAMPLES.)

3-120. Limitations.

When the XPLAIN command is used with no parameters, a description of the XPLAIN command itself is displayed.

3-121. Examples.

The following examples illustrate the use of the XPLAIN ADD, XPLAIN OR, XPLAIN, and XPLAIN ALL,OFFLINE commands.

The XPLAIN command with no parameters displays a description of the XPLAIN command itself.

Before the command XPLAIN ALL,OFFLINE command can be executed, the listfile must be declared with an MPE/3000 :FILE command and equated to an output device, then the :EDITOR command must reference this file name. See the first two lines in the example.

   :FILE OUT;DEV=LP

   :EDITOR *OUT



   HP32201A.4.01 EDIT/3000 TUE, MAY 13, 1975,    1:19 PM

   /XPLAIN ADD

   ADD: TO ENTER LINES OF TEXT INTO THE TEXT FILE FROM THE $STDIN DEVICE

   OR FROM THE HOLD FILE

   EXAMPLE: ADD,60. HOLD



   /XPLAIN OR

   OR: RESETS FLAG TO BE TRUE IF IT IS FALSE, OR TO FALSE IF FLAG IS

   TRUE

   EXAMPLE: BEGINQ

             FINDQ"THIS"/*(+40)

             OR

             FINDQ"PROGRAM"/*(+20)

             END



   /XPLAIN

   XPLAIN: TO 0BTAIN AN EXPLANATION OF THE COMMANDS

   EXAMPLE: XPLAIN A.SET,F



   /XPLAIN ALL,OFFLINE

   *** OFF LINE LISTING BEGUN. ***