//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_relay_relay]]
* `+relay+`: Relay-Kontrolle

----
/relay  list|listfull|listrelay
        add <name> <port>|<path>
        del|start|restart|stop <name>
        raw
        sslcertkey

         list: Auflistung der Relay-Clients (nur aktive Relays)
     listfull: detaillierte Auflistung der Relay-Clients (alle Relays)
    listrelay: Auflistung der Relays (Name und Port)
          add: fügt ein Relay, für ein Protokoll + Name, hinzu
          del: entfernt Relay für ein Protokoll + Name
        start: lausche am Port
      restart: beendet den Server Socket und lauscht erneut am Port (Clients bleiben verbunden)
         stop: schließt den Server Socket (Clients bleiben verbunden)
         name: Name des Relays (siehe Format weiter unten)
         port: Port der für Relay genutzt werden soll
         path: Pfad der für Relay genutzt werden soll (ausschließlich für UNIX Domain Socket); "%h" wird durch das WeeChat Verzeichnis ersetzt, Standardverzeichnis: ("~/.weechat"), Inhalt ist evaluiert (siehe /help eval)
          raw: öffnet einen Buffer mit Relay-Rohdaten
   sslcertkey: setzt SSL Zertifikat/Schlüssel mittels Pfad in Einstellung relay.network.ssl_cert_key

Aufbau des Relay-Namens: [ipv4.][ipv6.][ssl.]<Protokoll.Name> oder unix.[ssl.]<Protokoll.Name>
         ipv4: erzwingt die Nutzung von IPv4
         ipv6: erzwingt die Nutzung von IPv6
          ssl: aktiviert SSL
         unix: nutzt UNIX Domain Socket
protocol.name: Protokoll und Name des Relay:
                 - Protokoll "irc": Name des Servers welcher geteilt werden soll (optional. Falls kein Name angegeben wird, muss der Client einen Namen mit dem Befehl "PASS" übermitteln, das Format ist wie folgt: "PASS Server:Passwort")
                 - Protokoll "weechat" (es wird kein Name verwendet)

Das "irc" Protokoll dient dazu eine Verbindung zu einem anderen IRC Client (oder zu einem zweiten WeeChat) herzustellen.
Das "weechat" Protokoll wird von einem Remote-Interface genutzt um eine Verbindung auf dem Port herzustellen. Siehe https://weechat.org/about/interfaces

Ohne Angabe von Argumenten werden alle Relay-Clients in einem neuen Buffer dargestellt.

Beispiele:
  IRC Proxy für Server "freenode":
    /relay add irc.freenode 8000
  IRC Proxy, für Server "freenode", mit SSL:
    /relay add ssl.irc.freenode 8001
  IRC Proxy für alle Server (Client wählt aus), mit SSL:
    /relay add ssl.irc 8002
  WeeChat Protokoll:
    /relay add weechat 9000
  WeeChat Protokoll, mit SSL:
    /relay add ssl.weechat 9001
  WeeChat Protokoll, mit SSL, nur IPv4 nutzen:
    /relay add ipv4.ssl.weechat 9001
  WeeChat Protokoll, mit SSL, nur IPv6 nutzen:
    /relay add ipv6.ssl.weechat 9001
  WeeChat Protokoll, mit SSL, mit IPv4 + IPv6:
    /relay add ipv4.ipv6.ssl.weechat 9001
  Weechat Protokoll über UNIX Domain Socket:
    /relay add unix.weechat %h/relay_socket
----
