Skip to content

GitLab

Commit f29c9316 authored by Rocky Bernstein's avatar Rocky Bernstein
Browse files
Options

Add description of dummy interface. Order interface sections.

parent 8d8d97f5
Hide whitespace changes
Inline Side-by-side
Showing with 118 additions and 103 deletions
trunk/www.videolan.org/doc/vlc-user-guide/src/en/modules/intf.xml
View file @ f29c9316
......@@ -10,54 +10,42 @@ or interfaces you want to use (either graphical or control
interfaces).
</para>
<sect2><title>wxwindows</title>
&enabled;
<sect2><title>dummy</title>
&always;
<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>
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:
<sect2><title>skins</title>
&enabled;
<screen>
<prompt>% </prompt><userinput>vlc --intf dummy vcd://</userinput>
</screen>
</para>
</sect2>
<sect2><title>gestures</title>
&always;
<para>
This skinnable interface module works under Win32
and X11. You can create your own skins very easily with XML files
This module allows you to control VLC via mouse
gestures
.</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>
<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>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>gnome</title>
&disabled;
&linux-only;
......@@ -84,59 +72,15 @@ Argument is an integer that gives the maximum
</itemizedlist>
</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>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>rc</title>
&always;
<sect2><title>gtk</title>
&enabled;
<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
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>
&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>http</title>
&always;
<para>
......@@ -158,15 +102,33 @@ Gives the path to the HTML pages to be served.
</para></listitem></itemizedlist>
</sect2>
<sect2><title>ncurses</title>
<sect2><title>joystick</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)
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;
......@@ -176,6 +138,15 @@ 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>
......@@ -183,31 +154,75 @@ This is an interface plugin for the Qt Embedded
library (iPaq graphical library)
.</para></sect2>
<sect2><title>gestures</title>
<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 module allows you to control VLC via mouse
gestures
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>--gestures-threshold </emphasis>:
The integer argument is the threshold of move
required for a mouse gesture to be recorded
<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>--gestures-button {left,middle,right} </emphasis>:
The button to click before a gesture
<listitem><para><emphasis>--fake--tty, --no-fake-tty </emphasis>:
Enables or disables TTY virtual terminal
emulation (default disabled)
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2><title>joystick</title>
&disabled;
&linux-only;
<sect2><title>skins</title>
&enabled;
<para>
This module allows you to control VLC via a joystick
with many options.
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>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment