log3struct(4) log3struct(4)
NAME
log3struct - Logging description file
SYNOPSIS
$LOGPATH/log3struct
DESCRIPTION
The administrator defines the layout descriptions of the log data in
the description file log3struct, which the command log3display(1M)
requires to display this data. Here, the administrator assigns various
display options to the numbers of the descriptions (also called struc-
ture IDs). The command log3display(1M) interprets these options to
edit the application data.
The application transfers the value of the structure ID to the log
server as a parameter of the function log3write(5).
The description file is located in the directory defined by $ADMPATH.
If $ADMPATH is not specified in the environment, it is replaced by the
value of $LOGPATH.
The log3struct file is an ASCII text file, which can be edited either
directly with an editor, or via the menu.
The command log3display(1M) does not interpret the text file
log3struct directly, rather it waits for a binary file log3struct.obj,
which it can load and process in its own data structures.
This log3struct.obj file is created using the command log3str, which
is called automatically via the menu. After a description file has
been modified directly using the editor, the command log3str must be
called from Shell level.
The command log3str carries out a syntax test and creates the binary
file log3struct.obj, if there are no errors.
Options can be used to suppress or force the display of most fields.
The command log3display(1M) uses a layout description for the log data
blocks, - if a structure ID is available - for example, in order to
supply the individual blocks with a meaningful identifier.
A layout description is not required for log data blocks with the
structure ID 0, therefore it need not be entered.
If there is no suitable layout description for the structure ID
(STRUCT statement), every log data block is displayed on a new line
(with no identifier).
Page 1 Reliant UNIX 5.44 Printed 11/98
log3struct(4) log3struct(4)
Syntax of file log3struct
Every description begins with the following ID:
#STRUCT number ; (number = 1 ... 65534)
and ends with the first # character, that is not contained in a com-
ment field.
Comments include all characters that come after a semicolon (;) to the
end of the line, and all lines after a # character has been recognized
up to the next #STRUCT statement. Empty lines and pure comment lines
are permitted everywhere.
A number between 1 and 65534 follows the #STRUCT statement, represent-
ing the structure ID from the log data header.
The following lines contain a string in inverted commas "..." for each
data block, and this string can also include special characters, such
as \n, \r, \t, \b, \000 to \377.
If the number of strings specified exceeds the number of log data
blocks in the log information, the remaining strings are appended to
the evaluation. If the opposite is true, the remaining data blocks are
displayed as though there were no layout description.
Example of a description file
; #STRUCT 172 EXAMPLE
; "\nText1 "
; "~HEXDUMP:\n" ; Tilde (~) at the 1st position of a string for a
; ; HEXDUMP produces a display similar to the UNIX
; ; instruction 'od'. '~' is not displayed!
; "" ; Nothing should be output before the data field.
; "\nText2 "
#STRUCT 65534 ; syslogd
"\n"
"\nSYSTEM:"
" DATE:"
;------------ T-LOG 2.0 structure descriptions --------------
#STRUCT 3 ; T-LOG 2.0
"\n"
#STRUCT 4 ; T-LOG 2.0
"\ntype: "
"\nPGM: "
"\ntine no.: "
"\nerror no.: "
"\nUNIX errno: "
"\ntext: "
Page 2 Reliant UNIX 5.44 Printed 11/98
log3struct(4) log3struct(4)
#STRUCT 13 ; T-LOG 2.0
"\ntest device: "
"\nerror number: "
"\nfile: "
"\nrelease: "
"\nline: "
"~otmess" ; ~<Name of message file> - MCS
SEE ALSO
log3display(1M), syslogd(1M), log3admin(4), log3(5).
Page 3 Reliant UNIX 5.44 Printed 11/98