Tagged for release 2.17.90.V_2_17_90

svn path=/tags/V_2_17_90/; revision=3963

1 files changed, 42 insertions, 0 deletions

diff --git a/trunk/browser-plugin/README b/trunk/browser-plugin/README
new file mode 100644
index 000000000..26abf0692
--- /dev/null
+++ b/trunk/browser-plugin/README
@@ -0,0 +1,42 @@
+Notes on the plugin's internals
+===============================
+
+
+Envars of interest
+===================
+
+export TOTEM_EMBEDDED_DEBUG_SYNC=1
+- Pass --sync to the totem-plugin-viewer
+
+export TOTEM_EMBEDDED_DEBUG_FATAL=1
+- Pass --g-fatal-warnings to the totem-plugin-viewer
+
+export TOTEM_EMBEDDED_GDB=1
+- Launch a gdb session inside an xterm to capture crashes and errors
+  from the totem-plugin-viewer
+
+export MOZ_PLUGIN_PATH=`pwd`
+- Mozilla/Gecko/Firefox envar to lookup the browser plugins in the current
+  directory
+
+Special topics: Complex plugin
+==============================
+
+The complex plugin supports multiple plugins working together, see
+[http://service.real.com/help/library/guides/realone/ProductionGuide/HTML/realpgd.htm?page=htmfiles/embed.htm].
+
+To implement this, we maintain a list of totem complex plugins.
+The plugins are partitioned into classes by their 'console' name; and a
+random plugin (well, the first one instantiated) is chosen as representant.
+This one owns the plugin viewer and all viewer interaction of the linked plugins
+are done trough it. When this plugin is destroyed, we search for a new
+representant, transfer the viewer ownership to it and update the representant
+pointer in all of the classes' plugins.
+
+Special topics: NarrowSpace plugin
+==================================
+
+The NarrowSpace plugin currently handles only a small portions of the possible
+PARAMETERS possible:
+http://www.apple.com/quicktime/tutorials/embed2.html
+