1
0
mirror of https://github.com/weechat/weechat.git synced 2026-06-25 04:16:38 +02:00

Added command line section in doc

This commit is contained in:
Sebastien Helleu
2006-01-21 16:49:25 +00:00
parent 5aeb7921fe
commit 083ede73fd
4 changed files with 698 additions and 0 deletions
+173
View File
@@ -719,6 +719,179 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
</section>
<section id="secCommandLine">
<title>Command line</title>
<para>
WeeChat command line (at the bottom of window) lets you send text on
channels and execute WeeChat or IRC commands (see
<xref linkend="secWeeChatIRCCommands" />).
</para>
<para>
Commands begin with "/" char, followed by name of command.
For example, to initiate a private chat with "<literal>toto</literal>":
<screen><userinput>/query toto</userinput></screen>
</para>
<para>
Text sent to a channel is any text that does not begin with "/" char.
For example, to send text "<literal>hello</literal>" on current
channel:
<screen><userinput>hello</userinput></screen>
</para>
<para>
However, it is possible to start with "/" char, by adding another.
For example, to send text "<literal>/query toto</literal>" on current
channel:
<screen><userinput>//query toto</userinput></screen>
</para>
<para>
If option for sending IRC colors ("<literal>irc_colors_send</literal>")
is enabled, you can use color codes and attributes, as follow:
<informaltable colsep="0" frame="none">
<tgroup cols="2">
<thead>
<row>
<entry>Code</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>%B</entry>
<entry>
bold text
</entry>
</row>
<row>
<entry>%Cnn</entry>
<entry>
text color "<literal>nn</literal>" (see colors table below)
</entry>
</row>
<row>
<entry>%O</entry>
<entry>
disable color and attributes
</entry>
</row>
<row>
<entry>%R</entry>
<entry>
reverse video (revert text color with background)
</entry>
</row>
<row>
<entry>%U</entry>
<entry>
underlined text
</entry>
</row>
<row>
<entry>%%</entry>
<entry>
display one "<literal>%</literal>"
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
Note: the same code (without number for %C) may be used to stop the
attribute.
</para>
<para>
Color codes for %C are:
<informaltable colsep="0" frame="none">
<tgroup cols="2">
<thead>
<row>
<entry>Code</entry>
<entry>Color</entry>
</row>
</thead>
<tbody>
<row>
<entry>00</entry>
<entry>white</entry>
</row>
<row>
<entry>01</entry>
<entry>black</entry>
</row>
<row>
<entry>02</entry>
<entry>dark blue</entry>
</row>
<row>
<entry>03</entry>
<entry>dark green</entry>
</row>
<row>
<entry>04</entry>
<entry>light red</entry>
</row>
<row>
<entry>05</entry>
<entry>dark red</entry>
</row>
<row>
<entry>06</entry>
<entry>magenta</entry>
</row>
<row>
<entry>07</entry>
<entry>orange</entry>
</row>
<row>
<entry>08</entry>
<entry>yellow</entry>
</row>
<row>
<entry>09</entry>
<entry>light green</entry>
</row>
<row>
<entry>10</entry>
<entry>cyan</entry>
</row>
<row>
<entry>11</entry>
<entry>light cyan</entry>
</row>
<row>
<entry>12</entry>
<entry>light blue</entry>
</row>
<row>
<entry>13</entry>
<entry>light magenta</entry>
</row>
<row>
<entry>14</entry>
<entry>gray</entry>
</row>
<row>
<entry>15</entry>
<entry>light gray (white)</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para>
Example: display of "<literal>hello everybory!</literal>" with
"<literal>hello</literal>" in light blue bold, and
"<literal>everybody</literal>" in light red underlined:
<screen><userinput>%C12%Bhello%B%C04%U everybody%U%C!</userinput></screen>
</para>
</section>
<section id="secWeeChatIRCCommands">
<title>WeeChat / IRC commands</title>
+176
View File
@@ -729,6 +729,182 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
</section>
<section id="secLigneDeCommande">
<title>La ligne de commande</title>
<para>
La ligne de commande WeeChat (située en bas de la fenetre) permet
d'envoyer du texte sur les canaux et d'exécuter des commandes
WeeChat ou IRC (voir <xref linkend="secCommandesWeeChatIRC" />).
</para>
<para>
Les commandes débutent par un caractère "/", suivi du nom de la
commande. Par exemple pour initier une conversation privée avec
"<literal>toto</literal>" :
<screen><userinput>/query toto</userinput></screen>
</para>
<para>
Le texte envoyé à un canal est tout texte ne commençant pas par le
caractère "/", par exemple pour envoyer "<literal>bonjour</literal>"
sur le canal courant :
<screen><userinput>bonjour</userinput></screen>
</para>
<para>
Il est cependant possible de faire débuter un texte par "/" en le
doublant. Par exemple pour envoyer le texte
"<literal>/query toto</literal>" sur le canal courant :
<screen><userinput>//query toto</userinput></screen>
</para>
<para>
Si l'option d'envoi des couleurs IRC
("<literal>irc_colors_send</literal>") est activée, il est possible
d'utiliser des codes couleur et attributs comme suit :
<informaltable colsep="0" frame="none">
<tgroup cols="2">
<thead>
<row>
<entry>Code</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>%B</entry>
<entry>
texte gras
</entry>
</row>
<row>
<entry>%Cnn</entry>
<entry>
couleur du texte "<literal>nn</literal>"
(voir le tableau des couleurs ci-dessous)
</entry>
</row>
<row>
<entry>%O</entry>
<entry>
désactiver la couleur et tous les attributs
</entry>
</row>
<row>
<entry>%R</entry>
<entry>
vidéo inverse (inversion de la couleur d'écriture et du fond)
</entry>
</row>
<row>
<entry>%U</entry>
<entry>
texte souligné
</entry>
</row>
<row>
<entry>%%</entry>
<entry>
afficher un seul "<literal>%</literal>"
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
NB: le même code (sans le numéro pour %C) peut être utilisé pour stopper
l'attribut défini.
</para>
<para>
Les codes couleur pour %C sont :
<informaltable colsep="0" frame="none">
<tgroup cols="2">
<thead>
<row>
<entry>Code</entry>
<entry>Couleur</entry>
</row>
</thead>
<tbody>
<row>
<entry>00</entry>
<entry>blanc</entry>
</row>
<row>
<entry>01</entry>
<entry>noir</entry>
</row>
<row>
<entry>02</entry>
<entry>bleu foncé</entry>
</row>
<row>
<entry>03</entry>
<entry>vert foncé</entry>
</row>
<row>
<entry>04</entry>
<entry>rouge clair</entry>
</row>
<row>
<entry>05</entry>
<entry>rouge foncé</entry>
</row>
<row>
<entry>06</entry>
<entry>magenta</entry>
</row>
<row>
<entry>07</entry>
<entry>orange</entry>
</row>
<row>
<entry>08</entry>
<entry>jaune</entry>
</row>
<row>
<entry>09</entry>
<entry>vert clair</entry>
</row>
<row>
<entry>10</entry>
<entry>cyan</entry>
</row>
<row>
<entry>11</entry>
<entry>cyan clair</entry>
</row>
<row>
<entry>12</entry>
<entry>bleu clair</entry>
</row>
<row>
<entry>13</entry>
<entry>magenta clair</entry>
</row>
<row>
<entry>14</entry>
<entry>gris</entry>
</row>
<row>
<entry>15</entry>
<entry>gris clair (blanc)</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para>
Exemple : affichage de "<literal>bonjour tout le monde !</literal>"
avec "<literal>bonjour</literal>" en bleu clair gras, et
"<literal>tout le monde</literal>" en rouge clair souligné :
<screen><userinput>%C12%Bbonjour%B%C04%U tout le monde%U%C !</userinput></screen>
</para>
</section>
<section id="secCommandesWeeChatIRC">
<title>Commandes WeeChat / IRC</title>
+173
View File
@@ -719,6 +719,179 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
</section>
<section id="secCommandLine">
<title>Command line</title>
<para>
WeeChat command line (at the bottom of window) lets you send text on
channels and execute WeeChat or IRC commands (see
<xref linkend="secWeeChatIRCCommands" />).
</para>
<para>
Commands begin with "/" char, followed by name of command.
For example, to initiate a private chat with "<literal>toto</literal>":
<screen><userinput>/query toto</userinput></screen>
</para>
<para>
Text sent to a channel is any text that does not begin with "/" char.
For example, to send text "<literal>hello</literal>" on current
channel:
<screen><userinput>hello</userinput></screen>
</para>
<para>
However, it is possible to start with "/" char, by adding another.
For example, to send text "<literal>/query toto</literal>" on current
channel:
<screen><userinput>//query toto</userinput></screen>
</para>
<para>
If option for sending IRC colors ("<literal>irc_colors_send</literal>")
is enabled, you can use color codes and attributes, as follow:
<informaltable colsep="0" frame="none">
<tgroup cols="2">
<thead>
<row>
<entry>Code</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>%B</entry>
<entry>
bold text
</entry>
</row>
<row>
<entry>%Cnn</entry>
<entry>
text color "<literal>nn</literal>" (see colors table below)
</entry>
</row>
<row>
<entry>%O</entry>
<entry>
disable color and attributes
</entry>
</row>
<row>
<entry>%R</entry>
<entry>
reverse video (revert text color with background)
</entry>
</row>
<row>
<entry>%U</entry>
<entry>
underlined text
</entry>
</row>
<row>
<entry>%%</entry>
<entry>
display one "<literal>%</literal>"
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
Note: the same code (without number for %C) may be used to stop the
attribute.
</para>
<para>
Color codes for %C are:
<informaltable colsep="0" frame="none">
<tgroup cols="2">
<thead>
<row>
<entry>Code</entry>
<entry>Color</entry>
</row>
</thead>
<tbody>
<row>
<entry>00</entry>
<entry>white</entry>
</row>
<row>
<entry>01</entry>
<entry>black</entry>
</row>
<row>
<entry>02</entry>
<entry>dark blue</entry>
</row>
<row>
<entry>03</entry>
<entry>dark green</entry>
</row>
<row>
<entry>04</entry>
<entry>light red</entry>
</row>
<row>
<entry>05</entry>
<entry>dark red</entry>
</row>
<row>
<entry>06</entry>
<entry>magenta</entry>
</row>
<row>
<entry>07</entry>
<entry>orange</entry>
</row>
<row>
<entry>08</entry>
<entry>yellow</entry>
</row>
<row>
<entry>09</entry>
<entry>light green</entry>
</row>
<row>
<entry>10</entry>
<entry>cyan</entry>
</row>
<row>
<entry>11</entry>
<entry>light cyan</entry>
</row>
<row>
<entry>12</entry>
<entry>light blue</entry>
</row>
<row>
<entry>13</entry>
<entry>light magenta</entry>
</row>
<row>
<entry>14</entry>
<entry>gray</entry>
</row>
<row>
<entry>15</entry>
<entry>light gray (white)</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para>
Example: display of "<literal>hello everybory!</literal>" with
"<literal>hello</literal>" in light blue bold, and
"<literal>everybody</literal>" in light red underlined:
<screen><userinput>%C12%Bhello%B%C04%U everybody%U%C!</userinput></screen>
</para>
</section>
<section id="secWeeChatIRCCommands">
<title>WeeChat / IRC commands</title>
+176
View File
@@ -729,6 +729,182 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
</section>
<section id="secLigneDeCommande">
<title>La ligne de commande</title>
<para>
La ligne de commande WeeChat (située en bas de la fenetre) permet
d'envoyer du texte sur les canaux et d'exécuter des commandes
WeeChat ou IRC (voir <xref linkend="secCommandesWeeChatIRC" />).
</para>
<para>
Les commandes débutent par un caractère "/", suivi du nom de la
commande. Par exemple pour initier une conversation privée avec
"<literal>toto</literal>" :
<screen><userinput>/query toto</userinput></screen>
</para>
<para>
Le texte envoyé à un canal est tout texte ne commençant pas par le
caractère "/", par exemple pour envoyer "<literal>bonjour</literal>"
sur le canal courant :
<screen><userinput>bonjour</userinput></screen>
</para>
<para>
Il est cependant possible de faire débuter un texte par "/" en le
doublant. Par exemple pour envoyer le texte
"<literal>/query toto</literal>" sur le canal courant :
<screen><userinput>//query toto</userinput></screen>
</para>
<para>
Si l'option d'envoi des couleurs IRC
("<literal>irc_colors_send</literal>") est activée, il est possible
d'utiliser des codes couleur et attributs comme suit :
<informaltable colsep="0" frame="none">
<tgroup cols="2">
<thead>
<row>
<entry>Code</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>%B</entry>
<entry>
texte gras
</entry>
</row>
<row>
<entry>%Cnn</entry>
<entry>
couleur du texte "<literal>nn</literal>"
(voir le tableau des couleurs ci-dessous)
</entry>
</row>
<row>
<entry>%O</entry>
<entry>
désactiver la couleur et tous les attributs
</entry>
</row>
<row>
<entry>%R</entry>
<entry>
vidéo inverse (inversion de la couleur d'écriture et du fond)
</entry>
</row>
<row>
<entry>%U</entry>
<entry>
texte souligné
</entry>
</row>
<row>
<entry>%%</entry>
<entry>
afficher un seul "<literal>%</literal>"
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
NB: le même code (sans le numéro pour %C) peut être utilisé pour stopper
l'attribut défini.
</para>
<para>
Les codes couleur pour %C sont :
<informaltable colsep="0" frame="none">
<tgroup cols="2">
<thead>
<row>
<entry>Code</entry>
<entry>Couleur</entry>
</row>
</thead>
<tbody>
<row>
<entry>00</entry>
<entry>blanc</entry>
</row>
<row>
<entry>01</entry>
<entry>noir</entry>
</row>
<row>
<entry>02</entry>
<entry>bleu foncé</entry>
</row>
<row>
<entry>03</entry>
<entry>vert foncé</entry>
</row>
<row>
<entry>04</entry>
<entry>rouge clair</entry>
</row>
<row>
<entry>05</entry>
<entry>rouge foncé</entry>
</row>
<row>
<entry>06</entry>
<entry>magenta</entry>
</row>
<row>
<entry>07</entry>
<entry>orange</entry>
</row>
<row>
<entry>08</entry>
<entry>jaune</entry>
</row>
<row>
<entry>09</entry>
<entry>vert clair</entry>
</row>
<row>
<entry>10</entry>
<entry>cyan</entry>
</row>
<row>
<entry>11</entry>
<entry>cyan clair</entry>
</row>
<row>
<entry>12</entry>
<entry>bleu clair</entry>
</row>
<row>
<entry>13</entry>
<entry>magenta clair</entry>
</row>
<row>
<entry>14</entry>
<entry>gris</entry>
</row>
<row>
<entry>15</entry>
<entry>gris clair (blanc)</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para>
Exemple : affichage de "<literal>bonjour tout le monde !</literal>"
avec "<literal>bonjour</literal>" en bleu clair gras, et
"<literal>tout le monde</literal>" en rouge clair souligné :
<screen><userinput>%C12%Bbonjour%B%C04%U tout le monde%U%C !</userinput></screen>
</para>
</section>
<section id="secCommandesWeeChatIRC">
<title>Commandes WeeChat / IRC</title>