Release versions 1.2.11 and 1.2.11-1
[videolink.git] / videolink.1
1 .\" videolink.1 written by Ben Hutchings <ben@decadent.org.uk>
2 .TH VIDEOLINK 1 "10 August 2006"
3 .SH NAME
4 videolink \- assembles a DVD video filesystem from HTML pages and video files
5 .SH SYNOPSIS
6 .HP
7 .BR videolink
8 .RI [ gtk-options ]
9 .B \-\-preview
10 .RB [ \-\-video-std
11 .IR standard ]
12 .I menu-url
13 .HP
14 .BR videolink
15 .RI [ gtk-options ]
16 .RB [ \-\-video-std
17 .IR standard ]
18 .RB [ \-\-encoder
19 .IR encoder ]
20 .br
21 .I menu-url output-dir
22 .SH DESCRIPTION
23 .LP
24 VideoLink converts an interlinked set of HTML pages and video files
25 into a DVD.  Starting from a main menu page at \fImenu-url\fR, it
26 follows links and encodes all linked pages as video files.  It uses
27 \fBdvdauthor\fR(1) to assemble a DVD video filesystem in
28 \fIoutput-dir\fR containing the encoded pages and other video files
29 they link to.
30 .LP
31 There are some restrictions on the content of the HTML pages, detailed
32 in \fBREADME.gz\fR.  The existing video files are not converted and
33 therefore must conform to the DVD video specifications.
34 .SH OPTIONS
35 .TP
36 .B \-\-preview
37 .RS
38 Selects preview mode.  In preview mode, the pages are displayed in a
39 browser roughly as they will appear on a DVD player.  No conversion
40 is done.
41 .RE
42 .TP
43 .BI \-\-video-std " standard"
44 .RS
45 Selects the target video standard.  This should match the standard
46 used for the existing video files.  It affects the frame size and the
47 frame rate specified when encoding pages as video.  The standard of
48 525-line frames and 59.94\ Hz interlaced fields, commonly called NTSC,
49 can be specified as "525", "525/60", "NTSC" or "ntsc".  The standard
50 of 625-line frames and 50\ Hz interlaced fields, commonly called PAL,
51 can be specified as "625", "625/50", "PAL" or "pal"; this is the
52 default.
53 .RE
54 .TP
55 .BI \-\-encoder " encoder"
56 .RS
57 Selects the program(s) used to encode pages to video.  By default
58 VideoLink calls \fBffmpeg\fR(1), but it can alternately use programs
59 from mjpegtools and netpbm.  The \fIencoder\fR can be "ffmpeg",
60 "mjpegtools", or "mjpegtools-old" for versions of mjpegtools prior to
61 1.8.
62 .RE
63 .SH AUTHOR
64 Ben Hutchings <ben@decadent.org.uk>.
65 .SH SEE ALSO
66 dvdauthor(1), ffmpeg(1), gtk-options(7), /usr/share/doc/videolink/README\.gz