English ▾ Themen ▾ Neueste Version ▾ git-help zuletzt aktualisiert in 2.43.0

NAME

git-help - Hilfeinformationen über Git anzeigen

SYNOPSIS

git help [-a|--all] [--[no-]verbose] [--[no-]external-commands] [--[no-]aliases]
git help [[-i|--info] [-m|--man] [-w|--web]] [<command>|<doc>]
git help [-g|--guides]
git help [-c|--config]
git help [--user-interfaces]
git help [--developer-interfaces]

BESCHREIBUNG

Wenn keine Optionen und kein <Befehl> oder <doc> angegeben wird, werden die Synopsis des git Befehls und eine Liste der am häufigsten verwendeten Git Befehle auf der Standardausgabe ausgegeben.

Wenn die Option --all oder -a angegeben wird, werden alle verfügbaren Befehle auf der Standardausgabe ausgegeben.

Wenn die Option --guides oder -g angegeben wird, wird auch eine Liste der Git-Konzeptanleitungen auf der Standardausgabe ausgegeben.

Wenn ein Befehl oder eine andere Dokumentation angegeben wird, wird die entsprechende Handbuchseite aufgerufen. Das man Programm wird standardmäßig für diesen Zweck verwendet, dies kann jedoch durch andere Optionen oder Konfigurationsvariablen überschrieben werden.

Wenn ein Alias angegeben wird, zeigt git die Definition des Alias auf der Standardausgabe an. Um die Handbuchseite für den Aliased-Befehl zu erhalten, verwenden Sie git <Befehl> --help.

Beachten Sie, dass git --help ... identisch mit git help ... ist, da erstere intern in letzteres umgewandelt wird.

Um die Handbuchseite git[1] anzuzeigen, verwenden Sie git help git.

Diese Seite kann mit git help help oder git help --help angezeigt werden.

OPTIONEN

-a
--all

Zeigt alle verfügbaren Befehle auf der Standardausgabe an.

--no-external-commands

Wenn mit --all verwendet, schließt die Auflistung externer "git-*" Befehle, die im $PATH gefunden werden, aus.

--no-aliases

Wenn mit --all verwendet, schließt die Auflistung konfigurierter Aliase aus.

--verbose

Wenn mit --all verwendet, wird eine Beschreibung für alle erkannten Befehle ausgegeben. Dies ist die Standardeinstellung.

-c
--config

Zeigt alle verfügbaren Konfigurationsvariablen an. Dies ist eine kurze Zusammenfassung der Liste in git-config[1].

-g
--guides

Gibt eine Liste der Git-Konzeptanleitungen auf der Standardausgabe aus.

--user-interfaces

Gibt eine Liste der Dokumentation für Repository-, Befehls- und Dateischnittstellen auf der Standardausgabe aus.

Repository-interne Dateischnittstellen wie .git/info/exclude sind hier dokumentiert (siehe gitrepository-layout[5]), ebenso wie baumintegrierte Konfigurationen wie .mailmap (siehe gitmailmap[5]).

Dieser Abschnitt der Dokumentation behandelt auch allgemeine oder weit verbreitete Benutzeroberflächenkonventionen (z. B. gitcli[7]) und Pseudo-Konfigurationen wie die dateibasierte Schnittstelle .git/hooks/*, die in githooks[5] beschrieben wird.

--developer-interfaces

Gibt eine Liste der Dokumentation für Dateiformate, Protokolle und andere Entwicklerschnittstellen auf der Standardausgabe aus.

-i
--info

Zeigt die Handbuchseite für den Befehl im info Format an. Das info Programm wird für diesen Zweck verwendet.

-m
--man

Zeigt die Handbuchseite für den Befehl im man Format an. Diese Option kann verwendet werden, um einen Wert zu überschreiben, der in der Konfigurationsvariable help.format gesetzt wurde.

Standardmäßig wird das man Programm verwendet, um die Handbuchseite anzuzeigen, aber die Konfigurationsvariable man.viewer kann verwendet werden, um andere Anzeige-Programme auszuwählen (siehe unten).

-w
--web

Zeigt die Handbuchseite für den Befehl im web (HTML) Format an. Ein Webbrowser wird für diesen Zweck verwendet.

Der Webbrowser kann über die Konfigurationsvariable help.browser oder web.browser angegeben werden, wenn die erstere nicht gesetzt ist. Wenn keine dieser Konfigurationsvariablen gesetzt ist, wählt das Hilfsskript git web--browse (aufgerufen von git help) einen geeigneten Standard aus. Siehe git-web--browse[1] für weitere Informationen.

KONFIGURATION VARIABLEN

help.format

Wenn keine Befehlszeilenoption übergeben wird, wird die Konfigurationsvariable help.format geprüft. Die folgenden Werte werden für diese Variable unterstützt; sie bewirken, dass git help sich wie ihre entsprechenden Befehlszeilenoptionen verhält

  • "man" entspricht -m|--man,

  • "info" entspricht -i|--info,

  • "web" oder "html" entsprechen -w|--web.

help.browser, web.browser und browser.<tool>.path

Die Variablen help.browser, web.browser und browser.<tool>.path werden ebenfalls geprüft, wenn das web Format gewählt wird (entweder per Befehlszeilenoption oder Konfigurationsvariable). Siehe -w|--web im Abschnitt OPTIONEN oben und git-web--browse[1].

man.viewer

Die Konfigurationsvariable man.viewer wird geprüft, wenn das man Format gewählt wird. Die folgenden Werte werden derzeit unterstützt

  • "man": verwende das man Programm wie üblich,

  • "woman": verwende emacsclient, um den "woman" Modus in Emacs zu starten (dies funktioniert nur ab emacsclient Version 22),

  • "konqueror": verwende kfmclient, um die Handbuchseite in einem neuen Konqueror-Tab zu öffnen (siehe Hinweis zu Konqueror unten).

Werte für andere Tools können verwendet werden, wenn ein entsprechender Konfigurationseintrag man.<tool>.cmd vorhanden ist (siehe unten).

Mehrere Werte können der Konfigurationsvariable man.viewer zugewiesen werden. Ihre entsprechenden Programme werden in der Reihenfolge versucht, in der sie in der Konfigurationsdatei aufgeführt sind.

Zum Beispiel diese Konfiguration

	[man]
		viewer = konqueror
		viewer = woman

wird zuerst versuchen, Konqueror zu verwenden. Dies kann jedoch fehlschlagen (z. B. wenn DISPLAY nicht gesetzt ist) und in diesem Fall wird der woman-Modus von Emacs versucht.

Wenn alles fehlschlägt oder wenn kein Viewer konfiguriert ist, wird der in der Umgebungsvariable GIT_MAN_VIEWER angegebene Viewer versucht. Wenn dies ebenfalls fehlschlägt, wird trotzdem das man Programm versucht.

man.<tool>.path

Sie können explizit einen vollständigen Pfad zu Ihrem bevorzugten Man-Viewer angeben, indem Sie die Konfigurationsvariable man.<tool>.path setzen. Sie können beispielsweise den absoluten Pfad zu Konqueror konfigurieren, indem Sie man.konqueror.path setzen. Andernfalls geht git help davon aus, dass das Tool im PATH verfügbar ist.

man.<tool>.cmd

Wenn der durch die Konfigurationsvariable man.viewer angegebene Man-Viewer nicht unter den unterstützten ist, wird die entsprechende Konfigurationsvariable man.<tool>.cmd nachgeschlagen. Wenn diese Variable existiert, wird das angegebene Tool als benutzerdefinierter Befehl behandelt und ein Shell-Eval wird verwendet, um den Befehl mit der als Argument übergebenen Handbuchseite auszuführen.

Hinweis zu Konqueror

Wenn konqueror in der Konfigurationsvariable man.viewer angegeben ist, starten wir kfmclient, um zu versuchen, die Handbuchseite in einem bereits geöffneten Konqueror in einem neuen Tab zu öffnen, wenn möglich.

Zur Konsistenz versuchen wir einen solchen Trick auch, wenn man.konqueror.path auf etwas wie A_PATH_TO/konqueror gesetzt ist. Das bedeutet, wir werden versuchen, stattdessen A_PATH_TO/kfmclient zu starten.

Wenn Sie wirklich konqueror verwenden möchten, können Sie etwas wie das Folgende verwenden

	[man]
		viewer = konq

	[man "konq"]
		cmd = A_PATH_TO/konqueror

Hinweis zu git config --global

Beachten Sie, dass all diese Konfigurationsvariablen wahrscheinlich mit der Flagge --global gesetzt werden sollten, zum Beispiel so

$ git config --global help.format web
$ git config --global web.browser firefox

da sie wahrscheinlich benutzerspezifischer als repositoryspezifischer sind. Siehe git-config[1] für weitere Informationen.

GIT

Teil der git[1] Suite