docs/faq/: Faq review and update.

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.
This commit is contained in:
Stefan Kost 2006-03-16 15:33:55 +00:00
parent f4987a5399
commit 0dbc4f8321
10 changed files with 84 additions and 37 deletions

View file

@ -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> 2006-03-16 Jan Schmidt <thaytan@mad.scientist.com>
* gst/gstpad.c: (gst_pad_accept_caps), (gst_pad_alloc_buffer_full), * gst/gstpad.c: (gst_pad_accept_caps), (gst_pad_alloc_buffer_full),

View file

@ -1,6 +1,6 @@
<sect1 id="chapter-cvs"> <sect1 id="chapter-cvs">
<title id="title-cvs">Building GStreamer from CVS</title> <title id="title-cvs">Building GStreamer from CVS</title>
<qandaset> <qandaset defaultlabel="qanda">
<qandaentry> <qandaentry>
<question id="cvs-anon"> <question id="cvs-anon">
@ -18,12 +18,16 @@ the core, and "gst-plugins", containing the basic set of plugins.
<para> <para>
To check out the HEAD version of the core, use To check out the HEAD version of the core, use
<programlisting> <programlisting>
cvs -d:pserver:anoncvs@cvs.freedesktop.org:/cvs/gstreamer co gstreamer cvs -d:pserver:anoncvs@anoncvs.freedesktop.org:/cvs/gstreamer co gstreamer
</programlisting> </programlisting>
This will create a directory "gstreamer" in your current directory. This will create a directory "gstreamer" in your current directory.
If you want to get another module, replace the last "gstreamer" with the If you want to get another module, replace the last "gstreamer" with the
name of the module. name of the module.
</para> </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> </answer>
</qandaentry> </qandaentry>
@ -61,8 +65,8 @@ Once you have all these items, see <ulink url="http://freedesktop.org/wiki/Accou
<qandaentry> <qandaentry>
<question id="autogen-libtool"> <question id="autogen-libtool">
<label>I ran autogen.sh, but it fails with aclocal errors. What's wrong ?</label>
<para> <para>
I ran autogen.sh, but it fails with something like this:
<programlisting> <programlisting>
+ running aclocal -I m4 -I common/m4 ... + running aclocal -I m4 -I common/m4 ...
aclocal: configure.ac: 8: macro `AM_DISABLE_STATIC' not found in library aclocal: configure.ac: 8: macro `AM_DISABLE_STATIC' not found in library

View file

@ -1,6 +1,6 @@
<sect1 id="chapter-dependencies"> <sect1 id="chapter-dependencies">
<title id="title-dependencies">Dependencies</title> <title id="title-dependencies">Dependencies</title>
<qandaset> <qandaset defaultlabel="qanda">
<qandaentry> <qandaentry>
<question id="dependencies-why-so-many"> <question id="dependencies-why-so-many">
@ -18,7 +18,7 @@ the code others have written.
<para> <para>
However, do realize that in no way you are forced to have all dependencies 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 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 common stuff like glibc, a C compiler, and so on. All of the other
dependencies are optional. dependencies are optional.
</para> </para>

View file

@ -1,7 +1,6 @@
<sect1 id="chapter-developing"> <sect1 id="chapter-developing">
<title id="title-developing">Developing applications with GStreamer</title> <title id="title-developing">Developing applications with GStreamer</title>
<qandaset defaultlabel="qanda">
<qandaset>
<qandaentry> <qandaentry>
<question id="developing-compile-programs"> <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; &gst-uninstalled;
</programlisting> </programlisting>
If you put this script in your path, and symlink it to gst-cvs (if you want 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 to develop against cvs HEAD) or to gst-0.8 (if you want to develop against the
0.6 branch), it will automatically use the uninstalled version from that 0.8 branch), it will automatically use the uninstalled version from that
directory. directory.
</para> </para>
<para> <para>
@ -70,8 +69,7 @@ before any installed copies.
</answer> </answer>
</qandaentry> </qandaentry>
<qandaentry>
<qandaentry>
<question id="developing-gconf"> <question id="developing-gconf">
<para>How can I use GConf to get the system-wide defaults ?</para> <para>How can I use GConf to get the system-wide defaults ?</para>
</question> </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 funny shell scripts are made to modify your shared object search path
and then run your program. For instance, to debug gst-launch, try and then run your program. For instance, to debug gst-launch, try
<programlisting> <programlisting>
libtool gdb /path/to/gstreamer-launch libtool --mode=execute gdb /path/to/gst-launch
</programlisting>. </programlisting>.
If this does not work, you're probably using a broken version of libtool. If this does not work, you're probably using a broken version of libtool.
</para> </para>
@ -136,7 +134,7 @@ If this does not work, you're probably using a broken version of libtool.
<answer> <answer>
<para> <para>
Our main arena for coordination and discussion is IRC, not email. 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, For larger picture questions or getting more input from more persons,
a mail to gstreamer-devel is never a bad idea. a mail to gstreamer-devel is never a bad idea.
However, we do archive our IRC discussions, which you may find in the However, we do archive our IRC discussions, which you may find in the

View file

@ -35,6 +35,12 @@
</abstract> </abstract>
<revhistory> <revhistory>
<revision>
<revnumber>0.2.0</revnumber>
<date>2006-03-16</date>
<revremark>Review and update whole document.</revremark>
</revision>
<revision> <revision>
<revnumber>0.1.1</revnumber> <revnumber>0.1.1</revnumber>
<date>2003-04-24</date> <date>2003-04-24</date>

View file

@ -1,6 +1,6 @@
<sect1 id="chapter-general"> <sect1 id="chapter-general">
<title id="title-general">General</title> <title id="title-general">General</title>
<qandaset> <qandaset defaultlabel="qanda">
<qandaentry> <qandaentry>
<question id="general-media-player"> <question id="general-media-player">
@ -57,12 +57,14 @@ not, don't bother us; we're working :-)
</question> </question>
<answer> <answer>
<para> <para>
GStreamer is still very early in its development, but already we see some Many media player applications have chosen GStreamer for their backend.
really nice applications being developed in parallel with GStreamer. Also a couple of media format conversion tools have been written using the powers of GStreamer.
Both gst-player and gst-editor are very closely linked to GStreamer itself With the advent of GStreamer-0.10 several media editing applications have been started.
for obvious reasons. </para>
<!-- For a list of some of the more advanced projects, look at the list <para>
in our <ulink url="http://gstreamer.net/status/">Status table</ulink>. --> For a list of projects, look at the
<ulink url="http://gstreamer.freedesktop.org/apps/">application list</ulink>
on the GStreamer project website.
</para> </para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -139,8 +141,9 @@ Will GStreamer be available for platforms other than Unix ?
</question> </question>
<answer> <answer>
<para> <para>
Depends. Our main target is the Unix platform. That said, interest has been Depends. Our main target is the Unix platform. It also works on Win32 and Mac OS X,
expressed in porting GStreamer to other platforms and the GStreamer core 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. team will gladly accept patches to accomplish this.
<!-- Please refer to the <!-- Please refer to the
<ulink url="http://gstreamer.net/status/?category=7"> <ulink url="http://gstreamer.net/status/?category=7">
@ -157,10 +160,10 @@ platform support status table</ulink> -->
<para> <para>
While GStreamer is operated as an independent project, we do have a close While GStreamer is operated as an independent project, we do have a close
relationship with the GNOME community. Many of our hackers consider relationship with the GNOME community. Many of our hackers consider
themselves also to be members of the GNOME community. There are plans to themselves also to be members of the GNOME community.
make (some part of) GStreamer an official part of the development framework GStreamer is officialy bundled with the GNOME desktop, as lots of packages
of GNOME. This does not exclude use of GStreamer by other communities at (like gnome-media, totem and rhythmbox) are using it.
all, of course. This does not exclude use of GStreamer by other communities at all, of course.
</para> </para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -173,11 +176,11 @@ all, of course.
<para> <para>
The GStreamer community wants to have as good a relationship as possible 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 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 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. 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 Also, some of the KDE hackers have created Qt bindings of GStreamer,
and made a simple video player. made a simple video player and using it in some audio players (JuK and AmaroK).
</para> </para>
</answer> </answer>
</qandaentry> </qandaentry>

View file

@ -1,6 +1,6 @@
<sect1 id="chapter-getting"> <sect1 id="chapter-getting">
<title id="title-getting">Getting GStreamer</title> <title id="title-getting">Getting GStreamer</title>
<qandaset> <qandaset defaultlabel="qanda">
<qandaentry> <qandaentry>
<question id="getting-gstreamer"> <question id="getting-gstreamer">

View 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. by the FSF lawyer team and verified by FSF lawyer and law professor Eben Moglen.
</para> </para>
<qandaset> <qandaset defaultlabel="qanda">
<qandaentry> <qandaentry>
<question id="legal-distribute-three"> <question id="legal-distribute-three">

View file

@ -1,19 +1,21 @@
<sect1 id="chapter-troubleshooting"> <sect1 id="chapter-troubleshooting">
<title id="title-troubleshooting">Troubleshooting GStreamer</title> <title id="title-troubleshooting">Troubleshooting GStreamer</title>
<qandaset> <qandaset defaultlabel="qanda">
<qandaentry> <qandaentry>
<question id="troubleshooting-undefined-behaviour"> <question id="troubleshooting-undefined-behaviour">
<para> <label>
My GStreamer-based application crashes on startup with errors about unfound My GStreamer-based application crashes on startup with errors about unfound
schedulers on the command-line. I get undefined behaviour as soon as any schedulers on the command-line.
GStreamer element is being initialized. </label>
<para>
I get undefined behaviour as soon as anyGStreamer element is being initialized.
</para> </para>
</question> </question>
<answer> <answer>
<para> <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: a recent upgrade). Fix this by running gst-register yourself:
<programlisting> <programlisting>
gst-register gst-register
@ -172,5 +174,26 @@ To provide a backtrace, you should
</answer> </answer>
</qandaentry> </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> </qandaset>
</sect1> </sect1>

View file

@ -1,6 +1,6 @@
<sect1 id="chapter-using"> <sect1 id="chapter-using">
<title id="title-using">Using GStreamer</title> <title id="title-using">Using GStreamer</title>
<qandaset> <qandaset defaultlabel="qanda">
<qandaentry> <qandaentry>
<question id="using-getting-started"> <question id="using-getting-started">