HELPLIB.HLB  —  PEEK  Commands  SAVE_SCREEN
   $ PEEK/SAVE_SCREEN                PEEK> SAVE_SCREEN

   The PEEK/SAVE_SCREEN subcommand is used on AXP to start the
   screen-saver feature for a terminal. On AXP, SAVE_SCREEN also
   enables watching of RTA terminals.

   On AXP, terminals with the screen-saver feature turned on provide a
   full initial-screen-contents display for the watcher when they are
   watched with Peek/Spy.

   SAVE_SCREEN is also used on both AXP and VAX to start terminal-
   logging - the logging to a disk file of all the output sent to the
   terminal. See the PEEK Commands SAVE_SCREEN Subtopic: /OUTPUT_LOG_FILE.

   Examples for AXP:

   $ PEEK /SAVE_SCREEN         ! Start screen-saving for SYS$COMMAND.
   $ SPY  /SAVE_SCREEN LTA5059 ! Start screen-saving for LTA5059.

   Example for AXP or VAX:

   $ PEEK
   PEEK> SAVE_SCREEN/LOG       ! Start screen-saving with a log file.

1  –  Description

   Screen-saving begins on AXP after a SAVE_SCREEN command has been
   done.

   (On VAX, screen-saving is begun by turning on NDC's MultiSessions.)

   On AXP, RTA terminals may ONLY be watched after they've done a
   PEEK/SAVE_SCREEN. (The command on VAX is PEEK/RT_ENABLE.)

   On AXP it is wise, therefore, to do a PEEK/SAVE_SCREEN ahead of
   time, such as from SYLOGIN.COM or LOGIN.COM, so enough time
   elapses before watching begins for a full screen to be saved for
   display when watching begins.

   On AXP, if screen-saving has not yet been started when watching
   begins, then PEEK automatically turns on the screen-saver (this
   does not apply to RTA terminals which must issue a
   PEEK/SAVE_SCREEN on AXP in order to be watched with Peek/Spy), but
   in this case there hasn't yet been enough time to save a full
   screen, so only a partial screen is initially displayed for the
   watcher, or even no screen at all if nothing has been sent to the
   terminal since screen-saving started.

   For VAX, terminal-logging is now begun by using PEEK/SAVE_SCREEN/LOG.

   Screen-saving and any terminal-logging are both turned off by the
   NOSAVE_SCREEN command. Terminal-logging alone is turned off with
   the SAVE_SCREEN/CLOSE_FILE command, without also turning off
   screen-saving.

   If a screen-saver is on without a log file, then a log file can
   be started using the SAVE_SCREEN/LOG[=file] command.

   When logging is in progress, a new log file can be started with
   PEEK/SAVE_SCREEN/LOG/NEW_FILE. This closes any existing log file
   and starts terminal-logging to a new log file.

2  –  Parameters

   AXP-Only...

   For the SPY program only, you can specify the name of a terminal
   other than your own for which the screen-saver is to be turned on.

   You cannot, however, use SPY to start screen-saving with logging
   for some other terminal than your own. Terminal-logging can only
   be started from the terminal itself which is to be logged. (You
   can, of course, watch the terminal with $ SPY/LOG and make a log
   file that way.)

   Example:

   $ SPY /SAVE_SCREEN LTA5059 ! Start screen-saving for LTA5059.

   You can use the above command to start up screen-saving for
   LTA5059 before watching it, so you will have an initial full-
   screen display available when you do start watching LTA5059.

3  –  Qualifiers

3.1    /CLOSE_FILE

   $ PEEK/SAVE_SCREEN /CLOSE_FILE

   The /CLOSE_FILE qualifier closes any existing log file turned on with
   PEEK/SAVE_SCREEN/LOG, without interrupting the ongoing screen-saving.

   This means a watcher will still be able to get an initial full-screen
   display when starting to watch the terminal. Only any on-going
   terminal-logging is ended with SAVE_SCREEN/CLOSE_FILE.

   Example: PEEK> SAVE_SCREEN/CLOSE_FILE    ! Close current log file.

3.2    /LOG_FILE

   $ PEEK/SAVE_SCREEN /LOG_FILE [=file_spec]

   This a synonymous with the /OUTPUT_LOG_FILE qualifier.

   See the PEEK Commands SAVE_SCREEN Subtopic: /OUTPUT_LOG_FILE.

3.3    /MAX_REOPEN

   $ PEEK/SAVE_SCREEN/LOG/REOPEN /MAX_REOPEN = blocks
                                 /NOMAX_REOPEN

   Specifies the approximate maximum number of blocks to which a
   terminal-logging file may grow before a new version of the log file
   is started, when /REOPEN is in effect.

   Use /NOMAX_REOPEN to specify that any default /MAX_REOPEN value
   should be ignored.

   The default value for /MAX_REOPEN is taken from the logical
   SAVE$MAX_REOPEN, usually defined by PEEK_DEFAULTS.COM.

   Example: $ PEEK/SAVE_SCREEN/LOG/REOPEN/MAX_REOPEN=100

   For more information, see the PEEK Commands SAVE_SCREEN Subtopic:
   /REOPEN.

3.4    /MIN_REOPEN

   $ PEEK/SAVE_SCREEN/LOG/REOPEN /MIN_REOPEN = blocks
                                 /NOMIN_REOPEN

   Specifies the minimum number of blocks to which a terminal-
   logging file must grow before a new version of the log file is
   started, when /REOPEN is in effect.

   Use /NOMIN_REOPEN to specify that any default /MIN_REOPEN value
   should be ignored.

   The default value for /MIN_REOPEN is taken from the logical
   SAVE$MIN_REOPEN, usually defined by PEEK_DEFAULTS.COM.

   Example: $ PEEK/SAVE_SCREEN/LOG/REOPEN/MIN_REOPEN=10

   /MIN_REOPEN is ignored for reopens done as a result of
   a /TIME_OF_DAY specification.

   For more information, see the PEEK Commands SAVE_SCREEN Subtopic:
   /REOPEN

3.5    /NEW_FILE

   $ PEEK/SAVE_SCREEN/LOG /[NO]NEW_FILE

   Used to specify that a new terminal-logging file should be started.
   Any current terminal-logging file is closed.

   Example:

   $ PEEK/SAVE_SCREEN/LOG=LOG.LOG     ! Start logging to LOG.LOG.

   $ PEEK/SAVE_SCREEN/LOG=NEWLOG.LOG/NEW_FILE
                                      ! Close LOG.LOG and start
                                      ! logging to NEWLOG.LOG.

   The new file will contain the full initial contents of the screen
   at the time the command is executed.

3.6    /OUTPUT_LOG_FILE

   $ PEEK/SAVE_SCREEN /OUTPUT_LOG_FILE [=file_spec]

   SAVE_SCREEN/OUTPUT_LOG_FILE[=file] is used to create a log file
   containing everything output to the terminal while the screen-
   saving is in effect.

   The default filespec is taken from the logical SAVE$OUTPUT_LOG_FILE.
   This logical may be defined system-wide by PEEK_DEFAULTS.COM, or it
   may be defined in any of the logical-name tables specified in
   LNM$PEEK_TABLE_SEARCH_LIST, which is defined by PEEK_DEFAULTS.COM.
   See the top-level PEEK Subtopic: Defaults.

   If this logical is not defined and if /OUTPUT_LOG_FILE is specified
   without the optional file-spec, then PEEK will generate a log file
   in the current default directory using a default log-file name of:

       PEEK_TRMLOG_username_terminalname.LOG

   If a log file is already being made, then it can be closed with a
   $ PEEK/SAVE_SCREEN/CLOSE_FILE command.

   To close the current log file and start logging to a new log file
   use a $ PEEK/SAVE_SCREEN/LOG/NEW_FILE command.

   The /REOPEN qualifier also affects PEEK/SAVE_SCREEN/LOG.

   Terminal logging with /SAVE_SCREEN/LOG is terminated by a
   PEEK/SAVE_SCREEN/CLOSE_FILE command, or a PEEK/NOSAVE_SCREEN command.

   Example:

        $ PEEK/SAVE /OUTPUT=SAVE_OUTPUT

   Note that /LOG and /OUTPUT_LOG are synonymous.

3.7    /PERMANENT

   $ PEEK/SAVE_SCREEN /PERMANENT
                      /NOPERMANENT  (default)

   Used to specify that the screen-saving (on AXP) or terminal-logging
   (on AXP or VAX) cannot be shut off for the terminal concerned.

   Example: $ PEEK/SAVE_SCREEN/PERMANENT       ! (AXP-Only)

   Also applies to terminal-logging on both VAX and AXP. E.g.

     PEEK> SAVE_SCREEN /LOG=PERMANENT.LOG /PERMANENT

   The PERMANENT qualifier disallows turning off screen-saving with the
   NOSAVE_SCREEN command. If there is a log file for the screen-saving,
   then the logging cannot be turned off if /PERMANENT is used.

   A permanent screen-saver only goes away when the terminal itself goes
   away (for LTAs etc which are deleted when the user logs off) or when
   the system is shut down (for permanent terminals such as TTAs, etc.).

   The /PERMANENT qualifier should be used with EXTREME CAUTION with
   logging on direct-connect terminal such as TTA's, TXA's or OPA's
   since with these terminals the log file will just continue to grow
   and can't be turned off without rebooting the system.

   /PERMANENT is mainly intended for security use on such things as
   dial-up lines, where a log file of the terminal output is desired
   and the system manager doesn't want the user to be able to stop
   the logging by doing a NOSAVE_SCREEN or SAVE/CLOSE_FILE command.

3.8    /REOPEN

   $ PEEK/SAVE_SCREEN/LOG /[NO]REOPEN

   Used to specify that new versions of a terminal-logging file
   should [not] be periodically opened.

   Example: $ PEEK/SAVE_SCREEN/LOG/REOPEN

   /REOPEN re-opens a new version of the log file whenever it
   reaches a certain number of disk blocks, or whenever a certain
   time of day or span of time has elapsed, providing at least a certain
   minimum number of blocks have been written to the file.

   The maximum and minimum blocks and the time of day and time span are
   specified using the /MAX_REOPEN, /MIN_REOPEN, /SPAN and /TIME_OF_DAY
   qualifiers, or by defaults for these which are specified in logical
   names.

   Each reopened log files has a copy of the initial full-screen at the
   time the log file was reopened.

   The default /REOPEN value is taken from the logical SAVE$REOPEN.

   /NOREOPEN is used on the command line to override a default
   /REOPEN value.

   (Note: /APPEND is ignored for PEEK/SAVE/LOG when /REOPEN is
   in effect.)

3.9    /SPAN

   $ PEEK/SAVE_SCREEN/LOG/REOPEN /SPAN = minutes
                                 /NOSPAN

   Specifies the approximate time period which should elapse before
   a new version of a terminal-logging file should be started, when
   /REOPEN is in effect.

   Use /NOSPAN to specify that any default /SPAN value should
   be ignored.

   The default value for this qualifier is taken from the logical
   name SAVE$SPAN.

   Example: $ PEEK/SAVE_SCREEN/LOG/REOPEN/SPAN=10

   The number of minutes can contain a decimal point. The minimum
   acceptable value is 1 minute.

   For more information, see the PEEK Commands SAVE_SCREEN Subtopic:
   /REOPEN

3.10    /TIME_OF_DAY

   $ PEEK/SAVE_SCREEN/LOG/REOPEN /TIME_OF_DAY = hh:mm
                                 /NOTIME_OF_DAY

   Specifies the approximate time of day when a new version of a
   terminal-logging file should be started (when /REOPEN is in
   effect).

   Use /NOTIME_OF_DAY to specify that any default /TIME_OF_DAY
   value should be ignored.

   The default value for this qualifier is taken from the logical
   name SAVE$TIME_OF_DAY.

   Example: $ PEEK/SAVE_SCREEN/LOG/REOPEN/TIME_OF_DAY=23:59

   The above command specifies that a new log file version should
   be created at 1 minute before midnight each day.

   Valid values for /TIME_OF_DAY are 00:00 through 23:59.

   Note that all 5 characters of the hh:mm syntax are required
   in all cases. Midnight would be specfied as 00:00. (The
   special value /TIME_OF_DAY=-1 is the equivalent of
   /NOTIME_OF_DAY and causes the qualifier to be ignored.)

   Examples:             The log file will be reopened at:

   /TIME_OF_DAY=00:00    12:00 AM
   /TIME_OF_DAY=00:01	12:01 AM
   /TIME_OF_DAY=01:00 	 1:00 AM
   /TIME_OF_DAY=12:00 	12:00 PM
   /TIME_OF_DAY=14:03	 2:03 PM

   Any /MIN_REOPEN value is ignored when reopening a file at
   the /TIME_OF_DAY specified.

   For more information, see the PEEK Commands SAVE_SCREEN
   Subtopic:

   /REOPEN
Close Help