IDENT "V1.0-003" !++ ! Title: PHOTO - Session logging utility for VAX/VMS ! Module: PHOTOCLD.CLD - Command definition ! Author: James A. Harvey ! Organization: Indiana University-Purdue University at Indianapolis ! Department: Integrated Technologies Services-Technical Support/Networks ! Date Written: September 1991. ! Version: 1.0-003 ! ! PHOTO is an interactive session logging utility. ! ! Format: ! ! PHOTO [log-filespec] ! ! Parameters: ! ! log-filespec ! ! Specifies the name to use for the log file. The default name is ! PHOTO.LOG in your default directory. ! ! Qualifiers: ! ! /BROADCAST ! ! /BROADCAST ! /NOBROADCAST (default) ! ! Causes messages broadcast to the original session's terminal line ! to be captured and written to the PHOTO session's pseudoterminal ! device. This will cause the messages to appear both at the user's ! terminal and in the PHOTO session log file. The default action is ! /NOBROADCAST; that is, messages broadcast to the original session's ! terminal line will appear as they normally do on the user's terminal, ! but will not appear in the PHOTO session log. ! ! /CHECK ! ! /CHECK (default) ! /NOCHECK ! ! Do not allow PHOTO to be run under PHOTO, that is, if there is ! parent process "above" this one in the job's process tree that is ! already running PHOTO, issue an error message and exit. /CHECK is ! the default behavior. ! ! /COPYRIGHT ! ! /COPYRIGHT ! /NOCOPYRIGHT (default) ! ! Displays PHOTO copyright message. ! ! /FORMAT ! ! /FORMAT=BINARY ! /FORMAT=TEXT (default) ! ! Format of log file. Default is /FORMAT=TEXT. This produces a ! standard RMS text file with variable length records and carriage- ! return carriage control. For TEXT format, the terminal output is ! scanned for a carriage-return line-feed sequence which determines ! the record boundary. ! ! /FORMAT=BINARY writes a fixed-length 512 byte record file ! containing all characters written to the terminal. The last ! record is padded with nulls to 512 bytes. ! ! /SPAWN ! ! /SPAWN (default) ! /NOSPAWN ! ! PHOTO by default creates a subprocess of the process running PHOTO. ! Specifying /NOSPAWN creates an interactive detached process running ! LOGINOUT instead. ! ! /TIMESTAMP ! ! /TIMESTAMP[=quoted-format-string] ! /NOTIMESTAMP[=quoted-format-string] (default) ! ! The /TIMESTAMP qualifier causes the utility to initially ! write a timestamp to the terminal and log file before the ! first record output after each read completion. /NOTIMESTAMP, ! the default, suppresses this action as the initial state. ! Timestamping can be toggled on and off using the /TOGGLE ! qualifier and a suitable value. ! ! You can specify the date/time format of timestamps by giving ! a string value for this qualifier. The format is specified as ! described in section 3.3.2.3.2, "Specifying Output Formats at ! Compile Time", of the VMS RTL Library Manual (page 3-13, April ! 1988). If no value is specified, the format defaults to that ! obtained from the logical names SYS$LANGUAGE and LIB$DT_FORMAT. ! ! /TOGGLE ! ! /TOGGLE=(option-keyword:character-mnemonic[,...]) ! ! Sets the control character(s) used to toggle logging and ! time-stamping on and off. Option-keyword is one of LOG or ! TIMESTAMP. Control-character-mnemonic is one of the ANSI ! three-letter control character mnemonics (DLE, FS, GS, etc.), ! a name of the form CTRLx (e.g., CTRLP for DLE), or NONE, ! meaning do not toggle. The default is /TOGGLE=(LOG=NONE, ! TIMESTAMP=NONE). Because of their special meaning to the ! VMS terminal driver or to PHOTO, the control characters ! listed below not be used as the toggle control characters: ! ! Name ANSI Mnemonic Terminal Driver Usage ! ! NUL Used internally by PHOTO ! CTRL/C ETX Interrupt ! CTRL/J LF Line feed ! CTRL/M CR Carriage return ! CTRL/Q DC1 Flow control ! CTRL/S DC3 Flow control ! CTRL/T DC4 Process status ! CTRL/Y EM Interrupt ! CTRL/Z SUB End of file ! ! /VERBOSE ! ! /VERBOSE (default) ! /NOVERBOSE ! ! Issue informative messages when PHOTO is started or stopped, or ! when logging or timestamping is toggled on or off. ! !-- DEFINE VERB PHOTO PARAMETER P1, VALUE(TYPE=$FILE, DEFAULT="PHOTO.LOG") QUALIFIER BINARY, NEGATABLE ! Undocumented qualifier. QUALIFIER BROADCAST, NEGATABLE QUALIFIER CHECK, NEGATABLE, DEFAULT QUALIFIER COPYRIGHT, NEGATABLE QUALIFIER FORMAT, NONNEGATABLE, VALUE(TYPE=FORMAT_OPTIONS, REQUIRED) QUALIFIER SPAWN, NEGATABLE, DEFAULT QUALIFIER TIMESTAMP, NEGATABLE, VALUE QUALIFIER TOGGLE, NONNEGATABLE, VALUE(LIST, TYPE=TOGGLE_OPTIONS, REQUIRED) QUALIFIER VERBOSE, NEGATABLE, DEFAULT DISALLOW BINARY AND FORMAT DEFINE TYPE FORMAT_OPTIONS KEYWORD BINARY KEYWORD TEXT DEFINE TYPE TOGGLE_OPTIONS KEYWORD LOG VALUE(TYPE=CTRL_CHAR_MNEMONICS, REQUIRED) KEYWORD TIMESTAMP VALUE(TYPE=CTRL_CHAR_MNEMONICS, REQUIRED) DEFINE TYPE CTRL_CHAR_MNEMONICS KEYWORD NONE KEYWORD CTRLA KEYWORD CTRLB ! KEYWORD CTRLC KEYWORD CTRLD KEYWORD CTRLE KEYWORD CTRLF KEYWORD CTRLG KEYWORD CTRLH KEYWORD CTRLI ! KEYWORD CTRLJ KEYWORD CTRLK KEYWORD CTRLL ! KEYWORD CTRLM KEYWORD CTRLN KEYWORD CTRLO KEYWORD CTRLP ! KEYWORD CTRLQ KEYWORD CTRLR ! KEYWORD CTRLS ! KEYWORD CTRLT KEYWORD CTRLU KEYWORD CTRLV KEYWORD CTRLW KEYWORD CTRLX ! KEYWORD CTRLY ! KEYWORD CTRLZ ! KEYWORD NUL KEYWORD SOH KEYWORD STX ! KEYWORD ETX KEYWORD EOT KEYWORD ENQ KEYWORD ACK KEYWORD BEL KEYWORD BS KEYWORD HT ! KEYWORD LF KEYWORD VT KEYWORD FF ! KEYWORD CR KEYWORD SO KEYWORD SI KEYWORD DLE ! KEYWORD DC1 KEYWORD DC2 ! KEYWORD DC3 ! KEYWORD DC4 KEYWORD NAK KEYWORD SYN KEYWORD ETB KEYWORD CAN ! KEYWORD EM ! KEYWORD SUB KEYWORD ESC KEYWORD FS KEYWORD GS KEYWORD RS KEYWORD US ! End of PHOTOCLD.CLD