Kommandozeilenschnittstelle

Qgoda-Optionen, -Kommandos und Kommando-Optionen

Qgoda ist ein [Kommandozeilenprogramm](http://www.guido-flohr.net/de/kommandozeile/.

Allgemeines zur Verwendung

Die allgemeine Verwendung von Qgoda sieht so aus:

$ qgoda [GLOBAL_OPTIONS] [COMMAND, [OPTIONS]]

Zum Beispiel:

$ qgoda --verbose build --drafts --future

So wird die globale Option —verbose auf wahr gesetzt, und das Qgoda-Kommando build mit den Optionen —darfst und —future ausgewählt.

Globale Optionen

Qgoda unterstützt zur Zeit die folgenden globalen Optionen

-q, —quiet
Aktiviert den Quiet-Modus. In diesem Modus werden nur Fehler und fatale Fehler angezeigt.
-v, —verbose
Aktiviert ausführliche Protokollierung mit zahlreichen Details. Dieser Modus wird normalerweise nur aktiviert, um Fehler einzugrenzen und zu beheben.
—log-stderr
Bewirkt, dass Qgoda auf die Standard-Fehlerausgabe statt der Standard-Ausgabe protokolliert.
-h, —help
Qgoda gibt eine Zusammenfassung der Benutzung aus und terminiert sofort. Alle anderen Optionen und Befehle werden ignoriert.
-V, --version
Causes qgoda to display version information and exit immediately. All other options and commands are ignored.

Kommandos

Das nächste Token auf der Kommandozeile muss eins der unterstützten Kommandos sein, zur Zeit „build“, „watch“, „config“, „init“, „dump“, „markdown“, „xgettext“ oder „po“.

Kommandozeilen-Optionen und -Argumente

Der Rest der Kommandozeile besteht aus Optionen für das jeweilige Kommando. Mit qgoda KOMMANDO --help werden hilfreiche Hinweise für ein bestimmtes Kommando angezeigt (wobei KOMMANDO natürlich mit einem der unterstützten Kommandos ersetzt werden muss). Die Option -h bzw. --help wird von allen Qgoda-Kommandos unterstützt.

Die Benutzungshinweise werden mithilfe des System-Pacers angezeigt. Mit der Taste q wird dieser verlassen. LEERZEICHEN blättert eine Seite, Pfeil-nach-unten oder j eine Zeile vor. Mit k wird eine Zeile zurückgeblättert, und h zeigt weitere Hilfe.

Unterstützte Kommandos

build

Das Kommando build weist Qgoda an, die Site (neu) zu generieren und sich dann zu beenden. Hilfsprogramme werden nicht ausgeführt!

watch

Tut das gleiche wie build, aber statt sich zu beenden, wartet Qgoda auf Änderungen an Dateien, und initiiert eine Neu-Generierung, sobald sich eine Quelldatei ändert.

Hilfsprogramme werden parallel gestartet.

config

Dumps the current configuration as YAML and exits. The configuration printed is the result of merging the default configuration with the files _config.yaml and _localconfig.yaml.

init

Initializes a new qgoda site.

dump

Dumps the content of the entire site. The output is suitable for pumping it into external programs (for example full-text search engines like elasticsearch.

markdown

Generates html from a markdown file. This is meant for debugging problems with markdown rendering.

po

Various commands needed for multi-language sites. See for details.

xgettext

Extracts translatable snippets from the site's markdown source files into .po. files. This command is invoked implicitely by qgoda po pot (see above), and you normally don't have to use qgoda xgettext directly. See for more information.