[byzanz] Upadte man pages to 0.2.1



commit 9757395137694c8f2b2c373199afd600739cd8b7
Author: Benjamin Otte <otte redhat com>
Date:   Sat Feb 20 11:29:28 2010 +0100

    Upadte man pages to 0.2.1

 src/Makefile.am       |    2 +-
 src/byzanz-playback.1 |   38 ++++++++++++++++++++++++++++++++++++++
 src/byzanz-record.1   |   35 ++++++++++++++++++++++++++++++-----
 src/playback.c        |    2 +-
 4 files changed, 70 insertions(+), 7 deletions(-)
---
diff --git a/src/Makefile.am b/src/Makefile.am
index 769bca3..9ce716d 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -1,7 +1,7 @@
 noinst_LTLIBRARIES = libbyzanz.la
 bin_PROGRAMS = byzanz-record byzanz-playback
 libexec_PROGRAMS = byzanz-applet
-man_MANS = byzanz-record.1
+man_MANS = byzanz-record.1 byzanz-playback.1
 
 BUILT_SOURCES = \
 	byzanzmarshal.h \
diff --git a/src/byzanz-playback.1 b/src/byzanz-playback.1
new file mode 100644
index 0000000..28eb8b0
--- /dev/null
+++ b/src/byzanz-playback.1
@@ -0,0 +1,38 @@
+.\" Manual page for byzanz-record.
+.\" Written by Benjamin Otte <otte gnome org>
+.\"
+.\" Copyright (C) 2010 Benjamin Otte
+.\"
+.\" This manual page is free software; you can redistribute it and/or
+.\" modify it under the terms of the GNU Library General Public
+.\" License as published by the Free Software Foundation; either
+.\" version 3 of the License, or (at your option) any later version.
+.\"
+.\" This manual page is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+.\" Library General Public License for more details.
+.TH BYZANZ-PLAYBACK "1"
+.SH NAME
+byzanz-playback \- Process a byzanz debug recording
+.SH SYNOPSIS
+.B byzanz-record
+.RI [ options ] " INFILE OUTFILE"
+.SH DESCRIPTION
+Byzanz debug recording can be created by using the extension \fI.byzanz\fP.
+To convert these recordings into the other formats supported by Byzanz,
+\fBbyzanz-playback\fP can be used. The INFILE must e a byzanz debug file,
+the OUTFILE is the file to convert it to. Its extension determines the
+format to be used. See the \fBbyzanz-record\fP(1) man page for a list of
+supported formats and their extensions.
+.SH OPTIONS
+.SS "Help Options:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show help options
+.SH SEE ALSO
+\fBbyzanz-record\fR(1)
+.SH AUTHOR
+Byzanz was written by Benjamin Otte <otte gnome org>.
+.PP
+This manual page was last updated for version 0.2.1.
diff --git a/src/byzanz-record.1 b/src/byzanz-record.1
index 8245c43..ea935e7 100644
--- a/src/byzanz-record.1
+++ b/src/byzanz-record.1
@@ -2,7 +2,8 @@
 .\" Written by Josh Triplett <josh freedesktop org>,
 .\" with some help from help2man.
 .\"
-.\" Copyright (C) 2006 Josh Triplett
+.\" Copyright (C) 2006 Josh Triplett <josh freedesktop org>
+.\"               2010 Benjamin Otte <otte gnome org>
 .\"
 .\" This manual page is free software; you can redistribute it and/or
 .\" modify it under the terms of the GNU Library General Public
@@ -18,7 +19,7 @@
 byzanz-record \- record your desktop session to an animated GIF
 .SH SYNOPSIS
 .B byzanz-record
-.RI [ options ] " filename.gif"
+.RI [ options ] " FILENAME"
 .SH DESCRIPTION
 Byzanz records your desktop session to an animated GIF.  You can record your
 entire screen, a single window, or an arbitrary region.  \fBbyzanz-record\fP
@@ -67,8 +68,32 @@ Show GTK+ Options
 .TP
 \fB\-\-help\-all\fR
 Show all help options
+.SH OUTPUT FILE
+After \fBbyzanz-record\fP is finished, the recording is written to FILENAME.
+The format is determined by the filename extension. The following formats are
+supported:
+.TP
+\fBgif\fR
+Record to an animated GIF image. Use this if you want to record a mostly
+static screen with a limited amount of colors, such as using a file manager
+or an office application.
+This is the default and will be used if an unrecognized extension is used.
+.TP
+\fBogg\fR, \fBogv\fR
+Record to an Ogg Theora video. This format supports audio. Use this if you
+want to record dynamic contents, such as video playback.
+.TP
+\fBflv\fR
+Record to a Flash Screen video. This recording method is lossless. Use it if
+you want to postprocess the file in other applications.
+.TP
+\fBbyzanz\fR
+Record to Byzanz' internal debugging format. This is useful for benchmarking
+Byzanz or if you want to convert the recording to multiple formats later.
+You can use \fBbyzanz-playback\fP(1) to convert the file.
+.SH SEE ALSO
+\fBbyzanz-playback\fR(1)
 .SH AUTHOR
-byzanz was written by Benjamin Otte <otte gnome org>.
+Byzanz was written by Benjamin Otte <otte gnome org>.
 .PP
-This manual page was written by Josh Triplett <josh freedesktop org>, for the
-Debian project (but may be used by others).
+This manual page was last updated for version 0.2.1.
diff --git a/src/playback.c b/src/playback.c
index f5087e1..a8766f2 100644
--- a/src/playback.c
+++ b/src/playback.c
@@ -74,7 +74,7 @@ main (int argc, char **argv)
   g_thread_init (NULL);
   g_type_init ();
 
-  context = g_option_context_new (_("Process a byzanz debug file"));
+  context = g_option_context_new (_("process a byzanz debug recording"));
 #ifdef GETTEXT_PACKAGE
   g_option_context_set_translation_domain(context, GETTEXT_PACKAGE);
 #endif



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]