1 02/05/82 - audit_ I/O module
  2 
  3 
  4 Attach description:  audit_ switch_name {-control_args}
  5 
  6 
  7 Function: The audit_ I/O module intercepts I/O activity on a given
  8 switch, allowing one to log and or edit this data.
  9 
 10 
 11 Arguments:
 12 switch_name
 13    is the name of an I/O switch to inserted between the existing
 14    switch and its I/O module.
 15 
 16 
 17 Control arguments:
 18 -truncate, -tc
 19    truncate the old audit file, if it has the same name as the new
 20    one.
 21 -pathname, -pn
 22    use this pathname as the audit file. The default pathname is
 23    [homedir]>[date].audit .
 24 
 25 
 26 Modes operation:
 27 audit_input
 28    audit input lines. (DEFAULT -- on)
 29 audit_output
 30    audit output lines. (DEFAULT -- on)
 31 audit_edit
 32    enable audit editing. Does not put the user in the audit editor, it
 33    only makes it possible to enter the editor. (DEFAULT -- on)
 34 audit_meter
 35    write a metering stamp before each entry in the file.  The stamp
 36    consists of the actual time of the metering, incremental cpu time
 37    since the last stamp, and the incremental page faults since the
 38    last stamp.
 39 audit_file_size=n
 40    set the maximum number of records for the audit file to n.  The
 41    file is treated as a circular buffer of n records.  A file size of
 42    "unlimited" allows the audit file to grow indefinitely.
 43 audit_trigger=x
 44    set the audit request trigger character to x.
 45 audit_trace
 46    trace all control and mode calls to the module.  Mode trace
 47    entries are identified by a TM tag, control trace entries are
 48    identified by a TC tag.
 49 audit_truncate
 50    truncate the audit file.
 51 audit_transparent
 52    turn off auditing of audit and audit edit requests, as well as
 53    their output.
 54 audit_suspend
 55    turn off all modes.
 56 audit_use_editor_prompt
 57    turn on prompting in the audit editor.
 58 audit_editor_prompt_string=STR, audit_epstr=STR
 59    set the audit editor prompt string to STR.  The audit editor
 60    prompt has the default appearance "audit editor:  " ,or if the
 61    number of recursive invocations of the editor is greater than 1,
 62    "audit editor(level N):  ", where N is the depth of the current
 63    invocation.  This string is used as an ioa_ control string, with
 64    the arguments being: a bit which is on if the level is greater
 65    than 1; and, the level.  The default string is
 66    "^/audit editor^[(^d)^]:^2x".
 67 
 68 
 69 Notes on audit file: The default audit file pathname is
 70 [homedir]>[date].audit .  The default file_size is unlimited.  If one
 71 has sufficient data logged, the audit file may become a multi-segment
 72 file.  The first 10 bytes of the file contains the header, which is
 73 used by both the audit_ I/O module and the audit_editor.
 74 
 75 
 76 List of entry type identifiers:
 77 EL
 78    edit line, returned from audit editor.
 79 IC
 80    result of a get_chars.
 81 IL
 82    result of a get_line.
 83 M
 84    metering data.
 85 OC
 86    result of a put_chars.
 87 TC
 88    control request trace.
 89 TM
 90    mode request trace.
 91 
 92 
 93 Notes: For information about the audit editor see audit_editor.info.
 94 
 95 
 96 Notes on audit requests: The audit requests are always recognized when
 97 auditing is on.  The three character request sequence is the trigger
 98 character followed by the desired request followed by a new line.  The
 99 default trigger character is an exclamation mark ("!").
100 
101 
102 List of audit requests:
103 !.
104    print "audit" and which of input and output is being audited.
105 !?
106    print a brief description of available audit requests.
107 !e
108    enter the audit editor.
109 !E
110    enter the audit editor, with the input line processed as edit
111    requests.
112 !a
113    abbrev expand the input line.
114 !r
115    replay the input line.  That is, display the input line without a
116    new line.  Further input up to the next new line is appended to the
117    redisplayed input.  This is the input line which is passed through
118    the audit_ I/O module.
119 !t
120    instructs the audit_ module not to log the input line, i.e. to make
121    it transparent.
122 !d
123    delete the line.  It prevents the input line from ever being seen.
124 !n
125    no operation.  The input line to which this is appended is simply
126    passed through the audit_ module.