HELP [ KSAM/3000 Reference Manual ] MPE/iX 5.0 Documentation
KSAM/3000 Reference Manual
HELP
Requests help using KSAMUTIL
{HELP}
>{H }
This command returns a summary description of each of the KSAMUTIL
commands when entered at a terminal. The keyword "HELP" can be
abbreviated to "H" .
REQUESTING HELP
The HELP command lists all the valid KSAMUTIL commands and then asks if
you need information on a particular command. When you enter the name of
a KSAMUTIL command, HELP displays the command syntax. HELP is terminated
by entering N in response to the prompt MORE (Y/N)?.
The following example illustrates the HELP command. User input is
underlined.
>H
VALID COMMANDS ARE:
BUILD[B].......TO CREATE A FILE
ERASE..........TO RESET A FILE TO INITIAL CONDITIONS
EXIT[E]........TO LEAVE THIS ROUTINE
PURGE..........TO DELETE A FILE
RENAME[R]......TO RENAME A FILE
SAVE[S]........TO RETAIN A TEMPORARY FILE
VERIFY[V]......TO DESCRIBE FILE CHARACTERISTICS
KEYINFO[KI]....TO OBTAIN KEY FILE INFORMATIONS
KEYDUMB[KD]....TO OBTAIN FORMATTED KEY FILE STRUCTURAL DUMP
KEYSEQ[KS].....TO CHECK THE SEQUENCE OF KEY FILE
MORE (Y/N)?Y
ENTER COMMAND NAME: B
BUILD <DATAFILEREF>
[;DEV=<DEVICE>]
[;DISC=[<NUMREC>][,<NUMEXTENTS>][,<INITAL-OC>]]]
(REC=[<RECSIZE>][,[<BLOCKFACTOP>][,[F\V][,BINARY\,ASCII]]]]
[;TEMP]
[;CODE=<FILECODE>]
;KEY=<TYPE>,<POSITION>[,[<LENGTH>][,[<BLOCKING>][,DUPLICATE]]]
[,RDUP]
[;KEY=<TYPE>,<POSITION>[,[<LENGTH>][,[<BLOCKING>][,DUPLICATE]]]...]
[,RDUP]]]...]
[;LABELS=<NUMBERLABELS>]
[;FIRSTREC=0\-1]
[;KEYDEV=<DEVICE>]
;KEYFILE =FILEREFERENCE2
[;KEYENTPIES=<NUMBER>]
<TYPE>::=B\D\I\R\L\N\P\*
MORE (Y/N)?Y
ENTER COMMAND NAME: E
EXIT
MORE (Y/N)?Y
ENTER COMMAND NAME: ERASE
ERASE <FTLEREFERENCE>
MORE (Y/N)?Y
ENTER COMMAND NAME: PURGE
PURGE <FILEREFERENCE>[,TEMP]
MORE (Y/N)?Y
ENTER COMMAND NAME: R
RENAME <OLDFILEREF>,<NEWFILEREF>[,TEMP]
MORE (Y/N)?Y
ENTER COMMAND NAME: S
SAVE [<TEMPFILEREF>]
MORE (Y/N)?Y
ENTER COMMAND NAME: V
VERIFY [<FILFREFERENCE>]
[;OFFLINE]
[;NOCHECK]
MORE (Y/N)?Y
ENTER COMMAND NAME: KD
KEYDUMP [<FILEREFERENCE>]
[;SEQ=<KEYSEQUENCE>]
[;SUBSET=[ [-]<POSITION>][,<NUMBER>]]
I I
["CHAR-STRING"]
[;FILE =<FILEREFERENCE1>]
I I
[;OFFLINE ]
[;SORT]
MORE (Y/N)?Y
ENTER COMMAND NAME: KI
KEYINFO [<FILEREFERENCE>]
[;OFFLINE]
[;RECOVER]
MORE (Y/N)?Y
ENTER COMMAND NAME: KS
KEYSEQ [<FILEREFERENCE>]
[;SEQ=<KEYSEQENCE>]
(;OFFLINE]
[;NOLIST]
MORE (Y/N)?N <---------------- terminate HELP display
>E
END OF PROGRAM
MPE/iX 5.0 Documentation