guacenc.1.in (3125B)
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 guacenc 1 "26 Jan 2018" "version @PACKAGE_VERSION@" "Apache Guacamole" 20. 21.SH NAME 22guacenc \- Guacamole video encoder 23. 24.SH SYNOPSIS 25.B guacenc 26[\fB-s\fR \fIWIDTH\fRx\fIHEIGHT\fR] 27[\fB-r\fR \fIBITRATE\fR] 28[\fB-f\fR] 29[\fIFILE\fR]... 30. 31.SH DESCRIPTION 32.B guacenc 33is a video encoder which accepts Guacamole protocol dumps, such as those saved 34when screen recording is enabled on a Guacamole connection, writing standard 35video files as output. 36.B guacenc 37is essentially an implementation of a Guacamole client which accepts 38its input from files instead of a network connection, and renders directly to 39video instead of to the user's screen. 40.P 41Each \fIFILE\fR specified will be encoded as MPEG-4 video to a new 42file named \fIFILE\fR.m4v, encoded according to the other options specified. By 43default, the output video will be \fI640\fRx\fI480\fR pixels, and will be saved 44with a bitrate of \fI2000000\fR bits per second (2 Mbps). These defaults can be 45overridden with the \fB-s\fR and \fB-r\fR options respectively. Existing files 46will not be overwritten; the encoding process for any input file will be 47aborted if it would result in overwriting an existing file. 48.P 49Guacamole acquires a write lock on recordings as they are being written. By 50default, 51.B guacenc 52will check whether the each input file is locked and will refuse to read and 53encode an input file if it appears to be an in-progress recording. This 54behavior can be overridden by specifying the \fB-f\fR option. Encoding an 55in-progress recording will still result in a valid video; the video will simply 56cover the user's session only up to the current point in time. 57. 58.SH OPTIONS 59.TP 60\fB-s\fR \fIWIDTH\fRx\fIHEIGHT\fR 61Changes the resolution of the video that 62.B guacenc 63renders. By default, this will be \fI640\fRx\fI480\fR. 64.TP 65\fB-r\fR \fIBITRATE\fR 66Changes the bitrate that 67.B guacenc 68will use for the saved video. This is specified in bits per second. By default, 69this will be \fI2000000\fR (2 Mbps). Higher values will result in larger but 70higher-quality video files. Lower values will result in smaller but 71lower-quality video files. 72.TP 73\fB-f\fR 74Overrides the default behavior of 75.B guacenc 76such that input files will be encoded even if they appear to be recordings of 77in-progress Guacamole sessions. 78. 79.SH SEE ALSO 80.BR guaclog (1)