]> git.decadent.org.uk Git - videolink.git/blobdiff - README
Changed auto_kill_proc_closer to wait for the process to exit after killing it.
[videolink.git] / README
diff --git a/README b/README
index ec6534a8190cac81e355e5561b980675e26ab820..47125949b4a7a5c13435c6e8d60670dd80656aed 100644 (file)
--- a/README
+++ b/README
@@ -5,26 +5,23 @@ WebDVD is intended to provide a simple way of producing DVDs with
 attractive and usable menus.  It converts HTML pages into DVD menus by
 rendering them in Mozilla and reproducing their link structure.  This
 allows you to design DVDs using familiar HTML editing tools or your
-favourite text editor.  This very early version produces a set of
-files suitable for passing to the "dvdauthor" and "spumux" programs,
-but in future it is intended to run the necessary external programs
-automatically.
+favourite text editor.
 
 Requirements
 ------------
 
 WebDVD depends on the following software:
 
+- dvdauthor
 - Gtkmm 2.0
+- mjpegtools
 - Mozilla 1.7.x (later versions may work but are untested)
+- netpbm
 - Xvfb (from XFree86 or X.org)
 
 To build a complete DVD image you will also need:
 
-- dvdauthor
-- mjpegtools
 - mkisofs
-- netpbm
 
 You will also need a program such as ffmpeg or mencoder for producing
 DVD-suitable MPEG-1 or MPEG-2 video files.
@@ -32,47 +29,31 @@ DVD-suitable MPEG-1 or MPEG-2 video files.
 Usage
 -----
 
-Run "webdvd URL" where URL is the URL for the page that is to be the
-top menu of the DVD.  It will automatically follow links to other
-pages and to video files, rendering each page.  You must be careful
-not to link to pages that you do not want to appear on the disc, such
-as normal web sites.
-
-By default, webdvd uses a frame size of 720x576, which is suitable for
-PAL DVDs.  If you wish to produce NTSC DVDs you must override this
-by adding the option "-geometry 720x480".
-
-This will create the following files (with NNNNNN replaced with each
-successive page number):
-
-- webdvd.dvdauthor: This is an XML file to be passed to dvdauthor.
-- page_NNNNNN.spumux: These are XML files to be passed to spumux.
-- page_NNNNNN_back.png: This is a static image of the page, which
-  becomes the menu background.
-- page_NNNNNN_links.png: This is an image of the change in appearance
-  of each link when the pointer is over it.
-
-Currently, you must run commands along the following lines to produce
-a complete DVD image:
-
-for spumux in page_??????.spumux; do
-    page=$(basename $spumux .spumux)
-    pngtopnm ${page}_back.png                              \
-    | ppmtoy4m -v0 -n 1 -F 25:1 -A 59:54 -I p -S 420_mpeg2 \
-    | mpeg2enc -v0 -f 8 -a 2 -o /dev/stdout                \
-    | mplex -v0 -f 8 -o /dev/stdout /dev/stdin             \
-    | spumux -v0 -m dvd $spumux > ${page}.vob
-done
-rm -rf dvd-temp
-dvdauthor -o dvd-temp -x webdvd.dvdauthor
-mkisofs -dvd-video dvd-temp >dvd.iso
-rm -rf dvd-temp
-
-Adjust the name of the temporary directory (here "dvd-temp") and the
-output file ("dvd.iso") as you please.
-
-If you are using NTSC video, you will need to change the ppmtoy4m
-parameters.  Use "-F 30000:1001 -A 10:11" instead of "-F 25:1 -A 59:54".
+Design your DVD menus as a series of HTML pages linking to each other
+and to MPEG-1/2 videos that are suitable for use on a DVD.  Currently
+the videos must be local files with filenames ending in ".vob", but no
+such restrictions apply to the HTML pages.  You must be careful not to
+link to pages that you do not want to appear on the disc, such as
+normal web sites.  Also note the limitations listed below.
+
+By default, webdvd generates PAL/SECAM video.  If you wish to produce
+NTSC DVDs you can override this by adding the option "--video-std ntsc"
+to the following commands.
+
+To get a rough preview of the menus, run "webdvd --preview menu-url"
+where menu-url is the URL or filename of the first page to show.
+Currently videos cannot be displayed in this preview mode.
+
+To create a DVD filesystem, run "webdvd menu-url output-dir" where
+menu-url is the URL or filename of the top menu page and output-dir is
+the directory in which to create the filesystem (which should be
+either nonexistent or empty).  WebDVD will automatically follow links
+to the other pages and to the video files.
+
+If this is successful you can then use mkisofs to create a DVD image
+from the output directory.  Alternately you can write this directory
+directly to a writable DVD with growisofs or with mkisofs piped to a
+suitable version of cdrecord.
 
 Limitations
 -----------
@@ -84,6 +65,10 @@ than the visible area of a normal TV.  For this reason WebDVD applies
 a stylesheet to all pages that adds 50-60 pixels of padding on all
 sides of the body.
 
+DVD players do not have "back" buttons, so you should generally
+provide links to "higher" menu pages.  However, they do have a button
+for returning to the top menu.
+
 WebDVD sends a "mouseover" event for each link and sets it into its
 "hover" state, then records how this changes its appearance.  This
 change is then shown when the corresponding button on the DVD menu is