From 5957618c3d2de2e0527101c10a0e39f8d82d9dae Mon Sep 17 00:00:00 2001 From: GermanBluefox Date: Mon, 26 Aug 2024 08:34:13 +0800 Subject: [PATCH] Typos in CLI documentation --- docs/de/config/cli.md | 220 +++++++++++++++--------------- docs/en/config/cli.md | 308 ++++++++++++++++++++---------------------- 2 files changed, 258 insertions(+), 270 deletions(-) diff --git a/docs/de/config/cli.md b/docs/de/config/cli.md index 741c59ae1..5d4f2eedb 100644 --- a/docs/de/config/cli.md +++ b/docs/de/config/cli.md @@ -1,8 +1,8 @@ # Konsolenbefehle Einige Befehle wie z.B. starten, stoppen oder aktualisieren können über die Konsole (Windows bzw. Linux) ausgeführt werden. -***Hinweis:*** Alle Befehle, die mit ```iobroker``` beginnen, können von jedem Verzeichnis aus aufgerufen werden. -Der Befehl ```npm install``` muss jedoch im ioBroker-Stammverzeichnis ausgeführt werden. +***Hinweis:*** Alle Befehle, die mit `iobroker` beginnen, können von jedem Verzeichnis aus aufgerufen werden. +Der Befehl `npm install` muss jedoch im ioBroker-Stammverzeichnis ausgeführt werden. Befehlsübersicht: @@ -62,100 +62,100 @@ Befehlsübersicht: - [iobroker cert create](#iobroker-cert-create) - [iobroker logs \[--watch\]](#iobroker-logs) -***Hinweis:*** Mit dem Parameter ```--timeout 5000``` am Ende eines jeden Befehls kann ein Timeout (ms) für die Verbindung zur DB angegeben werden. +***Hinweis:*** Mit dem Parameter `--timeout 5000` am Ende eines jeden Befehls kann ein Timeout (ms) für die Verbindung zur DB angegeben werden. ## npm install iobroker.adapterName -Dieser Befehl muss vom Stammverzeichnis des ioBroker aus aufgerufen werden (normalerweise ```/opt/iobroker``` oder ```C:\Program Files\ioBroker```). Mit dem npm-Manager können bestimmte Adapter und der js-Controller installiert oder aktualisiert werden. Es funktioniert immer, auch wenn der "admin" oder "js-Controller" Probleme hat. +Dieser Befehl muss vom Stammverzeichnis des ioBroker aus aufgerufen werden (normalerweise `/opt/iobroker` oder `C:\Program Files\ioBroker`). Mit dem npm-Manager können bestimmte Adapter und der js-Controller installiert oder aktualisiert werden. Es funktioniert immer, auch wenn der "admin" oder "js-Controller" Probleme hat. Anwendungsbeispiele: -- ```npm install iobroker.admin``` - aktualisiert oder installiert den "admin" -Adapter -- ```npm install iobroker.js-controller``` - aktualisiert oder installiert den js-controller selbst -- ```npm installiere https://github.com/husky-koglhof/ioBroker.hmm/tarball/master/``` - installiert diesen Adapter direkt von github oder von einem anderen Ort aus. Es muss ein ZIP- oder GZ-Paket sein und muss package.json enthalten. +- `npm install iobroker.admin` - aktualisiert oder installiert den "admin" -Adapter +- `npm install iobroker.js-controller` - aktualisiert oder installiert den js-controller selbst +- `npm installiere https://github.com/husky-koglhof/ioBroker.hmm/tarball/master/` - installiert diesen Adapter direkt von github oder von einem anderen Ort aus. Es muss ein ZIP- oder GZ-Paket sein und muss package.json enthalten. -Damit die Änderungen wirksam werden sollte nach dem Aufruf von ```npm install ..``` der Neustart des angegebenen Adapters oder des gesamten js-Controllers durchgeführt werden, . +Damit die Änderungen wirksam werden sollte nach dem Aufruf von `npm install ..` der Neustart des angegebenen Adapters oder des gesamten js-Controllers durchgeführt werden. -Dies kann mit ```iobroker restart adapterName``` oder nur mit ```iobroker restart``` erfolgen. Für Einzelheiten siehe [iobroker restart](#iobroker-restart). +Dies kann mit `iobroker restart adapterName` oder nur mit `iobroker restart` erfolgen. Für Einzelheiten siehe [iobroker restart](#iobroker-restart). ***Hinweis:*** Nur Pakete mit dem Namen **ioBroker.zzz** können so installiert werden. ## iobroker start Startet Iobroker als Daemon. Wenn der ioBroker bereits gestartet ist, erscheint die Warnung: -```ioBroker controller daemon already running. PID: xx``` +`ioBroker controller daemon already running. PID: xx` -***Hinweis für Windows:*** ioBroker wird unter Windows als Dienst gestartet. Der Befehl ```iobroker start``` startet eine zweite Instanz von ioBroker und dies führt hier zu Konflikten. -Stattdessen mit Administratorrechten im ioBroker-Verzeichnis den Befehl ```serviceIoBroker.bat start``` ausführen um den Dienst zu starten. +***Hinweis für Windows:*** ioBroker wird unter Windows als Dienst gestartet. Der Befehl `iobroker start` startet eine zweite Instanz von ioBroker und dies führt hier zu Konflikten. +Stattdessen mit Administratorrechten im ioBroker-Verzeichnis den Befehl `serviceIoBroker.bat start` ausführen um den Dienst zu starten. ## iobroker stop Stoppt IoBroker, wenn er als Dämon ausgeführt wird. Wenn der ioBroker nicht gestartet war, erscheint die Warnung: -```ioBroker controller daemon is not running``` +`ioBroker controller daemon is not running` -***Hinweis für Windows:*** ioBroker wird unter Windows als Dienst gestartet. Der Befehl ```iobroker stop``` funktioniert hier nicht. Stattdessen mit Administratorrechten im ioBroker-Verzeichnis den Befehl ```serviceIoBroker.bat stop``` ausführen um den Dienst zu beenden. +***Hinweis für Windows:*** ioBroker wird unter Windows als Dienst gestartet. Der Befehl `iobroker stop` funktioniert hier nicht. Stattdessen mit Administratorrechten im ioBroker-Verzeichnis den Befehl `serviceIoBroker.bat stop` ausführen um den Dienst zu beenden. ## iobroker restart -Führt die Befehle ```iobroker stop``` und ```iobroker start``` nacheinander aus. +Führt die Befehle `iobroker stop` und `iobroker start` nacheinander aus. ## iobroker isrun Gibt aus ob ioBroker läuft oder nicht. Wenn ioBroker nicht gestartet ist, lautet der Ausgabecode 100. -Gleich Funktion wie ```iobroker status```. +Gleich Funktion wie `iobroker status`. ## iobroker start adapterName.instance Startet die Instanz des angegebenen Adapters. Falls die Instanz bereits läuft wird sie neu gestartet. Beispiel: -- ```iobroker start email.0``` - aktiviert und startet den email Adapter mit der Instanz 0 +- `iobroker start email.0` - aktiviert und startet den `email` Adapter mit der Instanz 0 -***Hinweis:*** Mit ```iobroker start all``` werden alle deaktivierten Instanzen gestartet, z.B. nach einer Systemwiederherstellung. +***Hinweis:*** Mit `iobroker start all` werden alle deaktivierten Instanzen gestartet, z.B. nach einer Systemwiederherstellung. ## iobroker stop adapterName.instance Stoppt die Instanz des angegebenen Adapters. Beispiel: -- ``` Iobroker stop email.0``` - stoppt den email Adapter mit der Instanz 0 +- ` Iobroker stop email.0` - stoppt den `email` Adapter mit der Instanz 0 ## iobroker restart adapterName.instance -Startet die Instanz des angegebenen Adapter neu. Wenn die Instanz deaktiviert war, wird sie aktiviert. +Startet die Instanz den angegebenen Adapter neu. Wenn die Instanz deaktiviert war, wird sie aktiviert. ## iobroker add adapterName -Die vollständige Syntax lautet ```iobroker add adapterName [desiredInstanceNumber] [--enabled] [--host \] [--port \]``` +Die vollständige Syntax lautet `iobroker add adapterName [desiredInstanceNumber] [--enabled] [--host \] [--port \]` Falls nicht installiert wird eine Instanz des angegebenen Adapters mit der Bezeichnung adaptername.0 installiert. Wenn die Instanz des Adapters bereits vorhanden ist, wird die nächsthöhere Instanznummer verwendet. Parameter: - enabled: Die Adapterinstanz wird nach der Erstellung automatisch aktiviert. Andernfalls wird der vom Adapter vordefinierte Wert dafür verwendet. -- host: Name des Hosts auf dem die Adapterinstanz erstellt werden soll. Die Liste der verfügbaren Hosts kann mit dem Befehl ```iobroker list hosts``` abgefragt werden. +- host: Name des Hosts, auf dem die Adapterinstanz erstellt werden soll. Die Liste der verfügbaren Hosts kann mit dem Befehl `iobroker list hosts` abgefragt werden. - port: Hier wird der gewünschte Port eingestellt. Bei normaler Installtion ist dies nicht notwendig, da der native port des Adapters verwendet wird. - desiredInstanceNumber: Hiermit wird die gewünschte ID der Instanz vergeben. Beipiel: -- ```iobroker add dwd``` - Installiert und erstellt eine Instanz des dwd-Adapters. -- ```iobroker add admin --enabled --port 80``` - Erstellt eine zweite (normalerweise ist admin.0 schon vorhanden) Instanz des Admin Adapters auf Port 80 und aktiviert sie. +- `iobroker add dwd` - Installiert und erstellt eine Instanz des dwd-Adapters. +- `iobroker add admin --enabled --port 80` - Erstellt eine zweite (normalerweise ist admin.0 schon vorhanden) Instanz des Admin Adapters auf Port 80 und aktiviert sie. -Falls dies nicht funktioniert sollte, ist die Installation immer über den Befehl ```npm install iobroker.adapterName``` im ioBroker-Stammverzeichnis möglich. Falls keine Instanz erstellt wird, den Befehl ```iobroker add iobroker.adapterName``` noch einmal aufrufen. +Falls dies nicht funktionieren sollte, ist die Installation immer über den Befehl `npm install iobroker.adapterName` im ioBroker-Stammverzeichnis möglich. Falls keine Instanz erstellt wird, den Befehl `iobroker add iobroker.adapterName` noch einmal aufrufen. ## iobroker install adapterName Installiert nur den Adapter ohne Instanz. Wenn der Adapter bereits installiert ist, erscheint die Warnung: -```adapter "admin" yet installed. Use "upgrade" to install newer version.``` +`adapter "admin" yet installed. Use "upgrade" to install newer version.` ## iobroker upload adapterName Lädt Webseiten aus den Ordnern "www" und "admin" eines Adapters in den ioBroker-Dateispeicher hoch. Wird normalerweise von Entwicklern verwendet, um die Änderungen auf deren Konfigurationsseiten oder auf den "www" -Seiten anzuzeigen. Die Dateien können nicht direkt in "iobroker/iobroker-data/adapter/file" geändert werden. -In der Konfigurationsdatei (*iobroker-data/iobroker.json*) objects.noFileCache gibt es ein Flag für Entwickler, um den Cache der Datei zu deaktivieren. Wenn dieses Flag auf true gesetzt ist (nachdem die Konfigurationsdatei geändert wurde ist ein Neustart erforderlich), werden die Änderungen im iobroker-data-Verzeichnis ohne den Befehl ```iobroker upload adapterName``` im Web angezeigt. +In der Konfigurationsdatei (*iobroker-data/iobroker.json*) objects.noFileCache gibt es ein Flag für Entwickler, um den Cache der Datei zu deaktivieren. Wenn dieses Flag auf true gesetzt ist (nachdem die Konfigurationsdatei geändert wurde ist ein Neustart erforderlich), werden die Änderungen im iobroker-data-Verzeichnis ohne den Befehl `iobroker upload adapterName` im Web angezeigt. -***Hinweis:*** Mit ```iobroker upload all``` werden alle Adapter hochgeladen, z.B nach einer Systemwiederherstellung. +***Hinweis:*** Mit `iobroker upload all` werden alle Adapter hochgeladen, z.B. nach einer Systemwiederherstellung. ## iobroker setup Dieser Befehl muss aufgerufen werden, wenn ioBroker nicht mit npm oder Windows Installer installiert wurde (z.B. von github kopiert und entpackt). Er erstellt die Standardkonfigurationsdatei und bereitet die Datenverzeichnisse vor. -```iobroker setup first``` - stellt sicher, dass nichts von einer bereits vorhandenen Konfiguration überschrieben wird. +`iobroker setup first` - stellt sicher, dass nichts von einer bereits vorhandenen Konfiguration überschrieben wird. ## iobroker setup custom Zur manuellen Einrichtung eines Multi-Host Systems muss dieser Befehl zuerst auf dem Master und dann auf den untergeordneten Systemen ausgeführt werden. Folgende Werte müssen nacheinander gesetzt werden: @@ -171,7 +171,7 @@ Mit ENTER wird der jeweilige Standarwert innerhalb der eckigen Klammern übernom ***Hinweis:*** derzeit wird nur *file* DB typen unterstützt. Port Änderungen setzt Sachkenntnis voraus. -***Hinweis:*** Die Firewall Einstellungen des Master Systems für die Standartports (9000/9001) prüfen. +***Hinweis:*** Die Firewall Einstellungen des Mastersystems für die Standartports (9000/9001) prüfen. ## iobroker del adapterName Entfernt alle Instanzen und Zustände dieses Adapters vollständig von ioBroker und löscht ihn von der Festplatte. @@ -179,7 +179,7 @@ Entfernt alle Instanzen und Zustände dieses Adapters vollständig von ioBroker ***Hinweis:*** Die Einstellungen der Adapterinstanzen können nach dem Löschen nicht wiederhergestellt werden. Bespiel: -```iobroker del dwd``` - löscht alle Instanzen und Zustände des dwd Adapters. +`iobroker del dwd` - löscht alle Instanzen und Zustände des dwd Adapters. ## iobroker del adapterName.instance Entfernt nur die angegebene Instanz dieses Adapters von ioBroker und löscht den Adapter aber **nicht** von der Festplatte. @@ -187,18 +187,18 @@ Entfernt nur die angegebene Instanz dieses Adapters von ioBroker und löscht den ***Hinweis:*** Die Einstellungen der Adapterinstanz können nach dem Löschen nicht wiederhergestellt werden. Beispiel: -```iobroker del dwd.0``` - löscht Instanz 0 des dwd Adapters. +`iobroker del dwd.0` - löscht Instanz 0 des dwd Adapters. ## iobroker update -Liest die Informationen gemäß dem im Admin Adapter eingestellten ioBroker-Repository aus und zeigt mögliche Updates an. Wenn ```\repository url\``` nachgestellt wird, werden die Informationen aus dem genannten Repository ausgelesen. +Liest die Informationen gemäß dem im Admin Adapter eingestellten ioBroker-Repository aus und zeigt mögliche Updates an. Wenn `\repository url\` nachgestellt wird, werden die Informationen aus dem genannten Repository ausgelesen. Dieser Befehl ändert nichts, aktualisiert lediglich die internen Informationen zu verfügbaren Adapterversionen und zeigt sie an. Beispiel: -- ```iobroker update``` - Liste der verfügbaren Version des konfigurierten (normalerweise lokalen) Repositorys. -- ```iobroker update https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json``` - Listet verfügbare Versionen aus dem Online-Repository auf. -- ```iobroker update --updatable``` - Listet nur aktualisierbare Adapter auf +- `iobroker update` - Liste der verfügbaren Version des konfigurierten (normalerweise lokalen) Repositorys. +- `iobroker update https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json` - Listet verfügbare Versionen aus dem Online-Repository auf. +- `iobroker update --updatable` - Listet nur aktualisierbare Adapter auf -Ausgabebeispiel für ```iobroker update```: +Ausgabebeispiel für `iobroker update`: ``` >./iobroker.js update update done @@ -244,24 +244,24 @@ Aktualisiert alle Adapter (nicht js-Controller), wenn sie mit einer neueren Vers Beispiel: -- ```iobroker upgrade``` - alle Adapter aktualisieren. -- ```iobroker upgrade https:// raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json``` - Aktualisiert alle Adapter aus dem Online-Repository +- `iobroker upgrade` - alle Adapter aktualisieren. +- `iobroker upgrade https:// raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json` - Aktualisiert alle Adapter aus dem Online-Repository ## iobroker upgrade self -Dieser Befehl aktualisiert den ioBroker.js-Controller auf die sich im Repository zu findende Version. +Dieser Befehl aktualisiert den `ioBroker.js-controller` auf die sich im Repository zu findende Version. ***Hinweis:*** Wenn das angegebene oder konfigurierte Repository eine niedrigere Version hat, wird es auf diese Version heruntergestuft. -- ```iobroker upgrade self``` - aktualisiert den js-Controller auf die Version im konfigurierten Repository. -- ```iobroker upgrade self https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json``` - Aktualisiert den js-controller auf die Version des online-Repository. +- `iobroker upgrade self` - aktualisiert den js-Controller auf die Version im konfigurierten Repository. +- `iobroker upgrade self https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json` - Aktualisiert den js-controller auf die Version des online-Repository. ## iobroker upgrade adapterName Dieser Befehl aktualisiert den angegebenen Adapter auf die Version, die sich im Repository befindet. ***Hinweis:*** Wenn das angegebene oder konfigurierte Repository eine niedrigere Version hat, wird es auf diese Version heruntergestuft. -- ```iobroker upgrade email``` - Upgrade des ioBroker.email-Adapters auf die Version im konfigurierten Repository. -- ```iobroker upgrade email https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json``` - Upgrade des ioBroker.email-Adapters auf die Version vom Online-Repository . +- `iobroker upgrade email` - Upgrade des `ioBroker.email`-Adapters auf die Version im konfigurierten Repository. +- `iobroker upgrade email https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json` - Upgrade des ioBroker.email-Adapters auf die Version vom Online-Repository. ## iobroker nodejs-update Dieser Befehl aktualisiert Node.js auf die sich im Repository zu findende Version. @@ -269,7 +269,7 @@ Dieser Befehl aktualisiert Node.js auf die sich im Repository zu findende Versio - `iobroker nodejs-update` - aktualisiert Node.js auf die aktuelle Version im konfigurierten Repository. ## iobroker object get -Liest Wert einer Objekt ID aus. Beispiel ```iobroker object get system.adapter.admin.0.uptime``` gibt aus: +Liest Wert einer Objekt-ID aus. Beispiel `iobroker object get system.adapter.admin.0.uptime` gibt aus: ``` >./iobroker object get system.adapter.admin.0.uptime @@ -298,17 +298,17 @@ iobroker object get system.adapter.admin.0.uptime --pretty ``` ## iobroker object chmod -Format: ```iobroker object chmod [state-mode] ``` +Format: `iobroker object chmod [state-mode] ` ID kann ein Muster mit '\*' sein. '\*' kann nur am Ende des Musters sein. ## iobroker object chown -Format: ```iobroker object chown ``` +Format: `iobroker object chown ` ID kann ein Muster mit '\*' sein. '\*' kann nur am Ende des Musters sein. ## iobroker object list -Format: ```iobroker object list ``` +Format: `iobroker object list ` Listenberechtigungen von Objekten, wie z.B.: @@ -329,19 +329,19 @@ rw-r--r-- admin administrator system.adapter.admin.0 ID kann ein Muster mit '\*' sein. '\*' kann nur am Ende des Musters sein. ## iobroker set -Vollständige Syntax: ```iobroker set [--port value] [--enabled true|false] [--ip address] [--auth true|false] [--secure true|false] [—-ttl value]``` +Vollständige Syntax: `iobroker set [--port value] [--enabled true|false] [--ip address] [--auth true|false] [--secure true|false] [—-ttl value]` Zum Ändern von Instanzeinstellungen von der Konsole aus. Folgende Einstellungen können geändert werden: - Port - Port ändern, an den die Instanz gebunden ist -- enabled - Aktivieren/Deaktivieren der Instanz (Kann auch mit ```iobroker start|stopp ``` durchgeführt werden) +- enabled - Aktivieren/Deaktivieren der Instanz (Kann auch mit `iobroker start|stopp ` durchgeführt werden) - ip - Gebundene IP-Adresse ändern - auth - Authentifizierung aktivieren oder deaktivieren - secure - SSL-Protokoll ein- oder ausschalten - TTL - Login Timeout in Sekunden ## iobroker state get -Vollständige Syntax: ```iobroker state get stateId``` +Vollständige Syntax: `iobroker state get stateId` Liest den JSON-Wert eines states aus: @@ -364,7 +364,7 @@ Mit dem Flag "--pretty" wird die Ausgabe formatiert:: ``` ## iobroker state getplain -Vollständige Syntax: ```iobroker state getplain stateId``` +Vollständige Syntax: `iobroker state getplain stateId` Liest den JSON-Wert eines states als Listenattribut aus: @@ -378,7 +378,7 @@ system.adapter.admin.0 ``` ## iobroker state getvalue -Vollständige Syntax: ```iobroker state getvalue stateId``` +Vollständige Syntax: `iobroker state getvalue stateId` Lesen Sie den einfachen Wert des Status als Listenattribute: @@ -388,23 +388,23 @@ Lesen Sie den einfachen Wert des Status als Listenattribute: ``` ## iobroker state set -Vollständige Syntax: ```iobroker state set stateId newValue ack``` +Vollständige Syntax: `iobroker state set stateId newValue ack` Setzt den Wert eines states. "ack" ist standardmäßig "false". -```>iobroker state set sayit.0.tts.text "Text"``` +`>iobroker state set sayit.0.tts.text "Text"` -```>iobroker state set adapter.0.states.temperature 28.5 true``` +`>iobroker state set adapter.0.states.temperature 28.5 true` ***Hinweis:*** Bei falscher ID wird keine Fehlermeldung angezeigt. ## iobroker state del -Vollständige Syntax: ```iobroker state del stateId``` +Vollständige Syntax: `iobroker state del stateId` Löscht diesen state. ## iobroker message -Vollständige Syntax: ```iobroker message adapter.instance command message``` +Vollständige Syntax: `iobroker message adapter.instance command message` Sendet eine Nachricht an die angegebene Adapterinstanz oder alle Instanzen des Adapters, wenn keine Instanz festgelegt ist. @@ -423,15 +423,15 @@ Restarting ioBroker... Sichert ioBroker als ZIP-Datei im Verzeichnis _backups_ und werden mit Datum und Zeit versehen: -```2015_02_10-17_49_45_backupIoBroker.tar.gz``` with current date and time. +`2015_02_10-17_49_45_backupIoBroker.tar.gz` with current date and time. ## iobroker restore ***Hinweis:*** ioBroker muss vor Ausführung dieses Befehls gestoppt werden. -Full syntax: ```iobroker restore ``` +Full syntax: `iobroker restore ` -Wenn Sicherungen mit dem Befehl ```iobroker backup``` erstellt wurden, können sie hiermit wiederhergestellt werden. Ohne Parameter aufgerufen wird eine Liste der verfügbaren Sicherungen ausgegeben. +Wenn Sicherungen mit dem Befehl `iobroker backup` erstellt wurden, können Sie hiermit wiederhergestellt werden. Ohne Parameter aufgerufen wird eine Liste der verfügbaren Sicherungen ausgegeben. ``` />iobroker restore @@ -440,7 +440,7 @@ Please specify one of the backup names: 2015_07_17-21_54_01_backupIoBroker.tar.gz or 2015_07_17-21_54_01 or 1 ``` -Mit ```iobroker restore 0``` wird die neueste Sicherungsdatei geladen. +Mit `iobroker restore 0` wird die neueste Sicherungsdatei geladen. Die folgenden Befehle sind für das angegebene Beispiel gleich: - iobroker restore 0 @@ -448,7 +448,7 @@ Die folgenden Befehle sind für das angegebene Beispiel gleich: - iobroker 2015_07_17-21_54_01_backupioBroker.tar.gz - iobroker /opt/iobroker/backups/2015_07_17-21_54_01_backupioBroker.tar.gz -Alle Adapter werden außer "admin" werden deaktiviert wiederhergestellt. Alle Adapter können gleichzeitig mit ```iobroker start all``` aktiviert werden. Falls einige Adapter nicht hochgeladen wurden, kann mit ```iobroker upload all``` um alle Adapterdateien gleichzeitig hochgeladen werden. +Alle Adapter werden außer "admin" werden deaktiviert wiederhergestellt. Alle Adapter können gleichzeitig mit `iobroker start all` aktiviert werden. Falls einige Adapter nicht hochgeladen wurden, kann mit `iobroker upload all` um alle Adapterdateien gleichzeitig hochgeladen werden. ## iobroker host Ändert den Hostnamen in den Objekten. @@ -457,80 +457,80 @@ Manchmal muss durch Verschieben der ioBroker Daten von einem System auf ein ande ***Hinweis:*** ioBroker muss vor Ausführung dieses Befehls gestoppt werden. -Um einen bestimmten Hostnamen in der DB in den aktuellen Hostnamen zu ändern, schreiben Sie ```iobroker host oldHostName```. +Um einen bestimmten Hostnamen in der DB in den aktuellen Hostnamen zu ändern, schreiben Sie `iobroker host oldHostName`. -Um einen beliebigen Hostnamen zu ändern (darf nur ein Hostsystem sein, nicht für Multihosts), schreiben Sie ```iobroker host this```. +Um einen beliebigen Hostnamen zu ändern (darf nur ein Hostsystem sein, nicht für Multihosts), schreiben Sie `iobroker host this`. ## iobroker host set -Sie können den Hostnamen in einen bestimmten Namen ändern (nicht den Computernamen). Dazu müssen Sie schreiben: ```iobroker host set newHostName```, um den tatsächlichen Computernamen oder den zuvor angegebenen Hostnamen umzubenennen. +Sie können den Hostnamen in einen bestimmten Namen ändern (nicht den Computernamen). Dazu müssen Sie schreiben: `iobroker host set newHostName`, um den tatsächlichen Computernamen oder den zuvor angegebenen Hostnamen umzubenennen. ## iobroker host remove -Um den Host zu löschen, schreiben Sie einfach ```iobroker host remove hostNameToRemove```. Bitte seien Sie damit vorsichtig. +Um den Host zu löschen, schreiben Sie einfach `iobroker host remove hostNameToRemove`. Bitte seien Sie damit vorsichtig. ## iobroker list Mit diesem Befehl können verschiedene Objekt-Typen und Zustände in ioBroker angezeigt werden. Beispiele: -- ```iobroker list objects hm-rega.0``` - zeigt alle Objekte der Instanz hm-rega.0 -- ```iobroker list states hm-rega.0``` - Zeigt alle Zustände der Instanz hm-rega.0 an -- ```iobroker list files vis.0``` - zeigt alle Dateien der Instanz vis.0 an -- ```iobroker list instances``` - alle Instanzen anzeigen -- ```iobroker list adapters``` - zeige alle Adapter -- ```iobroker list users``` - alle Benutzer anzeigen -- ```iobroker list groups``` - alle Gruppen anzeigen -- ```iobroker list enums``` - zeigt alle Aufzählungen -- ```iobroker list hosts``` - alle Hosts anzeigen +- `iobroker list objects hm-rega.0` - zeigt alle Objekte der Instanz hm-rega.0 +- `iobroker list states hm-rega.0` - Zeigt alle Zustände der Instanz hm-rega.0 an +- `iobroker list files vis.0` - zeigt alle Dateien der Instanz vis.0 an +- `iobroker list instances` - alle Instanzen anzeigen +- `iobroker list adapters` - zeige alle Adapter +- `iobroker list users` - alle Benutzer anzeigen +- `iobroker list groups` - alle Gruppen anzeigen +- `iobroker list enums` - zeigt alle Aufzählungen +- `iobroker list hosts` - alle Hosts anzeigen Es ist möglich, kurze Typenbezeichnungen zu verwenden: -- o - Objekte -- s - States -- u - Benutzer -- e - Aufzählungen -- g - Gruppen -- i - Instanzen -- f - Dateien -- h - Gastgeber +- `o` - Objekte +- `s` - States +- `u` - Benutzer +- `e` - Aufzählungen +- `g` - Gruppen +- `i` - Instanzen +- `f` - Dateien +- `h` - Gastgeber -Z.B. wird mit ```iobroker l u``` alle Benutzer aufgelistet. +Z.B. wird mit `iobroker l u` alle Benutzer aufgelistet. Mit den "Listeninstanzen" können zusätzliche Filter verwendet werden: -- enabled - listet alle aktivierten Instanzen auf -- disabled - listet alle deaktivierten Instanzen auf -- port - listet alle Instanzen mit Port auf -- ip - listet alle Instanzen auf, die an eine bestimmte IP-Adresse gebunden werden können -- ssl - listet alle Instanzen auf, in denen SSL aktiviert werden kann +- `enabled` - listet alle aktivierten Instanzen auf +- `disabled` - listet alle deaktivierten Instanzen auf +- `port` - listet alle Instanzen mit Port auf +- `ip` - listet alle Instanzen auf, die an eine bestimmte IP-Adresse gebunden werden können +- `ssl` - listet alle Instanzen auf, in denen SSL aktiviert werden kann -Mit ```iobroker list instances --enabled``` werden alle aktivierten Instanzen aufgelistet +Mit `iobroker list instances --enabled` werden alle aktivierten Instanzen aufgelistet -oder mit ```iobroker l i --port``` werden die verwendeten Ports aufgelistet. +oder mit `iobroker l i --port` werden die verwendeten Ports aufgelistet. ## iobroker adduser Mit diesem Befehl kann ein neuer Benutzer erstellt werden (standardmäßig in der Gruppe "Administrator"). Die Gruppe kann im Befehl mit dem Parameter "--ingroup" definiert werden. Wenn das Kennwort nicht angegeben ist, muss es über die Konsole eingegeben werden. Z.B. Benutzer "Martin" in der Gruppe "Benutzer" anlegen: -```iobroker adduser martin --group user``` +`iobroker adduser martin --group user` Benutzer mit Passwort erstellen: -```iobroker adduser martin --group user --password 12345``` +`iobroker adduser martin --group user --password 12345` ## iobroker deluser Löscht einen vorhandenen Benutzer: -```iobroker deluser username``` +`iobroker deluser username` -Der Benutzer wird automatisch aus allen Gruppen gelöscht. "admin" Benutzer kann nicht gelöscht werden. +Der Benutzer wird automatisch aus allen Gruppen gelöscht. `admin` Benutzer kann nicht gelöscht werden. ## iobroker passwd Ändert das Passwort eines bestehenden Benutzers: -```iobroker passwd username``` +`iobroker passwd username` Anschließend muss das Passwort eingeben und wiederholt werden. Wenn keine Konsoleninteraktion gewünscht wird, das Passwort wie folgt mitgeben: -```iobroker passwd username --password newPassword``` +`iobroker passwd username --password newPassword` ## iobroker chmod Dateimodus ändern @@ -542,32 +542,32 @@ Dateieigentümer ändern Liest eine Datei aus der Datenbank ein und speichert sie im lokalen Dateisystem. Verwendungszweck: -```iobroker file read [storeFile]``` +`iobroker file read [storeFile]` storeFile ist optional, kann jedoch der Pfad zum Verzeichnis oder zur neuen Datei sein. Beispiel: -```iobroker file read /vis.0/main/img/picture.png /opt/myfile.png``` +`iobroker file read /vis.0/main/img/picture.png /opt/myfile.png` -file bzw. read kann mit f bzw. r abgekürzt werden. +`file` bzw. `read` kann mit f bzw. r abgekürzt werden. ## iobroker file write Datei vom lokalen Dateisystem in die DB schreiben. Verwendungszweck: -```iobroker file write ``` +`iobroker file write ` storeFile kann ein Pfad zum Verzeichnis in DB oder ein vollständiger Name sein Beispiel: -```iobroker file write /opt/myfile.png /vis.0/main/img/picture.png``` +`iobroker file write /opt/myfile.png /vis.0/main/img/picture.png` -file bzw. write kann mit f bzw. w abgekürzt werden. +`file` bzw. `write` kann mit f bzw. w abgekürzt werden. ## iobroker version -Zeigt die Version eines Adapters oder des js-Controllers an. +Zeigt die Version eines Adapters oder des js-controllers an. Version des js-Controllers: @@ -646,9 +646,7 @@ NPM : v5.8.0 Zeigt den Status des Compact-Mode für den aktuellen Host an. -``` -Compact mode for this host is currently enabled -``` +`Compact mode for this host is currently enabled` ## iobroker compact [enable|disable|on|off] **Verfügbar seit js-controller 2.0.0** @@ -669,7 +667,7 @@ Folgende Befehle sind möglich: ## iobroker compact adapterName.instance **Verfügbar seit js-controller 2.0.0** -Dieser Befehl erlaubt die Compact-Modus Konfiguration einer Adapter-Instanz zu prüfen und zu ändern. +Dieser Befehl erlaubt des Compact-Modus Konfiguration einer Adapter-Instanz zu prüfen und zu ändern. Es werden immer alle Einstellungen (siehe status) angezeigt inklusive der vorgenommenen Änderungen. @@ -743,8 +741,8 @@ Letzte Zeilen anzeigen und das ioBroker-Protokoll überwachen. Dieser Befehl zeigt die letzten 1000 Protokollzeilen an und überwacht das Protokoll: -```iobroker logs --lines 1000``` +`iobroker logs --lines 1000` Um das Protokoll zu überwachen, fügen Sie "--watch" hinzu, wie hier: -```iobroker logs --lines 100 --watch``` +`iobroker logs --lines 100 --watch` diff --git a/docs/en/config/cli.md b/docs/en/config/cli.md index 94c2fa72d..304067364 100644 --- a/docs/en/config/cli.md +++ b/docs/en/config/cli.md @@ -1,9 +1,9 @@ # Console commands There is a possibility to do some operations like start, stop or update over console (windows and linux). Here is the description of them. -Note: all commands that start with ```iobroker``` can be called from any directory where ioBroker command is available. ```npm install``` command must be called from ioBroker root directory. +Note: all commands that start with `iobroker` can be called from any directory where ioBroker command is available. `npm install` command must be called from ioBroker root directory. -Following commands are possible: +The following commands are possible: - [npm install iobroker.adapterName](#npm-install-iobrokeradaptername) - [iobroker start](#iobroker-start) @@ -61,118 +61,118 @@ Following commands are possible: - [iobroker cert create](#iobroker-cert-create) - [iobroker logs \[--watch\]](#iobroker-logs) -**Note:** there is a parameter ```--timeout 5000```, that can be used with every command. It specifies the timeout in ms for connection to DB. +**Note:** there is a parameter `--timeout 5000`, that can be used with every command. It specifies the timeout in ms for connection to DB. ## npm install iobroker.adapterName -This command must be called from root directory of ioBroker (Normally ```/opt/iobroker``` or ```C:\Program Files\ioBroker```). It uses the npm manager to install or update given adapter or js-controller. It works always, even if the "admin" or "js-controller" have the problems. +This command must be called from root directory of ioBroker (Normally `/opt/iobroker` or `C:\Program Files\ioBroker`). It uses the npm manager to install or update given adapter or js-controller. It works always, even if the "admin" or "js-controller" have the problems. Usage examples: -- ```npm install iobroker.admin``` - update or install "admin" adapter -- ```npm install iobroker.js-controller``` - update or install js-controller itself -- ```npm install https://github.com/husky-koglhof/ioBroker.hmm/tarball/master/``` - install adapter direct from github or from some other place. It must be a ZIP or GZ package and must content package.json. +- `npm install iobroker.admin` - update or install "admin" adapter +- `npm install iobroker.js-controller` - update or install js-controller itself +- `npm install https://github.com/husky-koglhof/ioBroker.hmm/tarball/master/` - install adapter direct from github or from some other place. It must be a ZIP or GZ package and must content package.json. -If the adapter was installed, after call of ```npm install ..``` the restart of specified adapter or whole js-controller should be done so the changes will be active. +If the adapter was installed, after call of `npm install ..` the restart of specified adapter or whole js-controller should be done so the changes will be active. -This can be done with ```iobroker restart adapterName``` or just ```iobroker restart```. See [here](#restart) for details. +This can be done with `iobroker restart adapterName` or just `iobroker restart`. See [here](#restart) for details. -***Note:*** only packages with name **ioBroker.zzz** can be so installed. +***Note:*** only packages with the name `ioBroker.zzz` can be so installed. ##iobroker start Starts the iobroker as a daemon. If the ioBroker yet started you will get the warning: -```ioBroker controller daemon already running. PID: xx``` +`ioBroker controller daemon already running. PID: xx` -***Note for Windows:*** normally the ioBroker under Windows is started as service. This command will start second instance of ioBroker and this will lead to conflict. Use ```serviceIoBroker.bat start``` from ioBroker directory instead of ```iobroker start``` command. You should have administrator rights to startthe service. +***Note for Windows:*** normally the ioBroker under Windows is started as service. This command will start second instance of ioBroker and this will lead to conflict. Use `serviceIoBroker.bat start` from ioBroker directory instead of `iobroker start` command. You should have administrator rights to startthe service. ##iobroker stop Stops the iobroker if it runs as a daemon. If the ioBroker not started you will get the warning: -```ioBroker controller daemon is not running``` +`ioBroker controller daemon is not running` -***Note for Windows:*** normally the ioBroker under Windows is started as service. This command will have no effect. Use ```serviceIoBroker.bat stop``` from ioBroker directory instead of ```iobroker stop``` command. You should have administrator rights to stop the service. +***Note for Windows:*** normally the ioBroker under Windows is started as service. This command will have no effect. Use `serviceIoBroker.bat stop` from ioBroker directory instead of `iobroker stop` command. You should have administrator rights to stop the service. ## iobroker restart Just the stop and start commands together. See above. ## iobroker isrun -Returns the actual status of ioBroker. Is it started or not. If ioBroker is not started the return code is 100. +Returns the actual status of ioBroker. Is it started or not. If ioBroker is not started, the return code is 100. -Same as ```iobroker status```. +Same as `iobroker status`. ## iobroker start adapterName.instance -You can start the specified adapter from console. It will automatically enabled and started. +You can start the specified adapter from the console. It will be automatically enabled and started. -If adapter was started it will be restarted. +If the adapter was started, it will be restarted. You can control in "admin" that adapter instance is now enabled. Usage: -- ```iobroker start email.0``` - enables and starts adapter instance ioBroker.email.0 +- `iobroker start email.0` - enables and starts adapter instance ioBroker.email.0 -Note: you can call ```iobroker start all``` to start all disabled instances, e.g. after restore. +Note: you can call `iobroker start all` to start all disabled instances, e.g., after restore. ## iobroker stop adapterName.instance -You can stop the specified adapter from console. It will disabled and stopped. It will not be restarted automatically later. +You can stop the specified adapter from the console. It will be disabled and stopped. It will not be restarted automatically later. You can control in "admin" that adapter instance is now disabled. Usage: -- ```iobroker stop email.0``` - enables and starts adapter instance ioBroker.email.0 +- `iobroker stop email.0` - enables and starts adapter instance ioBroker.email.0 ## iobroker restart adapterName.instance -Just restarts the specified adapter. If it was disabled it will be enabled. +Just restarts the specified adapter. If it is disabled, it will be enabled. ## iobroker add adapterName -Full syntax is ```iobroker add adapterName [desiredInstanceNumber] [--enabled] [--host \] [--port \]``` +Full syntax is `iobroker add adapterName [desiredInstanceNumber] [--enabled] [--host \] [--port \]` -Installs if not installed and creates the instance of specified adapter. If instance of adapter yet exists the next instance number will be used. +Installs if not installed and creates the instance of specified adapter. If an instance of adapter yet exists, the next instance number will be used. There are some additional parameters: -- enabled: Adapter instance will be automatically enabled after creation, elsewise the adapter predefined value will be use for that. -- host: Host name where the adapter instance must be created. You can get the list of host with ```iobroker list hosts``` command.(Not yet implemented) +- enabled: Adapter instance will be automatically enabled after creation, elsewise the adapter predefined value will be used for that. +- host: Host name where the adapter instance must be created. You can get the list of host with `iobroker list hosts` command.(Not yet implemented) - port: if adapter has settings native.port it will be set to desired value after installation. - desiredInstanceNumber: you can specify the desired instance number. Usage: -- ```iobroker add dwd``` - Install and create instance of dwd adapter. -- ```iobroker add admin --enabled --port 80``` - Create second (normally) instance of admin adapter on port 80 and enable it. +- `iobroker add dwd` - Install and create instance of dwd adapter. +- `iobroker add admin --enabled --port 80` - Create second (normally) instance of admin adapter on port 80 and enable it. -If this command does not work, you can always use ```npm install iobroker.adapterName``` command to force the update or install. No instance will be created, you should call ```iobroker add iobroker.adapterName``` command after that one more time. +If this command does not work, you can always use `npm install iobroker.adapterName` command to force the update or install. No instance will be created, you should call `iobroker add iobroker.adapterName` command after that one more time. ## iobroker install adapterName -Only installs the adapter in ioBroker and creates no instance. If adapter yet installed you will get following warning: +Only installs the adapter in ioBroker and creates no instance. If adapter yet installed, you will get the following warning: -```adapter "admin" yet installed. Use "upgrade" to install newer version.``` +`adapter "admin" yet installed. Use "upgrade" to install newer version.` ## iobroker upload adapterName Upload web pages from "www" and "admin" folders in adapter into ioBroker file storage. Used normally by developers to see the changes done in the configuration pages or on "www" pages. -You cannot change the files directly in "iobroker/iobroker-data/adapter/file". There is a flag for developers in config file (*iobroker-data/iobroker.json*) objects.noFileCache to disable cache of the file. With this flag set to true (of course new start required after configuration file changed) the changes in iobroker-data directory will be seen on the web without ```iobroker upload adapterName``` command. +You cannot change the files directly in `iobroker/iobroker-data/adapter/file`. There is a flag for developers in a config file (`iobroker-data/iobroker.json`) objects.noFileCache to disable cache of the file. With this flag set to true (of course new start required after a configuration file was changed) the changes in iobroker-data directory will be seen on the web without `iobroker upload adapterName` command. -Note: you can call ```iobroker upload all``` to upload all adapters, e.g. after restore. +Note: you can call `iobroker upload all` to upload all adapters, e.g., after restore. ## iobroker setup -This command must be called if ioBroker was installed not with npm or windows installer (e.g. just copied from github and unpacked). It creates the default configuration file and prepares the data directories. +This command must be called if ioBroker was installed not with npm or Windows installer (e.g., just copied from GitHub and unpacked). It creates the default configuration file and prepares the data directories. You can call this command with parameter "first" to be sure that nothing will be overwritten if the config yet exists. Usage: -```iobroker setup first``` - create configuration files if not yet created. +`iobroker setup first` - create configuration files if not yet created. ## iobroker setup custom -To enable multi-host configuration (experimental) this command must be called. Following questions must be answered: -

+To enable multi-host configuration, this command must be called. The following questions must be answered:
+```
 Type of objects DB [file, couch, redis], default [file]:
 Host of objects DB(file), default[127.0.0.1]: enter IP address of the main system
 Port of objects DB(file), default[9001]:
 Type of states DB [file, redis], default [file]:
 Host of states DB (file), default[ip]:
 Port of states DB (file), default[9000]:
-
+``` You can just press ENTER to take the default value shown in \[\]. **Note:** at the moment only *file* DB type is supported. If you change the ports you must be an expert. @@ -185,7 +185,7 @@ Completely removes all instances and states of this adapter from ioBroker and de You cannot restore settings of the adapter instances after deletion. Usage: -```iobroker del dwd``` - deletes all instances and code of adapter dwd from ioBroker. +`iobroker del dwd` - deletes all instances and code of adapter dwd from ioBroker. ## iobroker del adapterName.instance Removes only specified instance of this adapter from ioBroker and **not** deletes it from the disk. @@ -193,16 +193,16 @@ Removes only specified instance of this adapter from ioBroker and **not** delete You cannot restore settings of the adapter instance after deletion. Usage: -```iobroker del dwd.0``` - deletes instance 0 of adapter dwd from ioBroker. +`iobroker del dwd.0` - deletes instance 0 of adapter dwd from ioBroker. ## iobroker update \[repository url\] -Full syntax: ```iobroker update \[repository url\]``` +Full syntax: `iobroker update \[repository url\]` -Read the information from configured ioBroker repository. If ```\repository url\``` is set the information will be read from this repository. +Read the information from the configured ioBroker repository. If `\repository url\` is set the information will be read from this repository. Usage: -- ```iobroker update``` - List available version from configured (normally local) repository. -- ```iobroker update https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json``` - List available version from on-line repository. +- `iobroker update` - List available version from configured (normally local) repository. +- `iobroker update https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json` - List available version from on-line repository. ``` >./iobroker.js update @@ -248,49 +248,49 @@ Adapter "artnet" : 0.0.3 Adapter "admin" : 0.3.21 , installed 0.3.20 [Updateable] ``` -This command changes nothing, just updates internal information about available adapter version and shows it. +This command changes nothing, just updates internal information about an available adapter version and shows it. -To show only updatable adapters use filter "--updatable". +To show only updatable adapters use filter `--updatable`. ## iobroker upgrade -Full syntax: ```iobroker upgrade \[repository url\]``` +Full syntax: `iobroker upgrade \[repository url\]` -Upgrades all adapters (not js-controller) if they are available with newer version in specified repository. If no repository link specified, so configured repository will be used. +Upgrades all adapters (not js-controller) if they are available with a newer version in specified repository. If no repository link is specified, so configured repository will be used. Usage: -- ```iobroker upgrade``` - upgrade all adapters. -- ```iobroker upgrade https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json``` - upgrade all adapters from on-line repository +- `iobroker upgrade` - upgrade all adapters. +- `iobroker upgrade https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json` - upgrade all adapters from on-line repository ## iobroker upgrade self -Full syntax: ```iobroker upgrade self \[repository url\]``` +Full syntax: `iobroker upgrade self \[repository url\]` -This command upgrades ioBroker.js-controller to version, that will be found in repository. +This command upgrades ioBroker.js-controller to version, that will be found in the repository. -**Note:** If specified or configured repository has lower version it will be downgraded to this version. +**Note:** If specified or configured repository has a lower version, it will be downgraded to this version. -- ```iobroker upgrade self``` - upgrade js-controller to version in the configured repository. -- ```iobroker upgrade self https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json``` - upgrade js-controller to version from on-line repository. +- `iobroker upgrade self` - upgrade js-controller to a version in the configured repository. +- `iobroker upgrade self https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json` - upgrade js-controller to version from on-line repository. ## iobroker upgrade adapterName -Full syntax: ```iobroker upgrade adapterName \[repository url\]``` +Full syntax: `iobroker upgrade adapterName \[repository url\]` -This command upgrades specified adapter to version, that will be found in repository. +This command upgrades specified adapter to the version that will be found in the repository. -**Note:** If specified or configured repository has lower version it will be downgraded to this version. +**Note:** If specified or configured repository has a lower version, it will be downgraded to this version. -- ```iobroker upgrade email``` - upgrade ioBroker.email adapter to version in the configured repository. -- ```iobroker upgrade email https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json``` - upgrade ioBroker.email adapter to version from on-line repository. +- `iobroker upgrade email` - upgrade `ioBroker.email` adapter to version in the configured repository. +- `iobroker upgrade email https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/master/conf/sources-dist.json` - upgrade ioBroker.email adapter to version from on-line repository. ## iobroker nodejs-update -This command upgrades Node.js to version, that will be found in repository. +This command upgrades Node.js to the version that will be found in the repository. -- ```iobroker nodejs-update``` - upgrade Node.js to version in the configured repository. +- `iobroker nodejs-update` - upgrade Node.js to a version in the configured repository. ## iobroker object get -Full syntax: ```iobroker get objectId``` +Full syntax: `iobroker get objectId` -Reads from command line the description of the object: +Reads from the command line the description of the object: C:\pWork>iobroker object get system.adapter.admin.0.uptime ``` @@ -302,20 +302,20 @@ C:\pWork>iobroker object get system.adapter.admin.0.uptime "native":{} } ``` -**Note:** Normally output is not formatted, but you can use flag "--pretty" to format them. +**Note:** Normally output is not formatted, but you can use flag `--pretty` to format them. ## iobroker object chmod -Format: ```iobroker object chmod [state-mode] ``` +Format: `iobroker object chmod [state-mode] ` ID can be a pattern with '\*'. '\*' can be only at the end of pattern. ## iobroker object chown -Format: ```iobroker object chown ``` +Format: `iobroker object chown ` ID can be a pattern with '\*'. '\*' can be only at the end of pattern. ## iobroker object list -Format: ```iobroker object list ``` +Format: `iobroker object list ` List permissions of objects, like: @@ -336,17 +336,17 @@ rw-r--r-- admin administrator system.adapter.admin.0 ID can be a pattern with '\*'. '\*' can be only at the end of pattern. ## iobroker set -Full syntax: ```iobroker set [--port value] [--enabled true|false] [--ip address] [--auth true|false] [--secure true|false] [—-ttl value]``` -Used to modify instance settings from console. Following settings can be modified: -- port - change port, where the instance is bound -- enabled - enable/disable the instance (Can be done with ```iobroker start|stop ``` too) -- ip - change binded ip address -- auth - enable or disable authentication -- secure - switch SSL protocol on or off -- ttl - login timeout in seconds +Full syntax: `iobroker set [--port value] [--enabled true|false] [--ip address] [--auth true|false] [--secure true|false] [—-ttl value]` +Used to modify instance settings from console. The following settings can be modified: +- `port` - change port, where the instance is bound +- `enabled` - enable/disable the instance (Can be done with `iobroker start|stop ` too) +- `ip` - change bound IP address +- `auth` - enable or disable authentication +- `secure` - switch SSL protocol on or off +- `ttl` - login timeout in seconds ## iobroker state get -Full syntax: ```iobroker state get stateId``` +Full syntax: `iobroker state get stateId` Read JSON value of the state: ``` >./iobroker state get system.adapter.admin.0.uptime @@ -367,7 +367,7 @@ You can use "--pretty" flag to format the output: ``` ## iobroker state getplain -Full syntax: ```iobroker state getplain stateId``` +Full syntax: `iobroker state getplain stateId` Read plain value of the state as a list attributes: ``` @@ -379,7 +379,7 @@ system.adapter.admin.0 1425925701 ``` ## iobroker state getvalue -Full syntax: ```iobroker state getvalue stateId``` +Full syntax: `iobroker state getvalue stateId` Read plain value of the state as a list attributes: ``` @@ -387,23 +387,23 @@ Read plain value of the state as a list attributes: 571 ``` ## iobroker state set -Full syntax: ```iobroker state set stateId newValue ack``` +Full syntax: `iobroker state set stateId newValue ack` Set value of the state. "ack is by default = false. -```>iobroker state set sayit.0.tts.text "Текст сказать"``` +`>iobroker state set sayit.0.tts.text "Текст сказать"` -```>iobroker state set adapter.0.states.temperature 28.5 true``` +`>iobroker state set adapter.0.states.temperature 28.5 true` There is no error message if ID is wrong. ## iobroker state del -Full syntax: ```iobroker state del stateId``` +Full syntax: `iobroker state del stateId` Remove the state. ## iobroker message -Full syntax: ```iobroker message adapter.instance command message``` +Full syntax: `iobroker message adapter.instance command message` Send a message to the given adapter-instance or all instances of the adapter when instance is not set. @@ -417,14 +417,14 @@ Restarting ioBroker... ``` ## iobroker backup -Backup settings of ioBroker in zip file. Backup files will be created in _backups_ directory and have names: -```2015_02_10-17_49_45_backupIoBroker.tar.gz``` with current date and time. +Backup settings of ioBroker in a zip file. Backup files will be created in `backups` directory and have names: +`2015_02_10-17_49_45_backupIoBroker.tar.gz` with current date and time. **Note:** not yet finished ## iobroker restore -Full syntax: ```iobroker restore ``` -If some backups were created with command ```iobroker backup```, so they can be restored. If you call restore without parameters, you will get the list of available backups. +Full syntax: `iobroker restore ` +If some backups were created with command `iobroker backup`, so they can be restored. If you call restore without parameters, you will get the list of available backups. ``` />iobroker restore @@ -432,124 +432,124 @@ Please specify one of the backup names: 2015_07_18-12_20_28_backupIoBroker.tar.gz or 2015_07_18-12_20_28 or 0 2015_07_17-21_54_01_backupIoBroker.tar.gz or 2015_07_17-21_54_01 or 1 ``` -You can call ```iobroker restore 0``` to use latest backup file or some other index. -Following commands are the same for given example: +You can call `iobroker restore 0` to use a latest backup file or some other index. +The following commands are the same for given example: - iobroker restore 0 - iobroker 2015_07_18-12_20_28 - iobroker 2015_07_17-21_54_01_backupIoBroker.tar.gz - iobroker /opt/iobroker/backups/2015_07_17-21_54_01_backupIoBroker.tar.gz -All adapters will be restored as disabled, except "admin". To enable all adapters at once you can call "iobroker start all". If some adapters are not uploaded you can call "iobroker upload all" to upload all adapter's files at once. +All adapters will be restored as disabled, except `admin`. To enable all adapters at once, you can call `iobroker start all`. If some adapters are not uploaded, you can call "iobroker upload all" to upload all adapter's files at once. ## iobroker host Change host name in the objects. -Sometimes by moving the iobroker data from one system to other it is required to change the host name. With this command it can be executed. +Sometimes by moving the iobroker data from one system to the other, it is required to change the host name. With this command it can be executed. You must stop ioBroker before this. -To change some specific host name in the DB to the current host name write ```iobroker host oldHostName```. +To change some specific host name in the DB to the current host name write `iobroker host oldHostName`. -To change any host name (must be only single host system, not for multihosts) write ```iobroker host this```. +To change any host name (must be only single host system, not for multihosts) write `iobroker host this`. ## iobroker host set -You can change host name to some specific (not the computer name). For that you must write: ```iobroker host set newHostName``` to rename from actual computer name or previously specified host name. +You can change the host name to some specific (not the computer name). For that you must write: `iobroker host set newHostName` to rename from actual computer name or previously specified host name. ## iobroker host remove -To delete host just write ```iobroker host remove hostNameToRemove```. Please be careful with it. +To delete host just write `iobroker host remove hostNameToRemove`. Please be careful with it. ## iobroker list -With this command it is possible to show different types of object and states in ioBroker. Examples: -- ```iobroker list objects hm-rega.0``` - show all objects of instance hm-rega.0 -- ```iobroker list states hm-rega.0``` - show all states of instance hm-rega.0 -- ```iobroker list files vis.0``` - show all files of instance vis.0 -- ```iobroker list instances``` - show all instances -- ```iobroker list adapters``` - show all adapters -- ```iobroker list users``` - show all users -- ```iobroker list groups``` - show all groups -- ```iobroker list enums``` - show all enums -- ```iobroker list hosts``` - show all hosts +With this command, it is possible to show different types of object and states in ioBroker. Examples: +- `iobroker list objects hm-rega.0` - show all objects of instance hm-rega.0 +- `iobroker list states hm-rega.0` - show all states of instance hm-rega.0 +- `iobroker list files vis.0` - show all files of instance vis.0 +- `iobroker list instances` - show all instances +- `iobroker list adapters` - show all adapters +- `iobroker list users` - show all users +- `iobroker list groups` - show all groups +- `iobroker list enums` - show all enums +- `iobroker list hosts` - show all hosts It is possible to use short names of types: -- o - objects -- s - states -- u - users -- e - enums -- g - groups -- i - instances -- f - files -- h - hosts +- `o` - objects +- `s` - states +- `u` - users +- `e` - enums +- `g` - groups +- `i` - instances +- `f` - files +- `h` - hosts -E.g. ```iobroker l u``` - list all users. +E.g. `iobroker l u` - list all users. -With the "list instances" you can use additional filters: -- enabled - list all enabled instances -- disabled - list all disabled instances -- port - list all instances with port -- ip - list all instances, that can be bound to some IP -- ssl - list all instances, where SSL can be enabled +With the `list instances` you can use additional filters: +- `enabled` - list all enabled instances +- `disabled` - list all disabled instances +- `port` - list all instances with port +- `ip` - list all instances, that can be bound to some IP +- `ssl` - list all instances, where SSL can be enabled -Using: ```iobroker list instances --enabled``` to list all enabled instances +Using: `iobroker list instances --enabled` to list all enabled instances -or ```iobroker l i --port``` to list used ports. +or `iobroker l i --port` to list used ports. ## iobroker adduser -This command allows to create a new user (by default in "administrator" group). The group can be defined in the command with parameter "--ingroup". If the password is not specified, it must be entered from console. -E.g. create user "martin" in group "user": +This command allows creating a new user (by default in "administrator" group). The group can be defined in the command with parameter `--ingroup`. If the password is not specified, it must be entered from the console. +E.g., create user "martin" in group "user": -```iobroker adduser martin --group user``` +`iobroker adduser martin --group user` Create user with password: -```iobroker adduser martin --group user --password 12345``` +`iobroker adduser martin --group user --password 12345` ## iobroker deluser To delete existing user, call: -```iobroker deluser username``` +`iobroker deluser username` -User will be automatically deleted from all groups too. "admin" user cannot be deleted. +Users will be automatically deleted from all groups too. `admin` user cannot be deleted. ## iobroker passwd -To change password of existing user call: +To change the password of existing user call: -```iobroker passwd username``` +`iobroker passwd username` You will be prompted to enter password and repeat the password. If no console interaction is desired, call: -```iobroker passwd username --password newPassword``` +`iobroker passwd username --password newPassword` ## iobroker chmod -Change file mode. +Change a file mode. ## iobroker chown -Change file owner. +Change a file owner. ## iobroker file read -Read file from DB and store it on the local file system. +Read a file from DB and store it on the local file system. Usage: -```iobroker file read [storeFile]``` +`iobroker file read [storeFile]` storeFile is optional, but can be path to directory or to the new file. Example: -```iobroker file read /vis.0/main/img/picture.png /opt/myfile.png``` +`iobroker file read /vis.0/main/img/picture.png /opt/myfile.png` -„file“ and „read“ can be shortened to „f r“. +`file` and `read` can be shortened to `f r`. ## iobroker file write -Write file from local file system to the DB. +Write a file from the local file system to the DB. Usage: -```iobroker file write ``` +`iobroker file write ` storeFile can be a path to direcotry in DB or can be a full name Example: -iobroker file write /opt/myfile.png /vis.0/main/img/picture.png +`iobroker file write /opt/myfile.png /vis.0/main/img/picture.png` -„file“ and „write“ can be shortened to „f w“. +`file` and `write` can be shortened to `f w`. ## iobroker version -Show version of adapter or of js-controller. +Show a version of adapter or of js-controller. Version of js-controller: @@ -623,17 +623,11 @@ NPM : v5.8.0 ``` ## iobroker compact status -**Available since js-controller 2.0.0** - Displays the status of the compact mode for the current host. -``` -Compact mode for this host is currently enabled -``` +`Compact mode for this host is currently enabled` ## iobroker compact [enable|disable|on|off] -**Available since js-controller 2.0.0** - Allows you to enable or disable compact mode for the current host. The current status is output first and then the change made. ``` @@ -646,11 +640,8 @@ Folgende Befehle sind möglich: - `disable/off` - deactivate Compact-Modus for ioBroker ## iobroker compact adapterName.instance -**Available since js-controller 2.0.0** - This command allows the Compact mode configuration of an adapter instance to be checked and changed. All settings (see status) are always displayed, including the changes made. -  All changes can also be made while the ioBroker is running. The adapter instances may be restarted. @@ -691,7 +682,6 @@ Compact group: 1 Instance settings for "simple-api.0" are changed. ``` - ### compact adapterName.instance group <enable|on> [group-id] Activates the compact mode for the instance and (optionally) sets the group in the same call: @@ -720,12 +710,12 @@ The object "system.certificates" was updated successfully. ``` ## iobroker logs -Show last lines and monitor the ioBroker log. +Show the last lines and monitor the ioBroker log. -This command shows last 1000 lines of log and monitors the log: +This command shows the last 1000 lines of log and monitors the log: -```iobroker logs --lines 1000``` +`iobroker logs --lines 1000` To monitor the log add `--watch`, like here: -```iobroker logs --lines 100 --watch``` +`iobroker logs --lines 100 --watch`