intf.xml 6.19 KB
Newer Older
Clément Stenac's avatar
Clément Stenac committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
<?xml version="1.0" encoding="UTF-8" ?>

<sect1><title>
Interface modules
</title>

<para>
These modules allow you to choose the interface
or interfaces you want to use (either graphical or control
interfaces).
</para>

<sect2><title>dummy</title>
&always;
<para>
Use this interface when you want
<emphasis>no</emphasis> interface! That is you just want to give a
self-contained command-line string.</para>

<para>
For example:

<screen>
<prompt>% </prompt><userinput>vlc --intf dummy vcd://</userinput>
</screen>
</para>
</sect2>

<sect2><title>gestures</title>
&always;
<para>
This module allows you to control VLC via mouse
gestures
.</para>
&options-st;
<itemizedlist>
<listitem>
<para><emphasis>--gestures-threshold </emphasis>:
The integer argument is the threshold of move
required for a mouse gesture to be recorded
</para></listitem>
<listitem><para><emphasis>--gestures-button {left,middle,right} </emphasis>:
The button to click before a gesture
</para>
</listitem>
</itemizedlist>
</sect2>

<sect2><title>gnome</title>
&disabled;
&linux-only;
<para>
This is the Gnome interface. It needs gnome libraries
(<emphasis>libgnome32</emphasis> package under Debian) and headers
(<emphasis>libgnome-dev</emphasis> package under Debian) if you wish to
compile it. Warning: this interface is no longer maintained, and outdated
.</para>
&options-st;
<itemizedlist>
<listitem>
<para><emphasis>--gnome-tooltips, --no-gnome-tooltips </emphasis>:
Whether to show tooltips (default enabled)
</para></listitem>
<listitem><para><emphasis>--gnome-toolbartext, --no-gnome-toolbartext </emphasis>:
Whether to show text on buttons (default enabled)
</para></listitem>
<listitem><para><emphasis>--gnome-prefs-maxh </emphasis>:
Argument is an integer that gives the maximum
	height for configuration windows
</para>
</listitem>
</itemizedlist>
</sect2>

<sect2><title>gtk</title>
&enabled;
<para>
This is the GTK+ interface. It needs gtk libraries
and headers files if you are compiling it. Note that it can also be used
under Windows. Warning: this interface is no longer maintained, and outdated
.</para>
</sect2>

<sect2><title>http</title>
&always;
<para>
This module allows you to remote control your VLC
via a web browser. You can create custom web pages.
.</para>
&options-st;
<itemizedlist>
<listitem>
<para><emphasis>--http-host </emphasis>:
The argument, a string, gives the host address. 
It must look like address[:port], where address can be an IP address 
or a DNS name, and port is the port on which the HTTP interface
will be available (default is 8080). Default address is localhost, 
which will be ok for almost everybody
</para></listitem>
<listitem><para><emphasis>--http-src </emphasis>:
Gives the path to the HTML pages to be served.
</para></listitem></itemizedlist>
</sect2>

<sect2><title>joystick</title>
&disabled;
&linux-only;
<para>
This module allows you to control VLC via a joystick
with many options.
.</para></sect2>

<sect2><title>kde</title>
&disabled;
&linux-only;
<para>
This is the KDE interface module. You will need the libraries
(<emphasis>kdelibs3</emphasis> package on Debian) and headers
(<emphasis>kde-devel</emphasis> package under Debian) if you wish to
compile it. Warning: this interface is no longer maintained, and outdated
.</para>
&options-st;
<itemizedlist>
<listitem>
<para><emphasis>--kde-uirc </emphasis>:
Path to the <filename>ui.rc</filename> file
</para>
</listitem>
</itemizedlist>
</sect2>

<sect2><title>lirc</title>
&disabled;
&linux-only;
<para>
This interface module allows you to control VLC
through a remote. A lircrc example is provided to help you configure it
to your remote (see <filename>doc/lirc/example.lircrc</filename>)
.</para></sect2>

<sect2><title>ncurses</title>
&disabled;
&linux-only;
<para>
This is a text interface, using ncurses library.
You will need ncurses headers if you want to compile it
(<emphasis>libncurses5-dev</emphasis> package on Debian)
.</para></sect2>

<sect2><title>opie</title>
&disabled;
<para>
This is an interface plugin for the Qt Embedded
library (iPaq graphical library)
.</para></sect2>

<sect2><title>qt</title>
&disabled;
<para>
This is the QT interface module. You will need the libraries
(<emphasis>libqt2</emphasis> package under Debian) and headers
(<emphasis>libqt-dev</emphasis> package under Debian) if you wish to
compile it. Warning: this interface is no longer maintained, and outdated
.</para></sect2>

<sect2><title>rc</title>
&always;
<para>
This is the Remote Control interface module. It allows you
to control VLC via commands, such as <emphasis>play</emphasis>,
<emphasis>stop</emphasis>, etc... or via a script. This interface is
text-based, so you should use it when you are in console mode
.</para>
&options-st;
<itemizedlist>
<listitem>
<para><emphasis>--rc-show-pos, --no-rc-show-pos </emphasis> :
Indicates whether the position in the stream
must be shown (outputs one timer line every seconds) (default
disabled)
</para></listitem>
<listitem><para><emphasis>--fake-tty, --no-fake-tty </emphasis>:
Enables or disables TTY virtual terminal
emulation (default disabled)
</para>
</listitem>
</itemizedlist>
</sect2>

<sect2><title>skins</title>
&enabled;
<para>
This skinnable interface module works under Win32
and X11. You can create your own skins very easily with XML files
.</para>
&options-st;
<itemizedlist>
<listitem>
  <para><emphasis>--skin_last</emphasis> :
    This option allows you to specify the last used skin
     (the argument is a string).
  </para></listitem>
  <listitem><para><emphasis>--skin_config</emphasis> :
    This allows you to set the skin configuration
     (the argument is a string).
  </para></listitem>
  <listitem><para><emphasis>--show_in_tray, --noshow_in_tray</emphasis> :
    Indicates whether the application must  
     be shown in traybar (default disabled).
  </para></listitem>
  <listitem><para><emphasis>
	--show_in_taskbar, --noshow_in_taskbar</emphasis> :
    Indicates whether the application must  
     be shown in the taskbar (default enabled).
  </para>
 </listitem>
</itemizedlist>
</sect2>

<sect2><title>wxwindows</title>
&enabled;
<para>
The wxWindows interface is a portable interface that
is currently working under GNU/Linux and Windows. It is now the most up-to-date
graphical interface available under both Windows and GNU/Linux
.</para></sect2>

</sect1>