guaclog.1 (4029B)
1.\" 2.\" Licensed to the Apache Software Foundation (ASF) under one 3.\" or more contributor license agreements. See the NOTICE file 4.\" distributed with this work for additional information 5.\" regarding copyright ownership. The ASF licenses this file 6.\" to you under the Apache License, Version 2.0 (the 7.\" "License"); you may not use this file except in compliance 8.\" with the License. You may obtain a copy of the License at 9.\" 10.\" http://www.apache.org/licenses/LICENSE-2.0 11.\" 12.\" Unless required by applicable law or agreed to in writing, 13.\" software distributed under the License is distributed on an 14.\" "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15.\" KIND, either express or implied. See the License for the 16.\" specific language governing permissions and limitations 17.\" under the License. 18.\" 19.TH guaclog 1 "26 Jan 2018" "version 1.5.4" "Apache Guacamole" 20. 21.SH NAME 22guaclog \- Guacamole input log interpreter 23. 24.SH SYNOPSIS 25.B guaclog 26[\fB-f\fR] 27[\fIFILE\fR]... 28. 29.SH DESCRIPTION 30.B guaclog 31is an interpreter which accepts Guacamole protocol dumps, such as those saved 32when input logging is enabled for a Guacamole session recording, writing 33human-readable text logs as output. 34.B guaclog 35is essentially an implementation of a Guacamole client which accepts 36its input from files instead of a network connection, however unlike 37.B guacenc 38it only handles instructions related to user input. 39.P 40Each \fIFILE\fR specified will be translated into a new human-readable text 41file named \fIFILE\fR.txt. Existing files will not be overwritten; the 42interpreting process for any input file will be aborted if it would result in 43overwriting an existing file. 44.P 45Guacamole acquires a write lock on recordings as they are being written. By 46default, 47.B guaclog 48will check whether the each input file is locked and will refuse to read and 49interpret an input file if it appears to be an in-progress recording. This 50behavior can be overridden by specifying the \fB-f\fR option. Interpreting an 51in-progress recording will still work; the resulting human-readable text file 52will simply cover the user's session only up to the current point in time. 53. 54.SH OPTIONS 55.TP 56\fB-f\fR 57Overrides the default behavior of 58.B guaclog 59such that input files will be interpreted even if they appear to be recordings 60of in-progress Guacamole sessions. 61. 62.SH OUTPUT FORMAT 63The output format of 64.B guaclog 65is meant to match what the user would have typed within a typical text editor 66as closely as possible, while also representing non-printable characters and 67keyboard shortcuts in a human-readable way. 68.P 69All output is on one line, with new lines started only as a result of the user 70pressing enter/return. Keys which produce printable characters are translated 71into their corresponding Unicode codepoints and encoded as UTF-8, while 72non-printable characters are enclosed within angle brackets and represented 73with their human-readable names. Keyboard shortcuts which are made up of more 74than one key are enclosed within angle brackets, with each key within the 75shortcut separated by plus signs. 76.P 77Spaces and newlines are included as their Unicode character, except when 78represented within a keyboard shortcut, in which case their human-readable 79names are used instead. As the output of pressing tab can be easily mistaken 80for spaces, and as pressing tab frequently has special meaning within 81applications, tab is always represented by its human-readable name. 82.P 83Modifiers are output as part of keyboard shortcuts only. Simple pressing and 84releasing of a modifier will be ignored, as are presses of shift or AltGr while 85typing. 86.P 87For example, if the user typed "Hello WORLD!", selected everything by pressing 88Ctrl+a, copied the selected text by pressing Ctrl+c, switched to another 89application by pressing Alt+Shift+Tab, and then pasted the previously-copied 90text by pressing Ctrl+v, the resulting log from 91.B 92guaclog 93would look like: 94.PP 95.RS 0 96Hello WORLD!<Ctrl+a><Ctrl+c><Alt+Shift+Tab><Ctrl+v> 97. 98.SH SEE ALSO 99.BR guacenc (1)