GUAC-236: Document usage. Use correct extension (.m4v).

This commit is contained in:
Michael Jumper 2016-03-12 17:56:31 -08:00
parent e74ea54eb9
commit e298975918
3 changed files with 48 additions and 1 deletions

View File

@ -24,6 +24,9 @@ AUTOMAKE_OPTIONS = foreign
bin_PROGRAMS = guacenc
man_MANS = \
man/guacenc.1
noinst_HEADERS = \
buffer.h \
display.h \

View File

@ -98,7 +98,7 @@ int main(int argc, char* argv[]) {
/* Generate output filename */
char out_path[4096];
int len = snprintf(out_path, sizeof(out_path), "%s.mpg", path);
int len = snprintf(out_path, sizeof(out_path), "%s.m4v", path);
/* Do not write if filename exceeds maximum length */
if (len >= sizeof(out_path)) {

44
src/guacenc/man/guacenc.1 Normal file
View File

@ -0,0 +1,44 @@
.TH guacenc 8 "12 Mar 2016" "version 0.9.9" "Guacamole"
.
.SH NAME
guacenc \- Guacamole video encoder
.
.SH SYNOPSIS
.B guacenc
[\fB-s\fR \fIWIDTH\fRx\fIHEIGHT\fR]
[\fB-r\fR \fIBITRATE\fR]
[\fIFILE\fR]...
.
.SH DESCRIPTION
.B guacenc
is a video encoder which accepts Guacamole protocol dumps, such as those saved
when screen recording is enabled on a Guacamole connection, writing standard
video files as output.
.B guacenc
is essentially an implementation of a Guacamole client which accepts
its input from files instead of a network connection, and renders directly to
video instead of to the user's screen.
.P
Each \fIFILE\fR specified will be encoded as a raw MPEG-4 video stream to a new
file named \fIFILE\fR.m4v, encoded according to the other options specified. By
default, the output video will be \fI640\fRx\fI480\fR pixels, and will be saved
with a bitrate of \fI2000000\fR bits per second (2 Mbps). These defaults can be
overridden with the \fB-s\fR and \fB-r\fR options respectively.
.
.SH OPTIONS
.TP
\fB-s\fR \fIWIDTH\fRx\fIHEIGHT\fR
Changes the resolution of the video that
.B guacenc
renders. By default, this will be \fI640\fRx\fI480\fR.
.TP
\fB-r\fR \fIBITRATE\fR
Changes the bitrate that
.B guacenc
will use for the saved video. This is specified in bits per second. By default,
this will be \fI2000000\fR (2 Mbps). Higher values will result in larger but
higher-quality video files. Lower values will result in smaller but
lower-quality video files.
.
.SH AUTHOR
Written by Michael Jumper <mike.jumper@guac-dev.org>