Added manual page.

[videolink.git] / videolink.1

diff --git a/videolink.1 b/videolink.1
new file mode 100644 (file)
index 0000000..6e65f2f
--- /dev/null
+++ b/videolink.1
@@ -0,0 +1,56 @@
+.\" videolink.1 written by Ben Hutchings <ben@decadent.org.uk>
+.TH VIDEOLINK 1 "10 August 2006"
+.SH NAME
+videolink \- assembles a DVD video filesystem from HTML pages and video files
+.SH SYNOPSIS
+.HP
+.BR videolink
+.RI [ gtk-options ]
+.B \-\-preview
+.RB [ \-\-video-std
+.IR standard ]
+.I menu-url
+.HP
+.BR videolink
+.RI [ gtk-options ]
+.RB [ \-\-video-std
+.IR standard ]
+.RB [ \-\-encoder
+.IR encoder ]
+.br
+.I menu-url output-dir
+.SH DESCRIPTION
+.LP
+VideoLink converts an interlinked set of HTML pages and video files
+into a DVD.  Starting from a main menu page, it follows links and
+encodes all linked pages as video files.  It uses \fBdvdauthor\fR(1)
+to assemble a DVD video filesystem containing the encoded pages and
+other video files they link to.
+.SH OPTIONS
+.TP
+.B \-\-preview
+.RS
+Selects preview mode.  In preview mode, the pages are displayed in a
+browser roughly as they will appear on a DVD player.
+.RE
+.TP
+.BI \-\-video-std " standard"
+.RS
+Selects the target video standard.  This should match the standard
+used for the video files.  It affects the frame size and the frame
+rate specified when encoding pages as video.  The two standards can be
+specified as "525", "525/60", "NTSC" or "ntsc" and as "625", "625/50",
+"PAL" or "pal" respectively.
+.RE
+.TP
+.BI \-\-encoder " encoder"
+.RS
+Selects the program(s) used to encode pages to video.  By default
+VideoLink calls \fBffmpeg\fR(1), but it can alternately use programs
+from mjpegtools.  The \fIencoder\fR can be "ffmpeg", "mjpegtools", or
+"mjpegtools-old" for versions of mjpegtools prior to 1.8.
+.RE
+.SH AUTHOR
+Ben Hutchings <ben@decadent.org.uk>.
+.SH SEE ALSO
+dvdauthor(1), ffmpeg(1), gtk-options(7), /usr/share/doc/videolink/README\.gz