docs/faq/: Faq review and update.
authorStefan Kost <ensonic@users.sourceforge.net>
Thu, 16 Mar 2006 15:33:55 +0000 (15:33 +0000)
committerStefan Kost <ensonic@users.sourceforge.net>
Thu, 16 Mar 2006 15:33:55 +0000 (15:33 +0000)
Original commit message from CVS:
* docs/faq/cvs.xml:
* docs/faq/dependencies.xml:
* docs/faq/developing.xml:
* docs/faq/faq.xml:
* docs/faq/general.xml:
* docs/faq/getting.xml:
* docs/faq/legal.xml:
* docs/faq/troubleshooting.xml:
* docs/faq/using.xml:
Faq review and update.

ChangeLog
docs/faq/cvs.xml
docs/faq/dependencies.xml
docs/faq/developing.xml
docs/faq/faq.xml
docs/faq/general.xml
docs/faq/getting.xml
docs/faq/legal.xml
docs/faq/troubleshooting.xml
docs/faq/using.xml

index 7adcc8751e89fa9a0d93a37b6f7910a24bfefa89..c7ef1fa1d884121418b97007d4e377a13163dddc 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,16 @@
+2006-03-16  Stefan Kost  <ensonic@users.sf.net>
+
+       * docs/faq/cvs.xml:
+       * docs/faq/dependencies.xml:
+       * docs/faq/developing.xml:
+       * docs/faq/faq.xml:
+       * docs/faq/general.xml:
+       * docs/faq/getting.xml:
+       * docs/faq/legal.xml:
+       * docs/faq/troubleshooting.xml:
+       * docs/faq/using.xml:
+       Faq review and update.
+
 2006-03-16  Jan Schmidt  <thaytan@mad.scientist.com>
 
        * gst/gstpad.c: (gst_pad_accept_caps), (gst_pad_alloc_buffer_full),
index 7d7800b252e63fe55d05f527c915405fcd652f5c..72d1f1da03838b421f2eff65ec7369f749dff0a5 100644 (file)
@@ -1,6 +1,6 @@
 <sect1 id="chapter-cvs">
   <title id="title-cvs">Building GStreamer from CVS</title>
-  <qandaset>
+  <qandaset defaultlabel="qanda">
 
     <qandaentry>
       <question id="cvs-anon">
@@ -18,12 +18,16 @@ the core, and "gst-plugins", containing the basic set of plugins.
         <para>
 To check out the HEAD version of the core, use
 <programlisting>
- cvs -d:pserver:anoncvs@cvs.freedesktop.org:/cvs/gstreamer co gstreamer
+ cvs -d:pserver:anoncvs@anoncvs.freedesktop.org:/cvs/gstreamer co gstreamer
 </programlisting>
 This will create a directory "gstreamer" in your current directory.
 If you want to get another module, replace the last "gstreamer" with the
 name of the module.
         </para>
+        <para>
+The <ulink url="http://gstreamer.freedesktop.org/modules/">modules page</ulink>
+has a list of active ones together with a short description.
+        </para>
       </answer>
     </qandaentry>
 
@@ -61,8 +65,8 @@ Once you have all these items, see <ulink url="http://freedesktop.org/wiki/Accou
 
     <qandaentry>
       <question id="autogen-libtool">
+        <label>I ran autogen.sh, but it fails with aclocal errors. What's wrong ?</label>
         <para>
-I ran autogen.sh, but it fails with something like this:
 <programlisting>
 + running aclocal -I m4 -I common/m4 ...
 aclocal: configure.ac: 8: macro `AM_DISABLE_STATIC' not found in library
index 488144ee2d2abaae8acb1f76409e346f42f4988f..9e1e6b34afb256f03ab813d0ba88a6b2c792f3c6 100644 (file)
@@ -1,6 +1,6 @@
 <sect1 id="chapter-dependencies">
   <title id="title-dependencies">Dependencies</title>
-  <qandaset>
+  <qandaset defaultlabel="qanda">
 
     <qandaentry>
       <question id="dependencies-why-so-many">
@@ -18,7 +18,7 @@ the code others have written.
         <para>
 However, do realize that in no way you are forced to have all dependencies
 installed.  None of the core developers has all of them installed.  GStreamer
-has only a few obligate dependencies : GLib 2.0, popt >= 1.6.0, and very
+has only a few obligate dependencies : GLib 2.0, liboil, and very
 common stuff like glibc, a C compiler, and so on.  All of the other
 dependencies are optional.
         </para>
index 803967d4e30d31f03055d1f31c6127ff680d25c5..757b2ca75cf0b99eabbb263fb6b385a72c2a588b 100644 (file)
@@ -1,7 +1,6 @@
 <sect1 id="chapter-developing">
   <title id="title-developing">Developing applications with GStreamer</title>
-
-  <qandaset>
+  <qandaset defaultlabel="qanda">
 
     <qandaentry>
       <question id="developing-compile-programs">
@@ -52,8 +51,8 @@ The easiest way to do this is to use a script like this (for bash):
 &gst-uninstalled;
 </programlisting>
 If you put this script in your path, and symlink it to gst-cvs (if you want
-to develop against cvs HEAD) or to gst-0.6 (if you want to develop against the
-0.6 branch), it will automatically use the uninstalled version from that
+to develop against cvs HEAD) or to gst-0.8 (if you want to develop against the
+0.8 branch), it will automatically use the uninstalled version from that
 directory.
         </para>
         <para>
@@ -70,8 +69,7 @@ before any installed copies.
       </answer>
     </qandaentry>
 
-     
-     <qandaentry>
+    <qandaentry>
       <question id="developing-gconf">
         <para>How can I use GConf to get the system-wide defaults ?</para>
       </question>
@@ -121,7 +119,7 @@ When you link a program against uninstalled GStreamer using libtool,
 funny shell scripts are made to modify your shared object search path 
 and then run your program. For instance, to debug gst-launch, try 
 <programlisting>
-libtool gdb /path/to/gstreamer-launch
+libtool --mode=execute gdb /path/to/gst-launch
 </programlisting>. 
 If this does not work, you're probably using a broken version of libtool. 
         </para>
@@ -136,7 +134,7 @@ If this does not work, you're probably using a broken version of libtool.
       <answer>
         <para>
 Our main arena for coordination and discussion is IRC, not email. 
-Join us in #gstreamer on irc.freenode.net
+Join us in <ulink url="irc://irc.freenode.net/#gstreamer">#gstreamer on irc.freenode.net</ulink>
 For larger picture questions or getting more input from more persons,
 a mail to gstreamer-devel is never a bad idea.
 However, we do archive our IRC discussions, which you may find in the 
index c6f34a909b586adba4a8756179a26f68d750b38c..6c9b567dd40c8daef2b64d6ae0fb458844f753a4 100644 (file)
     </abstract>
     
     <revhistory>
+      <revision>
+        <revnumber>0.2.0</revnumber>
+        <date>2006-03-16</date>
+        <revremark>Review and update whole document.</revremark>
+      </revision>
+
       <revision>
         <revnumber>0.1.1</revnumber>
         <date>2003-04-24</date>
index b1230ba1af8fd67c8cf6613099ff2e8e27d3bbbd..6417ab56be7cf1c7434a5680a1df5a10d5b4a7d5 100644 (file)
@@ -1,6 +1,6 @@
 <sect1 id="chapter-general">
   <title id="title-general">General</title>
-  <qandaset>
+  <qandaset defaultlabel="qanda">
 
     <qandaentry>
       <question id="general-media-player">
@@ -57,12 +57,14 @@ not, don't bother us; we're working :-)
       </question>
       <answer>
         <para>
-GStreamer is still very early in its development, but already we see some 
-really nice applications being developed in parallel with GStreamer. 
-Both gst-player and gst-editor are very closely linked to GStreamer itself
-for obvious reasons.
-<!-- For a list of some of the more advanced projects, look at the list
-in our <ulink url="http://gstreamer.net/status/">Status table</ulink>. -->
+Many media player applications have chosen GStreamer for their backend. 
+Also a couple of media format conversion tools have been written using the powers of GStreamer.
+With the advent of GStreamer-0.10 several media editing applications have been started.
+        </para>
+        <para>
+For a list of projects, look at the
+<ulink url="http://gstreamer.freedesktop.org/apps/">application list</ulink>
+on the GStreamer project website.
         </para>
       </answer>
     </qandaentry>
@@ -139,8 +141,9 @@ Will GStreamer be available for platforms other than Unix ?
       </question>
       <answer>
         <para>
-Depends. Our main target is the Unix platform. That said, interest has been 
-expressed in porting GStreamer to other platforms and the GStreamer core 
+Depends. Our main target is the Unix platform. It also works on Win32 and Mac OS X,
+but it may still be a bit challenging to get everything up and running.  
+That said, interest has been expressed in porting GStreamer to other platforms and the GStreamer core 
 team will gladly accept patches to accomplish this.
 <!-- Please refer to the
 <ulink url="http://gstreamer.net/status/?category=7">
@@ -157,10 +160,10 @@ platform support status table</ulink> -->
         <para>
 While GStreamer is operated as an independent project, we do have a close 
 relationship with the GNOME community. Many of our hackers consider 
-themselves also to be members of the GNOME community. There are plans to 
-make (some part of) GStreamer an official part of the development framework 
-of GNOME.  This does not exclude use of GStreamer by other communities at
-all, of course.
+themselves also to be members of the GNOME community.
+GStreamer is officialy bundled with the GNOME desktop, as lots of packages
+(like gnome-media, totem and rhythmbox) are using it.
+This does not exclude use of GStreamer by other communities at all, of course.
         </para>
       </answer>
     </qandaentry>
@@ -173,11 +176,11 @@ all, of course.
         <para>
 The GStreamer community wants to have as good a relationship as possible 
 with KDE, and we hope that someday KDE decides to adopt GStreamer as their 
-multimedia API, just like the GNOME community plans on doing
+multimedia API (planned for KDE 4)
 There have been contacts from time to time between the GStreamer community 
 and KDE and we do already have support for the aRTSd sound server used by KDE.
-Also, some of the KDE hackers have created Qt bindings of GStreamer 
-and made a simple video player.
+Also, some of the KDE hackers have created Qt bindings of GStreamer, 
+made a simple video player and using it in some audio players (JuK and AmaroK).
         </para>
       </answer>
     </qandaentry>
index e931107af3dd460bab42c125303a56bdfcf16199..79731464bb98ab683fd99e0e84fd570e53bb5598 100644 (file)
@@ -1,6 +1,6 @@
 <sect1 id="chapter-getting">
   <title id="title-getting">Getting GStreamer</title>
-  <qandaset>
+  <qandaset defaultlabel="qanda">
 
     <qandaentry>
       <question id="getting-gstreamer">
index cf9b191c2be4c12d0e343897ac969313703e1549..6705a5e621dd54b82ec51ce09bf7df0933dac272 100644 (file)
@@ -12,7 +12,7 @@ in order to obtain clear and quotable answers.  These answers were certified
 by the FSF lawyer team and verified by FSF lawyer and law professor Eben Moglen.
   </para>
 
-  <qandaset>
+  <qandaset defaultlabel="qanda">
 
     <qandaentry>
       <question id="legal-distribute-three">
index d30544c2a874ebc6fce1b5a0170f6c0b74f1cef9..eb619daba994a66f5510273833a98d6187b5f7f5 100644 (file)
@@ -1,19 +1,21 @@
 <sect1 id="chapter-troubleshooting">
   <title id="title-troubleshooting">Troubleshooting GStreamer</title>
-  <qandaset>
+  <qandaset defaultlabel="qanda">
 
     <qandaentry>
       <question id="troubleshooting-undefined-behaviour">
-        <para>
+        <label>
 My GStreamer-based application crashes on startup with errors about unfound
-schedulers on the command-line. I get undefined behaviour as soon as any
-GStreamer element is being initialized.
+schedulers on the command-line.
+        </label>
+        <para>
+I get undefined behaviour as soon as anyGStreamer element is being initialized.
         </para>
       </question>
 
       <answer>
         <para>
-Your registry is probably missing, or it is outdated (i.e. not updated after
+If the application is using GStreamer-0.8 it might be that your registry is missing, or is outdated (i.e. not updated after
 a recent upgrade). Fix this by running gst-register yourself:
           <programlisting>
 gst-register
@@ -172,5 +174,26 @@ To provide a backtrace, you should
       </answer>
     </qandaentry>
 
+    <qandaentry>
+      <question id="troubleshooting-gst-register">
+        <para>
+On my system there is no gst-register command.
+        </para>
+      </question>
+
+      <answer>
+        <para>
+GStreamer version 0.9 and higher does not need this anymore. The registry will
+be rebuild automatically. If you suspect the registry is broken, just delete the
+<filename>registry.*.xml</filename> files under <filename>$HOME/.gstreamer-0.X/</filename>
+and run
+<programlisting>
+  gst-inspect
+</programlisting>
+to rebuild the registry. You might need to do this as root again for the system-wide registry.
+        </para>
+      </answer>
+    </qandaentry>
+    
   </qandaset>
 </sect1>
index 41d28207b0a39d459e52c69a7fda4753f2708966..db5c2c8a86aa8077e826789887978bba0adeec17 100644 (file)
@@ -1,6 +1,6 @@
 <sect1 id="chapter-using">
   <title id="title-using">Using GStreamer</title>
-  <qandaset>
+  <qandaset defaultlabel="qanda">
 
     <qandaentry>
       <question id="using-getting-started">