Skip to content

Commit

Permalink
Document user-specific completions file.
Browse files Browse the repository at this point in the history
  • Loading branch information
georgebrock committed Nov 12, 2018
1 parent 8f05623 commit b5fef36
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
18 changes: 16 additions & 2 deletions man/man1/gitsh.1.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions man/man5/gitsh_completions.5.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b5fef36

Please sign in to comment.