http.xml

<?xml version="1.0" encoding="iso-8859-1" ?>

<chapter id="http"><title id="thttp">
<span xml:lang="en">The HTTP interface</span>
<span xml:lang="fr">L'interface de contrle HTTP</span>
<span xml:lang="de">Die HTTP-Oberflche</span>
</title>

<sect1><title>
<span xml:lang="en">Introduction</span>
<span xml:lang="fr">Introduction</span>
<span xml:lang="de">Einfhrung</span>
</title>

<para><emphasis>
<span xml:lang="en">This page is incomplete</span>
<span xml:lang="fr">Ce page n'est pas complet</span>
<span xml:lang="de">Diese Seite ist nicht komplett</span>
.</emphasis></para>

<sect2><title>
<span xml:lang="en">Presentation</span>
<span xml:lang="fr">Prsentation</span>
<span xml:lang="de">Prsentation</span>
</title>

<para>
<span xml:lang="en">VLC ships with a little HTTP server integrated.
It is used both to stream using HTTP, and for the HTTP remote control
interface</span>
<span xml:lang="fr">VLC inclut un petit serveur HTTP, qui lui permet 
de diffuser en HTTP, mais galement de proposer une interface de contrle
 distance utilisant HTTP</span>
<span xml:lang="de">VLC enthlt einen kleinen HTTP-Server. Er kann zum 
Streamen ber HTTP und fr die HTTP-Fernsteuerungsoberflche benutzt
werden</span>
.</para>

<para>
<span xml:lang="en">To start VLC with the HTTP interface, use </span>
<span xml:lang="fr">Pour dmarrer VLC avec l'interface HTTP, faites </span>
<span xml:lang="de">Um VLC mit der HTTP-Oberflche zu starten, machen
Sie folgendes</span>
:</para>

<screen>
<prompt>% </prompt><userinput>vlc -I http (--http-src /directory/ --http-host host:port)</userinput>
</screen>

<para>
<span xml:lang="en">The HTTP interface will start listening at host:port
(localhost:8080 if omitted), and will reproduce the structure of
/directory at http://host:port/ ( vlc_source_path/share/http if omitted
)</span>
<span xml:lang="fr">L'interface HTTP se mettra en coute sur host:port
(localhost:8080 par dfaut), et reproduira la structure de /directory
sur http://host:port/ ( rp_source_vlc/share/http par dfaut)</span>
<span xml:lang="de">Das HTTP-Interface wird anfangen, unter host:port
(standardmig localhost:8080) nach Anfragen zu hren und die Struktur von
/directory unter http://host:port/ reproduzieren (standardmig
vlc_quell_pfad/share/http)</span>
.</para>

<para>
<span xml:lang="en">VLC is shipped with a set of files that should be
enough for generic needs. The rest of this chapter will cover the ways
to customize these pages</span>
<span xml:lang="fr">VLC est fourni avec un certain nombre de fichiers
qui devraient suffire pour des besoins gnriques. La suite de ce
chapitre explique comment personnaliser ces pages</span>
<span xml:lang="de">VLC wird mit einer Reihe von Dateien ausgeliefert, die
fr bliche Zwecke ausreichend sein sollten. Der Rest dieses Kapitels wird die
Wege aufzeigen, diese Seiten dem persnlichen Bedarf anzupassen</span>
.</para>

<para>
<span xml:lang="en">Some files are handled a bit specially</span>
<span xml:lang="fr">Certains fichiers sont traits spcialement</span>
<span xml:lang="de">Einige Dateien mssen besonders behandelt werden</span> 
:</para>

<itemizedlist>

<listitem><para>
<span xml:lang="en">Files beginning with '.' are not exported</span>
<span xml:lang="fr">Les fichiers commenant par '.' ne sont pas exports</span>
<span xml:lang="de">Datei, die mit "." beginnen, werden nicht exportiert</span>
.</para></listitem>


<listitem><para>
<span xml:lang="en">A '.access' file will be opened and the http
interface will expect to find at the first line a login/password
(written as login:password). This login/password will be used to
protect all files in this directory. Be careful that only files in this
directory will be protected. (sub-directories won't be protected.)</span>
<span xml:lang="fr">Le fichier '.access' sera ouvert. L'interface HTTP
va chercher dans la premire ligne un login/mot de passe (crit sous la
forme login:mot_de_passe). Ce couple sera utilis pour protger tous les
fichiers de ce rpertoire. Attention: seuls les fichiers du rpertoire
seront protgs (les fichiers des sous-rpertoires ne le seront pas.).</span>
<span xml:lang="de">Eine '.access'-Datei wird geffnet werden und die
HTTP-Oberflche wird in der ersten Zeile einen Loginnamen/Passwort
(geschrieben als Loginname:Passwort) erwarten. Dieser Loginname/Passwort
werden zum Schutz aller Dateien in diesem Verzeichnis benutzt. Bitte beachten
Sie, dass nur Dateien in diesem Verzeichnis geschtzt werden.
(Unterverzeichnisse werden nicht geschtzt.)</span>
</para></listitem>


<listitem><para>
<span xml:lang="en">The file &lt;dir&gt;/index.html will be exported ad
&lt;dir&gt; and &lt;dir&gt;/ and not as index.html</span>
<span xml:lang="fr">Le fichier &lt;rp&gt; sera export en tant que
&lt;rep&gt; et &lt;rep&gt;/ mais pas en tant que index.html</span>
<span xml:lang="de">Die Datei &lt;dir&gt;/index.html wird als 
&lt;Verzeichnis&gt; und &lt;Verzeichnis&gt;/ exportiert, aber nicht als
index.html</span>
.</para></listitem>

</itemizedlist>

<para>
<span xml:lang="en">The MIME type is set by looking at the file
extension and cannot be specified nor modified for a specifi file.
Unknown extensions will have "application/octet-stream" as MIME
type</span>
<span xml:lang="fr">Le type MIME est choisi selon l'extension du fichier
et ne peut pas tre forc ou modifi pour un fichier particulier.
Les fichiers d'extension inconnue seront servis avec le type MIME
"application/octet-stream"</span>
<span xml:lang="de">Der MIME-Typ wird durch einen Blick an die
Dateiendung festgelegt und kann durch eine Einstellungsdatei weder
angegeben noch verndert werden. Unbekannte Endungen haben 
"application/octet-stream" als MIME-Typ</span>
.</para>

<para>
<span xml:lang="en">You should avoid exporting big files. Each file is
indeed first loaded into the memory before being sent to the client, so
please be careful.</span>
<span xml:lang="fr">Essayez d'viter l'export de gros fichiers. En
effet, chaque page est tout d'abord charge en mmoire avant l'envoi,
donc soyez prudents...</span>
<span xml:lang="de">Sie sollten den Export von groen Dateien
vermeiden. Jede Datei wird erst in den Speicher geladen, bevor sie an
den Client gesendet wird. Seien Sie also vorsichtig.</span>
</para>

</sect2>


<sect2><title>
<span xml:lang="en">VLC macros</span>
<span xml:lang="fr">Macros VLC</span>
<span xml:lang="de">VLC-Makros</span>
</title>


<para> <span xml:lang="en">Each type a .html/.htm page is requested,
it is parsed by VLC before being sent. The parser searchs for the VLC
macros, and executes or substitutes them. Moreover, URL arguments
received by the GET method can be interpreted</span>

<span xml:lang="fr">Tous les fichiers .html/.htm sont lus par VLC avant
d'tre envoys. Les macros VLC sont alors excutes ou substitues.
De plus, les arguments de l'URL, obtenus par un GET, peuvent tre
interprts</span>

<span xml:lang="de">Jede angeforderte .html/.htm - Seite wird von
VLC geparst, bevor sie gesendet wird. Der Parser sucht nach VLC-Makros
und fhrt sie aus oder ersetzt sie. Desweiteren knnen von der GET-Methode
empfangene Argumente ausgefhrt werden</span>
 .</para>


<para>
<span xml:lang="en">A VLC macro looks like :
<emphasis>&lt;vlc id="macro-name" param1="macro-parameters1"
param2="macro-parameters2" /&gt;</emphasis>.</span>
<span xml:lang="fr">Une macro VLC est de la forme :
<emphasis>&lt;vlc id="nom" param1="parametre1" param2="parametre2" /&gt;
</emphasis>.</span>
<span xml:lang="de">Ein VLC-Makro sieht folgendermaen aus:
<emphasis>&lt;vlc id="Makro-Name" param1="Macro-Parameter1"
param2="Makro-Parameters2" /&gt;</emphasis>.</span>
</para>


<para>
<span xml:lang="en"> "id" is the only mandatory field, param1 and param2
may or may not be present and depend on the value of "id".</span>
<span xml:lang="fr"> Seul le champ "id" est obligatoire, param1 et
param2 peuvent ne pas tre prsent selon la valeur de "id".</span>
<span xml:lang="de">"id" ist das einzige zwingend erforderliche Feld, param1
und param2 knnen prsent sein oder nicht und sind angewiesen auf "id".</span>
</para>

<para>
<span xml:lang="en"> You should take care that you _have to_ respect
this syntax, VLC won't like invalid syntax. (It could easily leads to
crashs)</span>
<span xml:lang="fr"> Veuillez faire attention de bien respecter cette
syntaxe, car VLC n'aime pas les syntaxes invalides. (Il pourrait crasher
facilement)</span>
<span xml:lang="de">Sie sollten darauf achten, dass Sie diese Syntax
respektieren mssen, da VLC keine ungltige Syntax mag (diese knnte leicht
zu Abstrzen fhren)</span>
.</para>

<para>
<span xml:lang="en">Examples</span>
<span xml:lang="fr">Exemples</span>
<span xml:lang="de">Beispiele</span>
:</para>


<para>
<span xml:lang="en">Correct: <emphasis>&lt;vlc id="value"
param1="version" /&gt; </emphasis></span>
<span xml:lang="fr">Correct :<emphasis>&lt;vlc id="value"
param1="version" /&gt; </emphasis>
<span xml:lang="de">Korrekt: <emphasis>&lt;vlc id="value"
param1="version" /&gt; </emphasis></span>
</span>
</para>

<para>
<span xml:lang="en">Incorrect: <emphasis>&lt;vlc id="value"
param1="version" &gt; </emphasis> (missing tag ending),
<emphasis>&lt;vlc id=value param1="version" /&gt;</emphasis> (missing "" )
</span>
<span xml:lang="fr">Incorrect :<emphasis>&lt;vlc id="value"
param1="version" &gt; </emphasis>(mauvaise fin de tag),
<emphasis>&lt;vlc id=value param1="version" /&gt;</emphasis> ("" manquants)
</span>
<span xml:lang="de">Inkorrekt: <emphasis>&lt;vlc id="value"
param1="version" &gt; </emphasis> (fehlendes Tag-Ende),
<emphasis>&lt;vlc id=value param1="version" /&gt;</emphasis> (fehlende "" )
</span>
</para>

<para>
<span xml:lang="en">Valid macros are:</span>
<span xml:lang="fr">Les macros valides sont :</span>
<span xml:lang="de">Gltige Makros sind:</span>
</para>

<itemizedlist>

<listitem><para>
<span xml:lang="en"><emphasis>control</emphasis> (1 optional parameter)</span>
<span xml:lang="fr"><emphasis>control</emphasis> (1 paramtre facultatif)</span>
<span xml:lang="de"><emphasis>control</emphasis> (1 optionaler Parameter)</span>
</para>
</listitem>

<listitem><para>
<span xml:lang="en"><emphasis>get</emphasis> (2 parameters)</span>
<span xml:lang="fr"><emphasis>get</emphasis> (2 paramtres)</span>
<span xml:lang="de"><emphasis>get</emphasis> (2 Parameter)</span>
</para>
</listitem>

<listitem><para>
<span xml:lang="en"><emphasis>set</emphasis> (2 parameters)</span>
<span xml:lang="fr"><emphasis>set</emphasis> (2 paramtres)</span>
<span xml:lang="de"><emphasis>set</emphasis> (2 Parameter)</span>
</para>
</listitem>

<listitem><para>
<span xml:lang="en"><emphasis>rpn</emphasis> (1 parameter)</span>
<span xml:lang="fr"><emphasis>rpn</emphasis> (1 paramtre)</span>
<span xml:lang="de"><emphasis>rpn</emphasis> (1 Parameter)</span>
</para>
</listitem>

<listitem><para>
<span xml:lang="en"><emphasis>if</emphasis> (1 optional parameter)</span>
<span xml:lang="fr"><emphasis>if</emphasis> (1 paramtre facultatif)</span>
<span xml:lang="de"><emphasis>if</emphasis> (1 optionaler Parameter)</span>
</para>
</listitem>

<listitem><para>
<span xml:lang="en"><emphasis>else</emphasis> (no parameter)</span>
<span xml:lang="fr"><emphasis>else</emphasis> (pas de paramtre)</span>
<span xml:lang="de"><emphasis>else</emphasis> (ohne Parameter)</span>
</para>
</listitem>

<listitem><para>
<span xml:lang="en"><emphasis>end</emphasis> (no parameter)</span>
<span xml:lang="fr"><emphasis>end</emphasis> (pas de paramtre)</span>
<span xml:lang="de"><emphasis>end</emphasis> (ohne Parameter)</span>
</para>
</listitem>


<listitem><para>
<span xml:lang="en"><emphasis>value</emphasis> (1 optional parameter)</span>
<span xml:lang="fr"><emphasis>value</emphasis> (1 paramtre facultatif)</span>
<span xml:lang="de"><emphasis>value</emphasis> (1 optionaler Parameter)</span>
</para>
</listitem>

<listitem><para>
<span xml:lang="en"><emphasis>foreach</emphasis> (2 parameters)</span>
<span xml:lang="fr"><emphasis>foreach</emphasis> (2 paramtres)</span>
<span xml:lang="de"><emphasis>foreach</emphasis> (2 Parameter)</span>
</para>
</listitem>

</itemizedlist>

<para>
<span xml:lang="en">For powerful macros, you may use these tools</span>
<span xml:lang="fr">Pour des utilisations avances, ces outils sont  votre
disposition</span>
<span xml:lang="de">Fr fortgeschrittene Makros knnen Sie diese Werkzeuge
benutzen</span>
:</para>

<itemizedlist>

<listitem><para>
<span xml:lang="en">RPN Evaluator (see part 2)</span>
<span xml:lang="fr">Evaluateur RPN (voir la partie 2)</span>
<span xml:lang="de">RPN-Bewerter (siehe Teil 2)</span>
</para></listitem>

<listitem><para>
<span xml:lang="en">Stacks: The stack is a place where you can push
numbers and strings, and then pop them backs. It's used with the little
RPN evaluator.</span>
<span xml:lang="fr">Piles: La pile est un endroit dans lequel vous
pouvez mettre des nombres et des chanes de caractre et les rcuprer.
Elle est utilise en conjonction de l'valuateur RPN.</span>
<span xml:lang="de">Stapel: Der Stapel ist ein Platz, an den Sie Nummern
und Zeichenketten schieben und von dort zurckholen knnen. Er wird
mit dem RPN-Bewerter benutzt.</span>
</para></listitem>


<listitem><para>
<span xml:lang="en">Local variables: You can dynamically create
new variables and changes their values. Some local variables are
predefined:</span>
<span xml:lang="fr">Variables locales: Vous pouvez crer dynamiquement
de nouvelles variables et modifier leurs valeurs. Un certain nombre de
variables locales sont prdfinies&nbsp;:</span>
<span xml:lang="de">Lokale Variablen: Sie knnen dynamische neue
Variablen erzeugen und deren Werte ndern. Einige lokale Variablen sind
vordefiniert:</span>

<itemizedlist>

<listitem><para>
<emphasis>url_value</emphasis>
<span xml:lang="en">: parameter of the URL</span>
<span xml:lang="fr">&nbsp;: paramtre de l'URL</span>
<span xml:lang="de">: Parameter der URL</span>
</para></listitem>

<listitem><para>
<emphasis>url_param</emphasis>
<span xml:lang="en">: 1 if url_value isn't empty else 0</span>
<span xml:lang="fr">&nbsp;: 1 si url_value n'est pas vide, 0 sinon</span>
<span xml:lang="de">: 1 wenn url_value nicht leer ist, sonst 0</span>
</para></listitem>

<listitem><para>
<emphasis>version</emphasis>
<span xml:lang="en">: the VLC version</span>
<span xml:lang="fr">&nbsp;: la version de VLC</span>
<span xml:lang="de">: die VLC-Version</span>
</para></listitem>

<listitem><para>
<emphasis>copyright</emphasis>
<span xml:lang="en">: the VLC copyright</span>
<span xml:lang="fr">&nbsp;: Copyright de VLC</span>
<span xml:lang="de">: das VLC-Copyright</span>
</para></listitem>

</itemizedlist>

</para></listitem>

</itemizedlist>

<para>
<span xml:lang="en">Remark : The stacks, and local variables context is
resetted before the page is executed</span>
<span xml:lang="fr">Remarque: les piles et les variables locales sont
remises  zro avant l'excution de la page</span>
<span xml:lang="de">Anmerkung: Die Stapel und die lokalen Variablen
werden vor der Ausfhrung der Seite zurckgesetzt</span>
.</para>

</sect2>

</sect1>

<sect1><title>
<span xml:lang="en">The RPN evaluator</span>
<span xml:lang="fr">L'valuateur RPN</span>
<span xml:lang="de">Der RPN-Bewerter</span>
</title>

<para>
<span xml:lang="en">RPN means Reverse Polish Notation</span>
<span xml:lang="fr">RPN signifie Notation Polonaise Inverse (Reverse
Polish Notation)</span>
<span xml:lang="de">RPN bedeutet Umgekehrte Polonaisennotation
(Reverse Polish Notation)</span>
</para>

<sect2><title>
<span xml:lang="en">Introduction</span>
<span xml:lang="fr">Introduction</span>
<span xml:lang="de">Einfhrung</span>
</title>

<para>
<span xml:lang="en"> RPN could look strange but it's a fast and easy way
to write expressions. It also avoids the use of ( and ).</span>
<span xml:lang="fr"> RPN peut sembler assez trange au premier abord,
mais c'est en fait un moyen simple et rapide d'crire des expressions.
Il permet galement d'viter l'utilisation des parenthses.</span>
<span xml:lang="de">RPN kann merkwrdig aussehen, aber es ist ein
einfacher und schneller Weg, Ausdrcke zu schreiben. Es vermeidet
auerdem die Benutzung von ( und ).</span>
</para>

<para>
<span xml:lang="en">Instead of writing ( 1 + 2 ) * 5 you just use 1 2 +
5 *.</span>
<span xml:lang="fr">Au lieu d'crire ( 1 + 2 ) * 5, vous devrez crire 1
2 + 5 *.</span>
<span xml:lang="de">Anstatt ( 1 + 2 ) * 5 knnen Sie einfach 1 2 + 5 *
schreiben.</span>
</para>

<para>
<span xml:lang="en">The idea beyond it is : if we have a number or a
string (using ''), push it on the stack. If it is an operator (like +),
pop the arguments from the stack, execute the operators and then push
the result onto the stack. The result of the RPN sequence is the value
on the top of the stack</span>
<span xml:lang="fr">L'ide derrire cela est : si on a un nombre ou une
chaine de caractres, on l'empile. Si on a un oprateur (tel que +), on
prend les arguments sur la pile, on excute l'oprateur, et on remet le
rsultat sur la pile. Le rsultat du calcul RPN est la valeur sur le sommet
de la pile</span>
<span xml:lang="de">Die Idee dahinter ist: Wenn man eine Nummer oder
eine Zeichenkette hat, legt man sie auf den Stapel. Wenn man einen Operator
(wie +) hat, nimmt man die Argumente vom Stapel, fhrt die Operatoren aus
legt das Ergebnis wieder auf den Stapel. Das Ergebnis der RPN-Sequenu ist
der oberste Wert des Stapels</span> 
.</para>

<para>
<programlisting>
 stack:      Word processed
 empty      1                   1 is pushed on the stack
 1          2                   2 same things
 1 | 2      +                   + : remove 1 and 2 and write 3 on the stack
 3          5                   5 is pushed on the stack
 3 | 5      *                   * : remove 3 and 5 and write 15
 15                             &lt;- result
</programlisting>
</para>

</sect2>

<sect2><title>
<span xml:lang="en">Operators</span>
<span xml:lang="fr">Les oprateurs</span>
<span xml:lang="de">Die Operatoren</span>
</title>

<para> <span xml:lang="en">Notation : ST(1) means the first stack
element, ST(2) the second one ... and op the operator. </span>
<span xml:lang="fr">Notation : ST(1) signifie le premier lment de la
pile, ST(2) le second, ... et op l'oprateur. </span>
<span xml:lang="de">Notation: ST(1) meint das erste Stapelelement,
ST(2) das zweite, usw. und op den Operator</span>
</para>

<para>
<span xml:lang="en">You have access to</span>
<span xml:lang="fr">Vous avez accs </span>
<span xml:lang="de">Sie haben Zugriff auf</span>
:</para>

<itemizedlist>

<listitem><para>
<span xml:lang="en">Standard arithmetics operators: +, -, *, /, % :
these ones push the result of ST(1) op ST(2) to the stack</span>
<span xml:lang="fr">Les oprateurs arithmtiques standards: +, -, *, /,
% : ils mettent le rsultat de ST(1) op ST(2) sur la pile</span>
<span xml:lang="de">Die artithmetrischen Standardoperatoren: +, -, /,
%: Diese legen das Ergebnis von ST(1) op ST(2) auf den Stapel</span>
</para></listitem>

<listitem><para>
<span xml:lang="en">Binary operators: ! (push !ST(1)); ^, &amp;, | : push
the result ST(1) op ST(2)</span>
<span xml:lang="fr">Oprateur binaires: ! (place !ST(1)); ^, &amp;, | :
place le rsultat de ST(1) op ST(2)</span>
<span xml:lang="de">Die binren Operatoren: ! (bearbeitet !ST(1)); ^, &amp;, | :
legen das Ergebnis von ST(1) op ST(2) ab</span>
</para></listitem>

<listitem><para>
<span xml:lang="en">test: =, &lt;, &lt;=, &gt;, &gt;= : execute ST(1) op
ST(2) and push -1 if true else 0</span>
<span xml:lang="fr">tests: =, &lt;, &lt;=, &gt;, &gt;= : excute ST(1) op
ST(2), place -1 si vrai, 0 sinon</span>
<span xml:lang="de">Tests: =, &lt;, &lt;=, &gt;, &gt;= : fhren  ST(1) op
ST(2) aus und legen -1 ab, wenn das Ergebnis wahr oder 0 wenn nicht</span>
</para>
</listitem>

<listitem><para>
<span xml:lang="en">string: strcat pushes the result of 'ST(1)ST(2)',
strcmp compares ST(1) and ST(2), pushes -1 if ST(1)&lt;ST(2), 0 if
equal, 1 else, strlen pushes the length of ST(1).</span>
<span xml:lang="fr">chaines de caractres: strcat place le rsultat de
'ST(1)ST(2)', strcmp compare ST(1) et ST(2), place -1 si ST(1)&lt;ST(2),
0 en cas d'galit et 1 sinon, strlen place la taille de ST(1).</span>
<span xml:lang="de">Zeichenketten: strcat legt das Ergebnis von
'ST(1)ST(2)' ab, strcmp vergleicht ST(1) und ST(2) und legt -1 ab, wenn 
ST(1)&lt;ST(2), 0 wenn sie gleich sind und 1, wenn nicht. strlen legt die
Lnge von ST(1) ab.</span>
</para>
</listitem>

<listitem><para>
<span xml:lang="en">stack manipulation: dup duplicates ST(1), drop
removes ST(1), swap exchanges ST(1) and ST(2), and flush empties the
stack.</span>
<span xml:lang="fr">manipulation de la pile: dup duplique ST(1), drop
enlve ST(1) de la pile, swap change ST(1) et ST(2), et flush vide la
pile.</span>
<span xml:lang="de">Manipulation des Stapels: dup verdoppelt ST(1), drop
entfernt ST(1), swap vertauscht ST(1) und ST(2) und flush leert den Stapel.</span>
</para>
</listitem>

<listitem><para>
<span xml:lang="en">variables manipulation: store stores ST(2) in a
local variable named ST(1), value pushes the value of the local variable
named ST(1), url_extract pushes the value of the ST(1) part of the url
parameters.</span>
<span xml:lang="fr">manipulation de variables: store stocke ST(2) dans
une variable locale dont le nom est la valeur de ST(1), values place la
valeur de la variable dont le nom est ST(1), et url_extract place la
valeur de la partie contenue de ST(1) des paramtres d'URL</span>
<span xml:lang="de">Manipulation von Variablen: store speichert ST(2)
in einer lokalen Variable namens ST(1), value legt den Wert der Variablen
namens ST(1) ab und url_extract legt den Wert des ST(1)-Teils der
URL-Parameter ab.</span>
</para></listitem>

</itemizedlist>

</sect2>

</sect1>


<sect1><title>
<span xml:lang="en">The macros</span>
<span xml:lang="fr">Les macros</span>
<span xml:lang="de">Die Makros</span>
</title>

<sect2><title>
<span xml:lang="en">The <emphasis>control</emphasis> macro</span>
<span xml:lang="fr">La macro <emphasis>control</emphasis></span>
<span xml:lang="de">Das <emphasis>control</emphasis>-Makro</span>
</title>

<para>
<span xml:lang="en">When asking for a page, you can pass
arguments to it through the url. (eg using a &lt;form&gt;). Ex:
http://host:port/page.html?var=value&amp;var2=value2&amp;... The "control" macro
tells a page to parse these arguments and to execute the ones that are
allowed. param1 of this macro says which commands are allowed. If empty,
all commands will be permitted.</span>
<span xml:lang="fr">Lors de la requte d'une page,
vous pouvez lui passer des arguments  travers l'URL.
(par exemple, en utilisant un &lt;form&gt;). Exemple:
http://host:port/page.html?var=value&amp;var2=value2&amp;... La macro "control"
dit  la page de lire ces arguments, et d'excuter les commandes
autorises qu'ils contiennent. Le param1 contient la liste des commandes
autorises. S'il est vide, toutes les commandes sont autorises.</span>
<span xml:lang="de">Wenn Sie eine Seite abrufen, knnen Sie dieser Argumente durch
die URL geben. Beispielsweise: http://host:port/page.html?var=value&amp;var2=value2&amp;...
Das "control"-Makro gibt einer Seite Bescheid, diese Argumente zu parsen und die erlaubten
auszufhren. param1 dieses Makros sagt aus, welche Befehle erlaubt sind. Wenn es leer ist,
sind alle Befehle erlaubt.</span>
</para>
<para>
<span xml:lang="en">Some commands require an argument that must be
passed in the URL too</span>
<span xml:lang="fr">Certaines commandes requirent des arguments qui
doivent tre passs dans l'URL</span>
<span xml:lang="de">Einige Befehle bentigen ein Argument, welches auch ber die URL
mitgegeben werden muss</span>
.</para>


<table frame="all">
<title>
<span xml:lang="en">URL commands</span>
<span xml:lang="fr">Commandes d'URL</span>
<span xml:lang="de">Die URL-Befehle</span>
</title>

<tgroup cols="3">
<thead>
<row>
 <entry>Name</entry>
 <entry>Argument</entry>
 <entry>
    <span xml:lang="en">Description</span>
    <span xml:lang="fr">Description</span>
    <span xml:lang="de">Beschreibung</span>
 </entry>
</row>
</thead>
<tbody>
<row>
 <entry>play</entry>
 <entry>
    <span xml:lang="en">item (integer)</span>
    <span xml:lang="fr">item (integer)</span>
    <span xml:lang="de">Objekt (Ganzzahl)</span>
 </entry>
 <entry>
    <span xml:lang="en">Play the specified playlist item</span>
    <span xml:lang="fr">Play the specified playlist item</span>
    <span xml:lang="de">Gibt das angegebene Wiedergabelistenobjekt wieder</span>
 </entry>
</row>
<row>
 <entry>stop</entry><entry></entry>
 <entry>
    <span xml:lang="en">Stop</span>
    <span xml:lang="fr">Stop</span>
    <span xml:lang="de">Stopp</span>
 </entry>
</row>
<row>
 <entry>pause</entry><entry></entry>
 <entry>Pause</entry>
</row>
<row>
 <entry>next</entry><entry></entry>
 <entry>
    <span xml:lang="en">Go to next playlist item</span>
    <span xml:lang="fr">Go to next playlist item</span>
    <span xml:lang="de">Zum nchsten Wiedergabelistenobjekt gehen</span>
 </entry>
</row>
<row>
 <entry>previous</entry><entry></entry>
 <entry>
    <span xml:lang="en">Go to previous playlist item</span>
    <span xml:lang="fr">Go to previous playlist item</span>
    <span xml:lang="de">Zum vorherigen Wiedergabelistenobjekt gehen</span>
 </entry>
</row>
<row>
 <entry>add</entry>
 <entry>
    <span xml:lang="en">mrl (string)</span>
    <span xml:lang="fr">mrl (string)</span>
    <span xml:lang="de">mrl (Zeichenkette)</span>
 </entry>
 <entry>
    <span xml:lang="en">Add a MRL (Media Resource Locator) to the playlist</span>
    <span xml:lang="fr">Add a MRL (Media Resource Locator) to the playlist</span>
    <span xml:lang="de">Fgt eine MRL (Media Resource Locator) der Wiedergabeliste hinzu</span>
 </entry>
</row>
<row>
 <entry>delete</entry>
 <entry>
    <span xml:lang="en">item (integer)</span>
    <span xml:lang="fr">item (integer)</span>
    <span xml:lang="de">Objekt (Ganzzahl)</span>
 </entry>
 <entry>
    <span xml:lang="en">Delete the specified playlist item or list of playlist items</span>
    <span xml:lang="fr">Delete the specified playlist item or list of playlist items</span>
    <span xml:lang="de">Lscht das angegebene Wiedergabelistenobjekt oder die angegebene Liste</span>
 </entry>
</row>
<row>
 <entry>empty</entry><entry></entry>
 <entry>
    <span xml:lang="en">Empty the playlist</span>
    <span xml:lang="fr">Empty the playlist</span>
    <span xml:lang="de">Leert die Wiedergabeliste</span>
 </entry>
</row>
<row>
 <entry>close</entry>
    <entry>
        <span xml:lang="en">id (hexa)</span>
        <span xml:lang="fr">id (hexa)</span>
        <span xml:lang="de">ID (hexadezimal)</span>
    </entry>
 <entry>
    <span xml:lang="en">Close a specific connection</span>
    <span xml:lang="fr">Close a specific connection</span>
    <span xml:lang="de">Schliet die angegebene Verbindung</span>
 </entry>
</row>
<row>
 <entry>shutdown</entry><entry></entry>
 <entry>
    <span xml:lang="en">Quit VLC</span>
    <span xml:lang="fr">Quit VLC</span>
    <span xml:lang="de">VLC beenden</span>
 </entry>
</row>
</tbody>
</tgroup>
</table>

<para>
<span xml:lang="en">For example, you can restrict execution of the
<command>shutdown</command> command to protected page (through a
<emphasis>.access</emphasis> file), using the control macro in all
unprotected pages.</span>
<span xml:lang="fr">Vous pouvez par exemple restreindre l'excution de
la commande <command>shutdown</command>  une page protge (par un
fichier <emphasis>.access</emphasis>) en utilisant la macro control dans
toutes les pages non protges.</span>
<span xml:lang="de">Beispielsweise knnen Sie die Ausfhrung des 
<command>shutdown</command>-Befehls auf geschtzte Seiten (durch eine
<emphasis>.access</emphasis>-Datei) beschrnken, in dem Sie das control-Makro
in allen ungeschtzten Seiten benutzen.</span>
</para>


</sect2>


<sect2><title>
<span xml:lang="en">The <emphasis>get</emphasis> macro</span>
<span xml:lang="fr">La macro <emphasis>get</emphasis></span>
<span xml:lang="de">Das <emphasis>get</emphasis>-Makro</span>
</title>

<para>
<span xml:lang="en">This macro will be replaced by the value of the
configuration variable which name is stored in param1 and which type is
given by param2.</span>
<span xml:lang="fr">Cette macro sera remplace par la variable de
configuration dont le nom est donn en param1 et dont le type es
donn en param2.</span>
<span xml:lang="de">Dies Makro wird durch den Wert der Einstellungsvariablen
ersetzt, die param1 gespeichert ist und deren Typ durch param2 bestimmt wird.</span>
</para>

<para>
<span xml:lang="en">param1 must be the name of an existing configuration
variable. param2 must be the right type of the variable. It can be
one of <emphasis>int</emphasis>, <emphasis>float</emphasis>, or
<emphasis>string</emphasis>.</span>
<span xml:lang="fr">param1 doit tre le nom d'une variable de
configuration existente, et param2 doit tre son type, qui peut
tre <emphasis>int</emphasis>, <emphasis>float</emphasis>, ou
<emphasis>string</emphasis>.</span>
<span xml:lang="de">param1 muss der Name einer existierenden Einstellungsvariablen
sein. param2 muss der richtige Typ der Variablen sein. Dies kann einer der folgenden sein:
<emphasis>int</emphasis> (Ganzzahl), <emphasis>float</emphasis> (Fliekommazahl)
oder <emphasis>string</emphasis> (Zeichenkette).</span> 
</para>

<para>
<span xml:lang="en">Example: &lt;vlc id="get" param1="sout"
param2="string" /&gt; will be replaced in the output page by the value
of sout.</span>
<span xml:lang="fr">Exemple: lt;vlc id="get" param1="sout"
param2="string" /&gt; sera remplace dans la page de sortie par la
valeur de sout. </span>
<span xml:lang="de">Beispiel: &lt;vlc id="get" param1="sout"
param2="string" /&gt; wird in der ausgegebenen Seite durch den Wert
von sout ersetzt.</span>
</para>

</sect2>


<sect2><title>
<span xml:lang="en">The <emphasis>set</emphasis> macro</span>
<span xml:lang="fr">La macro <emphasis>set</emphasis></span>
<span xml:lang="de">Das <emphasis>set</emphasis>-Makro</span>
</title>

<para>
<span xml:lang="en">This macro allows to set the value of a
configuration variable. The name is given by param1 and the type by
param2 (like for get). The value is retrieved from the url using the
name given in param1.</span>
<span xml:lang="fr">Cette macro permet de rgler la valeur d'une
variable de configuration. Le nom est donnépar param1 et le type par
param2, comme pour get. La valeur est recopie depuis l'URL en utilisant
le nom donnéen param1.</span>
<span xml:lang="de">Dieses Makro erlaubt Ihnen den Wert einer
Konfigurationsvariablen einzustellen. Der Name wird ber param1 und der
Typ param2 gesteuert (wie bei get). Der Wert wird der URL, ber den in param1
angegebenen Namen, entnommen.</span>
</para>

<para>
<span xml:lang="en">For example, if player.html contains &lt;vlc
id="set" param1="sout" param2="string" /&gt;, and if you browse at
<emphasis> http://host:ip/player.html?sout=sout_value</emphasis>, the
sout variable will be set to "sout_value". If the URL doesn't contain
sout, nothing will be done.</span>
<span xml:lang="fr">Par exemple, si player.html contient
&lt;vlc id="set" param1="sout" param2="string" /&gt; et
si vous allez  l'adresse <emphasis> http://host:ip/pl
ayer.html?sout=sout_value</emphasis>, la variable sout prendra
comme valeur sout_value. Si l'URL ne contient pas sout, rien ne se
passera.</span>
<span xml:lang="de">Zum Beispiel: Wenn player.html &lt;vlc
id="set" param1="sout" param2="string" /&gt; enthlt und die URL
<emphasis> http://host:ip/player.html?sout=sout_value</emphasis> ist,
wird die sout-Variable den Wert "sout_value" erhalten. Wenn die URL nicht
sout enthlt, wird nichts geschehen.</span>
</para>

</sect2>


<sect2><title>
<span xml:lang="en">The <emphasis>rpn</emphasis> macro</span>
<span xml:lang="fr">La macro <emphasis>rpn</emphasis></span>
<span xml:lang="de">Das <emphasis>rpn</emphasis>-Makro</span>
</title>
<para>
<span xml:lang="en">This macro allows you to interpret RPN commands.
(See II).</span>
<span xml:lang="fr">Cette macro vous permet d'interprter des commandes
RPN (voir II).</span>
<span xml:lang="de">Dieses Makro erlaubt Ihnen RPN-Befehle (siehe II)
auszuwerten.</span>
</para>
</sect2>

<sect2><title>
<span xml:lang="en">The <emphasis>if,else,end</emphasis> macro</span>
<span xml:lang="fr">La macro <emphasis>if,else,end</emphasis></span>
<span xml:lang="de">Das Makro <emphasis>if,else,end</emphasis></span>
</title>

<para>
<span xml:lang="en">This macro allows you to control the parsing of the
HTML page.</span>
<span xml:lang="fr">Cette macro vous permet de controler la lecture de
la page HTML.</span>
<span xml:lang="de">Dieses Makro erlaubt Ihnen das Parsen der HTML-Seite
zu kontrollieren.</span>
</para>

<para>
<span xml:lang="en">If param1 isn't empty, it is first executed with the
RPN evaluator. If the first element from the stack is not 0, the test
value is true, else false.</span>
<span xml:lang="fr">Si param1 n'est pas vide, il est excut par
l'valuateur RPN. Si le premier lment de la pile n'est pas nul, la
valeur du test est vraie, sinon, elle est fausse</span>
<span xml:lang="de">Wenn param1 nicht leer ist, wird es mit dem 
RPN-Bewerter ausgefhrt. Wenn das erste Element auf dem Stapel nicht 0
ist, ist der Testwert wahr, sonst unwahr</span> 
.</para>

<para>
<span xml:lang="en">
<programlisting> &lt;vlc id="if" param1="1 2 =" /&gt;
    &lt;!-- Never reached --&gt;
 &lt;vlc id="else" /&gt;
    &lt;p&gt; Test succeed: 1 isn't equal to 2 &lt;/p&gt;
 &lt;vlc id="end" /&gt;
</programlisting>
</span>
<span xml:lang="fr">
<programlisting> &lt;vlc id="if" param1="1 2 =" /&gt;
    &lt;!-- Jamais atteint --&gt;
 &lt;vlc id="else" /&gt;
    &lt;p&gt; Le test  russi: 1 n'est pas gal  2 &lt;/p&gt;
 &lt;vlc id="end" /&gt;
</programlisting>
</span>
<span xml:lang="de">
<programlisting> &lt;vlc id="if" param1="1 2 =" /&gt;
    &lt;!-- Nicht erreicht --&gt;
 &lt;vlc id="else" /&gt;
    &lt;p&gt; Test erfolgreich: 1 ist nicht gleich mit 2 &lt;/p&gt;
 &lt;vlc id="end" /&gt;
</programlisting>
</span>
</para>

<para>
<span xml:lang="en">You can also just use "if" and "end"</span>
<span xml:lang="fr">Vous pouvez aussi utiliser "if" et "end" seulement </span>
<span xml:lang="de">Sie knnen auch einfach "if" und "end" benutzen</span>
.</para>

</sect2>

<sect2><title>
<span xml:lang="en">The <emphasis>value</emphasis> macro</span>
<span xml:lang="fr">La macro <emphasis>value</emphasis></span>
<span xml:lang="de">Das <emphasis>value</emphasis>-Makro</span>
</title>

<para>
<span xml:lang="en">If param1 isn't empty, it is first executed with the
RPN evaluator. The macro is replaced with the value of the first element
of the stack.</span>
<span xml:lang="fr">Si param1 n'est pas vide, il est excut par
l'valuateur RPN. La macro est ensuite remplace par la valeur du
premier lment de la pile.</span>
<span xml:lang="de">Wenn param1 nicht leer ist, wird es ber den
RPN-Bewerter ausgefhrt. Das Makro ersetzt den Wert des ersten Elements
des Stapels.</span>
</para>

<para>
<span xml:lang="en">Note: If the element is the name of a local
variable, its value will be displayed instead of its name.</span>
<span xml:lang="fr">Si l'lment est le nom d'une variable locale, la
valeur sera affiche et non le nom</span>
<span xml:lang="de">Beachten Sie: Wenn das Element der Name einer
lokalen Variable ist, wird deren Wert und nicht ihr Name angezeigt.</span>
</para>

</sect2>

<sect2><title>
<span xml:lang="en">The <emphasis>foreach,end</emphasis> macro</span>
<span xml:lang="fr">La macro <emphasis>foreach,end</emphasis></span>
<span xml:lang="de">Das <emphasis>foreach,end</emphasis> Makro</span>
</title>

<para>

<span xml:lang="en">param1 is the name of the variable that will be used for the loop. param2 is the name of the set to be built:</span>
<span xml:lang="fr">param1 est le nom de la variable utilise pour la boucle, param2 est le nom de la plage de valeurs  utiliser :</span>
<span xml:lang="de">param1 ist der Name der Variable, die fr die
Schleife benutzt wird. param2 ist der Name der Variable, deren Werte
benutzt werden:</span>

</para>


<itemizedlist>

<listitem><para>
<span xml:lang="en"><emphasis>integer</emphasis>: take
the first element from the stack to construct a set of
integer. The stack element should be a string like:
<emphasis>first:last[:step][,first2:last2[:step2][,...]</emphasis> (Ex:
1:5:2,6:8:1 will be expanded into 1,3,5,6,7,8)</span>
<span xml:lang="fr"><emphasis>integer</emphasis> : prend
le premier lment de la pile pour construire une plage
d'entiers. L'lment doit etre une chaine de caractres du type:
<emphasis>premier:dernier[:pas][,premier2:dernier2[:pas2]][,...]</emphasis> (Exemple: 1:5:2 ,6:8:1 deviendra 1,3,5,6,7,8)</span>
<span xml:lang="de"><emphasis>integer</emphasis>: nimmt das
erste Element des Stapels um ein Set von Ganzzahlen zu erzeugen. Das
Stapelelement sollte folgendermaen aussehen:
<emphasis>erste:letzte[:Schritt][,erste2:letzte2[:Schritt2][,...]</emphasis>
(Beispiel: 1:5:2,6:8:1 wird zu 1,3,5,6,7,8)</span>
</para></listitem>

<listitem><para>
<span xml:lang="en"><emphasis>directory</emphasis>: take the first
element of the stack as the base directory and construct a set
of filename and directly in it. Each element has the following
fields:</span>
<span xml:lang="fr"><emphasis>directory</emphasis> : prend le premier
lment de la pile comme rpertoire et construit un ensemble de noms de
fichiers contenus dans ce rpertoire. Chaque lment comporte les champs
suivants:</span>
<span xml:lang="de"><emphasis>directory</emphasis>: nimmt das erste
Element des Stapels als Ausgangsverzeichnis und erzeugt ein Set von
Dateinamen direkt darin. Jedes Element hat die folgenden Felder:</span>
</para>

<itemizedlist>

<listitem><para>
<span xml:lang="en">name : file/directory name</span>
<span xml:lang="fr">name : nom du fichier/rpertoire</span>
<span xml:lang="de">name: Name der Datei/des Verzeichnisses</span>
</para></listitem>

<listitem><para>
<span xml:lang="en">type : "directory" or "file" or "unknown"</span>
<span xml:lang="fr">type : "directory" ou "file" ou "unknown"</span>
<span xml:lang="de">type: "directory" (Verzeichnis) oder "file" (Datei)
oder "unknown" (unbekannt)</span>
</para></listitem>

<listitem><para>
<span xml:lang="en">size : size of the file</span>
<span xml:lang="fr">size : taille du fichier</span>
<span xml:lang="de">size: die Gre der Datei</span>
</para></listitem>

<listitem><para>
<span xml:lang="en">date</span>
<span xml:lang="fr">date</span>
<span xml:lang="de">date: das Datum</span>
</para></listitem>

</itemizedlist>

</listitem>

<listitem><para>
<span xml:lang="en">playlist: set based on the playlist with fields:
current is 1 if item is currently selected, 0 else. index is the index
value, that can be used by the play or delete control command. name is the
name of the item</span>
<span xml:lang="fr">Construit un ensemble bas sur la liste de lecture.
Les champs sont: current qui vaut 1 si l'lment est slectionn, 0
sinon. index est la valeur de l'index  utiliser dans les commandes delete
ou play. name est le nom de l'lment</span>
<span xml:lang="de">playlist: ein auf der Wiedergabeliste mit folgenden
Feldern basierendes Set: current ist 1, wenn das Objekt derzeit ausgewhlt
ist, sonst 0. index ist der Index-Wert, der von den play oder delete - Befehlen
benutzt werden kann. name ist der Name des Objekts</span> 
.</para></listitem>

<listitem><para>
<span xml:lang="en">"informations" : Create informations for the current
playing stream. name is the name of the category, value is its value,
info is a new set that can be parsed with a new foreach (subfields of
info are name and value)</span>
<span xml:lang="fr">"informations" : cre des informations sur la
lecture en cours. name est le nom de la catgorie, value est sa valeur,
info est un nouvel ensemble sur lequel vous pouvez  nouveau appliquer
foreach, et qui contient deux champs name et value)</span>
<span xml:lang="de">"informations": Erzeugt Informationen fr den derzeit
abgespielten Stream. name ist der Name der Kategorie, value ist dessen Wert,
info ist ein neues Set, dass Sie erneut parsen knnen (Unterfelder von info
sind name und value)</span>
.</para></listitem>

<listitem><para>
<span xml:lang="en">"hosts" : Create the list of host we are listening.
Contains the "id" (opaque id), host, ip and port fields.</span>
<span xml:lang="fr">"hosts" : Cre une liste des hotes en coute.
Contient les champs "id" (identifiant interne), host, ip et port.</span>
<span xml:lang="de">"hosts": Erzeugt eine Liste von hrenden Hosts.
Enthlt die "id" (interne ID), host, ip und port-Felder.</span>
</para></listitem>

<listitem><para>
<span xml:lang="en">"urls" : Create the list of urls currently
available. Fields are id, stream (1 if we have a stream, 0 else), url,
mime, protected (1 if protected, 0 else), used (is it currently used
?).</span>
<span xml:lang="fr">"urls" : Cre une liste des urls disponibles.
Les champs sont id, stream (1 si c'est un flux, 0 sinon), url, mime,
protected (1 si le fichier est protg, 0 sinon), utilis (1 si utilis
actuellement).</span>
<span xml:lang="de">"urls": Erzeugt eine Liste der derzeit verfgbaren
URLs. Felder sind id, stream (1 wenn wir einen Stream haben, sonst 0),
url, mime, protected (1 wenn geschtzt, sonst 0), used (wird es derzeit
benutzt?).</span>
</para></listitem>

<listitem><para>
<span xml:lang="en">"connections" : Create the list of current
connections. Fields are: id, an opaque id that can be used in the close
command, ip, url, and status (HTTP error code).</span>
<span xml:lang="fr">"connections" : Cre la liste des connections en
cours. Les champs sont: id, un identifiant utilis par la commande
close, ip, url et status (Code de retour HTTP).</span>
<span xml:lang="de">"connections": Erzeugt eine Liste der derzeitigen
Verbindungen. Die Felder sind: id, eine interne ID, die mit dem
close-Befehl benutzt werden kann, ip, url und status
(HTTP-Fehlercode).</span>
</para></listitem>

<listitem><para>
<span xml:lang="en">the name of a foreach variable if it's a set of set
of value.</span>
<span xml:lang="fr">Le nom d'une variable de foreach, si c'est un
sous-ensemble.</span>
<span xml:lang="de">Der Name einer foreach-Variablen, wenn es ein
Set von eingestellten Werten ist.</span>
</para>

<programlisting>;&lt;vlc id="foreach" param1="cat" param2="informations" /&gt;
                &lt;p&gt; &lt;vlc id="value" param1="cat.name" /&gt;
                &lt;ul&gt;
                &lt;vlc id="foreach" param1="info" param2="cat.info" /&gt;
                    &lt;li&gt;
                    &lt;vlc id="value" param1="info.name" /&gt; :
                            &lt;vlc id="value" param1="info.value" /&gt;
                    &lt;/li&gt;
                &lt;vlc id="end" /&gt;
                &lt;/ul&gt;
            &lt;vlc id="end" /&gt;
</programlisting>

</listitem>

</itemizedlist>

<para><span xml:lang="en">For more details, have a look at the share/http
directory of the VLC source tree...</span>
<span xml:lang="fr">Pour plus de dtails, voyez le rpertoire share/http
des sources de VLC...</span>
<span xml:lang="de">Schauen Sie fr weitere Details in das share/http
- Verzeichnis der Quellen von VLC...</span>
</para>

</sect2>
</sect1>

</chapter>