]> git.decadent.org.uk Git - videolink.git/commitdiff
Made various small improvements.
authorBen Hutchings <ben@decadent.org.uk>
Thu, 10 Aug 2006 20:54:22 +0000 (20:54 +0000)
committerBen Hutchings <ben@decadent.org.uk>
Sun, 2 Nov 2008 23:54:41 +0000 (23:54 +0000)
videolink.1

index 6e65f2fff4a25fe6a216108867c82977c24cd77a..fcb2579c5f597929c84367d6e37b4183849317e1 100644 (file)
@@ -22,33 +22,43 @@ videolink \- assembles a DVD video filesystem from HTML pages and video files
 .SH DESCRIPTION
 .LP
 VideoLink converts an interlinked set of HTML pages and video files
 .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.
+into a DVD.  Starting from a main menu page at \fImenu-url\fR, it
+follows links and encodes all linked pages as video files.  It uses
+\fBdvdauthor\fR(1) to assemble a DVD video filesystem in
+\fIoutput-dir\fR containing the encoded pages and other video files
+they link to.
+.LP
+There are some restrictions on the content of the HTML pages, detailed
+in \fBREADME.gz\fR.  The existing video files are not converted and
+therefore must conform to the DVD video specifications.
 .SH OPTIONS
 .TP
 .B \-\-preview
 .RS
 Selects preview mode.  In preview mode, the pages are displayed in a
 .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.
+browser roughly as they will appear on a DVD player.  No conversion
+is done.
 .RE
 .TP
 .BI \-\-video-std " standard"
 .RS
 Selects the target video standard.  This should match the standard
 .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.
+used for the existing video files.  It affects the frame size and the
+frame rate specified when encoding pages as video.  The standard of
+525-line frames and 59.94\ Hz interlaced fields, commonly called NTSC,
+can be specified as "525", "525/60", "NTSC" or "ntsc".  The standard
+of 625-line frames and 50\ Hz interlaced fields, commonly called PAL,
+can be specified as "625", "625/50", "PAL" or "pal"; this is the
+default.
 .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
 .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.
+from mjpegtools and netpbm.  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>.
 .RE
 .SH AUTHOR
 Ben Hutchings <ben@decadent.org.uk>.