Git 🌙
Français â–Ÿ Topics â–Ÿ Latest version â–Ÿ git-help last updated in 2.43.0

NOM

git-help - Afficher l’information d’aide Ă  propos de Git

SYNOPSIS

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

DESCRIPTION

En l’absence d’options et de <commande> ou <doc>, le synopsis de la commande git et une liste des commandes Git les plus couramment utilisĂ©es sont affichĂ©s sur la sortie standard.

Si l’option --all ou -a est donnĂ©e, toutes les commandes disponibles sont affichĂ©es sur la sortie standard.

Si l’option --guides ou -g est donnĂ©e, une liste des guides de concepts Git est Ă©galement affichĂ©e sur la sortie standard.

Si une commande ou une autre documentation est donnĂ©e, la page de manuel correspondante sera affichĂ©e. Le programme "man" est utilisĂ© par dĂ©faut Ă  cette fin, mais il peut ĂȘtre remplacĂ© par d’autres options ou variables de configuration.

Si un alias est donnĂ©, git affiche la dĂ©finition de l’alias sur la sortie standard. Pour obtenir la page de manuel de la commande aliasĂ©e, utilisez git <commande> --help.

Notez que git --help ... est identique Ă  git help ... car le premier est converti en interne dans le second.

Pour afficher la page de manuel git[1], utilisez git help git.

Cette page peut ĂȘtre affichĂ©e avec git help help ou git help --help.

OPTIONS

-a
--all

Afficher toutes les commandes disponibles sur la sortie standard.

--no-external-commands

Lorsqu’utilisĂ© avec --all, exclure la liste des commandes externes "git-*" trouvĂ©es dans le $PATH.

--no-aliases

Lorsqu’utilisĂ© avec --all, exclure la liste des alias configurĂ©s.

--verbose

Lorsqu’utilisĂ© avec --all, afficher la description de toutes les commandes reconnues. C’est l’option par dĂ©faut.

-c
--config

Lister toutes les variables de configuration disponibles. Il s’agit d’un rĂ©sumĂ© de la liste de git-config[1].

-g
--guides

Afficher une liste des guides de concepts Git sur la sortie standard.

--user-interfaces

Afficher une liste de la documentation des interfaces de dépÎt, de commande et de fichier sur la sortie standard.

Les interfaces de fichiers dans le dĂ©pĂŽt comme .git/info/exclude sont documentĂ©es ici (voir gitrepository-layout[5]), ainsi que la configuration dans l’arborescence comme .mailmap (voir gitmailmap[5]).

Cette section de la documentation couvre Ă©galement les conventions d’interface utilisateur gĂ©nĂ©rales ou rĂ©pandues (par exemple gitcli[7]), et la pseudo-configuration telle que l’interface .git/hooks/* basĂ©e sur les fichiers dĂ©crite dans githooks[5].

--developer-interfaces

Afficher sur la sortie standard la liste des formats de fichiers, des protocoles et de la documentation relative aux autres interfaces de développement.

-i
--info

Afficher la page de manuel de la commande au format info. Le programme info sera utilisé à cette fin.

-m
--man

Afficher la page de manuel de la commande au format man. Cette option peut ĂȘtre utilisĂ©e pour remplacer une valeur dĂ©finie dans la variable de configuration help.format.

Par dĂ©faut, le programme man est utilisĂ© pour afficher la page de manuel, mais la variable de configuration man.viewer peut ĂȘtre utilisĂ©e pour choisir d’autres programmes d’affichage (voir ci-dessous).

-w
--web

Afficher la page de manuel de la commande au format web (HTML). Un navigateur web sera utilisé à cet effet.

Le navigateur web peut ĂȘtre spĂ©cifiĂ© en utilisant la variable de configuration help.browser, ou web.browser si la premiĂšre n’est pas dĂ©finie. Si aucune de ces variables de configuration n’est dĂ©finie, le script d’aide git web--browse (appelĂ© par git help) choisira un navigateur par dĂ©faut appropriĂ©. Voir git-web--browse[1] pour plus d’informations Ă  ce sujet.

VARIABLES DE CONFIGURATION

help.format

Si aucune option de ligne de commande n’est passĂ©e, la variable de configuration help.format sera vĂ©rifiĂ©e. Les valeurs suivantes sont supportĂ©es pour cette variable ; elles font que git help se comporte comme l’option de ligne de commande correspondante :

  • "man" correspond Ă  -m|--man,

  • "info" correspond Ă  -i|--info,

  • "web" ou "html" correspondent Ă  -w|--web.

help.browser, web.browser et browser. <outil>.path

Les navigateurs help.browser, web.browser et browser.<outil>.path seront également vérifiés si le format web est choisi (soit par une option de la ligne de commande, soit par une variable de configuration). Voir -w|--web dans la section OPTIONS ci-dessus et git-web--browse[1].

man.viewer

La variable de configuration man.viewer sera vérifiée si le format man est choisi. Les valeurs suivantes sont actuellement prises en charge :

  • "man" : utiliser le programme man comme d’habitude,

  • "woman" : utiliser emacsclient pour lancer le mode "woman" dans emacs (cela ne fonctionne qu’Ă  partir de la version 22 d’emacsclient),

  • "konqueror" : utiliser kfmclient pour ouvrir la page de manuel dans un nouvel onglet konqueror (voir Note sur konqueror ci-dessous).

Les valeurs des autres outils peuvent ĂȘtre utilisĂ©es s’il existe une entrĂ©e de configuration man.<outil>.cmd correspondante (voir ci-dessous).

Plusieurs valeurs peuvent ĂȘtre donnĂ©es Ă  la variable de configuration man.viewer. Les programmes correspondants seront essayĂ©s dans l’ordre indiquĂ© dans le fichier de configuration.

Par exemple, cette configuration :

	[man]
		viewer = konqueror
		viewer = woman

essaiera d’abord d’utiliser konqueror. Mais cela peut Ă©chouer (par exemple, si DISPLAY n’est pas dĂ©fini) et dans ce cas, le mode woman d’emacs sera utilisĂ©.

Si tout Ă©choue, ou si aucun visualiseur n’est configurĂ©, le visualiseur spĂ©cifiĂ© dans la variable d’environnement GIT_MAN_VIEWER sera essayĂ©. Si cela Ă©choue aussi, le programme man sera essayĂ© de toute façon.

man.<outil>.path

Vous pouvez fournir explicitement un chemin complet vers votre visualisateur favori de page man en rĂ©glant la variable de configuration man.<outil>.path. Par exemple, vous pouvez configurer le chemin absolu vers konqueror en dĂ©finissant man.konqueror.path. Sinon, git help suppose que l’outil est disponible dans PATH.

man.<outil>.cmd

Lorsque le visualiseur de manuel, spĂ©cifiĂ© par la variable de configuration man.viewer, ne fait pas partie des visualiseurs supportĂ©s, la variable de configuration correspondante man.<outil>.cmd sera recherchĂ©e. Si cette variable existe, l’outil spĂ©cifiĂ© sera traitĂ© comme une commande personnalisĂ©e et un interprĂ©teur de commandes sera utilisĂ© pour exĂ©cuter la commande avec la page de manuel passĂ©e en argument.

Note sur konqueror

Lorsque konqueror est spĂ©cifiĂ© dans la variable de configuration man.viewer, kfmclient est lancĂ© pour essayer d’ouvrir la page de manuel sur un konqueror dĂ©jĂ  ouvert, dans un nouvel onglet si possible.

Pour des raisons de cohérence, nous essayons aussi de faire cela si man.konqueror.path est réglé sur quelque chose comme UN_CHEMIN_VERS/konqueror. Cela signifie que nous essaierons de lancer UN_CHEMIN_VERS/kfmclient à la place.

Si vous voulez vraiment utiliser konqueror, vous pouvez utiliser quelque chose comme ce qui suit :

	[man]
		viewer = konq

	[man "konq"]
		cmd = UN_CHEMIN_VERS/konqueror

Note sur git config --global

Notez que toutes ces variables de configuration devraient probablement ĂȘtre dĂ©finies en utilisant le drapeau --global, par exemple comme ceci :

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

car ils sont probablement plus spĂ©cifiques Ă  l’utilisateur qu’au dĂ©pĂŽt. Voir git-config[1] pour plus d’informations Ă  ce sujet.

GIT

Fait partie de la suite git[1]

TRADUCTION

Cette page de manuel a été traduite par Jean-Noël Avila <jn.avila AT free DOT fr> et les membres du projet git-manpages-l10n. Veuillez signaler toute erreur de traduction par un rapport de bogue sur le site https://github.com/jnavila/git-manpages-l10n .

scroll-to-top