diff --git a/ChangeLog b/ChangeLog index a1b704902e..1272ccbd82 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,24 @@ +2005-10-08 Thomas Vander Stichele + + * docs/Makefile.am: + * docs/gst/Makefile.am: + * docs/gst/gstreamer-docs.sgml: + * docs/gst/running.xml: + * docs/version.entities.in: + add a chapter on running GStreamer. + document GST_DEBUG and GST_PLUGIN* env vars + +2005-10-08 Thomas Vander Stichele + + * Makefile.am: + remove include dir + * configure.ac: + remove PLUGINS_BUILDDIR stuff + * gst/gst.c: (init_post): + reorder parsing of GST_PLUGIN_PATH and GST_PLUGIN_SYSTEM_PATH + * idiottest.mak: + remove, it was condescending and not needed + 2005-10-08 Wim Taymans * gst/base/gstbasesink.c: (gst_base_sink_preroll_queue_flush), diff --git a/docs/Makefile.am b/docs/Makefile.am index 55b089a137..521371f19b 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -10,6 +10,8 @@ else SUBDIRS_DOCBOOK = endif +BUILT_SOURCES = version.entities + SUBDIRS = $(SUBDIRS_DOCBOOK) $(SUBDIRS_GTK_DOC) DIST_SUBDIRS = gst faq manual pwg libs xsl diff --git a/docs/gst/Makefile.am b/docs/gst/Makefile.am index 2ee7f7b731..0aa8510e07 100644 --- a/docs/gst/Makefile.am +++ b/docs/gst/Makefile.am @@ -99,7 +99,7 @@ IGNORE_HFILES= \ HTML_IMAGES = # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = +content_files = running.xml # Other files to distribute. extra_files = diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 635d6ab4e8..818e6c4edb 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -78,6 +78,8 @@ + + ]> @@ -87,6 +89,26 @@ + + GStreamer Overview + +GStreamer is a streaming media framework. +It uses graphs of elements which operate on data. +The functionality to process media is provided by plug-ins which provide +features like elements, typefinding, and so on. +This allows new functionality to be added simply by installing new plug-ins. + + + +GStreamer is cross-platform and works on most UNIX-like platforms as well as +Windows. It is released under the GNU Library General Public License +(GNU LGPL). + + + &gst-Running; + + + GStreamer Core Library diff --git a/docs/gst/running.xml b/docs/gst/running.xml new file mode 100644 index 0000000000..4ea923e3d1 --- /dev/null +++ b/docs/gst/running.xml @@ -0,0 +1,172 @@ + + +Running GStreamer Applications +3 +GStreamer Core + + + +Running GStreamer Applications + +How to run and debug your GStreamer application + + + + +Running and debugging GStreamer Applications + + +Environment variables + + +GStreamer inspects a few of environment variables in addition to standard +variables like LANG, PATH or HOME. + + + + <envar>GST_PLUGIN_SYSTEM_PATH</envar> + + + +This environment variable can be set to a colon-separated list of paths. +If this variable is not set, GStreamer will fill in this list for you +with + + + +plug-ins in the user's home directory. These are stored in a directory called +plugins inside the +.gstreamer-&GST_MAJORMINOR; directory in the user's +home directory. + + + + +plug-ins installed system-wide. On this system, they are stored in +&GST_PLUGINS_DIR;. + + + + + + + +GStreamer will scan these paths for GStreamer plug-ins. These plug-ins will +be loaded after the plug-ins in the GST_PLUGIN_PATH variable below. + +The paths are scanned in the given order. This allows a user to override +system-installed plug-ins with his own versions. + + + +Setting this variable to an empty string will cause GStreamer not to scan any +system paths at all for plug-ins. This can be useful if you're running +uninstalled (for development purposes) or while running testsuites. + + + + + + <envar>GST_PLUGIN_PATH</envar> + + +This environment variable can be set to a colon-separated list of paths. +GStreamer will scan these paths for GStreamer plug-ins. These plug-ins will +be loaded in addition to, and before, the plug-ins in the system paths. + + + + + + <envar>GST_DEBUG</envar> + + +If GStreamer has been configured with , +this variable can be set to a list of debug options, which cause GStreamer +to print out different types of debugging information to stderr. + + +The variable takes a comma-separated list of "category_name:level" pairs +to set specific levels for the individual categories. +The level value ranges from 0 (nothing) to 5 (LOG). + + + + 1 - + + +Logs all fatal errors. These are errors that do not allow the core or elements +to perform the requested action. The application can still recover if +programmed to handle the conditions that triggered the error. + + + + + + 2 - + + +Logs all warnings. Typically these are non-fatal, but user-visible problems +are expected to happen. + + + + + + 3 - + + +Logs all informational messages. These are typically used for events in +the system that only happen once, or are important and rare enough to be +logged at this level. + + + + + + 4 - + + +Logs all debug messages. These are general debug messages for events +that happen only a limited number of times during an object's lifetime; +these include setup, teardown, change of parameters, ... + + + + + + 5 - + + +Logs all log messages. These are messages for events +that happen repeatedly during an object's lifetime; +these include streaming and steady-state conditions. + + + + + + The category_name can contain " as a wildcard. + + + +For example, setting GST_DEBUG to +, will cause the + category to be logged at full + level, while all categories starting with + will be logged at level. + + + +To get all possible debug output, set +GST_DEBUG +to + + + + + + + + + diff --git a/docs/version.entities.in b/docs/version.entities.in index 79a68981d5..17fdda64c3 100644 --- a/docs/version.entities.in +++ b/docs/version.entities.in @@ -1,2 +1,3 @@ - + + diff --git a/idiottest.mak b/idiottest.mak deleted file mode 100644 index 45c96aec0d..0000000000 --- a/idiottest.mak +++ /dev/null @@ -1,15 +0,0 @@ -# Idiot test to stop the installing of versions with plugin builddir enabled -install-exec-local: -if PLUGINS_USE_BUILDDIR - @echo "*** ERROR: Cannot install:" - @echo "GStreamer was configured using the --enable-plugin-builddir option." - @echo - @echo "This option is for development purposes only: binaries built with" - @echo "it should be used with code in the build tree only. To build an" - @echo "installable version, use ./configure without the --enable-plugin-builddir" - @echo "option. Note that the autogen.sh script supplies the plugin builddir" - @echo "option automatically - it cannot be used to configure installable builds." - @echo - @/bin/false -endif -