]> git.decadent.org.uk Git - videolink.git/blob - videolink.1
Added manual page.
[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, it follows links and
26 encodes all linked pages as video files.  It uses \fBdvdauthor\fR(1)
27 to assemble a DVD video filesystem containing the encoded pages and
28 other video files they link to.
29 .SH OPTIONS
30 .TP
31 .B \-\-preview
32 .RS
33 Selects preview mode.  In preview mode, the pages are displayed in a
34 browser roughly as they will appear on a DVD player.
35 .RE
36 .TP
37 .BI \-\-video-std " standard"
38 .RS
39 Selects the target video standard.  This should match the standard
40 used for the video files.  It affects the frame size and the frame
41 rate specified when encoding pages as video.  The two standards can be
42 specified as "525", "525/60", "NTSC" or "ntsc" and as "625", "625/50",
43 "PAL" or "pal" respectively.
44 .RE
45 .TP
46 .BI \-\-encoder " encoder"
47 .RS
48 Selects the program(s) used to encode pages to video.  By default
49 VideoLink calls \fBffmpeg\fR(1), but it can alternately use programs
50 from mjpegtools.  The \fIencoder\fR can be "ffmpeg", "mjpegtools", or
51 "mjpegtools-old" for versions of mjpegtools prior to 1.8.
52 .RE
53 .SH AUTHOR
54 Ben Hutchings <ben@decadent.org.uk>.
55 .SH SEE ALSO
56 dvdauthor(1), ffmpeg(1), gtk-options(7), /usr/share/doc/videolink/README\.gz