1tlog-rec-session(8) System Manager's Manual tlog-rec-session(8)
2
6 tlog-rec-session - start a shell and log terminal I/O
7
10 tlog-rec-session [OPTION...] [CMD_FILE [CMD_ARG...]]
11 tlog-rec-session -c [OPTION...] CMD_STRING [CMD_NAME [CMD_ARG...]]
12
15 Tlog-rec-session is a terminal session I/O logging program, intended
16 for use as the login shell for a user. The actual user shell to start
17 is retrieved from configuration or environment. Tlog-rec-session starts
18 the actual shell under a pseudo-TTY, connects it to the actual terminal
19 and logs whatever passes between them including user input, program
20 output, and terminal window size changes.
21 Tlog-rec-session will not start recording if another process with the
23 same audit session ID (as seen in /proc/PID/sessionid) is already being
24 recorded. Instead, it will simply start the shell.
25 If no "-c" option is specified, then the first non-option argument
27 CMD_FILE specifies the location of a shell script the shell should read
28 and the following arguments (CMD_ARG) specify its arguments.
29 If the "-c" option is specified, then a non-option argument CMD_STRING
31 is required and should contain shell commands to execute, the following
32 arguments can specify first the script name (CMD_NAME, i.e. argv[0])
33 and then its arguments (CMD_ARG).
34 If no non-option arguments are encountered, then the shell is started
36 interactively.
37 If tlog-rec-session is invoked under a name beginning with a dash (i.e.
39 argv[0] beginning with '-'), then the executed shell name is also
40 prepended with a dash. This passes the "login shell" status to the
41 recorded shell and is equivalent to using the "-l" option.
42 If tlog-rec-session is invoked under a name containing "-shell-", then
44 the rest of the name after that string is considered an encoded abso‐
45 lute path to the shell to execute for the recorded session. The path is
46 expected to be encoded by replacing all forward slashes '/' with dashes
47 '-' and any characters to be preserved as is prepended with a backslash
48 '\'. E.g. to have tlog-rec-session execute /bin/dash as the shell,
49 invoke it with the name "tlog-rec-session-shell-bin-dash".
50 This is normally done by making a symlink with that name pointing to
52 tlog-rec-session, and then executing the link. Such links can be
53 assigned to users as their shells to have specific shells started under
54 recording for specific users.
55 Tlog-rec-session loads its parameters first from the system-wide con‐
57 figuration file /usr/local/etc/tlog/tlog-rec-session.conf, then from
58 the file pointed at by TLOG_REC_SESSION_CONF_FILE environment variable
59 (if set), then from the contents of the TLOG_REC_SESSION_CONF_TEXT
60 environment variable (if set), and then from command-line options.
61 Parameters from each of these sources override the previous one in
62 turn.
63
66 General options
67 -h, --help
68 Output a command-line usage message and exit.
69 -v, --version
74 Output version information and exit.
75 --configuration
80 Output program configuration in JSON and exit.
81 -l, --login
86 Make the shell a login shell.
87 If specified, the shell is signalled to act as a login shell.
89 This is done by prepending argv[0] of the shell with a dash
90 character.
91 -c, --command
94 Execute shell commands.
95 If specified, tlog-rec-session passes the -c option to the
97 shell, followed by all the positional arguments, which specify
98 the shell commands to execute along with command name and its
99 arguments.
100
105 TLOG_REC_SESSION_CONF_FILE
106 Specifies the location of a configuration file to be read. The
107 configuration parameters in this file override the ones in the
108 system-wide configuration file /usr/local/etc/tlog/tlog-rec-ses‐
109 sion.conf.
110 TLOG_REC_SESSION_CONF_TEXT
113 Specifies the configuration text to be read. The configuration
114 parameters in this variable override the ones in the file speci‐
115 fied with TLOG_REC_SESSION_CONF_FILE.
116 TLOG_REC_SESSION_SHELL
119 Specifies the shell to spawn. Overrides configuration specified
120 with TLOG_REC_SESSION_CONF_TEXT. Can be overridden by invoking
121 tlog-rec-session under a special name (see above).
122
125 /usr/local/etc/tlog/tlog-rec-session.conf
126 The system-wide configuration file
127
130 Start recording a login shell:
131 tlog-rec-session -l
132 Ask the recorded shell to execute a command:
135 tlog-rec-session -c whoami
136
139 tlog-rec-session.conf(5), tlog-rec(8), tlog-play(8)
140
143 Nikolai Kondrashov <spbnick@gmail.com>
144Tlog May 2017 tlog-rec-session(8)