1guaclog(1) Apache Guacamole guaclog(1)
2
6 guaclog - Guacamole input log interpreter
7
9 guaclog [-f] [FILE]...
10
12 guaclog is an interpreter which accepts Guacamole protocol dumps, such
13 as those saved when input logging is enabled for a Guacamole session
14 recording, writing human-readable text logs as output. guaclog is es‐
15 sentially an implementation of a Guacamole client which accepts its in‐
16 put from files instead of a network connection, however unlike guacenc
17 it only handles instructions related to user input.
18 Each FILE specified will be translated into a new human-readable text
20 file named FILE.txt. Existing files will not be overwritten; the inter‐
21 preting process for any input file will be aborted if it would result
22 in overwriting an existing file.
23 Guacamole acquires a write lock on recordings as they are being writ‐
25 ten. By default, guaclog will check whether the each input file is
26 locked and will refuse to read and interpret an input file if it ap‐
27 pears to be an in-progress recording. This behavior can be overridden
28 by specifying the -f option. Interpreting an in-progress recording will
29 still work; the resulting human-readable text file will simply cover
30 the user's session only up to the current point in time.
31
33 -f Overrides the default behavior of guaclog such that input files
34 will be interpreted even if they appear to be recordings of in-
35 progress Guacamole sessions.
36
38 The output format of guaclog is meant to match what the user would have
39 typed within a typical text editor as closely as possible, while also
40 representing non-printable characters and keyboard shortcuts in a hu‐
41 man-readable way.
42 All output is on one line, with new lines started only as a result of
44 the user pressing enter/return. Keys which produce printable characters
45 are translated into their corresponding Unicode codepoints and encoded
46 as UTF-8, while non-printable characters are enclosed within angle
47 brackets and represented with their human-readable names. Keyboard
48 shortcuts which are made up of more than one key are enclosed within
49 angle brackets, with each key within the shortcut separated by plus
50 signs.
51 Spaces and newlines are included as their Unicode character, except
53 when represented within a keyboard shortcut, in which case their human-
54 readable names are used instead. As the output of pressing tab can be
55 easily mistaken for spaces, and as pressing tab frequently has special
56 meaning within applications, tab is always represented by its human-
57 readable name.
58 Modifiers are output as part of keyboard shortcuts only. Simple press‐
60 ing and releasing of a modifier will be ignored, as are presses of
61 shift or AltGr while typing.
62 For example, if the user typed "Hello WORLD!", selected everything by
64 pressing Ctrl+a, copied the selected text by pressing Ctrl+c, switched
65 to another application by pressing Alt+Shift+Tab, and then pasted the
66 previously-copied text by pressing Ctrl+v, the resulting log from gua‐
67 clog would look like:
68 Hello WORLD!<Ctrl+a><Ctrl+c><Alt+Shift+Tab><Ctrl+v>
70
72 guacenc(1)
73version 1.5.4 26 Jan 2018 guaclog(1)