diff options
Diffstat (limited to 'doc/faq')
| -rw-r--r-- | doc/faq/Makefile.am | 49 | ||||
| -rw-r--r-- | doc/faq/faq.docbook (renamed from doc/faq/faq.sgml) | 90 |
2 files changed, 78 insertions, 61 deletions
diff --git a/doc/faq/Makefile.am b/doc/faq/Makefile.am index 6090fd272..782f618c1 100644 --- a/doc/faq/Makefile.am +++ b/doc/faq/Makefile.am @@ -3,20 +3,14 @@ include $(top_srcdir)/misc/Makefile.common doc_DATA = faq.txt html_DATA = faq.html -EXTRA_DIST = README faq.sgml $(doc_DATA) $(html_DATA) +EXTRA_DIST = README faq.docbook $(doc_DATA) $(html_DATA) -docs: $(doc_DATA) $(html_DATA) +DISTCLEANFILES = $(doc_DATA) $(html_DATA) -distclean-local: clean-docs - -docs-prepare: $(srcdir)/faq.sgml - if test "$(srcdir)" != "." -a "$(srcdir)" != "`pwd`"; then \ - test -f ./faq.sgml -a ./faq.sgml -nt $(srcdir)/faq.sgml || cp $^ . ; \ - fi +docs: $(hackersguide_DATA) clean-docs: - rm -f $(doc_DATA) $(html_DATA) - test "x$(srcdir)" = x. || rm -f faq.sgml + rm -f $(hackersguide_DATA) dist-hook: @if test x"$(distcheck_lax)" = x ; then \ @@ -25,38 +19,23 @@ dist-hook: $(MAKE) docs ; \ fi -if HAVE_SGMLTOOLS -faq.html: faq.sgml - @$(MAKE) docs-prepare - $(SGMLTOOLS) -b onehtml faq.sgml; -else -faq.html: faq.sgml - @$(MAKE) docs-prepare - if test x"$(fail_if_missing)" = x"yes"; then \ - echo "Please install sgmltools-lite."; \ - exit 1; \ - fi - if test x"$(fail_if_missing)" != x"yes"; then \ - touch $@; \ - sleep 1; \ - touch $(notdir $^); \ - fi -endif +distclean-local: clean-docs + +if HAVE_XMLTO +faq.html: faq.docbook + xmlto html-nochunks $^ -if HAVE_SGMLTOOLS -faq.txt: faq.sgml - @$(MAKE) docs-prepare - $(SGMLTOOLS) -b txt faq.sgml; +faq.txt: faq.docbook + xmlto txt $^ else -faq.txt: faq.sgml - @$(MAKE) docs-prepare +faq.html faq.txt: faq.docbook if test x"$(fail_if_missing)" = x"yes"; then \ - echo "Please install sgmltools-lite."; \ + echo "Please install xmlto."; \ exit 1; \ fi if test x"$(fail_if_missing)" != x"yes"; then \ touch $@; \ sleep 1; \ - touch $(notdir $^); \ + touch $^; \ fi endif diff --git a/doc/faq/faq.sgml b/doc/faq/faq.docbook index 76cf5cb12..8d09441e1 100644 --- a/doc/faq/faq.sgml +++ b/doc/faq/faq.docbook @@ -1,4 +1,6 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "/usr/share/sgml/docbook/xml-dtd-4.4/docbookx.dtd" > <book> @@ -6,7 +8,7 @@ <title>The xine engine FAQ</title> <titleabbrev>xine FAQ</titleabbrev> <copyright> - <year>2001-2003</year> + <year>2001-2008</year> <holder>the xine project team</holder> </copyright> </bookinfo> @@ -128,14 +130,6 @@ <para> Currently, only xine-lib and gxine are present here. </para> - <para> - If you have patches for a module which is maintained using mercurial, - you can make them available as diffs - use <command>hg - export</command> for this - or via HTTP by using <command>hg - serve</command>. In the latter case, you'll need to post a URL from - which a developer can pull the changes. We prefer these methods since - we get proper attribution this way. - </para> </sect3> <sect3> <title>Checking out xine modules from CVS</title> @@ -150,10 +144,46 @@ </para> <para> If you want xine-lib or gxine, you should use Mercurial instead. + The CVS repositories for these are not maintained. </para> </sect3> </sect2> + <sect2 id="patch"> + <title>How do I submit patches?</title> + <para> + First, make sure that you're using a current development version + (see above) or at least the current release version. Then, once you're + ready to send the patch... + </para> + <para> + Generate your patch using either <command>cvs diff -u > + my.patch</command> or <command>hg diff > my.patch</command> (as + appropriate). Make sure that your message subject briefly describes the + patch; your message body should contain a longer description of the + patch. Your patch should be applicable using <command>patch -p0 -i + my.patch</command> or, preferably, <command>patch -p1 -i + my.patch</command> from the top-level directory in the source tree + (i.e. where configure.ac is) - this is fairly important for our + Mercurial-based repositories since it makes importing your patch that + much easier (hg import defaults to -p1). + </para> + <para> + Alternatively, if you've been hacking away at a module which is + maintained using mercurial, you can make them available as diffs - use + <command>hg export</command> or, if you have several patches, you could + use <command>hg bundle</command> instead (both require extra + parameters; <command>hg help export</command> and <command>hg help + bundle</command> for more details) - or via HTTP by using <command>hg + serve</command>. In the latter case, you'll need to post a URL from + which a developer can pull the changes. + </para> + <para> + Patches should normally be sent to the xine-devel mailing list, + <email>xine-devel@lists.sourceforge.net</email>. + </para> + </sect2> + <sect2 id="gnome-xine"> <title>Why is gxine's CVS module named "gnome-xine"?</title> <para> @@ -303,7 +333,7 @@ In case that you have a fresh CVS checkout, you will need to do the following first in order to get a tarball release out of it which you can later use with the <command>rpmbuild -ta</command> command above: - <screen> <command>./autogen.sh && make clean && make dist</command></screen> + <screen> <command>./autogen.sh && make clean && make dist</command></screen> </para> <para> In any case, please keep in mind that you have to build and install @@ -334,7 +364,7 @@ <screen> <command>cd ..</command> <command>ls *.deb</command> - <command>su - -c 'cd '"`pwd`"' && dpkg -i <DEB_PACKAGES>'</command> + <command>su - -c 'cd '"`pwd`"' && dpkg -i <DEB_PACKAGES>'</command> </screen> Ubuntu users will probably want to use this instead of that <command>su</command>: <screen> @@ -395,7 +425,7 @@ </sect2> <sect2 id="athlonflags"> - <title>Are there binaries for my AMD K7 (Athlon™) available? Can I build them?</title> + <title>Are there binaries for my AMD K7 (Athlon™) available? Can I build them?</title> <para> If you have a recent gcc you can try to compile "more" k7 support in (esp. better instruction scheduling). If the configure script should fail to @@ -498,10 +528,10 @@ <sect2 id="win32build"> <title>How to compile xine for Windows?</title> <para> - For compiling xine under Windows with MinGW, CygWin or MS Visual C see <ulink url="http://xine.cvs.sourceforge.net/*checkout*/xine/xine-lib/doc/README.WIN32"><filename>README.WIN32</filename></ulink>. + For compiling xine under Windows with MinGW, CygWin or MS Visual C see <ulink url="http://hg.debian.org/hg/xine-lib/xine-lib?cmd=file;file=doc/README.WIN32;filenode=-1;style=raw"><filename>README.WIN32</filename></ulink>. </para> <para> - For cross-compiling xine under comfortable unix-like environment with MinGW see <ulink url="http://xine.cvs.sourceforge.net/*checkout*/xine/xine-lib/doc/README.MINGWCROSS"><filename>README.MINGWCROSS</filename></ulink>. + For cross-compiling xine under comfortable unix-like environment with MinGW see <ulink url="http://hg.debian.org/hg/xine-lib/xine-lib?cmd=file;file=doc/README.MINGWCROSS;filenode=-1;style=raw"><filename>README.MINGWCROSS</filename></ulink>. </para> </sect2> @@ -918,7 +948,7 @@ Latest xine-lib modules (1-beta3 or newer) support external subtitles for any media file, not only AVI. In order to use it you can pass a special MRL construction like: - <screen> <command>xine test.mpg#subtitle:file.sub</command></screen> + <screen> <command>xine file://path/to/test.mpg#subtitle:/path/to/file.sub</command></screen> The external subtitles support can also be used by any xine frontend. Currently xine-ui and kaffeine implement this feature with a subtitle selection dialog. @@ -1121,6 +1151,10 @@ </ulink> </para> <para> + For recent kernels (2.6.x series) the raw devices are neither + needed nor supported anymore, so don't bother. + </para> + <para> To use raw devices, first connect a free raw device to your dvd device, use something like: <screen> <command>raw /dev/raw1 /dev/dvd</command></screen> @@ -1215,10 +1249,13 @@ <sect2 id="audiodrivers"> <title>What audio drivers does xine support? OSS? Alsa? Arts? Esd?</title> <para> - Currently xine support audio output via OSS (kernel audio drivers), - ALSA 0.9.x (ALSA 0.5.x is no longer supported), arts (KDE's sound daemon) - and esound (esd, gnome's sound daemon - not recommended because it has - serious issues with a/v sync). + Currently xine support audio output via OSS (Linux 2.4 and most + *BSD audio drivers), + ALSA 0.9 and 1.0 (ALSA 0.5.x is no longer supported), aRTs (KDE + 3's sound daemon), ESounD (esd, gnome's sound daemon not + recommended because it has serious issues with a/v sync), JACK, + PulseAudio, plus platform-specific output through Sun devices for + Solaris and NetBSD and Irix output. </para> </sect2> @@ -1288,7 +1325,8 @@ You can do this either in the config dialog while xine is running (press the config button on the xine panel and go to the AUDIO tab) or have it the complicated way by editing the config file yourself which is located - in your home directory in <filename>.gxine</filename> or <filename>.xine</filename>: + in your home directory in <filename>.config/gxine</filename> or + <filename>.xine</filename>: <programlisting> audio.output.speaker_arrangement:Surround 4.0 audio.output.speaker_arrangement:Surround 4.1 @@ -1301,8 +1339,8 @@ <para> xine can do that too. Pretty much the same story as for 4-/5-channel surround (see above). You can either use the config dialog or edit - the config file (<filename>~/.xine/config</filename> or <filename>~/.gxine/config</filename>) - yourself: + the config file (<filename>~/.xine/config</filename> or + <filename>~/.config/gxine/config</filename>) yourself: <programlisting> audio.output.speaker_arrangement:Pass Through</programlisting> </para> </sect2> @@ -1790,7 +1828,7 @@ </para> <para> Drivers that access hardware directly includes VIDIX (warning: requires - root priviledges or kernel helper) and SyncFB (requires kernel helper - Matrox only). + root priviledges or kernel helper). User may try one of those, but should be warned that with root access they can cause the system to crash hard. The support is also limited to a couple of graphics cards only. @@ -1830,8 +1868,8 @@ </para> <para> Unscaled OSD usage by subtitles and xine-ui is controlled by - the following settings - (<filename>~/.xine/config</filename> or <filename>~/.gxine/config</filename>): + the following settings (<filename>~/.xine/config</filename> or + <filename>~/.config/gxine/config</filename>): <programlisting> gui.osd_use_unscaled:0</programlisting> <programlisting> subtitles.separate.use_unscaled_osd:0</programlisting> </para> |