1mozplugger(7)          Miscellaneous Information Manual          mozplugger(7)
2
3
4

NAME

6       mozplugger - a streaming multimedia plugin for UNIX mozilla
7
8

DESCRIPTION

10       MozPlugger is a  Mozilla plugin which can show many types of multimedia
11       inside your Mozilla. To accomplish this, MozPlugger uses external  pro‐
12       grams such as mplayer, xanim, mtv, timidity and tracker.
13
14

CONFIGURE FILE

16       You  can  configure  mozplugger by changing the file mozpluggerrc which
17       can be located in any of the following directories:
18
19            $HOME/.netscape/
20            $HOME/.opera/
21            $MOZILLA_HOME/
22            $OPERA_HOME/
23            /usr/local/netscape/mozpluggerrc
24            /etc/mozpluggerrc
25            /usr/etc/mozpluggerrc
26            /usr/local/etc/mozpluggerrc
27
28
29       The format of mozpluggerrc is very simple. The  general  layout  is  to
30       have  one  or  more lines describing mime types followed by one or more
31       lines describing commands used to handle those mime types. Lines begin‐
32       ning  with  # are considered comments and are ignored. Here is a simple
33       example:
34
35            video/mpeg; mpeg; Mpeg video
36            video/quicktime; qt; Mpeg video
37                 : xanim +W$window -Zr +q +Ze +f $file
38
39       Each line describing a mime type has three fields:
40
41             mime type ; extensions ; description
42
43
44       mime type
45              The mime type is the standardized name for the content type  you
46              want MozPlugger to handle. This must be the same type as the web
47              server claims the file to be, or MozPlugger will not be used for
48              that file, regardless of the extension.
49
50       extensions
51              This  is  a  comma  separated  list of extensions that should be
52              associated with this particular mime type.  The  extensions  are
53              only used when a web server does not report what type of file it
54              is, or when loading files directly from disk.
55
56       description
57              This is the description that shows up in  about:plugins  and  in
58              the application preferences section in Mozilla.
59
60
61              Lines  that  describe  what  command to use for a mime type must
62              begin with a whitespace and have two fields:
63
64                    flags : command
65
66
67       flags  This is a comma-separated list of flags which  tells  mozplugger
68              how to handle this particular application. See below for further
69              details.
70
71       command
72              This is a command which is sent to /bin/sh  when  handling  this
73              mime type.
74
75
76

FINDING THE RIGHT COMMAND

78       When  MozPlugger is called from your browser, it looks through the con‐
79       figuration file and tries to find a matching mime type.  For an  appli‐
80       cation  to  be  chosen  it  has  to fulfill certain criteria, it has to
81       exist, and it must match the flags given to mozplugger.
82
83       When it does, it tries to figure out which command to use.   First,  it
84       looks  through all the commands for that particular mime type to see if
85       it can find an application that has the stream flag. If it cannot  find
86       a  streaming  application  it  downloads the file and tries again. Note
87       that MozPlugger will check the first word of  the  command  and  search
88       your  $PATH  for  that command. If that command is not found MozPlugger
89       will go to the next line in your mozpluggerrc.
90
91

FLAGS

93       repeat This indicates that the command uses the $repeat variable.
94
95       loop   This indicates  that  the  application  loops  forever.  If  the
96              <EMBED>  tag  used  to  start MozPlugger indicated that the file
97              should not loop forever, the command on this line  will  not  be
98              used.
99
100       stream This  indicates  that  this application can take an url. In this
101              case, the variable $file contains the URL of the  file  to  play
102              and the browser does not download it.
103
104       ignore_errors
105              This  flag  tells  MozPlugger  to  ignore the exit status of the
106              application.
107
108       noisy  This flag tells MozPlugger to redirect the stdout and stderr  of
109              the application to /dev/null.
110
111       nokill This  will  tell  MozPlugger  not to try to kill the application
112              when leaving the page. This is normally used for programs  which
113              start  in  their own window and can play multiple files, such as
114              xmms.
115
116       swallow ( name )
117              This is the only flag that takes an argument  so  far.  It  will
118              tell mozplugger that the application will open a window with the
119              specified name and that this window will then be moved to inside
120              your browser.
121
122       fill   This keyword is used to maximize an swallowed window.
123
124       maxaspect
125              This keyword is used to maximize an swallowed window while keep‐
126              ing the width/height ratio constant.
127
128       controls
129              This flag is typically used with audio files to display  a  con‐
130              troller  with the buttons play, pause and stop while playing. It
131              only works with EMBED tags.
132
133       embed, noembed
134              These flags can be used to define embed-only or full-window-only
135              commands.
136
137       hidden In  conjunction  with the swallow keyword, this tells the plugin
138              to swallow windows which are not visible yet.
139
140

VARIABLES

142       MozPlugger gives some variables to /bin/sh when starting  the  applica‐
143       tion, these variables are:
144
145
146       $repeats
147              This variable contains how many times the file should be played.
148              Applications which use this variable should also set the  repeat
149              flag.
150
151       $window
152              This  is  the X window Mozilla has given the plugin. This can be
153              used with applications  such  as  MPlayer  to  display  graphics
154              inside the mozilla window.
155
156       $width This is the horizontal resolution in pixels.
157
158       $height
159              This is the vertical resolution in pixels.
160
161       $file  This  is  the  file to play.  If the application uses the stream
162              flag, this this variable contains the URL of the file to play.
163
164       $mimetype
165              This variable contains the mime type of $file.
166
167       $VAR_<parameter_name>
168              All the parameters of the <EMBED> tags  are  made  available  in
169              mozpluggerrc  through  environment  variables.   For example the
170              parameter loop="1"  in  an  <EMBED>  tag  defines  the  variable
171              VAR_loop=1.
172
173

BUGS

175       You  have to remove ~/.netscape/plugin-list or ~/.mozilla/pluginreg.dat
176       after changing the configuration, or nothing will  happen.  This  is  a
177       Netscape/Mozilla bug, not a MozPlugger bug.
178
179       Netscape  3.x  will not play anything for <EMBED> tags for which height
180       or width are zero. This too is a Netscape bug.
181
182

AUTHORS

184       Fredrik Hübinette, hubbe@hubbe.net
185       Louis Bavoil, louis@bavoil.net
186
187
188
189                                                                 mozplugger(7)
Impressum