Overview

Request 1798 (accepted)

Tarball from new repository plus a few minor changes.

Submit package home:Aloysius:branches:Multimedia / tovid to package Multimedia / tovid

tovid.changes Changed
x
 
1
@@ -1,4 +1,12 @@
2
 -------------------------------------------------------------------
3
+Mon Apr  6 19:29:20 UTC 2015 - aloisio@gmx.com
4
+
5
+- Version 0.35.0
6
+  * minor changes
7
+  * moved project to github 
8
+- Dropped tovid-rpmlintrc
9
+
10
+-------------------------------------------------------------------
11
 Sat Mar 14 15:34:58 UTC 2015 - aloisio@gmx.com
12
 
13
 - Update to 0.35
14
tovid.spec Changed
168
 
1
@@ -1,123 +1,93 @@
2
 # vim: set ts=4 sw=4 et:
3
+#
4
+# Copyright (c) 2015 Luigi Baldoni <aloisio@gmx.com>
5
 # Copyright (c) 2005-2010 oc2pus
6
-# This file and all modifications and additions to the pristine
7
-# package are under the same license as the package itself.
8
 #
9
+# All modifications and additions to the file contributed by third parties
10
+# remain the property of their copyright owners, unless otherwise agreed
11
+# upon. The license for this file, and modifications and additions to the
12
+# file, is the same license as for the pristine package itself (unless the
13
+# license for the pristine package is not an Open Source License, in which
14
+# case the license is the MIT License). An "Open Source License" is a
15
+# license that conforms to the Open Source Definition (Version 1.9)
16
+# published by the Open Source Initiative.
17
+
18
 # Please submit bugfixes or comments to packman@links2linux.de
19
 
20
-%{!?python_sitelib:  %global python_sitelib  %(%{__python} -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())")}
21
-%{!?python_sitearch: %global python_sitearch %(%{__python} -c "from distutils.sysconfig import get_python_lib; print(get_python_lib(1))")}
22
 
23
-Summary:        Video conversion and DVD authoring tools
24
+%{!?python_sitelib:  %global python_sitelib  %(python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())")}
25
+%{!?python_sitearch: %global python_sitearch %(python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib(1))")}
26
 Name:           tovid
27
-Version:        0.35
28
-Release:        0.pm.1
29
-Group:          Productivity/Multimedia/Video/Editors and Convertors
30
+Version:        0.35.0
31
+Release:        0
32
+Summary:        Video conversion and DVD authoring tools
33
 License:        GPL-2.0+
34
-Url:            http://tovid.sourceforge.net/
35
-# http://tovid.googlecode.com/files/tovid-%{version}.tar.gz
36
-Source:         tovid-%{version}.tar.gz
37
-Source90:       %{name}-rpmlintrc
38
-BuildRoot:      %{_tmppath}/%{name}-%{version}-%{release}-root
39
-%if %suse_version > 1110
40
-BuildArch:      noarch
41
-%endif
42
-%py_requires
43
-BuildRequires:  fdupes
44
+Group:          Productivity/Multimedia/Video/Editors and Convertors
45
+Url:            http://tovid.wikia.com/wiki/Tovid_Wiki
46
+Source:         https://github.com/tovid-suite/tovid/releases/download/v0.35.0/tovid-%{version}.tar.gz
47
 BuildRequires:  hicolor-icon-theme
48
 BuildRequires:  python-devel
49
 BuildRequires:  python-setuptools
50
 BuildRequires:  txt2tags
51
 BuildRequires:  update-desktop-files
52
+Requires:       ImageMagick >= 6.0
53
+Requires:       MPlayer
54
+Requires:       bc
55
 Requires:       binutils
56
 Requires:       dvd+rw-tools
57
 Requires:       dvdauthor >= 0.6.0
58
 Requires:       ffmpeg
59
-Requires:       ImageMagick >= 6.0
60
 Requires:       lsdvd
61
 Requires:       mjpegtools
62
-Requires:       /usr/bin/mkisofs
63
-Requires:       MPlayer
64
+Requires:       mkisofs
65
 Requires:       normalize
66
-%if %suse_version >= 1110
67
 Requires:       python-base >= %{py_ver}
68
-%else
69
-Requires:       python >= %{py_ver}
70
-%endif
71
-Requires:       python-cairo
72
-Requires:       python-imaging
73
-%if 0%{?suse_version} >= 1320
74
-Requires:       python-wxGTK >= 3.0
75
-%else
76
-Requires:       python-wxGTK < 3.0
77
-%endif
78
+Requires:       python-tk
79
 Requires:       sox
80
-Requires:       transcode
81
-Requires:       vcdimager
82
-Recommends:        libdvdcss2
83
-BuildRequires:  dvd+rw-tools
84
-BuildRequires:  dvdauthor >= 0.6.0
85
-BuildRequires:  ffmpeg
86
-BuildRequires:  ImageMagick >= 6.0
87
-BuildRequires:  lsdvd
88
-BuildRequires:  mjpegtools
89
-%if 0%{?suse_version} <= 1230
90
-BuildRequires:  mkisofs
91
-%else
92
-BuildRequires:  cdrkit-cdrtools-compat
93
-%endif
94
-BuildRequires:  MPlayer
95
-BuildRequires:  normalize
96
-BuildRequires:  python-cairo
97
-BuildRequires:  python-imaging
98
-%if 0%{?suse_version} >= 1320
99
-BuildRequires:  python-wxGTK >= 3.0
100
-%else
101
-BuildRequires:  python-wxGTK < 3.0
102
+Requires:       tix
103
+Requires:       tk
104
+Recommends:     libdvdcss2
105
+Recommends:     transcode
106
+BuildRoot:      %{_tmppath}/%{name}-%{version}-build
107
+%py_requires
108
+%if 0%{?suse_version} > 1110
109
+BuildArch:      noarch
110
 %endif
111
-BuildRequires:  sox
112
-BuildRequires:  transcode
113
-BuildRequires:  vcdimager
114
 
115
 %description
116
-tovid is a suite of utilities designed to make VCD, SVCD, and DVD
117
+tovid is a suite of utilities designed to make DVD
118
 authoring a little less painful. tovid can create MPEG output
119
-from arbitrary video formats; other components in the suite can
120
-help you identify video files, generate graphical menus for DVD,
121
-and write the XML for authoring DVDs. Video files converted with
122
-tovid can subsequently be burned to a CD or DVD, using software
123
-that can create the appropriate file structure for VCD or SVCD
124
-such as k3b or dvdauthor.
125
+from arbitrary video formats, help you identify video files,
126
+generate graphical menus for DVD (animated or static),
127
+generate DVD directories with the appropriate file structure,
128
+and optionally burn them to disk.
129
 
130
 %prep
131
 %setup -q
132
 
133
 %build
134
-%__python setup.py build
135
+python setup.py build
136
 
137
 %install
138
-%__python setup.py install \
139
+python setup.py install \
140
     --prefix=%{_prefix} \
141
     --root=%{buildroot}
142
 
143
-%__rm -f "%{buildroot}%{_usr}/lib/tovid/.install.log"
144
+rm -f "%{buildroot}%{_prefix}/lib/tovid/.install.log"
145
+chmod +x %{buildroot}%{_prefix}/lib/tovid/set_chapters
146
+chmod +x %{buildroot}%{_prefix}/lib/tovid/tovid-init
147
 
148
 for x in tovidgui titleset-wizard; do
149
     %suse_update_desktop_file -r "$x" AudioVideo AudioVideoEditing
150
 done
151
 
152
-%fdupes -s "%{buildroot}"
153
-
154
-%clean
155
-%{?buildroot:%__rm -rf "%{buildroot}"}
156
-
157
 %files
158
 %defattr(-,root,root)
159
 %doc AUTHORS ChangeLog COPYING README
160
 %{_bindir}/tovid
161
 %{python_sitelib}/libtovid
162
 %{python_sitelib}/tovid-%{version}*
163
-%{_usr}/lib/tovid
164
+%{_prefix}/lib/tovid
165
 %{_datadir}/applications/tovidgui.desktop
166
 %{_datadir}/applications/titleset-wizard.desktop
167
 %{_datadir}/icons/*/*/apps/tovid.png
168
tovid-0.35.tar.gz/PKG-INFO -> tovid-0.35.0.tar.gz/PKG-INFO Changed
20
 
1
@@ -1,10 +1,11 @@
2
-Metadata-Version: 1.0
3
+Metadata-Version: 1.1
4
 Name: tovid
5
-Version: 0.35
6
-Summary: UNKNOWN
7
+Version: 0.35.0
8
+Summary: A suite of tools for making video DVDs
9
 Home-page: http://tovid.wikia.com/
10
-Author: Eric Pierce
11
-Author-email: wapcaplet88@gmail.com
12
+Author: grepper
13
+Author-email: grepper@gmail.com
14
 License: GPL
15
-Description: UNKNOWN
16
-Platform: UNKNOWN
17
+Download-URL: https://github.com/tovid-suite/tovid/
18
+Description: A suite of tools for making video DVDs
19
+Platform: Linux
20
tovid-0.35.tar.gz/README -> tovid-0.35.0.tar.gz/README Changed
7
 
1
@@ -45,5 +45,3 @@
2
     http://tovid.wikia.com/
3
 tovid-users discussion group:
4
     http://groups.google.com/group/tovid-users
5
-tovid IRC channel:
6
-    irc.freenode.org, channel #tovid
7
tovid-0.35.0.tar.gz/docs/src/en/tovid.html Added
1920
 
1
@@ -0,0 +1,1918 @@
2
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3
+<HTML>
4
+<HEAD>
5
+<META NAME="generator" CONTENT="http://txt2tags.org">
6
+<TITLE>tovid manual</TITLE>
7
+</HEAD><BODY BGCOLOR="white" TEXT="black">
8
+<CENTER>
9
+<H1>tovid manual</H1>
10
+</CENTER>
11
+
12
+<P></P>
13
+<HR NOSHADE SIZE=1>
14
+<P></P>
15
+
16
+  <UL>
17
+  <LI><A HREF="#toc1">Name</A>
18
+  <LI><A HREF="#toc2">Description</A>
19
+  <LI><A HREF="#toc3">Usage</A>
20
+  <LI><A HREF="#toc4">Configuration</A>
21
+  <LI><A HREF="#toc5">Command:gui</A>
22
+  <LI><A HREF="#toc6">Usage</A>
23
+  <LI><A HREF="#toc7">Command:titlesets</A>
24
+  <LI><A HREF="#toc8">Command:disc</A>
25
+    <UL>
26
+    <LI><A HREF="#toc9">Usage</A>
27
+    <LI><A HREF="#toc10">General Options</A>
28
+    <LI><A HREF="#toc11">Menu style</A>
29
+    <LI><A HREF="#toc12">Thumbnail style</A>
30
+    <LI><A HREF="#toc13">Slideshows</A>
31
+    <LI><A HREF="#toc14">Burning the disc</A>
32
+    <LI><A HREF="#toc15">Advanced usage</A>
33
+    <LI><A HREF="#toc16">Menu Style</A>
34
+    <LI><A HREF="#toc17">Thumbnail Style</A>
35
+    <LI><A HREF="#toc18">Dvdauthor options</A>
36
+    <LI><A HREF="#toc19">Usage notes</A>
37
+    </UL>
38
+  <LI><A HREF="#toc20">Command:mpg</A>
39
+    <UL>
40
+    <LI><A HREF="#toc21">Usage</A>
41
+    <LI><A HREF="#toc22">Basic options</A>
42
+    <LI><A HREF="#toc23">Advanced options</A>
43
+    </UL>
44
+  <LI><A HREF="#toc24">Command:id</A>
45
+    <UL>
46
+    <LI><A HREF="#toc25">Usage</A>
47
+    <LI><A HREF="#toc26">Options</A>
48
+    <LI><A HREF="#toc27">Examples</A>
49
+    </UL>
50
+  <LI><A HREF="#toc28">Command:dvd</A>
51
+    <UL>
52
+    <LI><A HREF="#toc29">Usage</A>
53
+    <LI><A HREF="#toc30">Options</A>
54
+    </UL>
55
+  <LI><A HREF="#toc31">Command:chapters</A>
56
+    <UL>
57
+    <LI><A HREF="#toc32">Examples</A>
58
+    </UL>
59
+  <LI><A HREF="#toc33">CONTACT</A>
60
+  </UL>
61
+
62
+<P></P>
63
+<HR NOSHADE SIZE=1>
64
+<P></P>
65
+
66
+<A NAME="toc1"></A>
67
+<H1>Name</H1>
68
+
69
+<P>
70
+tovid: Make DVDs from video files
71
+</P>
72
+
73
+<A NAME="toc2"></A>
74
+<H1>Description</H1>
75
+
76
+<P>
77
+<B>tovid</B> is a command-line tool for creating DVDs. It can encode your video
78
+files to DVD-compliant MPEG format, generate simple or complex DVD menus,
79
+author and burn a ready-to-watch DVD, with just a few shell commands. A
80
+graphical interface is also provided to make the process even easier.
81
+</P>
82
+<P>
83
+<B>NOTE</B>: As of tovid 0.35, the legacy scripts <B>makemenu</B> and <B>makexml</B>
84
+have been removed and no longer appear in this manpage.
85
+All of their functions and more can be done with the 'tovid disc' command,
86
+(todisc script). See <B>Command:disc</B> and the <A HREF="http://tovid.wikia.com">wiki</A>
87
+for more info.
88
+</P>
89
+<P>
90
+Also note that as of tovid 0.32, this is the only manual page provided by tovid.
91
+There is now a single executable frontend to all functionality in the suite, so
92
+if you were expecting to find manpages for <B>todisc</B>, <B>idvid</B>, <B>makempg</B>
93
+and their kin, they can all be found in the <B>tovid</B> manpage you are reading now.
94
+And yes, this makes for a pretty large manual page. If you are viewing this
95
+manpage from the command-line <B>man</B> utility, which normally pages through the
96
+<B>less</B> utility, you can skip to a section by searching with the <B>/</B> key,
97
+followed by a <B>^</B> to match the given section name. For example, to skip to
98
+the <B>mpg</B> command, type <B>/^Command:mpg</B>. See <B>man less</B> for more on how
99
+to navigate.
100
+</P>
101
+
102
+<A NAME="toc3"></A>
103
+<H1>Usage</H1>
104
+
105
+<P>
106
+<B>tovid</B> <I>COMMAND</I> [<I>OPTIONS</I>]
107
+</P>
108
+<P>
109
+Where <I>COMMAND</I> is one of the following:
110
+</P>
111
+<P>
112
+    Main Commands
113
+</P>
114
+
115
+<DL>
116
+<DT><B>disc</B></DT><DD>
117
+    Encode, make menus, author, burn. (was <B>todisc</B>. See <B>Command:disc</B>)
118
+<DT><B>gui</B></DT><DD>
119
+    Start the tovid GUI (was <B>todiscgui</B>. See <B>Command:gui</B>)
120
+<DT><B>titlesets</B></DT><DD>
121
+    A GUI wizard for multiple titlesets. (new: See <B>Command:titlesets</B>)
122
+</DL>
123
+
124
+<P>
125
+    Helper Commands
126
+</P>
127
+
128
+<DL>
129
+<DT><B>mpg</B></DT><DD>
130
+    Encode videos to MPEG format (was <B>tovid</B>. See <B>Command:mpg</B>)
131
+<DT><B>dvd</B></DT><DD>
132
+    Author and/or burn a DVD (was <B>makedvd</B>. See <B>Command:dvd</B>)
133
+<DT><B>id</B></DT><DD>
134
+    Identify one or more video files (was <B>idvid</B>. See <B>Command:id</B>)
135
+<DT><B>chapters</B></DT><DD>
136
+    A GUI using mplayer for setting chapter points.  It will return a string of
137
+    chapter points to the terminal, in a format recognized by 'tovid disc'
138
+    (todisc) or by 'tovid gui', for the  <B>-chapters</B> option.
139
+</DL>
140
+
141
+<P>
142
+The <I>OPTIONS</I> differ for each command; run <B>tovid &lt;command&gt;</B> with no
143
+further arguments to get help on a command, and what options it expects.
144
+</P>
145
+
146
+<A NAME="toc4"></A>
147
+<H1>Configuration</H1>
148
+
149
+<P>
150
+Two configuration files are created the first time you run tovid:
151
+</P>
152
+
153
+<DL>
154
+<DT><B>~/.tovid/preferences</B></DT><DD>
155
+    Defines working directory for all scripts.
156
+    You can define the output directory for makempg here.
157
+    The 'ffmpeg' executable can be set here: ffmpeg or avconv (TOVID_FFMPEG)
158
+<DT><B>~/.tovid/tovid.ini</B></DT><DD>
159
+    Includes command-line options that should be passed to the various
160
+    <B>tovid</B> sub-commands.  Note: each sub-command has its own section,
161
+    starting with the line [sub-command], for example:
162
+
163
+<PRE>
164
+      [disc]
165
+      ; -no-warn
166
+      -static
167
+      -no-ask
168
+</PRE>
169
+
170
+</DL>
171
+
172
+<P>
173
+Edit these files if you wish to change your configuration.
174
+</P>
175
+<P>
176
+The following environment variables are also honoured:
177
+</P>
178
+
179
+<PRE>
180
+      TOVID_HOME (directory containing preferences: ~/.tovid)
181
+      TOVID_WORKING_DIR (working directory for all scripts).
182
+      TOVID_OUTPUT_DIR (output directory for the makempg script).
183
+      TOVID_FFMPEG_CMD (the 'ffmpeg' executable to use: ffmpeg or avconv)
184
+</PRE>
185
+
186
+<P>
187
+These will override 'TOVID_HOME', 'WORKING_DIR', 'OUTPUT_DIR',
188
+and 'TOVID_FFMPEG' if set in ~/.tovid/preferences.
189
+</P>
190
+
191
+<A NAME="toc5"></A>
192
+<H1>Command:gui</H1>
193
+
194
+<A NAME="toc6"></A>
195
+<H1>Usage</H1>
196
+
197
+<P>
198
+<B>tovid gui</B> [<I>OPTIONS</I>]
199
+</P>
200
+<P>
201
+<B>tovid gui</B> starts the graphical user interface (GUI) for tovid. This is
202
+the easiest way to start creating DVDs with tovid. The optional arguments
203
+<I>OPTIONS</I> are any option used by todisc ('tovid disc') which will save
204
+entering it manually, OR the full path to a saved script from the GUI.
205
+You can also combine these, but the script must be the FIRST option
206
+directly after <B>tovid gui</B> .  (This option to save the contents of your
207
+project allows you to use it as a bash script later, or to reload the
208
+project to continue working with it at another time.)
209
+</P>
210
+<P>
211
+<B>tovid gui</B> will also take the option <B>--position</B>, which denotes the
212
+screen position that the GUI will start at, in the form '+X+Y', similar to
213
+this part of the Xorg -geometry string.
214
+</P>
215
+<P>
216
+All help is integrated in the form of tooltips.  You can also see
217
+**Command:disc ** for more detail about the options.  Note: if you wish to use
218
+a GUI to make multiple titlesets on the same DVD use <B>*tovid titlesets*</B>,
219
+which is a wizard that uses the the 'tovid gui. See <B>*Command:titlesets*</B>.
220
+</P>
221
+<P>
222
+Please note that although the interface may seem complex with so many options,
223
+you can create a fully functional DVD with only a few options on the opening
224
+tab of the GUI (select video files and an output name).
225
+</P>
226
+
227
+<A NAME="toc7"></A>
228
+<H1>Command:titlesets</H1>
229
+
230
+<P>
231
+<B>tovid titlesets</B> will assist in making a DVD with multiple titlesets.  It can
232
+be started without any options, or you can feed it the path to a saved titleset
233
+script as an option.  The option to save a script is also useful as the resulting
234
+script can be run later from a terminal.
235
+</P>
236
+
237
+<A NAME="toc8"></A>
238
+<H1>Command:disc</H1>
239
+
240
+<P>
241
+<B>tovid disc</B> creates a DVD file-system with optional menus, from a list of
242
+multimedia video files and their titles.  As todisc can function as a master
243
+script, calling other scripts as it needs them, it is the easiest command line
244
+program for creating a DVD from start to finish, including automatically
245
+converting non-compliant videos and prompting to burn at completion.  It can do
246
+animated menus, static thumbnail menus, text-only menus, or author with no menu.
247
+In addition, it can do slideshows, using images as input, and even combine
248
+slideshows with videos.  It supports sub-menus for chapter breaks,
249
+configurable menu style, animated backgrounds and transparency effects.
250
+From simple (no menu) to complex (switched menus and titlesets), you should
251
+be able to do what you want with 'tovid disc'.
252
+</P>
253
+
254
+<A NAME="toc9"></A>
255
+<H2>Usage</H2>
256
+
257
+<PRE>
258
+   tovid disc [OPTIONS] \
259
+      -files &lt;file list&gt; -titles &lt;title list&gt;
260
+      -out mydvd
261
+</PRE>
262
+
263
+<P>
264
+For example:
265
+</P>
266
+
267
+<PRE>
268
+   $ tovid disc -files File1.mpg File2.mpg File3.mpg \
269
+        -titles "Episode 1" "Episode 2" "Episode 3" \
270
+        -out Season_one
271
+</PRE>
272
+
273
+<P>
274
+The number of <B>-files</B> and <B>-titles</B> must be equal, though if you do not
275
+include any titles <B>tovid disc</B> will use the basename of the included files
276
+as titles.  If you are doing a slideshow or multiple slideshows, use
277
+<B>-slides</B> rather than <B>-files</B> for passing in the images.  You may use
278
+-files and -slides more than once to create an ordering in a mixed
279
+slideshows/videos menu.  See Slideshows part of Usage section, below.
280
+</P>
281
+<P>
282
+If the input files are not mpeg, you will have the option to auto-encode them.
283
+</P>
284
+<P>
285
+General Options
286
+</P>
287
+<P>
288
+<B>At present there are 2 display arrangements or "templates":</B>
289
+</P>
290
+
291
+<DL>
292
+<DT>A. (Default)</DT><DD>
293
+    Thumbs will be centred, and as large as space restraints allow.
294
+<P></P>
295
+<DT>B. <B>-showcase</B> IMAGE|VIDEO</DT><DD>
296
+    Produces an arrangement with small buttons on
297
+    the side and the showcase image/video in the centre.  If no IMAGE or VIDEO
298
+    argument is supplied, the central thumb will be omitted.
299
+<P></P>
300
+    Note: <B>-textmenu</B>, <B>-quick-menu</B> and <B>-switched-menus</B> are all types
301
+    of showcase style menus.  See descriptions under <B>Menu style</B> section.
302
+</DL>
303
+
304
+<P>
305
+The <B>-titles</B> arguments should be double or single quoted, or have the spaces
306
+backslash-escaped. Special characters (like ", !, *, &amp;, ?) may need to be
307
+backslash-escaped.  To include a quoted string within a title, backslash-escape
308
+the quotes.  These titles are used for labelling thumbnails on the main menu,
309
+and for the submenu title for that video.  ( see also <B>-submenu-titles</B> )
310
+</P>
311
+<P>
312
+The <B>-showcase</B> styles can use longer titles than the default arrangement.
313
+With a showcase style, use: <B>-showcase-titles-align west</B> to give more space
314
+for the title, or use <B>-showcase-titles-align east</B> to allow titles of more
315
+than one line.
316
+</P>
317
+<P>
318
+The default style can only show about 16 characters (depending on the number
319
+of thumbs, and what <B>-titles-font</B> and <B>-titles-fontsize</B> is being used).
320
+If your titles are too long to fit in the label area, you may try using
321
+sub-menus, which can display longer titles, for example:
322
+</P>
323
+
324
+<PRE>
325
+   $ tovid disc -submenus \
326
+        -files file1.mpg file2.mpg ... \
327
+        -titles "Short 1" "Short 2" \
328
+        -submenus \
329
+        -submenu-titles "Long Title One" "Long Title Two" \
330
+        -out foo
331
+  
332
+</PRE>
333
+
334
+<P>
335
+The <B>-align</B> argument will position both titles and thumbs either south,
336
+north east, west, southwest, northwest, southeast, northeast, subject to
337
+certain constraints of each arrangement. For example a showcase style with
338
+a showcase thumb can only do north|south|center.
339
+</P>
340
+<P>
341
+More Examples:
342
+</P>
343
+<P>
344
+A text-only menu:
345
+</P>
346
+
347
+<PRE>
348
+   $ tovid disc -textmenu ...
349
+</PRE>
350
+
351
+<P>
352
+No menu:
353
+</P>
354
+
355
+<PRE>
356
+   $ tovid -nomenu -files file1.mpg file2.mp4 "file 3.avi" -out mydvd
357
+</PRE>
358
+
359
+<P>
360
+<B>Titlesets</B>
361
+</P>
362
+<P>
363
+A word should be mentioned here about titlesets, which is really just a
364
+hierarchy of menus.  You need to use titlesets, for example, if you have videos
365
+of different resolutions, or otherwise want to arrange videos on separate menus.
366
+If you want to have titlesets you need to put all the options for each titleset
367
+menu you would like to have between <B>-titleset</B> and <B>-end-titleset</B> options.
368
+</P>
369
+<P>
370
+Additionally, for the main menu (the opening menu that will let you jump to
371
+each titleset), you need to put options between <B>-vmgm</B> and <B>-end-vmgm</B>.
372
+You do not use <B>-files</B> for the opening menu options (<B>-vmgm</B>), but you
373
+will need as many TITLES after <B>-titles</B> as you have menus.
374
+</P>
375
+<P>
376
+Any options outside the <B>-titleset</B> <B>-end-titleset</B> and <B>-vmgm</B>
377
+<B>-end-vmgm</B> areas will be global options applying to every titleset.
378
+If a global option is duplicated inside a <B>-titleset</B> or <B>-vmgm</B> area, the
379
+global option will be overridden.
380
+</P>
381
+<P>
382
+Note: you do not need titlesets for a single menu with chapter break menus, for
383
+that just use <B>-submenus</B> or <B>-ani-submenus</B>
384
+</P>
385
+<P>
386
+Example of using <B>tovid disc</B> with titlesets:
387
+</P>
388
+
389
+<PRE>
390
+   $ tovid disc -static -out MY_DVD \
391
+     \
392
+     -titleset \
393
+     -files 1.mpg 2.mpg 3.mpg \
394
+     -titles "Title One" "Title Two" "Title Three" \
395
+     -end-titleset \
396
+     \
397
+     -titleset \
398
+     -files 4.mpg 5.mpg \
399
+     -titles "Title Four" "Title Five" \
400
+     -background foo.jpg \
401
+     -showcase bar.png \
402
+     -end-titleset \
403
+     \
404
+     -vmgm \
405
+     -titles "Season One" "Season Two" \
406
+     -background bg.jpg \
407
+     -bgaudio foo.mp3 \
408
+     -titles-fontsize 20 \
409
+     -end-vmgm
410
+</PRE>
411
+
412
+<P>
413
+See also <B>-titleset</B> and <B>-vmgm</B>
414
+</P>
415
+<P>
416
+<B>Slideshows</B>
417
+</P>
418
+<P>
419
+You can also use <B>tovid disc</B> to make slideshows.  This can either be a single
420
+slideshow, or multiple slideshows on the same menu.
421
+Remember to use <B>-slides</B> rather than <B>-files</B> for passing in the
422
+images.  Images can be any filetype that imagemagick supports: for example
423
+JPEG, PNG, GIF, TGA BMP etc.  For a single slideshow do not use <B>-titles</B>:
424
+use -menu-title to set the slideshow title.
425
+</P>
426
+<P>
427
+For a single slideshow the default is an animated menu that transitions from
428
+slide to slide.  The default transition type is 'crossfade', which fades each
429
+slide into the next and loops back to the first slide at the end.  If instead
430
+you use <B>-static</B>, then a static 'polaroid stack' menu of all the slides is
431
+created, with a single spumux'ed button for navigating with the enter key.  You
432
+may have to experiment to find out which DVD remote button advances the slides.
433
+Try the 'next chapter'(skip ?) button and the play or enter buttons.
434
+If you want to limit the number of slides in the menu to a subset of all files
435
+entered with <B>-slides</B>, then use <B>-menu-slide-total</B> INT.  Be sure to use
436
+a long enough audio file for <B>-bgaudio</B> or set <B>-menu-length</B> so the menu
437
+is long enough to support the slides plus transitions.
438
+</P>
439
+<P>
440
+You can also put multiple slideshows on one menu.  To do this, use
441
+<B>-slides IMAGES</B> for each slideshow desired.  You can even mix videos
442
+with slideshows by using <B>-files</B> <B>-slides</B> <B>-titles</B> multiple times.
443
+</P>
444
+<P>
445
+Example of a single slideshow with an animated menu with transitions:
446
+</P>
447
+
448
+<PRE>
449
+   $ tovid disc -menu-title "Autumn in Toronto" -slides images/*.jpg \
450
+      -menu-slide-total 20 -slide-transition crossfade -bgaudio slideshow.wav \
451
+      -out myslideshow
452
+</PRE>
453
+
454
+<P>
455
+Example of multiple slideshows on one menu:
456
+</P>
457
+
458
+<PRE>
459
+   $ tovid disc -menu-title "Autumn in Toronto" \
460
+     -slides photos/september/*.jpg \
461
+     -slides photos/october/*.jpg \
462
+     -slides photos/november/*.jpg \
463
+     -tile3x1 -rotate -5 5 -5 -align center \
464
+     -bgaudio background.wav \
465
+     -out myslideshow
466
+</PRE>
467
+
468
+<P>
469
+Example of mixed videos and slideshows:
470
+</P>
471
+
472
+<PRE>
473
+   $ tovid disc -menu-title "Autumn in Toronto" \
474
+     -files fall_fair.mov \
475
+     -slides  photos/september/*.jpg \
476
+     -files harvest.mpg \
477
+     -slides photos/october/*.jpg \
478
+     -titles "Fall Fair" "September" "Harvest" "October" \
479
+     -background autumn.png \
480
+     -bgaudio bg.mp3 \
481
+     -out myslideshow
482
+</PRE>
483
+
484
+<P>
485
+See the other slideshow options in the Slideshows options section.
486
+</P>
487
+<P>
488
+<B>Encoding Options</B>
489
+</P>
490
+<P>
491
+These are options for reencoding your non-compliant videos.  They are passed
492
+directly to the <B>tovid mpg</B> command which is invoked by <B>tovid disc</B> when
493
+non-compliant files are found.  For details, see the <B>Command:mpg</B> section.
494
+Here is a list of possible options you can pass:
495
+    <B>-config</B>, <B>-ntscfilm</B>, <B>-dvd-vcd</B>, <B>-half-dvd</B>, <B>-kvcd</B>,
496
+    <B>-kvcdx3</B>, <B>-kvcdx3a</B>, <B>-kdvd</B>, <B>-bdvd</B>, <B>-704</B>, <B>-normalize</B>,
497
+    <B>-amplitude</B>, <B>-overwrite</B>, <B>-panavision</B>, <B>-force</B>, <B>-fps</B>,
498
+    <B>-vbitrate</B>, <B>-quality</B>, <B>-safe</B>, <B>-crop</B>, <B>-filters</B>,
499
+    <B>-abitrate</B>, <B>-priority</B>, <B>-deinterlace</B>, <B>-progressive</B>,
500
+    <B>-interlaced</B>, <B>-interlaced_bf</B>, <B>-type</B>, <B>-fit</B>, <B>-discsize</B>,
501
+    <B>-parallel</B>, <B>-mkvsub</B>, <B>-autosubs</B>, <B>-subtitles</B>, <B>-update</B>,
502
+    <B>-mplayeropts</B>, <B>-audiotrack</B>, <B>-downmix</B>, <B>-ffmpeg</B>, <B>-nofifo</B>,
503
+    <B>-from-gui</B>, <B>-slice</B>, <B>-quiet</B>,
504
+    <B>-fake</B>, <B>-keepfiles</B>
505
+</P>
506
+
507
+<A NAME="toc10"></A>
508
+<H2>General Options</H2>
509
+
510
+<DL>
511
+<DT><B>-keep-files</B>, <B>-keepfiles</B></DT><DD>
512
+    Keep all intermediate/temporary files (helps with debugging)
513
+<DT><B>-no-ask</B> | <B>-noask</B></DT><DD>
514
+    Skip all interactive questions.  No preview, automatic re-encoding with
515
+    tovid if needed, no interactive option to use background video for bgaudio.
516
+<DT><B>-no-warn</B>, <B>-nowarn</B></DT><DD>
517
+    Don't pause after outputting warning or info messages
518
+<DT><B>-jobs</B></DT><DD>
519
+    By default, <B>tovid disc</B> starts a parallel job for each processor
520
+    detected.  With this option you can manually set the number of jobs.  For
521
+    example if you have a computer with 2 CPUs you can set "-jobs 1" to keep
522
+    one processor free for other things.  At present this applies to the time
523
+    consuming imagemagick loops: you will notice a substantial speedup now if
524
+    you have a multi-cpu system.
525
+<DT><B>-grid</B></DT><DD>
526
+    Show a second preview image with a grid and numbers that will help in finding
527
+    coordinates for options that might use them, like <B>-text-start</B>
528
+<DT><B>-no-confirm-backup</B></DT><DD>
529
+    This option is for when your DVD contains images for a slideshow.
530
+    Slideshows are an experimental (but well tested) feature.  Todisc is
531
+    unlikely to overwrite your personal files, but you should take precautions
532
+    and backup your images, as you would with any beta software.  Todisc
533
+    will prompt you to backup your files normally.  If you have already backed
534
+    up your images, use this option to disable the prompt.
535
+<P></P>
536
+==Options==
537
+<P></P>
538
+<DT><B>-ntsc</B></DT><DD>
539
+    720x480 output, compatible with NTSC standard (default)
540
+<DT><B>-pal</B></DT><DD>
541
+    720x576 output, compatible with PAL standard
542
+<DT><B>-submenus</B></DT><DD>
543
+    Create a sub-menu with chapters for each video (default: no sub-menus)
544
+<DT><B>-ani-submenus</B></DT><DD>
545
+    Create an animated sub-menu with chapters for each video (default: not
546
+    animated)
547
+<DT><B>-no-menu | -nomenu</B></DT><DD>
548
+    With this option todisc will just create a DVD file system, ready for
549
+    burning, with NO MENU, just the supplied video files.  These do not need
550
+    to be compliant, as non-compliant files will be encoded as usual.  The
551
+    <B>-out</B> option is not required.  Each  video will be a chapter unless
552
+    <B>-chapters</B> OPTION is passed.  The  <B>-chapters</B> option is a number
553
+    indicating the chapter interval in minutes, or a HH:MM:SS string
554
+    indicating chapter points.  See <B>-chapters</B>
555
+<DT><B>-encode-only</B></DT><DD>
556
+    This option was originally meant for the GUI, to allow it to be used for
557
+    just encoding rather than making a DVD structure.  But it works well from
558
+    the command line as well as it has the added advantage that you can input
559
+    a list of files.  Remember any makempg ('tovid mpg') options you use will
560
+    be passed on to the makempg script when encoding.
561
+</DL>
562
+
563
+<A NAME="toc11"></A>
564
+<H2>Menu style</H2>
565
+
566
+<DL>
567
+<DT><B>-showcase</B> IMAGE|VIDEO</DT><DD>
568
+    If used without an argument, use showcase style without a central thumb.
569
+    This is a different arrangement of images for the menu: small thumbnails
570
+    go at left (and right) side of screen, with a larger image in the centre.
571
+    Maximum of 10 videos.  If the provided argument is a video file, the
572
+    central thumb will be animated (regardless of whether <B>-static</B> is part
573
+    of the command line). Only 4:3 or 16:9 videos and images are accepted for
574
+    for the showcase file: if not one of these todisc will assume it is the
575
+    aspect ratio as the videos in the titleset.
576
+<DT><B>-textmenu</B>, <B>-text-menu</B> NUM</DT><DD>
577
+    If used without an argument, create a textmenu out of the supplied titles
578
+    The optional argument specifies how many titles are in the 1st column,
579
+    i.e. giving 4 titles and using "-textmenu 2" would make 2 columns of 2
580
+    titles. The default is to put all titles up to 13 in the first column
581
+    before starting a second column.  Maximum: 2 columns and 26 titles.
582
+    Note that column 2 titles are justified to the left unless you add
583
+    <B>-edge-justify</B> to the command line. The menu will be static if no video
584
+    files are supplied with either <B>-background</B> or <B>-showcase</B> options.
585
+<DT><B>-quick-menu</B></DT><DD>
586
+    If you are using ffmpeg 0.8 or newer you can use this option.  This will
587
+    make a very quick  menu by using ffmpeg instead of imagemagick.
588
+    There are two choices: you can either use '-showcase IMAGE|VIDEO' or
589
+    '-background VIDEO'.  There are no fancy effects like <B>-wave</B>
590
+    or <B>-rotate</B> available for it, but it is extremely fast.  It will be a
591
+    text-menu style of menu, with no video thumbs, and a central showcase
592
+    IMAGE(static) | VIDEO(animated).
593
+    (i) see <B>-bg-color</B> if you are not using a <B>-background</B> and want to
594
+    change the default.  (default is dark blue for -quick-menu arrangements). )
595
+    (ii) Note: todisc will still work with 'vhooks' if you have an old ffmpeg
596
+    with vhooks compiled in.
597
+<P></P>
598
+    Specifying the IMAGE|VIDEO argument to <B>-showcase</B> is mandatory for this
599
+    style of menu, unless used in conjunction with <B>-switched-menus</B>
600
+    in which case the videos passed with <B>-files</B> automatically become the
601
+    showcase videos.  If <B>-quick-menu</B> is used in combination with
602
+    <B>-switched-menus</B> it really speeds up an otherwise time consuming process.
603
+<P></P>
604
+    Example:
605
+<PRE>
606
+      -quick-menu -showcase /home/grepper/showcase.mpg
607
+</PRE>
608
+
609
+    See <B>-switched-menus</B> for example of making switched menus with
610
+    <B>-quick-menu</B>
611
+<P></P>
612
+<DT><B>-bg-color</B>, <B>-bg-colour</B></DT><DD>
613
+    The color to use for the menu background. (default: ntsc-safe black)
614
+    Note: use a color a great deal darker than you want, as it appears quite
615
+    a bit lighter in the video version.  You can use hexadecimal ('#ffac5f')
616
+    notation or named colors ('Lime').  convert -list color will show them.
617
+    See <A HREF="http://www.imagemagick.org/script/color.php">colors</A> for more details.
618
+<DT><B>-submenu-bg-color</B>, <B>-submenu-bg-colour</B></DT><DD>
619
+    The color to use as background for the  submenu(s).
620
+    (default: ntsc-safe black)  See <B>-bg-color</B>
621
+<DT><B>-static</B></DT><DD>
622
+    Main menu will consist of static thumbnail links. (default: animated)
623
+    If you use a video for -showcase or -background then it will still be
624
+    a 'moving' menu, in spite of the static buttons.  This option also does
625
+    double duty for the <B>-switched-menus</B> option, and will create static
626
+    "switched" images.
627
+    See also <B>-switched-menus</B>
628
+<DT><B>-background</B> IMAGE|VIDEO</DT><DD>
629
+    Menu background.  This can be a image file or an video file.  If it is a
630
+    video file the background will be animated.  Pick a file of correct aspect
631
+    ratio: i.e. it should still look good when resized to 4:3 aspect ratio.
632
+    It will be resized to fill the entire background.
633
+<DT><B>-submenu-background</B> IMAGE</DT><DD>
634
+    Submenu background.  This can be only be an image file.  Pick a file of
635
+    correct aspect ratio: i.e. it should still look good when resized to
636
+    4:3 aspect ratio.  It will be resized to fill the entire background.
637
+<DT><B>-menu-title</B></DT><DD>
638
+    Title for the root menu - may be longer than thumbnail labels
639
+    Also if you use \n in the title, you can use multi line titles, but you
640
+    would need to adjust <B>-title-fontsize</B> to something smaller than default
641
+    for example:
642
+<P></P>
643
+<PRE>
644
+      $ tovid disc ... -menu-title "A\nMultilined\nTitle" -title-fontsize 24
645
+</PRE>
646
+
647
+<DT><B>-title-font</B>, <B>-menu-font</B> FONT</DT><DD>
648
+    Font to use for titles, either by ImageMagick font name (ex., "Arial") or
649
+    explicit pathname (ex., "/full/path/to/arial.ttf"). To see a complete
650
+    list of acceptable ImageMagick font names, run <B>convert -list type</B>, and
651
+    refer to the leftmost column
652
+<DT><B>-title-fontsize</B>, <B>-menu-fontsize</B></DT><DD>
653
+    Font size for main menu - best to -preview if you use this
654
+<DT><B>-submenu-font</B></DT><DD>
655
+    Font to use for the sub-menu main titles.  See <B>-title-font</B>
656
+<DT><B>-submenu-fontsize</B></DT><DD>
657
+    Font size for the sub-menu main titles
658
+<DT><B>-menu-fade</B> ['BACKGROUND DURATION']</DT><DD>
659
+    Fade the menu in and out The background will fade in first, then title (and
660
+    mist if called for), then the menu thumbs.  The fadeout is in reverse
661
+    order.  'BACKGROUND DURATION' is an integer denoting the amount of time
662
+    the background will play before the menu begins to fade in.  This can allow
663
+    you to do a 'transition' to the menu: if you supply a -background VIDEO it
664
+    will play for the indicated time before the menu fades in.  Leave the
665
+    optional argument empty (just <B>-menu-fade</B>) to get the default behavior
666
+    of showing the background for 1 second before fading the menu in.  To
667
+    disable the fadeout portion, use '<B>-loop</B> inf'.  See also:
668
+    <B>-transition-to-menu</B> and <B>-loop</B>
669
+<DT><B>-transition-to-menu</B></DT><DD>
670
+    This option goes with the <B>-menu-fade</B> option above, which must be
671
+    enabled for it to have effect.  It is a convenience option for animated
672
+    backgrounds: the background will become static at the exact point the
673
+    thumbs finish fading in. This menu does not loop unless you pass
674
+    <B>-loop</B> VALUE.  See also: <B>-loop</B>
675
+<DT><B>-bgaudio</B>, <B>-bg-audio*</B> FILE</DT><DD>
676
+    An file containing audio for the main menu background.  For static menus
677
+    the default is to use 20 seconds of audio.  You can change this using the
678
+    <B>-menu-length</B> option.
679
+<DT><B>-submenu-audio</B> FILE(S)</DT><DD>
680
+    List of files for sub-menu audio backgrounds. If one file is given, then
681
+    it will be used for all sub-menus.  Otherwise the number given must equal
682
+    the number of submenus, though the keyword "none" in this list may be used for
683
+    silence.  See also <B>-submenu-length</B>
684
+<DT><B>-titleset</B> . . . <B>-end-titleset</B></DT><DD>
685
+    If you have more than one titleset, put options for each titleset between
686
+    <B>-titleset</B> and <B>-end-titleset</B>.  A separate menu will be created that
687
+    can be accessed from the main menu (VMGM).  You can create this main menu
688
+    using the <B>-vmgm</B> <B>-end-vmgm</B> options.  See <B>-vmgm</B> below and
689
+    TITLESET paragraph opening <B>Usage</B> section.
690
+<DT><B>-vmgm</B> . . . <B>-end-vmgm</B></DT><DD>
691
+    The VMGM menu is the root menu when you use titlesets.
692
+    Put your VMGM menu options between <B>-vmgm</B> and <B>-end-vmgm</B>.
693
+    You only need <B>-titles</B> "Titleset One title"  "Titleset Two title"
694
+    . . . , and not <B>-files</B>.
695
+    Any other options can be used, but the  menu will be a textmenu style by
696
+    default.  <B>Hint</B>: use <B>-showcase</B> IMAGE/VIDEO to create a fancier
697
+    VMGM menu.
698
+<DT><B>-no-vmgm-menu</B>, <B>-no-vmgm</B></DT><DD>
699
+  This will skip the creation of a VMGM ( root menu ) for titlesets. The DVD
700
+  will start with the first titleset.  You can not use this option unless also
701
+  using <B>-quick-nav</B> as you would not have a way to get to other titlesets.
702
+<DT><B>-skip-vmgm</B></DT><DD>
703
+  Start DVD from the first titleset instead of the VMGM ( root ) menu.
704
+<DT><B>-switched-menus</B>, <B>-switched-menu</B></DT><DD>
705
+    This will make a "switched menu": there will be a central image where the
706
+    showcase image would go, and text menu titles along the menu edge where
707
+    textmenu titles go.  As you select a video title with the down or up arrow
708
+    on your DVD remote, the image in the centre will change to the image or
709
+    video made from that selected video. Do not use <B>-showcase</B> IMAGE/VIDEO
710
+    with this option.
711
+<P></P>
712
+    This can be a time consuming process for making animated menus as you need
713
+    to make a separate menu for each video provided with <B>-files</B>.  The
714
+    process can be greatly sped up by using <B>-quick-menu</B> in conjunction with
715
+    this, though you will lose fancy options like <B>-rotate</B> and <B>-wave</B>.
716
+<P></P>
717
+    Note that if you want to just have a static rather than an 'animated'
718
+    image, add <B>-static</B> to the command line.
719
+<P></P>
720
+    Example for using with <B>-quick-menu</B>:
721
+<PRE>
722
+      -switched-menus -quick-menu
723
+</PRE>
724
+
725
+</DL>
726
+
727
+<A NAME="toc12"></A>
728
+<H2>Thumbnail style</H2>
729
+
730
+<DL>
731
+<DT><B>-titles-font</B> FONT</DT><DD>
732
+    Display thumbnail or textmenu titles in the given font
733
+<DT><B>-titles-fontsize</B> POINTS</DT><DD>
734
+    Font size to use for thumbnail or textmenu titles
735
+<DT><B>-thumb-shape</B></DT><DD>
736
+    normal|oval|vignette|plectrum|arch|spiral|blob|star|flare
737
+    Apply a shaped transparency mask to thumbnail videos.
738
+    These "feathered" shapes look best against a plain background (or used
739
+    in conjunction with <B>-thumb-mist</B> [COLOR]).  For this rectangular
740
+    semi-transparent misted background for each thumb:  see <B>-thumb-mist</B>.
741
+    Note: if you wish to make your own mask PNGS you can put them in
742
+    $PREFIX/lib/tovid/masks/ or $HOME/.tovid/masks/ and use them on the
743
+    command line using the filename minus the path and extension.
744
+    (i.e ~/.tovid/masks/tux.png becomes -thumb-shape tux)
745
+    No frame is used for shaped thumbs.
746
+<DT><B>-thumb-frame-size</B> INT</DT><DD>
747
+    The size (thickness) of the thumb frames in pixels.  This will also set the
748
+    thickness of the raised "frame" of thumbs when you use <B>-3d-thumbs</B>.
749
+    See also <B>-showcase-frame-size</B> and <B>-thumb-frame-color</B>
750
+<DT><B>-thumb-frame-color</B>, <B>-thumb-frame-colour</B> COLOR</DT><DD>
751
+    The color of frames for video thumbnails.  Use hexadecimal or named colors
752
+    notation.  Remember to quote if using hexadecimal! ( '#ffac5f' ).
753
+<DT><B>-3d-thumbs</B>, <B>-3dthumbs</B></DT><DD>
754
+    This will give an illusion of 3D to the thumbnails: dynamic lighting on
755
+    rounded thumbs, and a raised effect on rectangular thumbs.  Try it !
756
+</DL>
757
+
758
+<A NAME="toc13"></A>
759
+<H2>Slideshows</H2>
760
+
761
+<DL>
762
+<DT><B>-slides</B> IMAGES</DT><DD>
763
+    Use <B>-slides</B> IMAGES to pass in images for a slideshow.  The default is
764
+    to make an animated menu of the slides, moving from one slide to the
765
+    next. If you use <B>-static</B>, a 'polaroid stack' montage is created.  This
766
+    composites the slides onto the background in 'random' locations with random
767
+    rotations.  <B>-slides</B>  IMAGES can be used multiple times if you wish to
768
+    make a menu with multiple slideshows.  You can also make a menu
769
+    of mixed videos and slideshows by using <B>-slides</B> IMAGES, and <B>-files</B>
770
+    VIDEOS multiple times.  For such a menu, the number of <B>-titles</B>
771
+    needs to match the number of <B>-files</B> passed in plus the number of
772
+    slideshows.  (Each time you use <B>-slides</B> counts as one title.)  To use
773
+    a transition between the slides, use <B>-slide-transition</B>
774
+    crossfade|fade.  See <B>-slide-transition</B> <B>-menu-slide-total</B>
775
+<P></P>
776
+<DT><B>-menu-slide-total</B> INT</DT><DD>
777
+    Use INT number of the slides that were passed in with <B>-slides</B>
778
+    to make the animated or static slide menu.  The length of the menu is
779
+    determined by 1) <B>-menu-length</B> NUM if given,  and by 2) the length
780
+    of the audio from <B>-bgaudio</B>.  For submenu slideshows, it is determined
781
+    by 1) <B>-submenu-length</B> NUM if given,  and by 2) the length of the
782
+    audio from <B>-submenu-audio</B> FILE(S).
783
+<P></P>
784
+<DT><B>-submenu-slide-total</B> INT</DT><DD>
785
+    This option is the same as <B>-menu-slide-total</B> except that it is
786
+    for submenu slideshows.
787
+<P></P>
788
+<DT><B>-slide-transition</B> crossfade|fade [crossfade]</DT><DD>
789
+    The type of fade transition between slides in a animated slide menu.  Be
790
+    sure the menu length is long enough to support the 1 second transitions
791
+    between the slides.  The length is determined by 1) the length of the
792
+    -bgaudio AUDIO  2) the length given with -menu-length NUM.  For submenu
793
+    slideshows, it is determined by 1) <B>-submenu-length</B> NUM if given,  and
794
+    by 2) the length of the audio from <B>-submenu-audio</B> FILE(S).
795
+<P></P>
796
+    See <B>-menu-slide-total</B> , <B>-bgaudio</B> , <B>-menu-length</B> ,
797
+    <B>-submenu-length</B>, and <B>-submenu-audio</B>.
798
+<P></P>
799
+    The 'crossfade' transition fades from one slide to another.  The 'fade'
800
+    transition fades in and out from and to black.  If you don't use this
801
+    option, the default is to use a 'crossfade' transition.
802
+<P></P>
803
+<DT><B>-slideshow-menu-thumbs</B> FILES</DT><DD>
804
+    Use the FILES instead of the 1st image in each slideshow as the
805
+    thumb that shows on the menu.  This option is for multiple slideshows
806
+    or mixed slideshow/video menus only.
807
+<P></P>
808
+<DT><B>-slides-to-bin</B> FILES</DT><DD>
809
+    FILES will be resized to 640x480 using a 'box' filter - this
810
+    is called 'binning'.  It will reduce the 'signal to noise' ratio for the
811
+    image in the animated slide menu.  Use this if you get some unwanted
812
+    effects for certain images, such as pixels shifting in what should be a
813
+    static image.  See also <B>-slides-to-blur</B> and <B>-slide-border</B>
814
+<P></P>
815
+<DT><B>-slides-to-blur</B> FILES</DT><DD>
816
+    FILES will be blurred a small amount - which will help on
817
+    slides that still have noise even after 'binning' with -slides-to-bin.
818
+    The default blur is 0x0.2 - you can increase this with
819
+    -slide-blur ARG.  See also <B>-slides-to-bin</B> and <B>-slide-border</B>
820
+<P></P>
821
+<DT><B>-slide-blur</B> VALUE or LIST of VALUES [0x0.2]</DT><DD>
822
+    The argument to use for blurring files.  It will be passed to
823
+    imagemagick: convert -blur ARG.  The format of the arg is {radius}x{sigma}
824
+    and the default is 0x0.2. Using values between 0x0.1 and 0x0.9 is probably
825
+    the best range.  Use a single value for all, or a list to have a different
826
+    blur for each file passed with <B>-slides-to-blur</B>.  You must pass in
827
+    <B>-files-to-blur</B> FILES to use this option.  Blurring can help 'noise'
828
+    problems in the video.  See also <B>-slides-to-bin</B> and <B>-slide-border</B>
829
+<P></P>
830
+<DT><B>-slide-border</B> WIDTH [100]</DT><DD>
831
+    Pad the slides with a border for the animated slide menu.  The default
832
+    without using an argument is 100.  Using this option can also solve some
833
+    noise/ringing effects if used alone or in conjunction with 'binning'
834
+    (<B>-slides-to-bin</B>) or blurring (<B>-slides-to-blur</B>).
835
+<P></P>
836
+<DT><B>-slide-frame</B> WIDTH [12]</DT><DD>
837
+    Frame the slides for the animated slideshow menu.  The default width
838
+    without using an  argument is 12.  See also <B>-slide-frame-color</B>
839
+<P></P>
840
+<DT><B>-slide-frame-color</B>, <B>-slide-frame-colour</B></DT><DD>
841
+    The color of the slide frame if passing <B>-slide-frame</B>.  The default if
842
+    you don't use this option is a color-safe white: rgb(235,235,235).
843
+<P></P>
844
+<DT><B>-showcase-slideshow</B></DT><DD>
845
+    If doing multiple slideshows or mixed videos and slideshow(s), then use
846
+    the animated slideshow as a showcase video.  It will be composed of slides
847
+    from each slideshow in the menu.  The thumb for each slideshow button will
848
+    be static.  If you used with a mixed menu of videos and slideshows, then
849
+    the video thumbs WILL be animated, so you may wish to use -static or
850
+    -textmenu with the option in that case.  If you want to use the
851
+    **-switched-menus option with a mixed menu leave this option out.
852
+<P></P>
853
+<DT><B>-background-slideshow</B>, <B>-bg-slideshow</B></DT><DD>
854
+    If doing multiple slideshows or mixed videos and slideshow(s), then use
855
+    the animated slideshow as a background video.  See <B>-showcase-slideshow</B>
856
+    for additional details.
857
+<P></P>
858
+<DT><B>-no-confirm-backup</B></DT><DD>
859
+    Slideshows are an experimental (but well tested) feature.  Todisc is
860
+    unlikely to overwrite your personal files, but you should take precautions
861
+    and backup your images, as you would with any beta software.  Todisc
862
+    will prompt you to backup your files normally.  If you have already backed
863
+    up your images, use this option to disable the prompt.
864
+    See <B>General Options</B>
865
+<P></P>
866
+<DT><B>-use-dvd-slideshow</B> <A HREF="FILE">CONFIG</A></DT><DD>
867
+    If you pass this option without an argument, tovid will use the
868
+    dvd-slideshow program to create the animated slide menu, assuming you have
869
+    this program installed.  The optional argument is the dvd-slideshow
870
+    configuration file  - if you don't use this argument tovid will create it
871
+    for you.  If you want to use the 'Ken Burns effect' - then the
872
+    configuration file argument is required.  Note: the configuration file will
873
+    override many of the above options for slideshows.
874
+</DL>
875
+
876
+<A NAME="toc14"></A>
877
+<H2>Burning the disc</H2>
878
+
879
+<DL>
880
+<DT><B>-burn</B></DT><DD>
881
+    Prompt to burn the DVD directory on completion.
882
+<P></P>
883
+<DT><B>-device</B></DT><DD>
884
+    Device to use for the burning program [ /dev/dvdrw ]
885
+<P></P>
886
+<DT><B>-speed</B></DT><DD>
887
+    The speed to use for burning the disc.
888
+</DL>
889
+
890
+<A NAME="toc15"></A>
891
+<H2>Advanced usage</H2>
892
+
893
+<H3>Options</H3>
894
+
895
+<DL>
896
+<DT><B>-menu-length</B></DT><DD>
897
+    The desired animated main menu length in seconds
898
+<DT><B>-submenu-length</B></DT><DD>
899
+    The desired submenu length.  This will also affect the length of submenu
900
+    audio for static submenus.  (Assuming that -submenu-audio was passed in).
901
+    The default is to use 10 seconds of audio for static menus.
902
+<DT><B>-submenu-stroke</B> COLOR</DT><DD>
903
+    The color for the sub-menu font shadow
904
+<DT><B>-submenu-title-color</B>, <B>-submenu-title-colour</B></DT><DD>
905
+    The fill color used for sub-menu title fonts
906
+<DT><B>-submenu-titles</B></DT><DD>
907
+    You can supply a list of titles here for sub-menus without the length
908
+    restrictions found in thumb titles.  Must equal number of videos
909
+<DT><B>-chapters</B> [ NUM | CHAPTER POINTS in HH:MM:SS ]</DT><DD>
910
+    The number of chapters for each video (default: 6) OR
911
+    the actual chapter points in HH:MM:SS format.
912
+    Chapter points will be used for generating the submenu thumbs, and for
913
+    seeking with your DVD player.  You can pass in just one value that will
914
+    be used for all videos, or supply a list of values (number of chapters)
915
+    or time code strings.
916
+<P></P>
917
+    If you just pass an integer for 'number of chapters', then tovid will
918
+    make the chapter points for you by dividing the video length by the number
919
+    you supply.  If using the <B>-no-menu</B> option, the INT passed in will be
920
+    the chapter interval in minutes, rather than the above formula.
921
+<P></P>
922
+    If passing HH:MM:SS format you need to pass the string of chapter points for
923
+    each video and each string should have comma separated values.
924
+    Additionally, the first chapter should always start at 00:00:00 as
925
+    dvdauthor will add that if it is not there already.
926
+<P></P>
927
+    To get your time codes, you can play your videos in mplayer and press 'o'
928
+    to see them on-screen.  I have found these to be very accurate in my short
929
+    tests.  For greater frame accuracy you could try loading the file in
930
+    avidemux and find the time codes for the frames you want.
931
+<P></P>
932
+    If passing grouped chapters you need to join the chapters from all the
933
+    videos in a group with a '+' separator.  If you want to skip creating
934
+    chapters for a video in the group use '0' for its chapters.
935
+<P></P>
936
+    Note: chapters for grouped videos should probably be passed in using the
937
+    above HH:MM:SS format. (Arbitrary chapters using just an INT for the # of
938
+    chapters is not guaranteed to work reliably in all cases for grouped videos
939
+    at the moment.)
940
+<P></P>
941
+    Example for passing just number of chapters ( 4 videos ):
942
+<PRE>
943
+      -chapters 5 2 4 8
944
+</PRE>
945
+
946
+<P></P>
947
+    Example of passing chapter points ( 4 videos ):
948
+<PRE>
949
+      -chapters 00:00:00,00:05:34.41,00:12:54,00:20:45 \
950
+      00:00:00,00:04:25.623,00:09:12,00:15:51 \
951
+      00:00:00,00:05:10,00:13:41,00:18:13.033 \
952
+      00:00:00,00:15:23.342,00:26:42.523
953
+</PRE>
954
+
955
+<P></P>
956
+    Example of passing grouped chapters using the '+' separator:
957
+<PRE>
958
+      -chapters 00:00:00,00:05:34.41,00:12:54,00:20:45+00:04:23,00:09:35 \
959
+      00:00:00... etc.
960
+</PRE>
961
+
962
+<P></P>
963
+<DT><B>-chapter-titles</B> LIST</DT><DD>
964
+    If you are using submenus, you can pass a list of titles for the
965
+    chapters.  Each title must be quoted, and the number of titles given
966
+    must equal the total number of chapters for all videos.  In other words
967
+    if you use -chapters 4 6 8 , you must give 18 chapter titles, in the same
968
+    order that the videos were passed in.  Note: if you are passing in options
969
+    on the command line to the 'tovid disc' GUI, you must repeat the option
970
+    <B>-chapter-titles</B> for each video, accompanied by its respective chapter
971
+    titles. (you can also choose to use this syntax for the todisc script.)
972
+<P></P>
973
+<DT><B>-chapter-font</B> FONT</DT><DD>
974
+    Use FONT as the font for submenu chapters.
975
+<P></P>
976
+<DT><B>-chapter-fontsize</B> SIZE</DT><DD>
977
+    Use SIZE as the pointsize for the chapters font.
978
+<DT><B>-chapter-color</B> COLOR</DT><DD>
979
+    The color for the chapters font.
980
+<DT><B>-chapter-stroke</B> COLOR</DT><DD>
981
+    The color for the chapters font shadow
982
+<P></P>
983
+<DT><B>-seek</B> NUM | "NUM1 NUM2 NUM3 . . ."</DT><DD>
984
+    Seek to NUM seconds before generating thumbnails (default: 2.0 seconds)
985
+    If a quoted string of values matching the number of videos is used, then
986
+    each video can use a different seek value
987
+    If using switched menus, the <B>-seek</B> value(s) will be used to generate
988
+    the showcase image that displays on switching to another video choice with
989
+    the up/down arrow keys.
990
+<DT><B>-fast-seek</B></DT><DD>
991
+    Use faster seek method for ffmpeg.  This is not as accurate as the default
992
+    method, and may produce grey frames.
993
+<DT><B>-frame-safe</B>  Instead of seeking and then outputting one frame for</DT><DD>
994
+    previews and static menus, output 9 frames and choose the largest.  Not
995
+    frame accurate (may be as much as 9 frames off), but safer.  Choose this
996
+    if you are getting grey frames/thumbnails with some videos.  You can also
997
+    use it to try to get the 'best' frame.  This option
998
+    has no effect on submenus at present.
999
+<DT><B>-showcase-seek</B> NUM</DT><DD>
1000
+    Seek to NUM seconds before generating thumbnails for showcase video
1001
+    (default: 2.0 seconds)
1002
+<DT><B>-bgvideo-seek</B>, <B>-bg-video-seek</B> NUM</DT><DD>
1003
+    Seek to NUM seconds before generating images for background video
1004
+    (default: 2.0 seconds)
1005
+<DT><B>-bgaudio-seek</B>, **-bg-audio-seek NUM</DT><DD>
1006
+    Seek to NUM seconds before generating audio for bgaudio
1007
+    (default: 2.0 seconds)
1008
+<DT><B>-group</B> N VIDEO1 VIDEO2 . . .</DT><DD>
1009
+    Allow grouping videos in dvdauthor.xml, so they will play sequentially as
1010
+    a group.  The videos passed in after the 'N' will be grouped with the 'Nth'
1011
+    video. Example:
1012
+<P></P>
1013
+<PRE>
1014
+      -group 2 2.mpg 3.mpg 4.mpg
1015
+</PRE>
1016
+
1017
+<P></P>
1018
+    will group these 3 videos with the 2nd video given with <B>-files</B>, so that
1019
+    they will play sequentially as one title.  Only one thumbnail and/or title
1020
+    will appear on the menu for the group: it will be made from the 1st video
1021
+    in the group.  In the above example if you passed:
1022
+<PRE>
1023
+      -files foo.mpg bar.mpg baz.mpg -group 2 2.mpg 3.mpg 4.mpg
1024
+</PRE>
1025
+
1026
+    then the group will consist of bar.mpg  2.mpg, 3.mpg and 4.mpg, and only the
1027
+    title and/or thumbnail for bar.mpg will appear in the menu.  You can use
1028
+    <B>-group</B> more than once for multiple groups.  Be  sure to quote video
1029
+    filenames if they contain  spaces.
1030
+</DL>
1031
+
1032
+<A NAME="toc16"></A>
1033
+<H2>Menu Style</H2>
1034
+
1035
+<DL>
1036
+<DT><B>-menu-title-geo</B> north|south|east|west|center [south]</DT><DD>
1037
+    The position of the menu title.  You may need to use -align as well if
1038
+    you don't want your title covering other parts of your menu.  See
1039
+    <B>-align</B>
1040
+<DT><B>-menu-title-offset</B> OFFSET (+X+Y)</DT><DD>
1041
+    Move menu title by this offset from its N|S|E|W|Center position.  You
1042
+    may need to use -align as well if you don't want your title covering other
1043
+    parts of your menu.  See <B>-align</B>
1044
+<DT><B>-button-style</B> line|rect|text|text-rect [line]</DT><DD>
1045
+    The style of button that you will see when you play the DVD.
1046
+    "line" style underlines the title, "rect" draws a rectangle around the
1047
+    thumb when you select it in the DVD player, "text" highlights the video
1048
+    title text, and "text-rect" draws a rectangle around the title
1049
+    text.
1050
+<DT><B>-title-color</B>, <B>-title-colour</B> COLOR</DT><DD>
1051
+    Color to use for the main menu title.  For list of supported colors do:
1052
+    <B>convert -list</B> color.  HTML notation may be used: "#ff0000". See:
1053
+    <A HREF="http://www.imagemagick.org/script/color.php">http://www.imagemagick.org/script/color.php</A>
1054
+<DT><B>-title-stroke</B> COLOR</DT><DD>
1055
+    Shadow color for the main menu's title font. Use "none" for transparent
1056
+    outline  (see title-color).  Note: this is not a -stroke in the sense that
1057
+    imagemagick uses the term, but a shadow (the font is drawn twice).  To get
1058
+    a true imagemagick stroke see <B>-title-font-deco</B>
1059
+<DT><B>-title-font-deco</B>, <B>-title-fontdeco</B> "IMAGEMAGICK STRING"</DT><DD>
1060
+    Sets the font decoration method to FONTDECORATION. It is used by the 'convert'
1061
+    ImageMagick command to draw the menu text. You can add colored text
1062
+    outlines, gradient fills, and many others. See <B>Usage notes</B>
1063
+<DT><B>-titles-stroke</B> COLOR</DT><DD>
1064
+    Shadow color for the thumb or textmenu video titles font. Use "none" for
1065
+    transparent outline  (see <B>-titles-color</B>).  Note: this is not a -stroke
1066
+    in the sense that imagemagick uses the term, but a shadow
1067
+    (the font is drawn twice).  To get a true imagemagick stroke,
1068
+    see <B>-titles-font-deco</B>
1069
+<DT><B>-titles-font-deco</B>, <B>-titles-fontdeco</B> "IMAGEMAGICK STRING"</DT><DD>
1070
+    Sets the font decoration method to FONTDECORATION. It is used by the 'convert'
1071
+    ImageMagick command to draw the menu text. You can add colored text
1072
+    outlines, gradient fills, and others. See <B>Usage notes</B> for more info.
1073
+<DT><B>-highlight-color</B>, <B>-highlight-colour</B></DT><DD>
1074
+    Color to use for the menu buttons that your DVD remote uses to navigate.
1075
+<DT><B>-select-color</B>, <B>-select-colour</B></DT><DD>
1076
+    Color to use for the menu buttons that your DVD remote uses to select.
1077
+<DT><B>-text-mist</B></DT><DD>
1078
+    Put a semi-transparent misted background behind the text for the menu's
1079
+    title, just slightly larger than the text area.
1080
+<DT><B>-text-mist-color</B>, <B>-text-mist-colour</B> COLOR</DT><DD>
1081
+    Color of the mist behind the menu's title (see title-color).
1082
+<DT><B>-text-mist-opacity</B></DT><DD>
1083
+    Opacity of the mist behind the menu's title - see <B>-opacity</B>
1084
+<DT><B>-title-opacity</B></DT><DD>
1085
+    Opacity of the menu title text
1086
+<DT><B>-titles-opacity</B></DT><DD>
1087
+    Opacity of the text for video titles
1088
+<DT><B>-submenu-title-opacity</B></DT><DD>
1089
+    Opacity of the text for submenu menu titles
1090
+<DT><B>-chapter-title-opacity</B></DT><DD>
1091
+    Opacity of the text for submenu chapter titles
1092
+<DT><B>-menu-audio-fade</B></DT><DD>
1093
+    Number of sec to fade given menu audio in and out (default: 1.0 seconds)
1094
+    If you use <B>-menu-audio-fade</B> 0 then the audio will not be faded.
1095
+<DT><B>-submenu-audio-fade</B></DT><DD>
1096
+    Number of secs to fade sub-menu audio in and out (default: 1.0 seconds).
1097
+    See <B>-menu-audio-fade</B>
1098
+<DT><B>-intro</B> VIDEO</DT><DD>
1099
+    Use a introductory video that will play before the main menu.
1100
+    At present it must be a DVD compatible video at the correct resolution etc.
1101
+    Only 4:3 aspect is supported: 16:9 will give unexpected results.
1102
+</DL>
1103
+
1104
+<H3>Style options specific to showcase/textmenu arrangements</H3>
1105
+
1106
+<DL>
1107
+<DT><B>-text-start</B> N</DT><DD>
1108
+    This option is for <B>-textmenu</B> menus.  The titles will start at the Nth
1109
+    pixel from the top of the menu ( Y axis ).
1110
+<DT><B>-title-gap</B> N</DT><DD>
1111
+    This option is for <B>-textmenu</B> menus.  The gap is the space between
1112
+    titles vertically ( Y axis ).
1113
+<DT><B>-rotate</B> DEGREES</DT><DD>
1114
+    Rotate the showcase image|video clockwise by DEGREES.
1115
+    (default: if used without options, the rotate will be 5 degrees).  Note:
1116
+    this will not turn a portait image into a landscape image!
1117
+<DT><B>-showcase-geo</B> GEOMETRY</DT><DD>
1118
+    The position of the showcase image.  ( +X+Y  position )
1119
+    For example: <B>-showcase-geo</B> +300+200
1120
+<DT><B>-wave</B> default|GEOMETRY</DT><DD>
1121
+    Wave effect for showcase image|video.  Alters thumbs along a sine wave using
1122
+    GEOMETRY. (default: no wave)
1123
+    "default" will produce a wave arg of -20x556, which
1124
+    produces a gentle wave with a small amount of distortion.
1125
+    See: <A HREF="http://www.imagemagick.org/Usage/distorts/#wave">http://www.imagemagick.org/Usage/distorts/#wave</A> if you want
1126
+    to try other values.
1127
+<DT><B>-showcase-shape</B>  egg|oval|plectrum|arch|spiral|galaxy|flat-tube|normal</DT><DD>
1128
+    Apply a shaped transparency mask to showcase videos or images.
1129
+    Note: if you wish to make your own mask PNGS you can put them in
1130
+    $PREFIX/lib/tovid/masks/ or $HOME/.tovid/masks/ and use them on the
1131
+    command line using the filename minus the path and extension.
1132
+    No frame is used for shaped thumbs.
1133
+<DT><B>-showcase-framestyle</B>  none|glass</DT><DD>
1134
+    For -showcase-* style template only
1135
+    "none" will use the default frame method, using "convert -frame . . ."
1136
+    "glass" will use mplayer to make frames, which gives an interesting
1137
+    animated effect to the frames, and can be much faster ( especially if you
1138
+    don't use <B>-rotate</B> or <B>-wave</B> as thumbs will not need to be processed
1139
+    again after mplayer spits them out.  Note: you need to be using either
1140
+    <B>-showcase</B> IMAGE or <B>-showcase</B> VIDEO for this "frame style" to work.
1141
+<DT><B>-showcase-frame-size</B> PIXELS</DT><DD>
1142
+    The size of the showcase frame.  This value will be used for both width and
1143
+    height for the 'thickness' of the frame.  This will also set the thickness
1144
+    of the raised "frame" of the showcase thumb when you use <B>-3d-showcase</B>.
1145
+    See also <B>-thumb-frame-size</B> and <B>-showcase-frame-color</B>
1146
+<DT><B>-showcase-frame-color</B>, <B>-showcase-frame-colour</B> PIXELS</DT><DD>
1147
+    The color of the showcase frame.  Use hexadecimal or named colors notation.
1148
+    Remember to quote! ( '#ffac5f' ).
1149
+<DT><B>-3d-showcase</B>, <B>-3dshowcase</B></DT><DD>
1150
+    This will give an illusion of 3D to the showcase thumb: dynamic lighting on
1151
+    rounded thumbs, and a raised effect on rectangular thumbs.  Try it !
1152
+</DL>
1153
+
1154
+<A NAME="toc17"></A>
1155
+<H2>Thumbnail Style</H2>
1156
+
1157
+<DL>
1158
+<DT><B>-user-thumbs</B> IMAGE(S)</DT><DD>
1159
+    Supply your own images for menu buttons, rather than relying on todisc to
1160
+    generate them from the video.  They must be the same aspect ratio as the
1161
+    videos in the titleset (4:3 or 16:9), as todisc will resize them without
1162
+    checking and cropping.  There must be on image for each thumb that will be
1163
+    displayed on the menu (ie. one thumb for each video in a titleset).
1164
+<DT><B>-opacity</B> [0-100] (default 100)</DT><DD>
1165
+    Opacity of thumbnail videos as a percentage (no percent sign).
1166
+    Anything less than 100(%) is semi-transparent. Not recommended with dark
1167
+    backgrounds.
1168
+<DT><B>-thumb-blur</B>, <B>-blur</B> NUM</DT><DD>
1169
+    The amount of feather blur to apply to the thumb-shape.  The default is 1.0
1170
+    which will more or less keep the shape and produces transparency at the
1171
+    edges.  Choose float or integer values between 0.1 and 2.0. 3D thumbs are
1172
+    set to a tiny blur, so this option doesn't affect the <B>-3dthumbs</B> option.
1173
+<DT><B>-showcase-blur</B> NUM</DT><DD>
1174
+    The amount of 'feather' blur to apply to the showcase image/video.  Choose
1175
+    values between 0.1 and 2.0.  This option has no effect on <B>-3d-showcase</B>.
1176
+    See <B>-thumb-blur</B> for more info.
1177
+<DT><B>-align</B> DIRECTION</DT><DD>
1178
+    This will align  thumbs/titles in DIRECTION, which is a compass direction
1179
+    as used by imagemagick: ie. north|south|east|west|northeast|northwest etc.
1180
+    If <B>-align</B> south then menu title will align north, unless you manually
1181
+    set one or both of <B>-menu-title-geo</B> or <B>-menu-title-offset</B>.
1182
+    Only <B>-align</B> north|south|center has any effect on showcase with thumb,
1183
+    or with the default montage arrangement of central thumbs. The most
1184
+    apparent changes with be with textmenu, though with 2 column arrangements
1185
+    only the north* and south* changes will show an effect.
1186
+<P></P>
1187
+    Diagram:
1188
+<DT>   . northwest   north   northeast .</DT><DD>
1189
+<DT>   .                               .</DT><DD>
1190
+<DT>   . west        center       east .</DT><DD>
1191
+<DT>   .                               .</DT><DD>
1192
+<DT>   . southwest   south    souteast .</DT><DD>
1193
+<DT><B>-thumb-mist</B> [COLOR]</DT><DD>
1194
+    Use a mist behind thumbnails.  The optional argument is the color of the
1195
+    mist.  This option helps with contrast.  Be sure to set the font color
1196
+    to an appropriate color if using a colored mist, and/or use a bold font.
1197
+<DT><B>-titles-color</B>, <B>-titles-colour</B> COLOR</DT><DD>
1198
+    Color to use for the thumb or textmenu titles.  If your titles are not
1199
+    clear enough or look washed out, try using a <B>-titles-stroke</B> that
1200
+    is the same color as used with <B>-titles-color</B>  (see <B>-title-color</B>)
1201
+<DT><B>-showcase-titles-align</B> west|east (default: center [centre])</DT><DD>
1202
+    The default is to center the text above the thumbnails.  This option will
1203
+    align the titles either to the left (west) or right (east).  Aligning west
1204
+    gives more space to the titles.  Aligning east also does so, and as well
1205
+    will facilitate using \n in your titles to achieve multi line titles.
1206
+<DT><B>-tile-3x1</B>, <B>-tile3x1</B></DT><DD>
1207
+    Use a montage tile of 3x1 instead of the usual 2x2 for 3 videos
1208
+    ie.
1209
+<P></P>
1210
+    [movie1] [movie2] [movie3] instead of:
1211
+<P></P>
1212
+    [movie1] [movie2]
1213
+<P></P>
1214
+    [movie3]
1215
+<P></P>
1216
+    This option only comes into play if the number of videos supplied equals 3
1217
+    Otherwise it will be silently ignored. Not used for -showcase-* style.
1218
+<DT><B>-tile-4x1</B>, <B>-tile4x1</B></DT><DD>
1219
+    Same as <B>-tile-3x1</B> above, except use tile of 4x1. (one row of 4 videos)
1220
+<DT>**-thumb-columns 3|4</DT><DD>
1221
+    Same as <B>-tile-3x1</B> and tile-4x1** above, except it accepts either '3'
1222
+    (1 row of 3 thumbs), or '4' (one row of 4 thumbs) as an argument.  This
1223
+    alternative was added to help compact the gui layout.
1224
+<DT><B>-rotate-thumbs</B> DEGREE LIST ( list of degrees, one for each thumb )</DT><DD>
1225
+    Rotate thumbs the given amount in degrees - can be positive or negative.
1226
+    There must be one value for each file given with <B>-files</B>.
1227
+    If the values are not the same distance from zero, the thumbs will be of
1228
+    different sizes as images are necessarily resized *after* rotating.  With
1229
+    the default montage template - this will also resize the titles; with the
1230
+    showcase template the titles will remain the same size. Example:
1231
+<P></P>
1232
+<PRE>
1233
+      -rotate-thumbs -10 10 -10 10 -10  (for 5 files)
1234
+</PRE>
1235
+
1236
+     **Note: this option will not turn a portrait image into a landscape image!
1237
+</DL>
1238
+
1239
+<A NAME="toc18"></A>
1240
+<H2>Dvdauthor options</H2>
1241
+
1242
+<DL>
1243
+<DT><B>-loop</B> PAUSE</DT><DD>
1244
+    Pause in seconds at end of menu.  Use "inf" if you wish indefinite pause.
1245
+    Note: using "inf" with <B>-menu-fade</B> will disable the fadeout portion of
1246
+    the fade.  (default: "inf" for static menu, 10.0 seconds for animated.)
1247
+<DT><B>-playall</B></DT><DD>
1248
+    This option will create a button on the main menu that will allow going
1249
+    right to the 1st title and playing all videos in succession before
1250
+    returning to the main menu.  If doing titlesets you can use this within
1251
+    the <B>-vmgm</B> ... <B>-end-vmgm</B> options to allow playing ALL titlesets.
1252
+    (If you want also to have a playall button in each titleset you could use
1253
+    this option between each <B>-titleset</B> ... <B>-end-titleset</B> option or put
1254
+    it outside of the vmgm and titlset options as a global option.
1255
+<DT><B>-videos-are-chapters</B></DT><DD>
1256
+    A button will be made on the main menu for each video, which you can use as
1257
+    a chapter button.  Selecting any video will play them all in order
1258
+    starting with the selected one.
1259
+<DT><B>-chain-videos</B> NUM | N1-NN</DT><DD>
1260
+    Without options this will chain all videos together so they play
1261
+    sequentially without returning to the main menu, except for the last, which
1262
+    will return.  You can also specify which videos you want to behave this way
1263
+    by number or by a range. ( ie. <B>-chain-videos</B> 1 2 4-6 ).
1264
+<DT><B>-subtitle-lang</B> "lang1 lang2 . . ."</DT><DD>
1265
+    This allows selectable subtitles in the DVD, assuming you have optional
1266
+    subtitles muxed into your videos.  Use 2 character language codes.
1267
+<DT><B>-audio-channel</B> "Video1_track Video2_track Video3_track . . ."</DT><DD>
1268
+    "VideoN_track" is the track number to use in a multi-track (multi-language)
1269
+    mpeg: usually something like <B>-audio-channel</B> "1 0 1".  The 1st track is
1270
+    0, 2nd is 1 . . . etc.  If the tracks are 0. English 1.French, then the
1271
+    above would make French the audio language on Video1 and Video3, and
1272
+    English the audio language on Video2.  You can check the mpeg with
1273
+    "mplayer -v . . .".
1274
+<DT><B>-audio-lang</B> LANGUAGE CODES</DT><DD>
1275
+    Identify the audio tracks on the DVD.  These language codes are used for
1276
+    each video in the titleset.  When you use the audio button on your DVD
1277
+    remote the language name is displayed.  Example: <B>-audio-lang</B> en fr
1278
+<DT><B>-aspect</B> 4:3|16:9</DT><DD>
1279
+    This will output a &lt;video aspect WIDTH:HEIGHT /&gt; tag for the dvdauthor
1280
+    xml file.  It will affect all videos in the titleset.  Example:
1281
+<P></P>
1282
+<PRE>
1283
+      -aspect 16:9
1284
+</PRE>
1285
+
1286
+<DT><B>-widescreen</B> nopanscan|noletterbox [nopanscan]</DT><DD>
1287
+    This will output a &lt;video widescreen=nopanscan /&gt; tag (for example)
1288
+    for the dvdauthor xml file.  It will affect all videos in the titleset. Use
1289
+    in conjunction with <B>-aspect</B> if your dvd player is cropping your videos.
1290
+    Example:
1291
+<P></P>
1292
+<PRE>
1293
+      -aspect 16:9 -widescreen
1294
+</PRE>
1295
+
1296
+<DT><B>-quick-nav</B></DT><DD>
1297
+    This option will allow navigation of a menu with more than one titleset by
1298
+    using the left and right arrow keys of your DVD remote.  When you press
1299
+    this key the highlight will go the next or previous title.  If you are at
1300
+    the end of a titleset the right key will go to the next titleset.  If you
1301
+    are at the beginning of a titleset, the left key will go to the previous
1302
+    titleset.  If no next or previous titleset it will cycle to the end or
1303
+    beginning of the titlesets.
1304
+<DT><B>-outlinewidth</B>, <B>-outline-width</B> WIDTH</DT><DD>
1305
+    For spumux outlinewidth variable.  If there is a large gap between words in
1306
+    a text button, this option may help.
1307
+<DT><B>-video-pause</B> PAUSE (single value or list)</DT><DD>
1308
+    The pause in seconds after playing a video title.  This is useful for
1309
+    slideshows: the 'slide' will remain on the screen for this length of time.
1310
+    If you have grouped videos you should probably not pause the videos that
1311
+    have a grouped title after it, but instead see <B>-grouped-video-pause</B>.
1312
+    Note: if you provide a list of values they must be one for each video.
1313
+<DT><B>-group-video-pause</B> PAUSE (single value or list)</DT><DD>
1314
+    The pause in seconds after a grouped video plays.  If you wish to pause
1315
+    after the whole group finishes, then only use a value greater than zero
1316
+    for the last video in the group.  If providing a list of values they must
1317
+    equal the number of grouped videos.
1318
+</DL>
1319
+
1320
+<A NAME="toc19"></A>
1321
+<H2>Usage notes</H2>
1322
+
1323
+<P>
1324
+The argument given to various *-font options that set the font to use must be
1325
+one of the fonts listed by the command 'convert -list type'. Please note that
1326
+many of your installed fonts may not be available; if you want to maximize the
1327
+number of fonts available to todisc, download and run
1328
+<A HREF="http://www.cit.gu.edu.au/~anthony/anthony.html">Anthony Thyssen's</A>
1329
+<A HREF="http://www.imagemagick.org/Usage/scripts/imagick_type_gen">imagick_type_gen</A>
1330
+script and run it like this:
1331
+imagick_type_gen &gt; ~/.magick/type.xml.
1332
+If that doesn't work, try imagick_type_gen &gt; ~/.magick/type.mgk.
1333
+</P>
1334
+<P>
1335
+Or you can specify a ttf font file directly to the *-font options if you don't
1336
+want to install fonts to ImageMagick.
1337
+</P>
1338
+<P>
1339
+The *-stroke options in todisc are not a stroke in the sense that ImageMagick
1340
+uses the term, but rather a font shadow (the text is drawn twice)  To get a
1341
+truer Imagemagick -stroke try something like:
1342
+-title-font-deco "-stroke black" (or -titles-font-deco "-stroke black").  The
1343
+<B>-fontdeco</B> option is quite flexible and takes a lot of ImageMagick's
1344
+<I>convert</I> options. Please refer to the tovid
1345
+<A HREF="http://tovid.wikia.com/wiki/Making_a_DVD_with_text_menus">wiki</A> and Anthony
1346
+Thyssen's guide [<A HREF="http://www.imagemagick.org/Usage">http://www.imagemagick.org/Usage</A>] for further explanation and examples.
1347
+</P>
1348
+
1349
+<A NAME="toc20"></A>
1350
+<H1>Command:mpg</H1>
1351
+
1352
+<P>
1353
+<B>tovid mpg</B> converts arbitrary video files into (S)VCD/DVD-compliant
1354
+MPEG format, suitable for burning to CD/DVD-R for playback on a
1355
+standalone DVD player.
1356
+</P>
1357
+
1358
+<A NAME="toc21"></A>
1359
+<H2>Usage</H2>
1360
+
1361
+<P>
1362
+<B>tovid mpg</B> [<I>OPTIONS</I>] <B>-in</B> <I>INFILE</I> <B>-out</B> <I>OUTPREFIX</I>
1363
+</P>
1364
+<P>
1365
+Where <I>INFILE</I> is any multimedia video file, and <I>OUTPREFIX</I> is what
1366
+you want to call the output file, minus the file extension. <I>OPTIONS</I>
1367
+are additional customizations, described below.
1368
+</P>
1369
+<P>
1370
+By default, you will (hopefully) end up with an NTSC DVD-compliant
1371
+MPEG-2 video file; if you burn this file to a DVD-R, it should be
1372
+playable on most DVD players.
1373
+</P>
1374
+<P>
1375
+For example:
1376
+</P>
1377
+
1378
+<DL>
1379
+<DT><CODE>tovid mpg -in foo.avi -out foo_encoded</CODE></DT><DD>
1380
+    Convert 'foo.avi' to NTSC DVD format, saving to 'foo_encoded.mpg'.
1381
+<P></P>
1382
+<DT><CODE>tovid mpg -pal -vcd foo.avi -out foo_encoded</CODE></DT><DD>
1383
+    Convert 'foo.avi' to PAL VCD format, saving to 'foo_encoded.mpg'.
1384
+</DL>
1385
+
1386
+<A NAME="toc22"></A>
1387
+<H2>Basic options</H2>
1388
+
1389
+<DL>
1390
+<DT><B>-v</B>, <B>-version</B></DT><DD>
1391
+    Print tovid version number only, then exit.
1392
+<DT><B>-quiet</B></DT><DD>
1393
+    Reduce output to the console.
1394
+<DT><B>-fake</B></DT><DD>
1395
+    Do not actually encode; only print the commands (mplayer, mpeg2enc etc.)
1396
+    that would be executed. Useful in debugging; have tovid give you the
1397
+    commands, and run them manually.
1398
+<DT><B>-ffmpeg</B></DT><DD>
1399
+    Use ffmpeg for video encoding, instead of mplayer/mpeg2enc. Try this if
1400
+    you have any problems with the default encoding method. Using this option,
1401
+    encoding will be considerably faster. It can do almost everything that 
1402
+    mpeg2enc does such as -filters and -subtitles by using a pipe from mplayer
1403
+    though using these options will make encoding somewhat slower. The 
1404
+    exceptions are some special options like -kvcd* -bdvd where you will still
1405
+    need to use the default mpeg2enc option.
1406
+</DL>
1407
+
1408
+<H3>Television standards</H3>
1409
+
1410
+<DL>
1411
+<DT><B>-ntsc</B></DT><DD>
1412
+    NTSC format video (USA, Americas) (default)
1413
+<DT><B>-ntscfilm</B></DT><DD>
1414
+    NTSC-film format video
1415
+<DT><B>-pal</B></DT><DD>
1416
+    PAL format video (Europe and others)
1417
+</DL>
1418
+
1419
+<H3>Formats</H3>
1420
+
1421
+<P>
1422
+Standard formats, should be playable in most DVD players:
1423
+</P>
1424
+
1425
+<DL>
1426
+<DT><B>-dvd</B></DT><DD>
1427
+    (720x480 NTSC, 720x576 PAL) DVD-compatible output (default)
1428
+<DT><B>-half-dvd</B></DT><DD>
1429
+    (352x480 NTSC, 352x576 PAL) Half-D1-compatible output
1430
+<DT><B>-svcd</B></DT><DD>
1431
+    (480x480 NTSC, 480x576 PAL) Super VideoCD-compatible output
1432
+<DT><B>-dvd-vcd</B></DT><DD>
1433
+    (352x240 NTSC, 352x288 PAL) VCD-on-DVD output
1434
+<DT><B>-vcd</B></DT><DD>
1435
+    (352x240 NTSC, 352x288 PAL) VideoCD-compatible output
1436
+</DL>
1437
+
1438
+<P>
1439
+Non-standard formats, playable in some DVD players:
1440
+</P>
1441
+
1442
+<DL>
1443
+<DT><B>-kvcd</B></DT><DD>
1444
+    (352x240 NTSC, 352x288 PAL) KVCD-enhanced long-playing video CD
1445
+<DT><B>-kdvd</B></DT><DD>
1446
+    (720x480 NTSC, 720x576 PAL) KVCD-enhanced long-playing DVD
1447
+<DT><B>-kvcdx3</B></DT><DD>
1448
+    (528x480 NTSC, 520x576 PAL) KVCDx3 specification
1449
+<DT><B>-kvcdx3a</B></DT><DD>
1450
+    (544x480 NTSC, 544x576 PAL) KVCDx3a specification (slightly wider)
1451
+<DT><B>-bdvd</B></DT><DD>
1452
+    (720x480 NTSC, 720x576 PAL) BVCD-enhanced long-playing DVD
1453
+</DL>
1454
+
1455
+<P>
1456
+See <A HREF="http://kvcd.net/">kvcd.net</A> for details on the KVCD specification. Please
1457
+note that KVCD ("K Video Compression Dynamics") is the name of a compression
1458
+scheme that can be applied to any MPEG-1 or MPEG-2 video, and has little to
1459
+do with VCD ("Video Compact Disc"), which is the name of a standard video disc
1460
+format.
1461
+</P>
1462
+
1463
+<A NAME="toc23"></A>
1464
+<H2>Advanced options</H2>
1465
+
1466
+<H3>Aspect ratios</H3>
1467
+
1468
+<P>
1469
+tovid automatically determines aspect ratio of the input video by playing it in
1470
+mplayer. If your video plays with correct aspect in mplayer, you should not
1471
+need to override the default tovid behavior.
1472
+</P>
1473
+<P>
1474
+If mplayer does not play your video with correct aspect, you may provide an
1475
+explicit aspect ratio in one of several ways:
1476
+</P>
1477
+
1478
+<DL>
1479
+<DT><B>-full</B></DT><DD>
1480
+    Same as <B>-aspect 4:3</B>
1481
+<DT><B>-wide</B></DT><DD>
1482
+    Same as <B>-aspect 16:9</B>
1483
+<DT><B>-panavision</B></DT><DD>
1484
+    Same as <B>-aspect 235:100</B>
1485
+<DT><B>-aspect</B> <I>WIDTH</I><B>:</B><I>HEIGHT</I></DT><DD>
1486
+    Custom aspect, where <I>WIDTH</I> and <I>HEIGHT</I> are integers.
1487
+</DL>
1488
+
1489
+<P>
1490
+The above are the intended INPUT aspect ratio. tovid chooses an optimal output
1491
+aspect ratio for the selected disc format (VCD, DVD, etc.) and does the
1492
+appropriate letterboxing or anamorphic scaling. Use <B>-widetv</B> to encode
1493
+for a widescreen monitor or TV.
1494
+</P>
1495
+
1496
+<H3>Video stream options</H3>
1497
+
1498
+<DL>
1499
+<DT><B>-quality</B> <I>NUM</I> (default 6)</DT><DD>
1500
+    Desired output quality, on a scale of 1 to 10, with 10 giving the best
1501
+    quality at the expense of a larger output file. Default is 6. Output size
1502
+    can vary by approximately a factor of 4 (that is, <B>-quality 1</B> output
1503
+    can be 1/4 the size of <B>-quality 10</B> output). Your results may vary.
1504
+    WARNING: With <B>-quality 10</B>, the output bitrate may be too high for
1505
+    your hardware DVD player to handle. Stick with 9 or lower unless you
1506
+    have phenomenally good eyesight.
1507
+<P></P>
1508
+    At present, this option affects both output bitrate and quantization (but
1509
+    may, in the future, affect other quality/size-related attributes). Use
1510
+    <B>-vbitrate</B> if you want to explicitly provide a maximum bitrate.
1511
+<P></P>
1512
+<DT><B>-vbitrate</B> <I>NUM</I></DT><DD>
1513
+    Maximum bitrate to use for video (in kbits/sec). Must be within allowable
1514
+    limits for the given format. Overrides default values. Ignored for VCD,
1515
+    which must be constant bitrate.
1516
+<P></P>
1517
+<DT><B>-interlaced</B></DT><DD>
1518
+    Do interlaced encoding of the input video (top fields first). Use this
1519
+    option if your video is  interlaced, and you want to preserve as much
1520
+    picture quality as possible. This option is ignored for VCD, which
1521
+    doesn't support it.
1522
+<P></P>
1523
+    You can tell your source video is interlaced by playing it, and pausing
1524
+    during a scene with horizontal motion; if you see a "comb" effect at the
1525
+    edges of objects in the scene, you have interlaced video. Use this option
1526
+    to encode it properly.
1527
+<P></P>
1528
+    If you would prefer to have output in progressive format, use
1529
+    <B>-progressive</B>. If you have a DV camera, use <B>-interlaced_bf</B> since
1530
+    DV footage is generally bottom fields first.
1531
+<P></P>
1532
+<DT><B>-interlaced_bf</B></DT><DD>
1533
+    Do interlaced encoding of the input video (bottom fields first).
1534
+<P></P>
1535
+<DT><B>-deinterlace</B>, <B>-progressive</B></DT><DD>
1536
+    Convert interlaced source video into progressive output video. Because
1537
+    deinterlacing works by averaging fields together, some picture quality is
1538
+    invariably lost. Uses an adaptive kernel deinterlacer (kerndeint), or,
1539
+    if that's not available, the libavcodec deinterlacer (lavcdeint).
1540
+<P></P>
1541
+<DT><B>-mkvsub</B> <I>LANG</I> (EXPERIMENTAL)</DT><DD>
1542
+    Attempt to encode an integrated subtitle stream (such as may be found in
1543
+    Matroska .mkv files) in the given language code (eng, jpn, etc.) May work
1544
+    for other formats.
1545
+<P></P>
1546
+<DT><B>-autosubs</B></DT><DD>
1547
+    Automatically include subtitle files with the same name as the input video.
1548
+<P></P>
1549
+<DT><B>-subtitles</B> <I>FILE</I></DT><DD>
1550
+    Get subtitles from <I>FILE</I> and encode them into the video.  WARNING: This
1551
+    hard-codes the subtitles into the video, and you cannot turn them off while
1552
+    viewing the video. By default, no subtitles are loaded. If your video is
1553
+    already compliant with the chosen output format, it will be re-encoded to
1554
+    include the subtitles. This works with both -ffmpeg and the default,
1555
+    mpeg2enc.
1556
+<P></P>
1557
+<DT><B>-dvd-subtitles</B>, <B>-dvdsubs</B> | <I>FILE</I></DT><DD>
1558
+    Get subtitles from <I>FILE(S)</I> and add them <B>as a subtitle stream</B> into the
1559
+    video.  This allows selectable subtitles on your DVD. You can use more than
1560
+    one file for multiple languages. Be sure to use the -subtitle-lang option
1561
+    in 'tovid disc' so the name of the language will show up on the DVD instead
1562
+    of 'UNKNOWN' or similar
1563
+<P></P>
1564
+<DT><B>-dvdsubs-only</B></DT><DD>
1565
+    Use this if you have an already complient MPEG and wish to add a subtitle
1566
+    stream without re-encoding, using <B>-dvdsubs</B> ,
1567
+<P></P>
1568
+<DT><B>-dvdsubs-fontsize</B> <I>NUM</I> [18]</DT><DD>
1569
+    The pointsize in pixels for DVD selectable subtitles. To affect this for
1570
+    hard-coded subtitles ( <B>-subtitles</B> ) you will need to pass options to
1571
+    the player via <B>-mplayeropts</B> or <B>-mpvopts</B>.
1572
+<P></P>
1573
+<DT><B>-type</B> {live|animation|bw}</DT><DD>
1574
+    Optimize video encoding for different kinds of video. Use 'live' (default)
1575
+    for live-action video, use 'animation' for cartoons or anime, and 'bw' for
1576
+    black-and-white video.  This option currently only has an effect with
1577
+    KVCD/KSVCD output formats; other formats may support this in the future.
1578
+<P></P>
1579
+<DT><B>-safe</B> <I>PERCENT</I></DT><DD>
1580
+    Fit the video within a safe area defined by <I>PERCENT</I>. For example,
1581
+    <B>-safe 90%</B> will scale the video to 90% of the width/height of the output
1582
+    resolution, and pad the edges with a black border. Use this if some of the
1583
+    picture is cut off when played on your TV.  The percent sign is optional.
1584
+<P></P>
1585
+<DT><B>-filters</B> {none,denoise,deblock,contrast,all} (default none)</DT><DD>
1586
+    Apply post-processing filters to enhance the video. If your input video is
1587
+    very high quality, use 'none'. If your input video is grainy, use 'denoise';
1588
+    if it looks washed out or faded, use 'contrast'. You can use multiple
1589
+    filters separated by commas. To apply all filters, use 'all'. This works
1590
+    with both mpeg2enc and -ffmpeg.
1591
+<P></P>
1592
+<DT><B>-fps</B> <I>RATIO</I></DT><DD>
1593
+    Force input video to be interpreted as <I>RATIO</I> frames per second.  May be
1594
+    necessary for some ASF, MOV, or other videos. <I>RATIO</I> should be an
1595
+    integer ratio such as "24000:1001" (23.976fps), "30000:1001" (29.97fps), or
1596
+    "25:1" (25fps). This option is temporary, and may disappear in future
1597
+    releases. (Hint: To convert a decimal like 23.976 to an integer ratio, just
1598
+    multiply by 1000, i.e. 23976:1000)
1599
+<P></P>
1600
+<DT><B>-crop</B> <I>WIDTH</I>:<I>HEIGHT</I>:<I>X</I>:<I>Y</I></DT><DD>
1601
+    Crop a portion of the video <I>WIDTH</I> by <I>HEIGHT</I> in size, with the
1602
+    top-left corner at <I>X</I>, <I>Y</I>.
1603
+<P></P>
1604
+<DT><B>-widetv</B></DT><DD>
1605
+    Always encode to 16:9 widescreen (only supported by <B>-dvd</B>, <B>-kdvd</B>,
1606
+    <B>-bdvd</B>), for optimal viewing on a widescreen monitor or TV.
1607
+</DL>
1608
+
1609
+<H3>Audio stream options</H3>
1610
+
1611
+<DL>
1612
+<DT><B>-normalize</B></DT><DD>
1613
+    Analyze the audio stream and then normalize the volume of the audio.
1614
+    This is useful if the audio is too quiet or too loud, or you want to
1615
+    make volume consistent for a bunch of videos. Similar to running
1616
+    normalize without any parameters. The default is -12dB average level
1617
+    with 0dB gain.
1618
+<P></P>
1619
+<DT><B>-amplitude</B> <I>NUM</I>[dB]</DT><DD>
1620
+    In addition to analyzing and normalizing, apply the gain to the audio
1621
+    such that the 'average' (RMS) sound level is <I>NUM</I>. Valid values
1622
+    range 0.0 - 1.0, with 0.0 being silent and 1.0 being full scale. Use
1623
+    <I>NUM</I>dB for a decibel gain below full scale (the default without
1624
+    -amplitude is -12dB).
1625
+<P></P>
1626
+<DT><B>-abitrate</B> <I>NUM</I></DT><DD>
1627
+    Encode audio at <I>NUM</I> kilobits per second.  Reasonable values include
1628
+    128, 224, and 384. The default is 224 kbits/sec, good enough for most
1629
+    encodings. The value must be within the allowable range for the chosen disc
1630
+    format; Ignored for VCD, which must be 224.
1631
+<P></P>
1632
+<DT><B>-audiotrack</B> <I>NUM</I></DT><DD>
1633
+    Encode the given audio track, if the input video has multiple audio tracks.
1634
+    <I>NUM</I> is <I>1</I> for the first track, <I>2</I> for the second, etc. You may
1635
+    also provide a list of tracks, separated by spaces or commas, for example
1636
+    <B>-audiotrack 3,1,2</B>. Use <B>tovid id</B> on your source video to determine
1637
+    which audio tracks it contains.
1638
+<P></P>
1639
+<DT><B>-downmix</B></DT><DD>
1640
+    Encode all audio tracks as stereo.  This can save space on your DVD if
1641
+    your player only does stereo.  The default behavior of tovid is to use
1642
+    the original number of channels in each track.  For aac audio, downmixing
1643
+    is not possible: tovid runs a quick 1 frame test to try to downmix the
1644
+    input track with the largest number of channels, and if it fails then it
1645
+    will revert to the default behavior of using the original channels.
1646
+</DL>
1647
+
1648
+<H3>Other options</H3>
1649
+
1650
+<DL>
1651
+<DT><B>-config</B> <I>FILE</I></DT><DD>
1652
+    Read configuration from <I>FILE</I>, containing 'tovid' alone on the first
1653
+    line, and free-formatted (whitespace-separated) tovid command-line options
1654
+    on remaining lines.
1655
+<P></P>
1656
+<DT><B>-force</B></DT><DD>
1657
+    Force encoding of already-compliant video or audio streams.
1658
+<P></P>
1659
+<DT><B>-overwrite</B></DT><DD>
1660
+    Overwrite any existing output files (with the same name as the given
1661
+    <B>-out</B> option).
1662
+<P></P>
1663
+<DT><B>-priority</B> {low|medium|high}</DT><DD>
1664
+    Sets the main encoding process to the given priority. With high priority,
1665
+    it may take other programs longer to load and respond. With lower priority,
1666
+    other programs will be more responsive, but encoding may take 30-40%
1667
+    longer.  The default is high priority.
1668
+<P></P>
1669
+<DT><B>-discsize</B> <I>NUM</I></DT><DD>
1670
+    When encoding, tovid automatically splits the output file into several
1671
+    pieces if it exceeds the size of the target media. This option sets the
1672
+    desired target DVD/CD-R size to <I>NUM</I> mebibytes (MiB, 2^20). By default,
1673
+    splitting occurs at 700 for CD, 4300 for DVD. Use higher values at your
1674
+    own risk. Use 650 or lower if you plan to burn to smaller-capacity CDs.
1675
+    Doesn't work with the <B>-ffmpeg</B> option.
1676
+<P></P>
1677
+<DT><B>-fit</B> <I>NUM</I></DT><DD>
1678
+    Fit the output file into <I>NUM</I> MiB. Rather than using default (or
1679
+    specified) video bitrates, tovid will calculate the correct video bitrate
1680
+    that will limit the final output size to <I>NUM</I> MiB. This is different
1681
+    than <B>-discsize</B>, which cuts the final file into <I>NUM</I> MiB pieces.
1682
+    <B>-fit</B> makes sure that the file never exceeds <I>NUM</I> MiB. This works
1683
+    with <B>-ffmpeg</B>, but not with <B>-vcd</B> since VCDs have a standardized
1684
+    constant bitrate.
1685
+<P></P>
1686
+<DT><B>-parallel</B></DT><DD>
1687
+    Perform ripping, encoding, and multiplexing processes in parallel using
1688
+    named pipes. Maximizes CPU utilization and minimizes disk usage. Note that
1689
+    this option simply does more tasks simultaneously, in order to make better
1690
+    use of available CPU cycles; it's unrelated to multi-CPU processing (which
1691
+    is done automatically anyway). Has no effect when <B>-ffmpeg</B> is used.
1692
+<P></P>
1693
+<DT><B>-update</B> <I>SECS</I></DT><DD>
1694
+    Print status updates at intervals of <I>SECS</I> seconds. This affects how
1695
+    regularly the progress-meter is updated. The default is once every five
1696
+    seconds.
1697
+<P></P>
1698
+<DT><B>-mpv</B></DT><DD>
1699
+    Use mpv instead of mplayer. This option is experimental.
1700
+<P></P>
1701
+<DT><B>-mplayeropts</B> <I>OPTIONS</I></DT><DD>
1702
+    Append <I>OPTIONS</I> to the mplayer command run during video encoding.  Use
1703
+    this if you want to add specific video filters (documented in the mplayer
1704
+    manual page). Overriding some options will cause encoding to fail, so use
1705
+    this with caution!
1706
+<P></P>
1707
+<DT><B>-mpvopts</B> <I>OPTIONS</I></DT><DD>
1708
+    Append <I>OPTIONS</I> to the mpv command run during video encoding.  Use
1709
+    this if you want to add specific video filters (documented in the mplayer
1710
+    or mpv manual page). Overriding some options will cause encoding to fail,
1711
+    so use this with caution!
1712
+<P></P>
1713
+<DT><B>-nofifo</B> (EXPERIMENTAL)</DT><DD>
1714
+    Do not use a FIFO pipe for video encoding. If you are getting "Broken pipe"
1715
+    errors with normal encoding, try this option.  WARNING: This uses lots of
1716
+    disk space (about 2 GB per minute of video).
1717
+<P></P>
1718
+<DT><B>-keepfiles</B></DT><DD>
1719
+    Keep the intermediate files after encoding. Usually, this means the audio
1720
+    and video streams are kept (eg the .ac3 and .m2v files for an NTSC DVD).
1721
+    This doesn't work with -parallel because the intermediate files are named
1722
+    pipes, and not real files.
1723
+<P></P>
1724
+<DT><B>-slice</B> <I>START</I>-<I>END</I></DT><DD>
1725
+    Encode a segment from <I>START</I> to <I>END</I> (in seconds). Only works with
1726
+    -ffmpeg.
1727
+<P></P>
1728
+<DT><B>-from-gui</B></DT><DD>
1729
+    Put makempg into a fully non-interactive state, suitable for calling from
1730
+    a gui.
1731
+<P></P>
1732
+<DT><B>-noask</B></DT><DD>
1733
+    Don't ask questions when choices need to be made. Assume reasonable
1734
+    answers.
1735
+</DL>
1736
+
1737
+<A NAME="toc24"></A>
1738
+<H1>Command:id</H1>
1739
+
1740
+<P>
1741
+<B>tovid id</B> identifies each multimedia video file in a
1742
+list, and reports its compliance with video disc standards such as VCD,
1743
+SVCD, and DVD.
1744
+</P>
1745
+
1746
+<A NAME="toc25"></A>
1747
+<H2>Usage</H2>
1748
+
1749
+<P>
1750
+<B>tovid id</B> [<I>OPTIONS</I>] <I>VIDEO_FILE(s)</I>
1751
+</P>
1752
+<P>
1753
+For example:
1754
+</P>
1755
+
1756
+<DL>
1757
+<DT><CODE>tovid id foo.avi</CODE></DT><DD>
1758
+<DT><CODE>tovid id -tabluar videos/*.mpg</CODE></DT><DD>
1759
+</DL>
1760
+
1761
+<A NAME="toc26"></A>
1762
+<H2>Options</H2>
1763
+
1764
+<DL>
1765
+<DT><B>-terse</B></DT><DD>
1766
+    Print raw video characteristics, no formatting. Helpful when
1767
+    calling from other scripts.
1768
+<P></P>
1769
+<DT><B>-verbose</B></DT><DD>
1770
+    Print extra information from mplayer, tcprobe, and ffmpeg.
1771
+<P></P>
1772
+<DT><B>-accurate</B></DT><DD>
1773
+    Do lengthy play-time estimation by scanning through the entire video file.
1774
+    Use this if the default behavior is giving you inaccurate play times.
1775
+<P></P>
1776
+<DT><B>-fast</B></DT><DD>
1777
+    Skip lengthy play-time estimation, and go with what mplayer reports
1778
+    as being the video duration. Unlike pre-0.32 versions of tovid, this
1779
+    is now the default behavior, and the <B>-fast</B> option doesn't do anything.
1780
+<P></P>
1781
+<DT><B>-tabular</B></DT><DD>
1782
+    Display output in a table format for easier comparison. Most useful
1783
+    when identifying multiple video files.
1784
+<P></P>
1785
+<DT><B>-keepfiles</B></DT><DD>
1786
+    Keep temporary directory for debugging.
1787
+<P></P>
1788
+<DT><B>-isformat</B> [<I>pal-dvd</I>|<I>ntsc-dvd</I>] (same syntax for vcd and svcd)</DT><DD>
1789
+    Check <I>VIDEO_FILE</I> for compliance with the given disc format.
1790
+    If <I>VIDEO_FILE</I> matches the given format, then <B>tovid id</B> reports "true"
1791
+    and exits successfully. Otherwise, <B>tovid id</B> reports "false" and exits
1792
+    with status 1 (failure).  This checks and reports both vcd/svcd/dvd
1793
+    and pal/ntsc.
1794
+<P></P>
1795
+<DT><B>-mpv</B></DT><DD>
1796
+    This option is mainly for testing. If you have only mpv installed instead
1797
+    of mplayer, it is used automatically. With this option, you can have BOTH
1798
+    installed and choose which one to use. (default: mplayer)
1799
+</DL>
1800
+
1801
+<A NAME="toc27"></A>
1802
+<H2>Examples</H2>
1803
+
1804
+<DL>
1805
+<DT><CODE>tovid id -verbose homevideo.avi</CODE></DT><DD>
1806
+    Report everything mplayer, ffmpeg, and transcode can determine about
1807
+    homevideo.avi.
1808
+<P></P>
1809
+<DT><CODE>tovid id -isformat dvd homevideo.mpg</CODE></DT><DD>
1810
+    Check to see if homevideo.mpg is compliant with the DVD standard.
1811
+</DL>
1812
+
1813
+<A NAME="toc28"></A>
1814
+<H1>Command:dvd</H1>
1815
+
1816
+<P>
1817
+<B>tovid dvd</B> takes a DVD directory as generated by tovid with 'tovid disc' or
1818
+one of the GUI frontends like 'tovid gui' or 'tovid titlesets' and burns
1819
+it to appropriate media.  This will also work if the DVD directory is
1820
+generated by the dvdauthor backend that tovid also uses.
1821
+</P>
1822
+<P>
1823
+Running this program may slow down your other applications, due to intense
1824
+disk activity.
1825
+</P>
1826
+
1827
+<A NAME="toc29"></A>
1828
+<H2>Usage</H2>
1829
+
1830
+<P>
1831
+<B>tovid dvd</B> [<I>OPTIONS</I>] <I>DVD_DIR</I>
1832
+</P>
1833
+<P>
1834
+For example:
1835
+</P>
1836
+
1837
+<DL>
1838
+<DT><CODE>tovid dvd /path/to/DVD/directory</CODE></DT><DD>
1839
+</DL>
1840
+
1841
+<A NAME="toc30"></A>
1842
+<H2>Options</H2>
1843
+
1844
+<DL>
1845
+<DT><B>-burn</B></DT><DD>
1846
+    Burn a DVD file-system in <I>DVD_DIR</I> (must contain a VIDEO_TS folder).
1847
+    This option is currently not necessary as the makedvd script ONLY burns
1848
+    now that legacy scripts like makexml have been removed.  Left for
1849
+    compatibility only.
1850
+<P></P>
1851
+<DT><B>-eject</B></DT><DD>
1852
+    Eject the DVD tray after burning is complete. By default, the DVD is not
1853
+    ejected.
1854
+<P></P>
1855
+<DT><B>-device</B> <I>DEVICE</I> (default /dev/dvdrw)</DT><DD>
1856
+    Burn the disc image to <I>DEVICE</I>, the Linux device file-system
1857
+    name of your DVD-recorder. Common examples might be /dev/dvdrw,
1858
+    /dev/scd1, and /dev/hdc. You can also use a bus/id/lun triple
1859
+    such as ATAPI:0,1,0
1860
+<P></P>
1861
+<DT><B>-speed</B> <I>NUM</I> (default 1)</DT><DD>
1862
+    Burn disc at speed <I>NUM</I>.
1863
+<P></P>
1864
+<DT><B>-label</B> <I>DISC_LABEL</I></DT><DD>
1865
+    Uses <I>DISC_LABEL</I> as the volume ID. This appears as the mount
1866
+    name of the disc on some computer platforms. Must be &lt;=32
1867
+    alphanumeric digits without spaces.
1868
+<P></P>
1869
+<DT><B>-quiet</B></DT><DD>
1870
+    Limit output to essential messages.
1871
+<P></P>
1872
+<DT><B>-noask</B></DT><DD>
1873
+    Don't ask interactive questions and assume answers that will continue
1874
+    execution.
1875
+</DL>
1876
+
1877
+<P>
1878
+    After burning, the DVD can be previewed by calling:
1879
+    <I><B>xine</B> dvd:/path/to/output/directory</I>
1880
+    or:
1881
+    <I><B>vlc</B> /path/to/output/directory</I>
1882
+</P>
1883
+
1884
+<A NAME="toc31"></A>
1885
+<H1>Command:chapters</H1>
1886
+
1887
+<P>
1888
+<B>tovid chapters</B> will start a GUI using mplayer to set chapter points in a
1889
+video.  If the video plays through and you want to add more chapters you can
1890
+press the play button again, but remember that new chapter points will be
1891
+appended (in correct sequential order).  It will display the resulting chapter
1892
+points, and also output to a terminal (useful for scripts).  As well it will
1893
+give the option of saving the chapters string to a text file.
1894
+</P>
1895
+<P>
1896
+Note that the 'tovid gui' now features a similar widget when you press the
1897
+chapters button on the opening page.
1898
+</P>
1899
+
1900
+<A NAME="toc32"></A>
1901
+<H2>Examples</H2>
1902
+
1903
+<DL>
1904
+<DT><CODE>tovid chapters foo.avi</CODE></DT><DD>
1905
+<P></P>
1906
+<DT><CODE>chapters=$(tovid chapters /home/grepper/videos/foo.avi)</CODE></DT><DD>
1907
+</DL>
1908
+
1909
+<A NAME="toc33"></A>
1910
+<H1>CONTACT</H1>
1911
+
1912
+<P>
1913
+For further assistance, contact information, forum and IRC links,
1914
+please refer to the <A HREF="http://tovid.wikia.com/">tovid homepage</A>.
1915
+</P>
1916
+
1917
+<!-- html code generated by txt2tags 2.6 (http://txt2tags.org) -->
1918
+<!-- cmdline: txt2tags -t html -\-toc -\-toc-level 2 docs/src/en/tovid.t2t -->
1919
+</BODY></HTML>
1920
tovid-0.35.0.tar.gz/docs/src/en/tovid.wiki Added
1665
 
1
@@ -0,0 +1,1663 @@
2
+'''tovid manual'''
3
+
4
+
5
+
6
+
7
+----
8
+
9
+__TOC__
10
+
11
+----
12
+
13
+
14
+== Name ==
15
+
16
+tovid: Make DVDs from video files
17
+
18
+== Description ==
19
+
20
+'''tovid''' is a command-line tool for creating DVDs. It can encode your video
21
+files to DVD-compliant MPEG format, generate simple or complex DVD menus,
22
+author and burn a ready-to-watch DVD, with just a few shell commands. A
23
+graphical interface is also provided to make the process even easier.
24
+
25
+'''NOTE''': As of tovid 0.35, the legacy scripts '''makemenu''' and '''makexml'''
26
+have been removed and no longer appear in this manpage.
27
+All of their functions and more can be done with the 'tovid disc' command,
28
+(todisc script). See '''Command:disc''' and the [http://tovid.wikia.com wiki]
29
+for more info.
30
+
31
+Also note that as of tovid 0.32, this is the only manual page provided by tovid.
32
+There is now a single executable frontend to all functionality in the suite, so
33
+if you were expecting to find manpages for '''todisc''', '''idvid''', '''makempg'''
34
+and their kin, they can all be found in the '''tovid''' manpage you are reading now.
35
+And yes, this makes for a pretty large manual page. If you are viewing this
36
+manpage from the command-line '''man''' utility, which normally pages through the
37
+'''less''' utility, you can skip to a section by searching with the '''/''' key,
38
+followed by a '''^''' to match the given section name. For example, to skip to
39
+the '''mpg''' command, type '''/^Command:mpg'''. See '''man less''' for more on how
40
+to navigate.
41
+
42
+== Usage ==
43
+
44
+'''tovid''' ''COMMAND'' [''OPTIONS'']
45
+
46
+Where ''COMMAND'' is one of the following:
47
+
48
+    Main Commands
49
+
50
+; '''disc'''
51
+: Encode, make menus, author, burn. (was '''todisc'''. See '''Command:disc''')
52
+; '''gui'''
53
+: Start the tovid GUI (was '''todiscgui'''. See '''Command:gui''')
54
+; '''titlesets'''
55
+: A GUI wizard for multiple titlesets. (new: See '''Command:titlesets''')
56
+
57
+    Helper Commands
58
+
59
+; '''mpg'''
60
+: Encode videos to MPEG format (was '''tovid'''. See '''Command:mpg''')
61
+; '''dvd'''
62
+: Author and/or burn a DVD (was '''makedvd'''. See '''Command:dvd''')
63
+; '''id'''
64
+: Identify one or more video files (was '''idvid'''. See '''Command:id''')
65
+; '''chapters'''
66
+: A GUI using mplayer for setting chapter points.  It will return a string of
67
+: chapter points to the terminal, in a format recognized by 'tovid disc'
68
+: (todisc) or by 'tovid gui', for the  '''-chapters''' option.
69
+
70
+The ''OPTIONS'' differ for each command; run '''tovid <command>''' with no
71
+further arguments to get help on a command, and what options it expects.
72
+
73
+== Configuration ==
74
+
75
+Two configuration files are created the first time you run tovid:
76
+
77
+; '''~/.tovid/preferences'''
78
+: Defines working directory for all scripts.
79
+: You can define the output directory for makempg here.
80
+: The 'ffmpeg' executable can be set here: ffmpeg or avconv (TOVID_FFMPEG)
81
+; '''~/.tovid/tovid.ini'''
82
+: Includes command-line options that should be passed to the various
83
+: '''tovid''' sub-commands.  Note: each sub-command has its own section,
84
+: starting with the line [sub-command], for example:
85
+<pre>
86
+    [disc]
87
+    ; -no-warn
88
+    -static
89
+    -no-ask
90
+</pre>
91
+
92
+
93
+Edit these files if you wish to change your configuration.
94
+
95
+The following environment variables are also honoured:
96
+
97
+<pre>
98
+    TOVID_HOME (directory containing preferences: ~/.tovid)
99
+    TOVID_WORKING_DIR (working directory for all scripts).
100
+    TOVID_OUTPUT_DIR (output directory for the makempg script).
101
+    TOVID_FFMPEG_CMD (the 'ffmpeg' executable to use: ffmpeg or avconv)
102
+</pre>
103
+
104
+These will override 'TOVID_HOME', 'WORKING_DIR', 'OUTPUT_DIR',
105
+and 'TOVID_FFMPEG' if set in ~/.tovid/preferences.
106
+
107
+== Command:gui ==
108
+
109
+== Usage ==
110
+
111
+'''tovid gui''' [''OPTIONS'']
112
+
113
+'''tovid gui''' starts the graphical user interface (GUI) for tovid. This is
114
+the easiest way to start creating DVDs with tovid. The optional arguments
115
+''OPTIONS'' are any option used by todisc ('tovid disc') which will save
116
+entering it manually, OR the full path to a saved script from the GUI.
117
+You can also combine these, but the script must be the FIRST option
118
+directly after '''tovid gui''' .  (This option to save the contents of your
119
+project allows you to use it as a bash script later, or to reload the
120
+project to continue working with it at another time.)
121
+
122
+'''tovid gui''' will also take the option '''--position''', which denotes the
123
+screen position that the GUI will start at, in the form '+X+Y', similar to
124
+this part of the Xorg -geometry string.
125
+
126
+All help is integrated in the form of tooltips.  You can also see
127
+**Command:disc ** for more detail about the options.  Note: if you wish to use
128
+a GUI to make multiple titlesets on the same DVD use '''*tovid titlesets*''',
129
+which is a wizard that uses the the 'tovid gui. See '''*Command:titlesets*'''.
130
+
131
+Please note that although the interface may seem complex with so many options,
132
+you can create a fully functional DVD with only a few options on the opening
133
+tab of the GUI (select video files and an output name).
134
+
135
+== Command:titlesets ==
136
+
137
+'''tovid titlesets''' will assist in making a DVD with multiple titlesets.  It can
138
+be started without any options, or you can feed it the path to a saved titleset
139
+script as an option.  The option to save a script is also useful as the resulting
140
+script can be run later from a terminal.
141
+
142
+== Command:disc ==
143
+
144
+'''tovid disc''' creates a DVD file-system with optional menus, from a list of
145
+multimedia video files and their titles.  As todisc can function as a master
146
+script, calling other scripts as it needs them, it is the easiest command line
147
+program for creating a DVD from start to finish, including automatically
148
+converting non-compliant videos and prompting to burn at completion.  It can do
149
+animated menus, static thumbnail menus, text-only menus, or author with no menu.
150
+In addition, it can do slideshows, using images as input, and even combine
151
+slideshows with videos.  It supports sub-menus for chapter breaks,
152
+configurable menu style, animated backgrounds and transparency effects.
153
+From simple (no menu) to complex (switched menus and titlesets), you should
154
+be able to do what you want with 'tovid disc'.
155
+
156
+=== Usage ===
157
+
158
+<pre>
159
+ tovid disc [OPTIONS] \
160
+    -files <file list> -titles <title list>
161
+    -out mydvd
162
+</pre>
163
+
164
+For example:
165
+
166
+<pre>
167
+ $ tovid disc -files File1.mpg File2.mpg File3.mpg \
168
+      -titles "Episode 1" "Episode 2" "Episode 3" \
169
+      -out Season_one
170
+</pre>
171
+
172
+The number of '''-files''' and '''-titles''' must be equal, though if you do not
173
+include any titles '''tovid disc''' will use the basename of the included files
174
+as titles.  If you are doing a slideshow or multiple slideshows, use
175
+'''-slides''' rather than '''-files''' for passing in the images.  You may use
176
+-files and -slides more than once to create an ordering in a mixed
177
+slideshows/videos menu.  See Slideshows part of Usage section, below.
178
+
179
+If the input files are not mpeg, you will have the option to auto-encode them.
180
+
181
+General Options
182
+
183
+'''At present there are 2 display arrangements or "templates":'''
184
+
185
+; A. (Default)
186
+: Thumbs will be centred, and as large as space restraints allow.
187
+: 
188
+; B. '''-showcase''' IMAGE|VIDEO
189
+: Produces an arrangement with small buttons on
190
+: the side and the showcase image/video in the centre.  If no IMAGE or VIDEO
191
+: argument is supplied, the central thumb will be omitted.
192
+: 
193
+: Note: '''-textmenu''', '''-quick-menu''' and '''-switched-menus''' are all types
194
+: of showcase style menus.  See descriptions under '''Menu style''' section.
195
+
196
+The '''-titles''' arguments should be double or single quoted, or have the spaces
197
+backslash-escaped. Special characters (like ", !, *, &, ?) may need to be
198
+backslash-escaped.  To include a quoted string within a title, backslash-escape
199
+the quotes.  These titles are used for labelling thumbnails on the main menu,
200
+and for the submenu title for that video.  ( see also '''-submenu-titles''' )
201
+
202
+The '''-showcase''' styles can use longer titles than the default arrangement.
203
+With a showcase style, use: '''-showcase-titles-align west''' to give more space
204
+for the title, or use '''-showcase-titles-align east''' to allow titles of more
205
+than one line.
206
+
207
+The default style can only show about 16 characters (depending on the number
208
+of thumbs, and what '''-titles-font''' and '''-titles-fontsize''' is being used).
209
+If your titles are too long to fit in the label area, you may try using
210
+sub-menus, which can display longer titles, for example:
211
+
212
+<pre>
213
+ $ tovid disc -submenus \
214
+      -files file1.mpg file2.mpg ... \
215
+      -titles "Short 1" "Short 2" \
216
+      -submenus \
217
+      -submenu-titles "Long Title One" "Long Title Two" \
218
+      -out foo
219
+
220
+</pre>
221
+
222
+The '''-align''' argument will position both titles and thumbs either south,
223
+north east, west, southwest, northwest, southeast, northeast, subject to
224
+certain constraints of each arrangement. For example a showcase style with
225
+a showcase thumb can only do north|south|center.
226
+
227
+More Examples:
228
+
229
+A text-only menu:
230
+
231
+<pre>
232
+ $ tovid disc -textmenu ...
233
+</pre>
234
+
235
+No menu:
236
+
237
+<pre>
238
+ $ tovid -nomenu -files file1.mpg file2.mp4 "file 3.avi" -out mydvd
239
+</pre>
240
+
241
+'''Titlesets'''
242
+
243
+A word should be mentioned here about titlesets, which is really just a
244
+hierarchy of menus.  You need to use titlesets, for example, if you have videos
245
+of different resolutions, or otherwise want to arrange videos on separate menus.
246
+If you want to have titlesets you need to put all the options for each titleset
247
+menu you would like to have between '''-titleset''' and '''-end-titleset''' options.
248
+
249
+Additionally, for the main menu (the opening menu that will let you jump to
250
+each titleset), you need to put options between '''-vmgm''' and '''-end-vmgm'''.
251
+You do not use '''-files''' for the opening menu options ('''-vmgm'''), but you
252
+will need as many TITLES after '''-titles''' as you have menus.
253
+
254
+Any options outside the '''-titleset''' '''-end-titleset''' and '''-vmgm'''
255
+'''-end-vmgm''' areas will be global options applying to every titleset.
256
+If a global option is duplicated inside a '''-titleset''' or '''-vmgm''' area, the
257
+global option will be overridden.
258
+
259
+Note: you do not need titlesets for a single menu with chapter break menus, for
260
+that just use '''-submenus''' or '''-ani-submenus'''
261
+
262
+Example of using '''tovid disc''' with titlesets:
263
+
264
+<pre>
265
+ $ tovid disc -static -out MY_DVD \
266
+   \
267
+   -titleset \
268
+   -files 1.mpg 2.mpg 3.mpg \
269
+   -titles "Title One" "Title Two" "Title Three" \
270
+   -end-titleset \
271
+   \
272
+   -titleset \
273
+   -files 4.mpg 5.mpg \
274
+   -titles "Title Four" "Title Five" \
275
+   -background foo.jpg \
276
+   -showcase bar.png \
277
+   -end-titleset \
278
+   \
279
+   -vmgm \
280
+   -titles "Season One" "Season Two" \
281
+   -background bg.jpg \
282
+   -bgaudio foo.mp3 \
283
+   -titles-fontsize 20 \
284
+   -end-vmgm
285
+</pre>
286
+
287
+See also '''-titleset''' and '''-vmgm'''
288
+
289
+'''Slideshows'''
290
+
291
+You can also use '''tovid disc''' to make slideshows.  This can either be a single
292
+slideshow, or multiple slideshows on the same menu.
293
+Remember to use '''-slides''' rather than '''-files''' for passing in the
294
+images.  Images can be any filetype that imagemagick supports: for example
295
+JPEG, PNG, GIF, TGA BMP etc.  For a single slideshow do not use '''-titles''':
296
+use -menu-title to set the slideshow title.
297
+
298
+For a single slideshow the default is an animated menu that transitions from
299
+slide to slide.  The default transition type is 'crossfade', which fades each
300
+slide into the next and loops back to the first slide at the end.  If instead
301
+you use '''-static''', then a static 'polaroid stack' menu of all the slides is
302
+created, with a single spumux'ed button for navigating with the enter key.  You
303
+may have to experiment to find out which DVD remote button advances the slides.
304
+Try the 'next chapter'(skip ?) button and the play or enter buttons.
305
+If you want to limit the number of slides in the menu to a subset of all files
306
+entered with '''-slides''', then use '''-menu-slide-total''' INT.  Be sure to use
307
+a long enough audio file for '''-bgaudio''' or set '''-menu-length''' so the menu
308
+is long enough to support the slides plus transitions.
309
+
310
+You can also put multiple slideshows on one menu.  To do this, use
311
+'''-slides IMAGES''' for each slideshow desired.  You can even mix videos
312
+with slideshows by using '''-files''' '''-slides''' '''-titles''' multiple times.
313
+
314
+Example of a single slideshow with an animated menu with transitions:
315
+
316
+<pre>
317
+ $ tovid disc -menu-title "Autumn in Toronto" -slides images/*.jpg \
318
+    -menu-slide-total 20 -slide-transition crossfade -bgaudio slideshow.wav \
319
+    -out myslideshow
320
+</pre>
321
+
322
+Example of multiple slideshows on one menu:
323
+
324
+<pre>
325
+ $ tovid disc -menu-title "Autumn in Toronto" \
326
+   -slides photos/september/*.jpg \
327
+   -slides photos/october/*.jpg \
328
+   -slides photos/november/*.jpg \
329
+   -tile3x1 -rotate -5 5 -5 -align center \
330
+   -bgaudio background.wav \
331
+   -out myslideshow
332
+</pre>
333
+
334
+Example of mixed videos and slideshows:
335
+
336
+<pre>
337
+ $ tovid disc -menu-title "Autumn in Toronto" \
338
+   -files fall_fair.mov \
339
+   -slides  photos/september/*.jpg \
340
+   -files harvest.mpg \
341
+   -slides photos/october/*.jpg \
342
+   -titles "Fall Fair" "September" "Harvest" "October" \
343
+   -background autumn.png \
344
+   -bgaudio bg.mp3 \
345
+   -out myslideshow
346
+</pre>
347
+
348
+See the other slideshow options in the Slideshows options section.
349
+
350
+'''Encoding Options'''
351
+
352
+These are options for reencoding your non-compliant videos.  They are passed
353
+directly to the '''tovid mpg''' command which is invoked by '''tovid disc''' when
354
+non-compliant files are found.  For details, see the '''Command:mpg''' section.
355
+Here is a list of possible options you can pass:
356
+    '''-config''', '''-ntscfilm''', '''-dvd-vcd''', '''-half-dvd''', '''-kvcd''',
357
+    '''-kvcdx3''', '''-kvcdx3a''', '''-kdvd''', '''-bdvd''', '''-704''', '''-normalize''',
358
+    '''-amplitude''', '''-overwrite''', '''-panavision''', '''-force''', '''-fps''',
359
+    '''-vbitrate''', '''-quality''', '''-safe''', '''-crop''', '''-filters''',
360
+    '''-abitrate''', '''-priority''', '''-deinterlace''', '''-progressive''',
361
+    '''-interlaced''', '''-interlaced_bf''', '''-type''', '''-fit''', '''-discsize''',
362
+    '''-parallel''', '''-mkvsub''', '''-autosubs''', '''-subtitles''', '''-update''',
363
+    '''-mplayeropts''', '''-audiotrack''', '''-downmix''', '''-ffmpeg''', '''-nofifo''',
364
+    '''-from-gui''', '''-slice''', '''-quiet''',
365
+    '''-fake''', '''-keepfiles'''
366
+
367
+=== General Options ===
368
+
369
+; '''-keep-files''', '''-keepfiles'''
370
+: Keep all intermediate/temporary files (helps with debugging)
371
+; '''-no-ask''' | '''-noask'''
372
+: Skip all interactive questions.  No preview, automatic re-encoding with
373
+: tovid if needed, no interactive option to use background video for bgaudio.
374
+; '''-no-warn''', '''-nowarn'''
375
+: Don't pause after outputting warning or info messages
376
+; '''-jobs'''
377
+: By default, '''tovid disc''' starts a parallel job for each processor
378
+: detected.  With this option you can manually set the number of jobs.  For
379
+: example if you have a computer with 2 CPUs you can set "-jobs 1" to keep
380
+: one processor free for other things.  At present this applies to the time
381
+: consuming imagemagick loops: you will notice a substantial speedup now if
382
+: you have a multi-cpu system.
383
+; '''-grid'''
384
+: Show a second preview image with a grid and numbers that will help in finding
385
+: coordinates for options that might use them, like '''-text-start'''
386
+; '''-no-confirm-backup'''
387
+: This option is for when your DVD contains images for a slideshow.
388
+: Slideshows are an experimental (but well tested) feature.  Todisc is
389
+: unlikely to overwrite your personal files, but you should take precautions
390
+: and backup your images, as you would with any beta software.  Todisc
391
+: will prompt you to backup your files normally.  If you have already backed
392
+: up your images, use this option to disable the prompt.
393
+: 
394
+: ==Options==
395
+: 
396
+; '''-ntsc'''
397
+: 720x480 output, compatible with NTSC standard (default)
398
+; '''-pal'''
399
+: 720x576 output, compatible with PAL standard
400
+; '''-submenus'''
401
+: Create a sub-menu with chapters for each video (default: no sub-menus)
402
+; '''-ani-submenus'''
403
+: Create an animated sub-menu with chapters for each video (default: not
404
+: animated)
405
+; '''-no-menu | -nomenu'''
406
+: With this option todisc will just create a DVD file system, ready for
407
+: burning, with NO MENU, just the supplied video files.  These do not need
408
+: to be compliant, as non-compliant files will be encoded as usual.  The
409
+: '''-out''' option is not required.  Each  video will be a chapter unless
410
+: '''-chapters''' OPTION is passed.  The  '''-chapters''' option is a number
411
+: indicating the chapter interval in minutes, or a HH:MM:SS string
412
+: indicating chapter points.  See '''-chapters'''
413
+; '''-encode-only'''
414
+: This option was originally meant for the GUI, to allow it to be used for
415
+: just encoding rather than making a DVD structure.  But it works well from
416
+: the command line as well as it has the added advantage that you can input
417
+: a list of files.  Remember any makempg ('tovid mpg') options you use will
418
+: be passed on to the makempg script when encoding.
419
+
420
+=== Menu style ===
421
+
422
+; '''-showcase''' IMAGE|VIDEO
423
+: If used without an argument, use showcase style without a central thumb.
424
+: This is a different arrangement of images for the menu: small thumbnails
425
+: go at left (and right) side of screen, with a larger image in the centre.
426
+: Maximum of 10 videos.  If the provided argument is a video file, the
427
+: central thumb will be animated (regardless of whether '''-static''' is part
428
+: of the command line). Only 4:3 or 16:9 videos and images are accepted for
429
+: for the showcase file: if not one of these todisc will assume it is the
430
+: aspect ratio as the videos in the titleset.
431
+; '''-textmenu''', '''-text-menu''' NUM
432
+: If used without an argument, create a textmenu out of the supplied titles
433
+: The optional argument specifies how many titles are in the 1st column,
434
+: i.e. giving 4 titles and using "-textmenu 2" would make 2 columns of 2
435
+: titles. The default is to put all titles up to 13 in the first column
436
+: before starting a second column.  Maximum: 2 columns and 26 titles.
437
+: Note that column 2 titles are justified to the left unless you add
438
+: '''-edge-justify''' to the command line. The menu will be static if no video
439
+: files are supplied with either '''-background''' or '''-showcase''' options.
440
+; '''-quick-menu'''
441
+: If you are using ffmpeg 0.8 or newer you can use this option.  This will
442
+: make a very quick  menu by using ffmpeg instead of imagemagick.
443
+: There are two choices: you can either use '-showcase IMAGE|VIDEO' or
444
+: '-background VIDEO'.  There are no fancy effects like '''-wave'''
445
+: or '''-rotate''' available for it, but it is extremely fast.  It will be a
446
+: text-menu style of menu, with no video thumbs, and a central showcase
447
+: IMAGE(static) | VIDEO(animated).
448
+: (i) see '''-bg-color''' if you are not using a '''-background''' and want to
449
+: change the default.  (default is dark blue for -quick-menu arrangements). )
450
+: (ii) Note: todisc will still work with 'vhooks' if you have an old ffmpeg
451
+: with vhooks compiled in.
452
+: 
453
+: Specifying the IMAGE|VIDEO argument to '''-showcase''' is mandatory for this
454
+: style of menu, unless used in conjunction with '''-switched-menus'''
455
+: in which case the videos passed with '''-files''' automatically become the
456
+: showcase videos.  If '''-quick-menu''' is used in combination with
457
+: '''-switched-menus''' it really speeds up an otherwise time consuming process.
458
+: 
459
+: Example:
460
+<pre>
461
+    -quick-menu -showcase /home/grepper/showcase.mpg
462
+</pre>
463
+
464
+: See '''-switched-menus''' for example of making switched menus with
465
+: '''-quick-menu'''
466
+: 
467
+; '''-bg-color''', '''-bg-colour'''
468
+: The color to use for the menu background. (default: ntsc-safe black)
469
+: Note: use a color a great deal darker than you want, as it appears quite
470
+: a bit lighter in the video version.  You can use hexadecimal ('#ffac5f')
471
+: notation or named colors ('Lime').  convert -list color will show them.
472
+: See [http://www.imagemagick.org/script/color.php colors] for more details.
473
+; '''-submenu-bg-color''', '''-submenu-bg-colour'''
474
+: The color to use as background for the  submenu(s).
475
+: (default: ntsc-safe black)  See '''-bg-color'''
476
+; '''-static'''
477
+: Main menu will consist of static thumbnail links. (default: animated)
478
+: If you use a video for -showcase or -background then it will still be
479
+: a 'moving' menu, in spite of the static buttons.  This option also does
480
+: double duty for the '''-switched-menus''' option, and will create static
481
+: "switched" images.
482
+: See also '''-switched-menus'''
483
+; '''-background''' IMAGE|VIDEO
484
+: Menu background.  This can be a image file or an video file.  If it is a
485
+: video file the background will be animated.  Pick a file of correct aspect
486
+: ratio: i.e. it should still look good when resized to 4:3 aspect ratio.
487
+: It will be resized to fill the entire background.
488
+; '''-submenu-background''' IMAGE
489
+: Submenu background.  This can be only be an image file.  Pick a file of
490
+: correct aspect ratio: i.e. it should still look good when resized to
491
+: 4:3 aspect ratio.  It will be resized to fill the entire background.
492
+; '''-menu-title'''
493
+: Title for the root menu - may be longer than thumbnail labels
494
+: Also if you use \n in the title, you can use multi line titles, but you
495
+: would need to adjust '''-title-fontsize''' to something smaller than default
496
+: for example:
497
+: 
498
+<pre>
499
+    $ tovid disc ... -menu-title "A\nMultilined\nTitle" -title-fontsize 24
500
+</pre>
501
+
502
+; '''-title-font''', '''-menu-font''' FONT
503
+: Font to use for titles, either by ImageMagick font name (ex., "Arial") or
504
+: explicit pathname (ex., "/full/path/to/arial.ttf"). To see a complete
505
+: list of acceptable ImageMagick font names, run '''convert -list type''', and
506
+: refer to the leftmost column
507
+; '''-title-fontsize''', '''-menu-fontsize'''
508
+: Font size for main menu - best to -preview if you use this
509
+; '''-submenu-font'''
510
+: Font to use for the sub-menu main titles.  See '''-title-font'''
511
+; '''-submenu-fontsize'''
512
+: Font size for the sub-menu main titles
513
+; '''-menu-fade''' ['BACKGROUND DURATION']
514
+: Fade the menu in and out The background will fade in first, then title (and
515
+: mist if called for), then the menu thumbs.  The fadeout is in reverse
516
+: order.  'BACKGROUND DURATION' is an integer denoting the amount of time
517
+: the background will play before the menu begins to fade in.  This can allow
518
+: you to do a 'transition' to the menu: if you supply a -background VIDEO it
519
+: will play for the indicated time before the menu fades in.  Leave the
520
+: optional argument empty (just '''-menu-fade''') to get the default behavior
521
+: of showing the background for 1 second before fading the menu in.  To
522
+: disable the fadeout portion, use ''''-loop''' inf'.  See also:
523
+: '''-transition-to-menu''' and '''-loop'''
524
+; '''-transition-to-menu'''
525
+: This option goes with the '''-menu-fade''' option above, which must be
526
+: enabled for it to have effect.  It is a convenience option for animated
527
+: backgrounds: the background will become static at the exact point the
528
+: thumbs finish fading in. This menu does not loop unless you pass
529
+: '''-loop''' VALUE.  See also: '''-loop'''
530
+; '''-bgaudio''', '''-bg-audio*''' FILE
531
+: An file containing audio for the main menu background.  For static menus
532
+: the default is to use 20 seconds of audio.  You can change this using the
533
+: '''-menu-length''' option.
534
+; '''-submenu-audio''' FILE(S)
535
+: List of files for sub-menu audio backgrounds. If one file is given, then
536
+: it will be used for all sub-menus.  Otherwise the number given must equal
537
+: the number of submenus, though the keyword "none" in this list may be used for
538
+: silence.  See also '''-submenu-length'''
539
+; '''-titleset''' . . . '''-end-titleset'''
540
+: If you have more than one titleset, put options for each titleset between
541
+: '''-titleset''' and '''-end-titleset'''.  A separate menu will be created that
542
+: can be accessed from the main menu (VMGM).  You can create this main menu
543
+: using the '''-vmgm''' '''-end-vmgm''' options.  See '''-vmgm''' below and
544
+: TITLESET paragraph opening '''Usage''' section.
545
+; '''-vmgm''' . . . '''-end-vmgm'''
546
+: The VMGM menu is the root menu when you use titlesets.
547
+: Put your VMGM menu options between '''-vmgm''' and '''-end-vmgm'''.
548
+: You only need '''-titles''' "Titleset One title"  "Titleset Two title"
549
+: . . . , and not '''-files'''.
550
+: Any other options can be used, but the  menu will be a textmenu style by
551
+: default.  '''Hint''': use '''-showcase''' IMAGE/VIDEO to create a fancier
552
+: VMGM menu.
553
+; '''-no-vmgm-menu''', '''-no-vmgm'''
554
+: This will skip the creation of a VMGM ( root menu ) for titlesets. The DVD
555
+: will start with the first titleset.  You can not use this option unless also
556
+: using '''-quick-nav''' as you would not have a way to get to other titlesets.
557
+; '''-skip-vmgm'''
558
+: Start DVD from the first titleset instead of the VMGM ( root ) menu.
559
+; '''-switched-menus''', '''-switched-menu'''
560
+: This will make a "switched menu": there will be a central image where the
561
+: showcase image would go, and text menu titles along the menu edge where
562
+: textmenu titles go.  As you select a video title with the down or up arrow
563
+: on your DVD remote, the image in the centre will change to the image or
564
+: video made from that selected video. Do not use '''-showcase''' IMAGE/VIDEO
565
+: with this option.
566
+: 
567
+: This can be a time consuming process for making animated menus as you need
568
+: to make a separate menu for each video provided with '''-files'''.  The
569
+: process can be greatly sped up by using '''-quick-menu''' in conjunction with
570
+: this, though you will lose fancy options like '''-rotate''' and '''-wave'''.
571
+: 
572
+: Note that if you want to just have a static rather than an 'animated'
573
+: image, add '''-static''' to the command line.
574
+: 
575
+: Example for using with '''-quick-menu''':
576
+<pre>
577
+    -switched-menus -quick-menu
578
+</pre>
579
+
580
+
581
+=== Thumbnail style ===
582
+
583
+; '''-titles-font''' FONT
584
+: Display thumbnail or textmenu titles in the given font
585
+; '''-titles-fontsize''' POINTS
586
+: Font size to use for thumbnail or textmenu titles
587
+; '''-thumb-shape'''
588
+: normal|oval|vignette|plectrum|arch|spiral|blob|star|flare
589
+: Apply a shaped transparency mask to thumbnail videos.
590
+: These "feathered" shapes look best against a plain background (or used
591
+: in conjunction with '''-thumb-mist''' [COLOR]).  For this rectangular
592
+: semi-transparent misted background for each thumb:  see '''-thumb-mist'''.
593
+: Note: if you wish to make your own mask PNGS you can put them in
594
+: $PREFIX/lib/tovid/masks/ or $HOME/.tovid/masks/ and use them on the
595
+: command line using the filename minus the path and extension.
596
+: (i.e ~/.tovid/masks/tux.png becomes -thumb-shape tux)
597
+: No frame is used for shaped thumbs.
598
+; '''-thumb-frame-size''' INT
599
+: The size (thickness) of the thumb frames in pixels.  This will also set the
600
+: thickness of the raised "frame" of thumbs when you use '''-3d-thumbs'''.
601
+: See also '''-showcase-frame-size''' and '''-thumb-frame-color'''
602
+; '''-thumb-frame-color''', '''-thumb-frame-colour''' COLOR
603
+: The color of frames for video thumbnails.  Use hexadecimal or named colors
604
+: notation.  Remember to quote if using hexadecimal! ( '#ffac5f' ).
605
+; '''-3d-thumbs''', '''-3dthumbs'''
606
+: This will give an illusion of 3D to the thumbnails: dynamic lighting on
607
+: rounded thumbs, and a raised effect on rectangular thumbs.  Try it !
608
+
609
+=== Slideshows ===
610
+
611
+; '''-slides''' IMAGES
612
+: Use '''-slides''' IMAGES to pass in images for a slideshow.  The default is
613
+: to make an animated menu of the slides, moving from one slide to the
614
+: next. If you use '''-static''', a 'polaroid stack' montage is created.  This
615
+: composites the slides onto the background in 'random' locations with random
616
+: rotations.  '''-slides'''  IMAGES can be used multiple times if you wish to
617
+: make a menu with multiple slideshows.  You can also make a menu
618
+: of mixed videos and slideshows by using '''-slides''' IMAGES, and '''-files'''
619
+: VIDEOS multiple times.  For such a menu, the number of '''-titles'''
620
+: needs to match the number of '''-files''' passed in plus the number of
621
+: slideshows.  (Each time you use '''-slides''' counts as one title.)  To use
622
+: a transition between the slides, use '''-slide-transition'''
623
+: crossfade|fade.  See '''-slide-transition''' '''-menu-slide-total'''
624
+: 
625
+; '''-menu-slide-total''' INT
626
+: Use INT number of the slides that were passed in with '''-slides'''
627
+: to make the animated or static slide menu.  The length of the menu is
628
+: determined by 1) '''-menu-length''' NUM if given,  and by 2) the length
629
+: of the audio from '''-bgaudio'''.  For submenu slideshows, it is determined
630
+: by 1) '''-submenu-length''' NUM if given,  and by 2) the length of the
631
+: audio from '''-submenu-audio''' FILE(S).
632
+: 
633
+; '''-submenu-slide-total''' INT
634
+: This option is the same as '''-menu-slide-total''' except that it is
635
+: for submenu slideshows.
636
+: 
637
+; '''-slide-transition''' crossfade|fade [crossfade]
638
+: The type of fade transition between slides in a animated slide menu.  Be
639
+: sure the menu length is long enough to support the 1 second transitions
640
+: between the slides.  The length is determined by 1) the length of the
641
+: -bgaudio AUDIO  2) the length given with -menu-length NUM.  For submenu
642
+: slideshows, it is determined by 1) '''-submenu-length''' NUM if given,  and
643
+: by 2) the length of the audio from '''-submenu-audio''' FILE(S).
644
+: 
645
+: See '''-menu-slide-total''' , '''-bgaudio''' , '''-menu-length''' ,
646
+: '''-submenu-length''', and '''-submenu-audio'''.
647
+: 
648
+: The 'crossfade' transition fades from one slide to another.  The 'fade'
649
+: transition fades in and out from and to black.  If you don't use this
650
+: option, the default is to use a 'crossfade' transition.
651
+: 
652
+; '''-slideshow-menu-thumbs''' FILES
653
+: Use the FILES instead of the 1st image in each slideshow as the
654
+: thumb that shows on the menu.  This option is for multiple slideshows
655
+: or mixed slideshow/video menus only.
656
+: 
657
+; '''-slides-to-bin''' FILES
658
+: FILES will be resized to 640x480 using a 'box' filter - this
659
+: is called 'binning'.  It will reduce the 'signal to noise' ratio for the
660
+: image in the animated slide menu.  Use this if you get some unwanted
661
+: effects for certain images, such as pixels shifting in what should be a
662
+: static image.  See also '''-slides-to-blur''' and '''-slide-border'''
663
+: 
664
+; '''-slides-to-blur''' FILES
665
+: FILES will be blurred a small amount - which will help on
666
+: slides that still have noise even after 'binning' with -slides-to-bin.
667
+: The default blur is 0x0.2 - you can increase this with
668
+: -slide-blur ARG.  See also '''-slides-to-bin''' and '''-slide-border'''
669
+: 
670
+; '''-slide-blur''' VALUE or LIST of VALUES [0x0.2]
671
+: The argument to use for blurring files.  It will be passed to
672
+: imagemagick: convert -blur ARG.  The format of the arg is {radius}x{sigma}
673
+: and the default is 0x0.2. Using values between 0x0.1 and 0x0.9 is probably
674
+: the best range.  Use a single value for all, or a list to have a different
675
+: blur for each file passed with '''-slides-to-blur'''.  You must pass in
676
+: '''-files-to-blur''' FILES to use this option.  Blurring can help 'noise'
677
+: problems in the video.  See also '''-slides-to-bin''' and '''-slide-border'''
678
+: 
679
+; '''-slide-border''' WIDTH [100]
680
+: Pad the slides with a border for the animated slide menu.  The default
681
+: without using an argument is 100.  Using this option can also solve some
682
+: noise/ringing effects if used alone or in conjunction with 'binning'
683
+: ('''-slides-to-bin''') or blurring ('''-slides-to-blur''').
684
+: 
685
+; '''-slide-frame''' WIDTH [12]
686
+: Frame the slides for the animated slideshow menu.  The default width
687
+: without using an  argument is 12.  See also '''-slide-frame-color'''
688
+: 
689
+; '''-slide-frame-color''', '''-slide-frame-colour'''
690
+: The color of the slide frame if passing '''-slide-frame'''.  The default if
691
+: you don't use this option is a color-safe white: rgb(235,235,235).
692
+: 
693
+; '''-showcase-slideshow'''
694
+: If doing multiple slideshows or mixed videos and slideshow(s), then use
695
+: the animated slideshow as a showcase video.  It will be composed of slides
696
+: from each slideshow in the menu.  The thumb for each slideshow button will
697
+: be static.  If you used with a mixed menu of videos and slideshows, then
698
+: the video thumbs WILL be animated, so you may wish to use -static or
699
+: -textmenu with the option in that case.  If you want to use the
700
+: **-switched-menus option with a mixed menu leave this option out.
701
+: 
702
+; '''-background-slideshow''', '''-bg-slideshow'''
703
+: If doing multiple slideshows or mixed videos and slideshow(s), then use
704
+: the animated slideshow as a background video.  See '''-showcase-slideshow'''
705
+: for additional details.
706
+: 
707
+; '''-no-confirm-backup'''
708
+: Slideshows are an experimental (but well tested) feature.  Todisc is
709
+: unlikely to overwrite your personal files, but you should take precautions
710
+: and backup your images, as you would with any beta software.  Todisc
711
+: will prompt you to backup your files normally.  If you have already backed
712
+: up your images, use this option to disable the prompt.
713
+: See '''General Options'''
714
+: 
715
+; '''-use-dvd-slideshow''' [FILE CONFIG]
716
+: If you pass this option without an argument, tovid will use the
717
+: dvd-slideshow program to create the animated slide menu, assuming you have
718
+: this program installed.  The optional argument is the dvd-slideshow
719
+: configuration file  - if you don't use this argument tovid will create it
720
+: for you.  If you want to use the 'Ken Burns effect' - then the
721
+: configuration file argument is required.  Note: the configuration file will
722
+: override many of the above options for slideshows.
723
+
724
+=== Burning the disc ===
725
+
726
+; '''-burn'''
727
+: Prompt to burn the DVD directory on completion.
728
+: 
729
+; '''-device'''
730
+: Device to use for the burning program [ /dev/dvdrw ]
731
+: 
732
+; '''-speed'''
733
+: The speed to use for burning the disc.
734
+
735
+=== Advanced usage ===
736
+
737
+==== Options ====
738
+
739
+; '''-menu-length'''
740
+: The desired animated main menu length in seconds
741
+; '''-submenu-length'''
742
+: The desired submenu length.  This will also affect the length of submenu
743
+: audio for static submenus.  (Assuming that -submenu-audio was passed in).
744
+: The default is to use 10 seconds of audio for static menus.
745
+; '''-submenu-stroke''' COLOR
746
+: The color for the sub-menu font shadow
747
+; '''-submenu-title-color''', '''-submenu-title-colour'''
748
+: The fill color used for sub-menu title fonts
749
+; '''-submenu-titles'''
750
+: You can supply a list of titles here for sub-menus without the length
751
+: restrictions found in thumb titles.  Must equal number of videos
752
+; '''-chapters''' [ NUM | CHAPTER POINTS in HH:MM:SS ]
753
+: The number of chapters for each video (default: 6) OR
754
+: the actual chapter points in HH:MM:SS format.
755
+: Chapter points will be used for generating the submenu thumbs, and for
756
+: seeking with your DVD player.  You can pass in just one value that will
757
+: be used for all videos, or supply a list of values (number of chapters)
758
+: or time code strings.
759
+: 
760
+: If you just pass an integer for 'number of chapters', then tovid will
761
+: make the chapter points for you by dividing the video length by the number
762
+: you supply.  If using the '''-no-menu''' option, the INT passed in will be
763
+: the chapter interval in minutes, rather than the above formula.
764
+: 
765
+: If passing HH:MM:SS format you need to pass the string of chapter points for
766
+: each video and each string should have comma separated values.
767
+: Additionally, the first chapter should always start at 00:00:00 as
768
+: dvdauthor will add that if it is not there already.
769
+: 
770
+: To get your time codes, you can play your videos in mplayer and press 'o'
771
+: to see them on-screen.  I have found these to be very accurate in my short
772
+: tests.  For greater frame accuracy you could try loading the file in
773
+: avidemux and find the time codes for the frames you want.
774
+: 
775
+: If passing grouped chapters you need to join the chapters from all the
776
+: videos in a group with a '+' separator.  If you want to skip creating
777
+: chapters for a video in the group use '0' for its chapters.
778
+: 
779
+: Note: chapters for grouped videos should probably be passed in using the
780
+: above HH:MM:SS format. (Arbitrary chapters using just an INT for the # of
781
+: chapters is not guaranteed to work reliably in all cases for grouped videos
782
+: at the moment.)
783
+: 
784
+: Example for passing just number of chapters ( 4 videos ):
785
+<pre>
786
+    -chapters 5 2 4 8
787
+</pre>
788
+
789
+: 
790
+: Example of passing chapter points ( 4 videos ):
791
+<pre>
792
+    -chapters 00:00:00,00:05:34.41,00:12:54,00:20:45 \
793
+    00:00:00,00:04:25.623,00:09:12,00:15:51 \
794
+    00:00:00,00:05:10,00:13:41,00:18:13.033 \
795
+    00:00:00,00:15:23.342,00:26:42.523
796
+</pre>
797
+
798
+: 
799
+: Example of passing grouped chapters using the '+' separator:
800
+<pre>
801
+    -chapters 00:00:00,00:05:34.41,00:12:54,00:20:45+00:04:23,00:09:35 \
802
+    00:00:00... etc.
803
+</pre>
804
+
805
+: 
806
+; '''-chapter-titles''' LIST
807
+: If you are using submenus, you can pass a list of titles for the
808
+: chapters.  Each title must be quoted, and the number of titles given
809
+: must equal the total number of chapters for all videos.  In other words
810
+: if you use -chapters 4 6 8 , you must give 18 chapter titles, in the same
811
+: order that the videos were passed in.  Note: if you are passing in options
812
+: on the command line to the 'tovid disc' GUI, you must repeat the option
813
+: '''-chapter-titles''' for each video, accompanied by its respective chapter
814
+: titles. (you can also choose to use this syntax for the todisc script.)
815
+: 
816
+; '''-chapter-font''' FONT
817
+: Use FONT as the font for submenu chapters.
818
+: 
819
+; '''-chapter-fontsize''' SIZE
820
+: Use SIZE as the pointsize for the chapters font.
821
+; '''-chapter-color''' COLOR
822
+: The color for the chapters font.
823
+; '''-chapter-stroke''' COLOR
824
+: The color for the chapters font shadow
825
+: 
826
+; '''-seek''' NUM | "NUM1 NUM2 NUM3 . . ."
827
+: Seek to NUM seconds before generating thumbnails (default: 2.0 seconds)
828
+: If a quoted string of values matching the number of videos is used, then
829
+: each video can use a different seek value
830
+: If using switched menus, the '''-seek''' value(s) will be used to generate
831
+: the showcase image that displays on switching to another video choice with
832
+: the up/down arrow keys.
833
+; '''-fast-seek'''
834
+: Use faster seek method for ffmpeg.  This is not as accurate as the default
835
+: method, and may produce grey frames.
836
+; '''-frame-safe'''  Instead of seeking and then outputting one frame for
837
+: previews and static menus, output 9 frames and choose the largest.  Not
838
+: frame accurate (may be as much as 9 frames off), but safer.  Choose this
839
+: if you are getting grey frames/thumbnails with some videos.  You can also
840
+: use it to try to get the 'best' frame.  This option
841
+: has no effect on submenus at present.
842
+; '''-showcase-seek''' NUM
843
+: Seek to NUM seconds before generating thumbnails for showcase video
844
+: (default: 2.0 seconds)
845
+; '''-bgvideo-seek''', '''-bg-video-seek''' NUM
846
+: Seek to NUM seconds before generating images for background video
847
+: (default: 2.0 seconds)
848
+; '''-bgaudio-seek''', **-bg-audio-seek NUM
849
+: Seek to NUM seconds before generating audio for bgaudio
850
+: (default: 2.0 seconds)
851
+; '''-group''' N VIDEO1 VIDEO2 . . .
852
+: Allow grouping videos in dvdauthor.xml, so they will play sequentially as
853
+: a group.  The videos passed in after the 'N' will be grouped with the 'Nth'
854
+: video. Example:
855
+: 
856
+<pre>
857
+    -group 2 2.mpg 3.mpg 4.mpg
858
+</pre>
859
+
860
+: 
861
+: will group these 3 videos with the 2nd video given with '''-files''', so that
862
+: they will play sequentially as one title.  Only one thumbnail and/or title
863
+: will appear on the menu for the group: it will be made from the 1st video
864
+: in the group.  In the above example if you passed:
865
+<pre>
866
+    -files foo.mpg bar.mpg baz.mpg -group 2 2.mpg 3.mpg 4.mpg
867
+</pre>
868
+
869
+: then the group will consist of bar.mpg  2.mpg, 3.mpg and 4.mpg, and only the
870
+: title and/or thumbnail for bar.mpg will appear in the menu.  You can use
871
+: '''-group''' more than once for multiple groups.  Be  sure to quote video
872
+: filenames if they contain  spaces.
873
+
874
+=== Menu Style ===
875
+
876
+; '''-menu-title-geo''' north|south|east|west|center [south]
877
+: The position of the menu title.  You may need to use -align as well if
878
+: you don't want your title covering other parts of your menu.  See
879
+: '''-align'''
880
+; '''-menu-title-offset''' OFFSET (+X+Y)
881
+: Move menu title by this offset from its N|S|E|W|Center position.  You
882
+: may need to use -align as well if you don't want your title covering other
883
+: parts of your menu.  See '''-align'''
884
+; '''-button-style''' line|rect|text|text-rect [line]
885
+: The style of button that you will see when you play the DVD.
886
+: "line" style underlines the title, "rect" draws a rectangle around the
887
+: thumb when you select it in the DVD player, "text" highlights the video
888
+: title text, and "text-rect" draws a rectangle around the title
889
+: text.
890
+; '''-title-color''', '''-title-colour''' COLOR
891
+: Color to use for the main menu title.  For list of supported colors do:
892
+: '''convert -list''' color.  HTML notation may be used: "#ff0000". See:
893
+: [http://www.imagemagick.org/script/color.php]
894
+; '''-title-stroke''' COLOR
895
+: Shadow color for the main menu's title font. Use "none" for transparent
896
+: outline  (see title-color).  Note: this is not a -stroke in the sense that
897
+: imagemagick uses the term, but a shadow (the font is drawn twice).  To get
898
+: a true imagemagick stroke see '''-title-font-deco'''
899
+; '''-title-font-deco''', '''-title-fontdeco''' "IMAGEMAGICK STRING"
900
+: Sets the font decoration method to FONTDECORATION. It is used by the 'convert'
901
+: ImageMagick command to draw the menu text. You can add colored text
902
+: outlines, gradient fills, and many others. See '''Usage notes'''
903
+; '''-titles-stroke''' COLOR
904
+: Shadow color for the thumb or textmenu video titles font. Use "none" for
905
+: transparent outline  (see '''-titles-color''').  Note: this is not a -stroke
906
+: in the sense that imagemagick uses the term, but a shadow
907
+: (the font is drawn twice).  To get a true imagemagick stroke,
908
+: see '''-titles-font-deco'''
909
+; '''-titles-font-deco''', '''-titles-fontdeco''' "IMAGEMAGICK STRING"
910
+: Sets the font decoration method to FONTDECORATION. It is used by the 'convert'
911
+: ImageMagick command to draw the menu text. You can add colored text
912
+: outlines, gradient fills, and others. See '''Usage notes''' for more info.
913
+; '''-highlight-color''', '''-highlight-colour'''
914
+: Color to use for the menu buttons that your DVD remote uses to navigate.
915
+; '''-select-color''', '''-select-colour'''
916
+: Color to use for the menu buttons that your DVD remote uses to select.
917
+; '''-text-mist'''
918
+: Put a semi-transparent misted background behind the text for the menu's
919
+: title, just slightly larger than the text area.
920
+; '''-text-mist-color''', '''-text-mist-colour''' COLOR
921
+: Color of the mist behind the menu's title (see title-color).
922
+; '''-text-mist-opacity'''
923
+: Opacity of the mist behind the menu's title - see '''-opacity'''
924
+; '''-title-opacity'''
925
+: Opacity of the menu title text
926
+; '''-titles-opacity'''
927
+: Opacity of the text for video titles
928
+; '''-submenu-title-opacity'''
929
+: Opacity of the text for submenu menu titles
930
+; '''-chapter-title-opacity'''
931
+: Opacity of the text for submenu chapter titles
932
+; '''-menu-audio-fade'''
933
+: Number of sec to fade given menu audio in and out (default: 1.0 seconds)
934
+: If you use '''-menu-audio-fade''' 0 then the audio will not be faded.
935
+; '''-submenu-audio-fade'''
936
+: Number of secs to fade sub-menu audio in and out (default: 1.0 seconds).
937
+: See '''-menu-audio-fade'''
938
+; '''-intro''' VIDEO
939
+: Use a introductory video that will play before the main menu.
940
+: At present it must be a DVD compatible video at the correct resolution etc.
941
+: Only 4:3 aspect is supported: 16:9 will give unexpected results.
942
+
943
+==== Style options specific to showcase/textmenu arrangements ====
944
+
945
+; '''-text-start''' N
946
+: This option is for '''-textmenu''' menus.  The titles will start at the Nth
947
+: pixel from the top of the menu ( Y axis ).
948
+; '''-title-gap''' N
949
+: This option is for '''-textmenu''' menus.  The gap is the space between
950
+: titles vertically ( Y axis ).
951
+; '''-rotate''' DEGREES
952
+: Rotate the showcase image|video clockwise by DEGREES.
953
+: (default: if used without options, the rotate will be 5 degrees).  Note:
954
+: this will not turn a portait image into a landscape image!
955
+; '''-showcase-geo''' GEOMETRY
956
+: The position of the showcase image.  ( +X+Y  position )
957
+: For example: '''-showcase-geo''' +300+200
958
+; '''-wave''' default|GEOMETRY
959
+: Wave effect for showcase image|video.  Alters thumbs along a sine wave using
960
+: GEOMETRY. (default: no wave)
961
+: "default" will produce a wave arg of -20x556, which
962
+: produces a gentle wave with a small amount of distortion.
963
+: See: [http://www.imagemagick.org/Usage/distorts/#wave] if you want
964
+: to try other values.
965
+; '''-showcase-shape'''  egg|oval|plectrum|arch|spiral|galaxy|flat-tube|normal
966
+: Apply a shaped transparency mask to showcase videos or images.
967
+: Note: if you wish to make your own mask PNGS you can put them in
968
+: $PREFIX/lib/tovid/masks/ or $HOME/.tovid/masks/ and use them on the
969
+: command line using the filename minus the path and extension.
970
+: No frame is used for shaped thumbs.
971
+; '''-showcase-framestyle'''  none|glass
972
+: For -showcase-* style template only
973
+: "none" will use the default frame method, using "convert -frame . . ."
974
+: "glass" will use mplayer to make frames, which gives an interesting
975
+: animated effect to the frames, and can be much faster ( especially if you
976
+: don't use '''-rotate''' or '''-wave''' as thumbs will not need to be processed
977
+: again after mplayer spits them out.  Note: you need to be using either
978
+: '''-showcase''' IMAGE or '''-showcase''' VIDEO for this "frame style" to work.
979
+; '''-showcase-frame-size''' PIXELS
980
+: The size of the showcase frame.  This value will be used for both width and
981
+: height for the 'thickness' of the frame.  This will also set the thickness
982
+: of the raised "frame" of the showcase thumb when you use '''-3d-showcase'''.
983
+: See also '''-thumb-frame-size''' and '''-showcase-frame-color'''
984
+; '''-showcase-frame-color''', '''-showcase-frame-colour''' PIXELS
985
+: The color of the showcase frame.  Use hexadecimal or named colors notation.
986
+: Remember to quote! ( '#ffac5f' ).
987
+; '''-3d-showcase''', '''-3dshowcase'''
988
+: This will give an illusion of 3D to the showcase thumb: dynamic lighting on
989
+: rounded thumbs, and a raised effect on rectangular thumbs.  Try it !
990
+
991
+=== Thumbnail Style ===
992
+
993
+; '''-user-thumbs''' IMAGE(S)
994
+: Supply your own images for menu buttons, rather than relying on todisc to
995
+: generate them from the video.  They must be the same aspect ratio as the
996
+: videos in the titleset (4:3 or 16:9), as todisc will resize them without
997
+: checking and cropping.  There must be on image for each thumb that will be
998
+: displayed on the menu (ie. one thumb for each video in a titleset).
999
+; '''-opacity''' [0-100] (default 100)
1000
+: Opacity of thumbnail videos as a percentage (no percent sign).
1001
+: Anything less than 100(%) is semi-transparent. Not recommended with dark
1002
+: backgrounds.
1003
+; '''-thumb-blur''', '''-blur''' NUM
1004
+: The amount of feather blur to apply to the thumb-shape.  The default is 1.0
1005
+: which will more or less keep the shape and produces transparency at the
1006
+: edges.  Choose float or integer values between 0.1 and 2.0. 3D thumbs are
1007
+: set to a tiny blur, so this option doesn't affect the '''-3dthumbs''' option.
1008
+; '''-showcase-blur''' NUM
1009
+: The amount of 'feather' blur to apply to the showcase image/video.  Choose
1010
+: values between 0.1 and 2.0.  This option has no effect on '''-3d-showcase'''.
1011
+: See '''-thumb-blur''' for more info.
1012
+; '''-align''' DIRECTION
1013
+: This will align  thumbs/titles in DIRECTION, which is a compass direction
1014
+: as used by imagemagick: ie. north|south|east|west|northeast|northwest etc.
1015
+: If '''-align''' south then menu title will align north, unless you manually
1016
+: set one or both of '''-menu-title-geo''' or '''-menu-title-offset'''.
1017
+: Only '''-align''' north|south|center has any effect on showcase with thumb,
1018
+: or with the default montage arrangement of central thumbs. The most
1019
+: apparent changes with be with textmenu, though with 2 column arrangements
1020
+: only the north* and south* changes will show an effect.
1021
+: 
1022
+: Diagram:
1023
+;    . northwest   north   northeast .
1024
+;    .                               .
1025
+;    . west        center       east .
1026
+;    .                               .
1027
+;    . southwest   south    souteast .
1028
+; '''-thumb-mist''' [COLOR]
1029
+: Use a mist behind thumbnails.  The optional argument is the color of the
1030
+: mist.  This option helps with contrast.  Be sure to set the font color
1031
+: to an appropriate color if using a colored mist, and/or use a bold font.
1032
+; '''-titles-color''', '''-titles-colour''' COLOR
1033
+: Color to use for the thumb or textmenu titles.  If your titles are not
1034
+: clear enough or look washed out, try using a '''-titles-stroke''' that
1035
+: is the same color as used with '''-titles-color'''  (see '''-title-color''')
1036
+; '''-showcase-titles-align''' west|east (default: center [centre])
1037
+: The default is to center the text above the thumbnails.  This option will
1038
+: align the titles either to the left (west) or right (east).  Aligning west
1039
+: gives more space to the titles.  Aligning east also does so, and as well
1040
+: will facilitate using \n in your titles to achieve multi line titles.
1041
+; '''-tile-3x1''', '''-tile3x1'''
1042
+: Use a montage tile of 3x1 instead of the usual 2x2 for 3 videos
1043
+: ie.
1044
+: 
1045
+: [movie1] [movie2] [movie3] instead of:
1046
+: 
1047
+: [movie1] [movie2]
1048
+: 
1049
+: [movie3]
1050
+: 
1051
+: This option only comes into play if the number of videos supplied equals 3
1052
+: Otherwise it will be silently ignored. Not used for -showcase-* style.
1053
+; '''-tile-4x1''', '''-tile4x1'''
1054
+: Same as '''-tile-3x1''' above, except use tile of 4x1. (one row of 4 videos)
1055
+; **-thumb-columns 3|4
1056
+: Same as '''-tile-3x1''' and tile-4x1** above, except it accepts either '3'
1057
+: (1 row of 3 thumbs), or '4' (one row of 4 thumbs) as an argument.  This
1058
+: alternative was added to help compact the gui layout.
1059
+; '''-rotate-thumbs''' DEGREE LIST ( list of degrees, one for each thumb )
1060
+: Rotate thumbs the given amount in degrees - can be positive or negative.
1061
+: There must be one value for each file given with '''-files'''.
1062
+: If the values are not the same distance from zero, the thumbs will be of
1063
+: different sizes as images are necessarily resized *after* rotating.  With
1064
+: the default montage template - this will also resize the titles; with the
1065
+: showcase template the titles will remain the same size. Example:
1066
+: 
1067
+<pre>
1068
+    -rotate-thumbs -10 10 -10 10 -10  (for 5 files)
1069
+</pre>
1070
+
1071
+: **Note: this option will not turn a portrait image into a landscape image!
1072
+
1073
+=== Dvdauthor options ===
1074
+
1075
+; '''-loop''' PAUSE
1076
+: Pause in seconds at end of menu.  Use "inf" if you wish indefinite pause.
1077
+: Note: using "inf" with '''-menu-fade''' will disable the fadeout portion of
1078
+: the fade.  (default: "inf" for static menu, 10.0 seconds for animated.)
1079
+; '''-playall'''
1080
+: This option will create a button on the main menu that will allow going
1081
+: right to the 1st title and playing all videos in succession before
1082
+: returning to the main menu.  If doing titlesets you can use this within
1083
+: the '''-vmgm''' ... '''-end-vmgm''' options to allow playing ALL titlesets.
1084
+: (If you want also to have a playall button in each titleset you could use
1085
+: this option between each '''-titleset''' ... '''-end-titleset''' option or put
1086
+: it outside of the vmgm and titlset options as a global option.
1087
+; '''-videos-are-chapters'''
1088
+: A button will be made on the main menu for each video, which you can use as
1089
+: a chapter button.  Selecting any video will play them all in order
1090
+: starting with the selected one.
1091
+; '''-chain-videos''' NUM | N1-NN
1092
+: Without options this will chain all videos together so they play
1093
+: sequentially without returning to the main menu, except for the last, which
1094
+: will return.  You can also specify which videos you want to behave this way
1095
+: by number or by a range. ( ie. '''-chain-videos''' 1 2 4-6 ).
1096
+; '''-subtitle-lang''' "lang1 lang2 . . ."
1097
+: This allows selectable subtitles in the DVD, assuming you have optional
1098
+: subtitles muxed into your videos.  Use 2 character language codes.
1099
+; '''-audio-channel''' "Video1_track Video2_track Video3_track . . ."
1100
+: "VideoN_track" is the track number to use in a multi-track (multi-language)
1101
+: mpeg: usually something like '''-audio-channel''' "1 0 1".  The 1st track is
1102
+: 0, 2nd is 1 . . . etc.  If the tracks are 0. English 1.French, then the
1103
+: above would make French the audio language on Video1 and Video3, and
1104
+: English the audio language on Video2.  You can check the mpeg with
1105
+: "mplayer -v . . .".
1106
+; '''-audio-lang''' LANGUAGE CODES
1107
+: Identify the audio tracks on the DVD.  These language codes are used for
1108
+: each video in the titleset.  When you use the audio button on your DVD
1109
+: remote the language name is displayed.  Example: '''-audio-lang''' en fr
1110
+; '''-aspect''' 4:3|16:9
1111
+: This will output a <video aspect WIDTH:HEIGHT /> tag for the dvdauthor
1112
+: xml file.  It will affect all videos in the titleset.  Example:
1113
+: 
1114
+<pre>
1115
+    -aspect 16:9
1116
+</pre>
1117
+
1118
+; '''-widescreen''' nopanscan|noletterbox [nopanscan]
1119
+: This will output a <video widescreen=nopanscan /> tag (for example)
1120
+: for the dvdauthor xml file.  It will affect all videos in the titleset. Use
1121
+: in conjunction with '''-aspect''' if your dvd player is cropping your videos.
1122
+: Example:
1123
+: 
1124
+<pre>
1125
+    -aspect 16:9 -widescreen
1126
+</pre>
1127
+
1128
+; '''-quick-nav'''
1129
+: This option will allow navigation of a menu with more than one titleset by
1130
+: using the left and right arrow keys of your DVD remote.  When you press
1131
+: this key the highlight will go the next or previous title.  If you are at
1132
+: the end of a titleset the right key will go to the next titleset.  If you
1133
+: are at the beginning of a titleset, the left key will go to the previous
1134
+: titleset.  If no next or previous titleset it will cycle to the end or
1135
+: beginning of the titlesets.
1136
+; '''-outlinewidth''', '''-outline-width''' WIDTH
1137
+: For spumux outlinewidth variable.  If there is a large gap between words in
1138
+: a text button, this option may help.
1139
+; '''-video-pause''' PAUSE (single value or list)
1140
+: The pause in seconds after playing a video title.  This is useful for
1141
+: slideshows: the 'slide' will remain on the screen for this length of time.
1142
+: If you have grouped videos you should probably not pause the videos that
1143
+: have a grouped title after it, but instead see '''-grouped-video-pause'''.
1144
+: Note: if you provide a list of values they must be one for each video.
1145
+; '''-group-video-pause''' PAUSE (single value or list)
1146
+: The pause in seconds after a grouped video plays.  If you wish to pause
1147
+: after the whole group finishes, then only use a value greater than zero
1148
+: for the last video in the group.  If providing a list of values they must
1149
+: equal the number of grouped videos.
1150
+
1151
+=== Usage notes ===
1152
+
1153
+The argument given to various *-font options that set the font to use must be
1154
+one of the fonts listed by the command 'convert -list type'. Please note that
1155
+many of your installed fonts may not be available; if you want to maximize the
1156
+number of fonts available to todisc, download and run
1157
+[http://www.cit.gu.edu.au/~anthony/anthony.html Anthony Thyssen's]
1158
+[http://www.imagemagick.org/Usage/scripts/imagick_type_gen imagick_type_gen]
1159
+script and run it like this:
1160
+imagick_type_gen > ~/.magick/type.xml.
1161
+If that doesn't work, try imagick_type_gen > ~/.magick/type.mgk.
1162
+
1163
+Or you can specify a ttf font file directly to the *-font options if you don't
1164
+want to install fonts to ImageMagick.
1165
+
1166
+The *-stroke options in todisc are not a stroke in the sense that ImageMagick
1167
+uses the term, but rather a font shadow (the text is drawn twice)  To get a
1168
+truer Imagemagick -stroke try something like:
1169
+-title-font-deco "-stroke black" (or -titles-font-deco "-stroke black").  The
1170
+'''-fontdeco''' option is quite flexible and takes a lot of ImageMagick's
1171
+''convert'' options. Please refer to the tovid
1172
+[http://tovid.wikia.com/wiki/Making_a_DVD_with_text_menus wiki] and Anthony
1173
+Thyssen's guide [[http://www.imagemagick.org/Usage]] for further explanation and examples.
1174
+
1175
+== Command:mpg ==
1176
+
1177
+'''tovid mpg''' converts arbitrary video files into (S)VCD/DVD-compliant
1178
+MPEG format, suitable for burning to CD/DVD-R for playback on a
1179
+standalone DVD player.
1180
+
1181
+=== Usage ===
1182
+
1183
+'''tovid mpg''' [''OPTIONS''] '''-in''' ''INFILE'' '''-out''' ''OUTPREFIX''
1184
+
1185
+Where ''INFILE'' is any multimedia video file, and ''OUTPREFIX'' is what
1186
+you want to call the output file, minus the file extension. ''OPTIONS''
1187
+are additional customizations, described below.
1188
+
1189
+By default, you will (hopefully) end up with an NTSC DVD-compliant
1190
+MPEG-2 video file; if you burn this file to a DVD-R, it should be
1191
+playable on most DVD players.
1192
+
1193
+For example:
1194
+
1195
+; <tt>tovid mpg -in foo.avi -out foo_encoded</tt>
1196
+: Convert 'foo.avi' to NTSC DVD format, saving to 'foo_encoded.mpg'.
1197
+: 
1198
+; <tt>tovid mpg -pal -vcd foo.avi -out foo_encoded</tt>
1199
+: Convert 'foo.avi' to PAL VCD format, saving to 'foo_encoded.mpg'.
1200
+
1201
+=== Basic options ===
1202
+
1203
+; '''-v''', '''-version'''
1204
+: Print tovid version number only, then exit.
1205
+; '''-quiet'''
1206
+: Reduce output to the console.
1207
+; '''-fake'''
1208
+: Do not actually encode; only print the commands (mplayer, mpeg2enc etc.)
1209
+: that would be executed. Useful in debugging; have tovid give you the
1210
+: commands, and run them manually.
1211
+; '''-ffmpeg'''
1212
+: Use ffmpeg for video encoding, instead of mplayer/mpeg2enc. Try this if
1213
+: you have any problems with the default encoding method. Using this option,
1214
+: encoding will be considerably faster. It can do almost everything that 
1215
+: mpeg2enc does such as -filters and -subtitles by using a pipe from mplayer
1216
+: though using these options will make encoding somewhat slower. The 
1217
+: exceptions are some special options like -kvcd* -bdvd where you will still
1218
+: need to use the default mpeg2enc option.
1219
+
1220
+==== Television standards ====
1221
+
1222
+; '''-ntsc'''
1223
+: NTSC format video (USA, Americas) (default)
1224
+; '''-ntscfilm'''
1225
+: NTSC-film format video
1226
+; '''-pal'''
1227
+: PAL format video (Europe and others)
1228
+
1229
+==== Formats ====
1230
+
1231
+Standard formats, should be playable in most DVD players:
1232
+
1233
+; '''-dvd'''
1234
+: (720x480 NTSC, 720x576 PAL) DVD-compatible output (default)
1235
+; '''-half-dvd'''
1236
+: (352x480 NTSC, 352x576 PAL) Half-D1-compatible output
1237
+; '''-svcd'''
1238
+: (480x480 NTSC, 480x576 PAL) Super VideoCD-compatible output
1239
+; '''-dvd-vcd'''
1240
+: (352x240 NTSC, 352x288 PAL) VCD-on-DVD output
1241
+; '''-vcd'''
1242
+: (352x240 NTSC, 352x288 PAL) VideoCD-compatible output
1243
+
1244
+Non-standard formats, playable in some DVD players:
1245
+
1246
+; '''-kvcd'''
1247
+: (352x240 NTSC, 352x288 PAL) KVCD-enhanced long-playing video CD
1248
+; '''-kdvd'''
1249
+: (720x480 NTSC, 720x576 PAL) KVCD-enhanced long-playing DVD
1250
+; '''-kvcdx3'''
1251
+: (528x480 NTSC, 520x576 PAL) KVCDx3 specification
1252
+; '''-kvcdx3a'''
1253
+: (544x480 NTSC, 544x576 PAL) KVCDx3a specification (slightly wider)
1254
+; '''-bdvd'''
1255
+: (720x480 NTSC, 720x576 PAL) BVCD-enhanced long-playing DVD
1256
+
1257
+See [http://kvcd.net/ kvcd.net] for details on the KVCD specification. Please
1258
+note that KVCD ("K Video Compression Dynamics") is the name of a compression
1259
+scheme that can be applied to any MPEG-1 or MPEG-2 video, and has little to
1260
+do with VCD ("Video Compact Disc"), which is the name of a standard video disc
1261
+format.
1262
+
1263
+=== Advanced options ===
1264
+
1265
+==== Aspect ratios ====
1266
+
1267
+tovid automatically determines aspect ratio of the input video by playing it in
1268
+mplayer. If your video plays with correct aspect in mplayer, you should not
1269
+need to override the default tovid behavior.
1270
+
1271
+If mplayer does not play your video with correct aspect, you may provide an
1272
+explicit aspect ratio in one of several ways:
1273
+
1274
+; '''-full'''
1275
+: Same as '''-aspect 4:3'''
1276
+; '''-wide'''
1277
+: Same as '''-aspect 16:9'''
1278
+; '''-panavision'''
1279
+: Same as '''-aspect 235:100'''
1280
+; '''-aspect''' ''WIDTH''''':'''''HEIGHT''
1281
+: Custom aspect, where ''WIDTH'' and ''HEIGHT'' are integers.
1282
+
1283
+The above are the intended INPUT aspect ratio. tovid chooses an optimal output
1284
+aspect ratio for the selected disc format (VCD, DVD, etc.) and does the
1285
+appropriate letterboxing or anamorphic scaling. Use '''-widetv''' to encode
1286
+for a widescreen monitor or TV.
1287
+
1288
+==== Video stream options ====
1289
+
1290
+; '''-quality''' ''NUM'' (default 6)
1291
+: Desired output quality, on a scale of 1 to 10, with 10 giving the best
1292
+: quality at the expense of a larger output file. Default is 6. Output size
1293
+: can vary by approximately a factor of 4 (that is, '''-quality 1''' output
1294
+: can be 1/4 the size of '''-quality 10''' output). Your results may vary.
1295
+: WARNING: With '''-quality 10''', the output bitrate may be too high for
1296
+: your hardware DVD player to handle. Stick with 9 or lower unless you
1297
+: have phenomenally good eyesight.
1298
+: 
1299
+: At present, this option affects both output bitrate and quantization (but
1300
+: may, in the future, affect other quality/size-related attributes). Use
1301
+: '''-vbitrate''' if you want to explicitly provide a maximum bitrate.
1302
+: 
1303
+; '''-vbitrate''' ''NUM''
1304
+: Maximum bitrate to use for video (in kbits/sec). Must be within allowable
1305
+: limits for the given format. Overrides default values. Ignored for VCD,
1306
+: which must be constant bitrate.
1307
+: 
1308
+; '''-interlaced'''
1309
+: Do interlaced encoding of the input video (top fields first). Use this
1310
+: option if your video is  interlaced, and you want to preserve as much
1311
+: picture quality as possible. This option is ignored for VCD, which
1312
+: doesn't support it.
1313
+: 
1314
+: You can tell your source video is interlaced by playing it, and pausing
1315
+: during a scene with horizontal motion; if you see a "comb" effect at the
1316
+: edges of objects in the scene, you have interlaced video. Use this option
1317
+: to encode it properly.
1318
+: 
1319
+: If you would prefer to have output in progressive format, use
1320
+: '''-progressive'''. If you have a DV camera, use '''-interlaced_bf''' since
1321
+: DV footage is generally bottom fields first.
1322
+: 
1323
+; '''-interlaced_bf'''
1324
+: Do interlaced encoding of the input video (bottom fields first).
1325
+: 
1326
+; '''-deinterlace''', '''-progressive'''
1327
+: Convert interlaced source video into progressive output video. Because
1328
+: deinterlacing works by averaging fields together, some picture quality is
1329
+: invariably lost. Uses an adaptive kernel deinterlacer (kerndeint), or,
1330
+: if that's not available, the libavcodec deinterlacer (lavcdeint).
1331
+: 
1332
+; '''-mkvsub''' ''LANG'' (EXPERIMENTAL)
1333
+: Attempt to encode an integrated subtitle stream (such as may be found in
1334
+: Matroska .mkv files) in the given language code (eng, jpn, etc.) May work
1335
+: for other formats.
1336
+: 
1337
+; '''-autosubs'''
1338
+: Automatically include subtitle files with the same name as the input video.
1339
+: 
1340
+; '''-subtitles''' ''FILE''
1341
+: Get subtitles from ''FILE'' and encode them into the video.  WARNING: This
1342
+: hard-codes the subtitles into the video, and you cannot turn them off while
1343
+: viewing the video. By default, no subtitles are loaded. If your video is
1344
+: already compliant with the chosen output format, it will be re-encoded to
1345
+: include the subtitles. This works with both -ffmpeg and the default,
1346
+: mpeg2enc.
1347
+: 
1348
+; '''-dvd-subtitles''', '''-dvdsubs''' | ''FILE''
1349
+: Get subtitles from ''FILE(S)'' and add them '''as a subtitle stream''' into the
1350
+: video.  This allows selectable subtitles on your DVD. You can use more than
1351
+: one file for multiple languages. Be sure to use the -subtitle-lang option
1352
+: in 'tovid disc' so the name of the language will show up on the DVD instead
1353
+: of 'UNKNOWN' or similar
1354
+: 
1355
+; '''-dvdsubs-only'''
1356
+: Use this if you have an already complient MPEG and wish to add a subtitle
1357
+: stream without re-encoding, using '''-dvdsubs''' ,
1358
+: 
1359
+; '''-dvdsubs-fontsize''' ''NUM'' [18]
1360
+: The pointsize in pixels for DVD selectable subtitles. To affect this for
1361
+: hard-coded subtitles ( '''-subtitles''' ) you will need to pass options to
1362
+: the player via '''-mplayeropts''' or '''-mpvopts'''.
1363
+: 
1364
+; '''-type''' {live|animation|bw}
1365
+: Optimize video encoding for different kinds of video. Use 'live' (default)
1366
+: for live-action video, use 'animation' for cartoons or anime, and 'bw' for
1367
+: black-and-white video.  This option currently only has an effect with
1368
+: KVCD/KSVCD output formats; other formats may support this in the future.
1369
+: 
1370
+; '''-safe''' ''PERCENT''
1371
+: Fit the video within a safe area defined by ''PERCENT''. For example,
1372
+: '''-safe 90%''' will scale the video to 90% of the width/height of the output
1373
+: resolution, and pad the edges with a black border. Use this if some of the
1374
+: picture is cut off when played on your TV.  The percent sign is optional.
1375
+: 
1376
+; '''-filters''' {none,denoise,deblock,contrast,all} (default none)
1377
+: Apply post-processing filters to enhance the video. If your input video is
1378
+: very high quality, use 'none'. If your input video is grainy, use 'denoise';
1379
+: if it looks washed out or faded, use 'contrast'. You can use multiple
1380
+: filters separated by commas. To apply all filters, use 'all'. This works
1381
+: with both mpeg2enc and -ffmpeg.
1382
+: 
1383
+; '''-fps''' ''RATIO''
1384
+: Force input video to be interpreted as ''RATIO'' frames per second.  May be
1385
+: necessary for some ASF, MOV, or other videos. ''RATIO'' should be an
1386
+: integer ratio such as "24000:1001" (23.976fps), "30000:1001" (29.97fps), or
1387
+: "25:1" (25fps). This option is temporary, and may disappear in future
1388
+: releases. (Hint: To convert a decimal like 23.976 to an integer ratio, just
1389
+: multiply by 1000, i.e. 23976:1000)
1390
+: 
1391
+; '''-crop''' ''WIDTH'':''HEIGHT'':''X'':''Y''
1392
+: Crop a portion of the video ''WIDTH'' by ''HEIGHT'' in size, with the
1393
+: top-left corner at ''X'', ''Y''.
1394
+: 
1395
+; '''-widetv'''
1396
+: Always encode to 16:9 widescreen (only supported by '''-dvd''', '''-kdvd''',
1397
+: '''-bdvd'''), for optimal viewing on a widescreen monitor or TV.
1398
+
1399
+==== Audio stream options ====
1400
+
1401
+; '''-normalize'''
1402
+: Analyze the audio stream and then normalize the volume of the audio.
1403
+: This is useful if the audio is too quiet or too loud, or you want to
1404
+: make volume consistent for a bunch of videos. Similar to running
1405
+: normalize without any parameters. The default is -12dB average level
1406
+: with 0dB gain.
1407
+: 
1408
+; '''-amplitude''' ''NUM''[dB]
1409
+: In addition to analyzing and normalizing, apply the gain to the audio
1410
+: such that the 'average' (RMS) sound level is ''NUM''. Valid values
1411
+: range 0.0 - 1.0, with 0.0 being silent and 1.0 being full scale. Use
1412
+: ''NUM''dB for a decibel gain below full scale (the default without
1413
+: -amplitude is -12dB).
1414
+: 
1415
+; '''-abitrate''' ''NUM''
1416
+: Encode audio at ''NUM'' kilobits per second.  Reasonable values include
1417
+: 128, 224, and 384. The default is 224 kbits/sec, good enough for most
1418
+: encodings. The value must be within the allowable range for the chosen disc
1419
+: format; Ignored for VCD, which must be 224.
1420
+: 
1421
+; '''-audiotrack''' ''NUM''
1422
+: Encode the given audio track, if the input video has multiple audio tracks.
1423
+: ''NUM'' is ''1'' for the first track, ''2'' for the second, etc. You may
1424
+: also provide a list of tracks, separated by spaces or commas, for example
1425
+: '''-audiotrack 3,1,2'''. Use '''tovid id''' on your source video to determine
1426
+: which audio tracks it contains.
1427
+: 
1428
+; '''-downmix'''
1429
+: Encode all audio tracks as stereo.  This can save space on your DVD if
1430
+: your player only does stereo.  The default behavior of tovid is to use
1431
+: the original number of channels in each track.  For aac audio, downmixing
1432
+: is not possible: tovid runs a quick 1 frame test to try to downmix the
1433
+: input track with the largest number of channels, and if it fails then it
1434
+: will revert to the default behavior of using the original channels.
1435
+
1436
+==== Other options ====
1437
+
1438
+; '''-config''' ''FILE''
1439
+: Read configuration from ''FILE'', containing 'tovid' alone on the first
1440
+: line, and free-formatted (whitespace-separated) tovid command-line options
1441
+: on remaining lines.
1442
+: 
1443
+; '''-force'''
1444
+: Force encoding of already-compliant video or audio streams.
1445
+: 
1446
+; '''-overwrite'''
1447
+: Overwrite any existing output files (with the same name as the given
1448
+: '''-out''' option).
1449
+: 
1450
+; '''-priority''' {low|medium|high}
1451
+: Sets the main encoding process to the given priority. With high priority,
1452
+: it may take other programs longer to load and respond. With lower priority,
1453
+: other programs will be more responsive, but encoding may take 30-40%
1454
+: longer.  The default is high priority.
1455
+: 
1456
+; '''-discsize''' ''NUM''
1457
+: When encoding, tovid automatically splits the output file into several
1458
+: pieces if it exceeds the size of the target media. This option sets the
1459
+: desired target DVD/CD-R size to ''NUM'' mebibytes (MiB, 2^20). By default,
1460
+: splitting occurs at 700 for CD, 4300 for DVD. Use higher values at your
1461
+: own risk. Use 650 or lower if you plan to burn to smaller-capacity CDs.
1462
+: Doesn't work with the '''-ffmpeg''' option.
1463
+: 
1464
+; '''-fit''' ''NUM''
1465
+: Fit the output file into ''NUM'' MiB. Rather than using default (or
1466
+: specified) video bitrates, tovid will calculate the correct video bitrate
1467
+: that will limit the final output size to ''NUM'' MiB. This is different
1468
+: than '''-discsize''', which cuts the final file into ''NUM'' MiB pieces.
1469
+: '''-fit''' makes sure that the file never exceeds ''NUM'' MiB. This works
1470
+: with '''-ffmpeg''', but not with '''-vcd''' since VCDs have a standardized
1471
+: constant bitrate.
1472
+: 
1473
+; '''-parallel'''
1474
+: Perform ripping, encoding, and multiplexing processes in parallel using
1475
+: named pipes. Maximizes CPU utilization and minimizes disk usage. Note that
1476
+: this option simply does more tasks simultaneously, in order to make better
1477
+: use of available CPU cycles; it's unrelated to multi-CPU processing (which
1478
+: is done automatically anyway). Has no effect when '''-ffmpeg''' is used.
1479
+: 
1480
+; '''-update''' ''SECS''
1481
+: Print status updates at intervals of ''SECS'' seconds. This affects how
1482
+: regularly the progress-meter is updated. The default is once every five
1483
+: seconds.
1484
+: 
1485
+; '''-mpv'''
1486
+: Use mpv instead of mplayer. This option is experimental.
1487
+: 
1488
+; '''-mplayeropts''' ''OPTIONS''
1489
+: Append ''OPTIONS'' to the mplayer command run during video encoding.  Use
1490
+: this if you want to add specific video filters (documented in the mplayer
1491
+: manual page). Overriding some options will cause encoding to fail, so use
1492
+: this with caution!
1493
+: 
1494
+; '''-mpvopts''' ''OPTIONS''
1495
+: Append ''OPTIONS'' to the mpv command run during video encoding.  Use
1496
+: this if you want to add specific video filters (documented in the mplayer
1497
+: or mpv manual page). Overriding some options will cause encoding to fail,
1498
+: so use this with caution!
1499
+: 
1500
+; '''-nofifo''' (EXPERIMENTAL)
1501
+: Do not use a FIFO pipe for video encoding. If you are getting "Broken pipe"
1502
+: errors with normal encoding, try this option.  WARNING: This uses lots of
1503
+: disk space (about 2 GB per minute of video).
1504
+: 
1505
+; '''-keepfiles'''
1506
+: Keep the intermediate files after encoding. Usually, this means the audio
1507
+: and video streams are kept (eg the .ac3 and .m2v files for an NTSC DVD).
1508
+: This doesn't work with -parallel because the intermediate files are named
1509
+: pipes, and not real files.
1510
+: 
1511
+; '''-slice''' ''START''-''END''
1512
+: Encode a segment from ''START'' to ''END'' (in seconds). Only works with
1513
+: -ffmpeg.
1514
+: 
1515
+; '''-from-gui'''
1516
+: Put makempg into a fully non-interactive state, suitable for calling from
1517
+: a gui.
1518
+: 
1519
+; '''-noask'''
1520
+: Don't ask questions when choices need to be made. Assume reasonable
1521
+: answers.
1522
+
1523
+== Command:id ==
1524
+
1525
+'''tovid id''' identifies each multimedia video file in a
1526
+list, and reports its compliance with video disc standards such as VCD,
1527
+SVCD, and DVD.
1528
+
1529
+=== Usage ===
1530
+
1531
+'''tovid id''' [''OPTIONS''] ''VIDEO_FILE(s)''
1532
+
1533
+For example:
1534
+
1535
+; <tt>tovid id foo.avi</tt>
1536
+; <tt>tovid id -tabluar videos/*.mpg</tt>
1537
+
1538
+=== Options ===
1539
+
1540
+; '''-terse'''
1541
+: Print raw video characteristics, no formatting. Helpful when
1542
+: calling from other scripts.
1543
+: 
1544
+; '''-verbose'''
1545
+: Print extra information from mplayer, tcprobe, and ffmpeg.
1546
+: 
1547
+; '''-accurate'''
1548
+: Do lengthy play-time estimation by scanning through the entire video file.
1549
+: Use this if the default behavior is giving you inaccurate play times.
1550
+: 
1551
+; '''-fast'''
1552
+: Skip lengthy play-time estimation, and go with what mplayer reports
1553
+: as being the video duration. Unlike pre-0.32 versions of tovid, this
1554
+: is now the default behavior, and the '''-fast''' option doesn't do anything.
1555
+: 
1556
+; '''-tabular'''
1557
+: Display output in a table format for easier comparison. Most useful
1558
+: when identifying multiple video files.
1559
+: 
1560
+; '''-keepfiles'''
1561
+: Keep temporary directory for debugging.
1562
+: 
1563
+; '''-isformat''' [''pal-dvd''|''ntsc-dvd''] (same syntax for vcd and svcd)
1564
+: Check ''VIDEO_FILE'' for compliance with the given disc format.
1565
+: If ''VIDEO_FILE'' matches the given format, then '''tovid id''' reports "true"
1566
+: and exits successfully. Otherwise, '''tovid id''' reports "false" and exits
1567
+: with status 1 (failure).  This checks and reports both vcd/svcd/dvd
1568
+: and pal/ntsc.
1569
+: 
1570
+; '''-mpv'''
1571
+: This option is mainly for testing. If you have only mpv installed instead
1572
+: of mplayer, it is used automatically. With this option, you can have BOTH
1573
+: installed and choose which one to use. (default: mplayer)
1574
+
1575
+=== Examples ===
1576
+
1577
+; <tt>tovid id -verbose homevideo.avi</tt>
1578
+: Report everything mplayer, ffmpeg, and transcode can determine about
1579
+: homevideo.avi.
1580
+: 
1581
+; <tt>tovid id -isformat dvd homevideo.mpg</tt>
1582
+: Check to see if homevideo.mpg is compliant with the DVD standard.
1583
+
1584
+== Command:dvd ==
1585
+
1586
+'''tovid dvd''' takes a DVD directory as generated by tovid with 'tovid disc' or
1587
+one of the GUI frontends like 'tovid gui' or 'tovid titlesets' and burns
1588
+it to appropriate media.  This will also work if the DVD directory is
1589
+generated by the dvdauthor backend that tovid also uses.
1590
+
1591
+Running this program may slow down your other applications, due to intense
1592
+disk activity.
1593
+
1594
+=== Usage ===
1595
+
1596
+'''tovid dvd''' [''OPTIONS''] ''DVD_DIR''
1597
+
1598
+For example:
1599
+
1600
+; <tt>tovid dvd /path/to/DVD/directory</tt>
1601
+
1602
+=== Options ===
1603
+
1604
+; '''-burn'''
1605
+: Burn a DVD file-system in ''DVD_DIR'' (must contain a VIDEO_TS folder).
1606
+: This option is currently not necessary as the makedvd script ONLY burns
1607
+: now that legacy scripts like makexml have been removed.  Left for
1608
+: compatibility only.
1609
+: 
1610
+; '''-eject'''
1611
+: Eject the DVD tray after burning is complete. By default, the DVD is not
1612
+: ejected.
1613
+: 
1614
+; '''-device''' ''DEVICE'' (default /dev/dvdrw)
1615
+: Burn the disc image to ''DEVICE'', the Linux device file-system
1616
+: name of your DVD-recorder. Common examples might be /dev/dvdrw,
1617
+: /dev/scd1, and /dev/hdc. You can also use a bus/id/lun triple
1618
+: such as ATAPI:0,1,0
1619
+: 
1620
+; '''-speed''' ''NUM'' (default 1)
1621
+: Burn disc at speed ''NUM''.
1622
+: 
1623
+; '''-label''' ''DISC_LABEL''
1624
+: Uses ''DISC_LABEL'' as the volume ID. This appears as the mount
1625
+: name of the disc on some computer platforms. Must be <=32
1626
+: alphanumeric digits without spaces.
1627
+: 
1628
+; '''-quiet'''
1629
+: Limit output to essential messages.
1630
+: 
1631
+; '''-noask'''
1632
+: Don't ask interactive questions and assume answers that will continue
1633
+: execution.
1634
+
1635
+    After burning, the DVD can be previewed by calling:
1636
+    '''''xine''' dvd:/path/to/output/directory''
1637
+    or:
1638
+    '''''vlc''' /path/to/output/directory''
1639
+
1640
+== Command:chapters ==
1641
+
1642
+'''tovid chapters''' will start a GUI using mplayer to set chapter points in a
1643
+video.  If the video plays through and you want to add more chapters you can
1644
+press the play button again, but remember that new chapter points will be
1645
+appended (in correct sequential order).  It will display the resulting chapter
1646
+points, and also output to a terminal (useful for scripts).  As well it will
1647
+give the option of saving the chapters string to a text file.
1648
+
1649
+Note that the 'tovid gui' now features a similar widget when you press the
1650
+chapters button on the opening page.
1651
+
1652
+=== Examples ===
1653
+
1654
+; <tt>tovid chapters foo.avi</tt>
1655
+: 
1656
+; <tt>chapters=$(tovid chapters /home/grepper/videos/foo.avi)</tt>
1657
+
1658
+== CONTACT ==
1659
+
1660
+For further assistance, contact information, forum and IRC links,
1661
+please refer to the [http://tovid.wikia.com/ tovid homepage].
1662
+
1663
+<!-- wiki code generated by txt2tags 2.6 (http://txt2tags.org) -->
1664
+<!-- cmdline: txt2tags -t wiki -\-toc -\-toc-level 2 docs/src/en/tovid.t2t -->
1665
tovid-0.35.tar.gz/libtovid/metagui/gui.py -> tovid-0.35.0.tar.gz/libtovid/metagui/gui.py Changed
19
 
1
@@ -390,7 +390,7 @@
2
         # Hack: This is broken (commented section), presumably because of
3
         # load_args limitations. This hack fixes it for libtovid, but does not
4
         # belong in metagui.  So refactor this when load_args is fixed.
5
-        # see http://code.google.com/p/tovid/issues/detail?id=121
6
+        # see https://github.com/tovid-suite/tovid/issues/121
7
         filename = askopenfilename(parent=self,
8
             title="Select a shell script or text file to load",
9
             filetypes=[('Shell scripts', '*.sh *.bash'),
10
@@ -437,7 +437,7 @@
11
 
12
     def load_script(self, filename):
13
         # this is now disabled and its functionality passed to guis.helpers.py
14
-        # see http://code.google.com/p/tovid/issues/detail?id=121
15
+        # see https://github.com/tovid-suite/tovid/issues/121
16
         pass
17
         #"""Load current Control settings from a text file.
18
         #"""
19
tovid-0.35.tar.gz/setup.py -> tovid-0.35.0.tar.gz/setup.py Changed
25
 
1
@@ -44,7 +44,7 @@
2
 # Current SVN version number
3
 #_tovid_version = svn_version()
4
 # Official release number
5
-_tovid_version = '0.35'
6
+_tovid_version = '0.35.0'
7
 
8
 
9
 import os
10
@@ -194,8 +194,12 @@
11
     version = _tovid_version, # Defined at the top of this file
12
     url = 'http://tovid.wikia.com/',
13
     license = 'GPL',
14
-    maintainer = 'Eric Pierce',
15
-    maintainer_email = 'wapcaplet88@gmail.com',
16
+    maintainer = 'grepper',
17
+    maintainer_email = 'grepper@gmail.com',
18
+    description = 'A suite of tools for making video DVDs',
19
+    platforms = 'Linux',
20
+    download_url = 'https://github.com/tovid-suite/tovid/',
21
+    long_description = 'A suite of tools for making video DVDs',
22
 
23
     cmdclass = {
24
         'install': InstallCommand,
25
tovid-0.35.tar.gz/src/makedvd -> tovid-0.35.0.tar.gz/src/makedvd Changed
10
 
1
@@ -80,7 +80,7 @@
2
     echo "$@"
3
     echo "See if anything in the above output helps you diagnose the"
4
     echo "problem, and please file a bug report at:"
5
-    echo "   http://code.google.com/p/tovid/issues"
6
+    echo "   https://github.com/tovid-suite/tovid/issues"
7
     echo "(_not_ the dvdauthor list) containing the above output."
8
     echo "Sorry for the inconvenience!"
9
     echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
10
tovid-0.35.tar.gz/src/makempg -> tovid-0.35.0.tar.gz/src/makempg Changed
10
 
1
@@ -810,7 +810,7 @@
2
         echo "See the manual ('man tovid') for more information and options."
3
         echo
4
         echo "Please report bugs to:"
5
-        echo "   http://code.google.com/p/tovid/issues/list"
6
+        echo "   https://github.com/tovid-suite/tovid/issues"
7
         yecho "Thanks for using tovid!"
8
         yecho
9
     fi
10
tovid-0.35.0.tar.gz/src/mpv_identify.sh Added
160
 
1
@@ -0,0 +1,158 @@
2
+#!/bin/sh
3
+
4
+# file identification script
5
+#
6
+# manual usage:
7
+#   mpv_identify.sh foo.mkv
8
+#
9
+# sh/dash/ksh/bash usage:
10
+#   . mpv_identify.sh FOO_ foo.mkv
11
+# will fill properties into variables like FOO_length
12
+#
13
+# zsh usage:
14
+#   mpv_identify() { emulate -L sh; . mpv_identify.sh "$@"; }
15
+#   mpv_identify FOO_ foo.mkv
16
+# will fill properties into variables like FOO_length
17
+#
18
+# When multiple files were specified, their info will be put into FOO_* for the
19
+# first file, FOO_1_* for the second file, FOO_2_* for the third file, etc.
20
+#
21
+# Note: this script appears without a COPYRIGHT header in the mpv source
22
+# according to the mpv COPYRIGHT:
23
+# "Files without Copyright notice are licensed as LGPLv2+."
24
+
25
+__midentify__main() {
26
+
27
+    case "$0" in
28
+        mpv_identify.sh|*/mpv_identify.sh)
29
+            # we are NOT being sourced
30
+            [ -n "$1" ] && set -- '' "$@"
31
+            ;;
32
+    esac
33
+
34
+    if [ "$#" -lt 2 ]; then
35
+        cat >&2 <<EOF
36
+Usage 1 (for humans only): $0 filename.mkv
37
+will print all property values.
38
+Note that this output really shouldn't be parsed, as the
39
+format is subject to change.
40
+
41
+Usage 2 (for use by scripts): see top of this file
42
+
43
+NOTE: for mkv with ordered chapters, this may
44
+not always identify the specified file, but the
45
+file providing the first chapter. Specify
46
+--no-ordered-chapters to prevent this.
47
+EOF
48
+        return 2
49
+    fi
50
+
51
+    local LF="
52
+"
53
+
54
+    local nextprefix="$1"
55
+    shift
56
+
57
+    if [ -n "$nextprefix" ]; then
58
+        # in case of error, we always want this unset
59
+        unset "${nextprefix}path"
60
+    fi
61
+
62
+    local allprops="
63
+        filename
64
+        path
65
+        stream-start
66
+        stream-end
67
+        stream-length
68
+
69
+        demuxer
70
+
71
+        length
72
+        chapters
73
+        editions
74
+        titles
75
+
76
+        audio
77
+        audio-bitrate
78
+        audio-codec
79
+        audio-format
80
+        channels
81
+        samplerate
82
+
83
+        video
84
+        angle
85
+        video-bitrate
86
+        video-codec
87
+        video-format
88
+        video-aspect
89
+        fps
90
+        width
91
+        height
92
+        dwidth
93
+        dheight
94
+
95
+        sub
96
+    "
97
+    # TODO add metadata support once mpv can do it
98
+
99
+    local propstr="X-MIDENTIFY-START:$LF"
100
+    local key
101
+    for key in $allprops; do
102
+        propstr="${propstr}X-MIDENTIFY: $key \${=$key}$LF"
103
+        key="$(printf '%s\n' "$key" | tr - _)"
104
+        unset "$nextprefix$key"
105
+    done
106
+
107
+    local fileindex=0
108
+    local prefix=
109
+    local line
110
+    while IFS= read -r line; do
111
+        case "$line" in
112
+            X-MIDENTIFY-START:)
113
+                if [ -n "$nextprefix" ]; then
114
+                    prefix="$nextprefix"
115
+                    if [ "$fileindex" -gt 0 ]; then
116
+                        nextprefix="${prefix%${fileindex}_}"
117
+                    fi
118
+                    fileindex="$((fileindex+1))"
119
+                    nextprefix="${nextprefix}${fileindex}_"
120
+                    for key in $allprops; do
121
+                        key="$(printf '%s\n' "$key" | tr - _)"
122
+                        unset "$nextprefix$key"
123
+                    done
124
+                else
125
+                    if [ "$fileindex" -gt 0 ]; then
126
+                        printf '\n'
127
+                    fi
128
+                    fileindex="$((fileindex+1))"
129
+                fi
130
+                ;;
131
+            X-MIDENTIFY:\ *)
132
+                local key="${line#X-MIDENTIFY: }"
133
+                local value="${key#* }"
134
+                key="${key%% *}"
135
+                key="$(printf '%s\n' "$key" | tr - _)"
136
+                if [ -n "$nextprefix" ]; then
137
+                    if [ -z "$prefix" ]; then
138
+                        echo >&2 "Got X-MIDENTIFY: without X-MIDENTIFY-START:"
139
+                    elif [ -n "$value" ]; then
140
+                        eval "$prefix$key"='"$value"'
141
+                    fi
142
+                else
143
+                    if [ -n "$value" ]; then
144
+                        printf '%s=%s\n' "$key" "$value"
145
+                    fi
146
+                fi
147
+                ;;
148
+        esac
149
+    done <<EOF
150
+echo $propstr
151
+
152
+$(${MPV:-mpv} --term-playing-msg="$propstr" --vo=null --ao=null \
153
+              --frames=1 --quiet --no-cache --no-config -- "$@")
154
+EOF
155
+}
156
+
157
+__midentify__main "$@"
158
+
159
+echo Running mpv --term-playing-msg="$propstr" --vo=null --ao=null --frames=1 --quiet --no-cache --no-config -- "$@" >&2
160
tovid-0.35.tar.gz/src/pytovid -> tovid-0.35.0.tar.gz/src/pytovid Changed
9
 
1
@@ -119,6 +119,6 @@
2
     print(' ')
3
     print("Done encoding '%s' to '%s.mpg'" % (options['in'], options['out']))
4
     print(' ')
5
-    print("Please report bugs to http://code.google.com/p/tovid/issues/list")
6
+    print("Please report bugs to https://github.com/tovid-suite/tovid/issues")
7
     print("Thanks for using pytovid!")
8
 
9
tovid-0.35.tar.gz/src/tovid-init -> tovid-0.35.0.tar.gz/src/tovid-init Changed
19
 
1
@@ -45,7 +45,7 @@
2
 #set -u
3
 
4
 # Suite version
5
-TOVID_VERSION="0.35"
6
+TOVID_VERSION="0.35.0"
7
 
8
 # String used to separate blocks of output
9
 SEPARATOR="========================================================="
10
@@ -53,7 +53,7 @@
11
 TOVID_HOME="$HOME/.tovid"
12
 TOVID_HOME_PAGE="http://tovid.wikia.com"
13
 TOVID_FORUMS="http://groups.google.com/group/tovid-users"
14
-TOVID_ISSUES="http://code.google.com/p/tovid/issues/list"
15
+TOVID_ISSUES="https://github.com/tovid-suite/tovid/issues"
16
 
17
 # ******************************************************************************
18
 # ******************************************************************************
19
tovid-0.35.tar.gz/src/tovid-init.in -> tovid-0.35.0.tar.gz/src/tovid-init.in Changed
10
 
1
@@ -53,7 +53,7 @@
2
 TOVID_HOME="$HOME/.tovid"
3
 TOVID_HOME_PAGE="http://tovid.wikia.com"
4
 TOVID_FORUMS="http://groups.google.com/group/tovid-users"
5
-TOVID_ISSUES="http://code.google.com/p/tovid/issues/list"
6
+TOVID_ISSUES="https://github.com/tovid-suite/tovid/issues"
7
 
8
 # ******************************************************************************
9
 # ******************************************************************************
10
tovid-0.35.tar.gz/src/tovid-test -> tovid-0.35.0.tar.gz/src/tovid-test Changed
10
 
1
@@ -165,7 +165,7 @@
2
         OUTFILE="$DEFAULT_OUTFILE"
3
         rm -f "$OUTFILE"
4
     fi
5
-    CMD="tovid $@ -overwrite -out $OUTFILE"
6
+    CMD="tovid mpg $@ -overwrite -out $OUTFILE"
7
     $TEST_FFMPEG && CMD="$CMD -ffmpeg"
8
     yecho $CMD
9
     if $DEBUG; then
10
tovid-rpmlintrc Deleted
3
 
1
@@ -1,1 +0,0 @@
2
-addFilter("python-naming-policy-not-applied")
3
Refresh

No build results available

Refresh

No rpmlint results available

Request History
Luigi Baldoni's avatar

Aloysius created request about 10 years ago

Tarball from new repository plus a few minor changes.


Peter Linnell's avatar

mrdocs accepted request about 10 years ago

ok, nice clean up