diff --git a/man/man1/gitsh.1.in b/man/man1/gitsh.1.in index 6d26d1ec..7ae20343 100644 --- a/man/man1/gitsh.1.in +++ b/man/man1/gitsh.1.in @@ -17,8 +17,7 @@ is a language for interacting with a .Xr git 1 repository. It supports all git subcommands, custom aliases, and custom -commands for interacting with the shell itself. Commands, path names, -branch names, and tag names can all be completed using tab completion. +commands for interacting with the shell itself. .Pp Running gitsh with no arguments will start an interactive session. Quit by either typing @@ -31,6 +30,13 @@ Passing the path to a file containing a series of commands or sending a series of commands to gitsh's standard input will run each of those commands in sequence. .Pp +In interactive mode, commands and their arguments can be completed using tab +completion. +The rules for what can be completed are defined in configuration files; +see +.Xr gitsh_completions 5 +for details. +.Pp It supports these options and arguments: . .Bl -tag @@ -415,6 +421,14 @@ for popular Git commands. See .Xr gitsh_completions 5 for details on the format of this file. +.It Pa $HOME/.gitsh_completions +User-defined tab completions file, which can be used to add additional +completion rules, for example to add tab completion support for custom +commands and aliases. +.Pp +As with the system-wide completions file, +this file uses the format described in +.Xr gitsh_completions 5 . .El .Sh ENVIRONMENT .Bl -tag -width Ds diff --git a/man/man5/gitsh_completions.5.in b/man/man5/gitsh_completions.5.in index a9750664..d45619d8 100644 --- a/man/man5/gitsh_completions.5.in +++ b/man/man5/gitsh_completions.5.in @@ -258,6 +258,9 @@ wouldn't. .It Pa @pkgsysconfdir@/completions System-wide tab completions file, which defines the tab completion options for popular Git commands. +.It Pa $HOME/.gitsh_completions +User-defined completions file, which can be used to add completions for custom +commands or aliases. .El . .Sh EXAMPLES