/sys$common/syshlp/TPUHELP.HLB  —  SET(JOURNALING)
  SET(JOURNALING)

     Performs either of two functions depending on the variant used.

     One variant specifies how frequently records are written to the journal
     file.  This variant can be used regardless of whether keystroke
     journaling or buffer change journaling is being used.

     The other variant turns on or turns off buffer-change journaling and
     allows you to specify a journal file name.

  Syntax

     SET (JOURNALING, integer)

              or

     SET (JOURNALING, buffer, {ON | OFF} [,file_name_string])

  Parameters

     JOURNALING         A keyword indicating that the SET built-in is being
                        used to enable, disable, or set the frequency of
                        journaling.

     integer            A number from 1 through 10.  The lower the value,
                        the more frequently records are written to disk.

     buffer             The buffer for which you want to turn on
                        buffer-change journaling.

     ON                 A keyword turning on buffer-change journaling.

     OFF                A keyword turning off buffer-change journaling.

     file_name_string   The string naming the file you want to use as the
                        buffer's journal file.  If the file does not exist,
                        TPU automatically creates it.  You cannot specify
                        this parameter if you have specified the keyword OFF
                        for the third parameter.  If you do not specify any
                        file name when you turn journaling on, TPU
                        creates a journal file for you and names the file
                        using the default naming algorithm.

  Comments

     If you are using the variant that sets journaling frequency, a value
     of 1 causes a record to be written for approximately every 10 keys
     pressed; a value of 10, for every 125 keys.  If you are entering only
     text (rather than procedures bound to keys), the number of keystrokes
     included in a record is greater:

     o  For a value of 1, a record is written for approximately every 30 to
        35 keystrokes.

     o  For a value of 10, a record is written for approximately every 400
        keystrokes.

  Examples

     1.  SET (JOURNALING, CURRENT_BUFFER, ON, "disk1:[reinig]journal.jnl")

         Turns on buffer-change journaling for the current buffer and
         directs TPU to use the file JOURNAL.JNL in the directory
         [REINIG] as the journal file.

     2.  SET (JOURNALING, 1);

         Specifies that journaling records are to be written as frequently
         as possible.  Thus, if the editing session is interrupted by a
         system failure, such as a communications break between your
         terminal and the computer, you are less likely to have lost any
         keystrokes.

     3.  SET (JOURNALING, 10);

         Specifies that journaling records are to be written as infrequently
         as possible.  This may improve performance, depending on your
         system configuration, but it increases the risk that some
         keystrokes will be lost if you have to use the journal file to
         recover your edits after a system failure.

  Related topics

     CREATE_BUFFER                 GET_INFO(BUFFER_VARIABLE)
     GET_INFO(STRING_VARIABLE)     GET_INFO(SYSTEM)
     JOURNAL_CLOSE                 JOURNAL_OPEN
     RECOVER_BUFFER
Close Help