add tab completion section to man page

rupa · Jul 25, 2011 · a508e83 · a508e83
1 parent 79dc3f3
commit a508e83
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/README b/README
@@ -70,6 +70,17 @@ NOTES
        quickly	have higher rank than a directory accessed frequently a long time
        ago.
 
+       Tab Completion
+
+       z supports tab completion. After any number of  arguments,  press  TAB  to
+       complete	 on  directories  that match each argument. Due to limitations of
+       the completion implementations, only the last argument will  be	completed
+       in the shell.
+
+       Internally,  z  decides you've requested a completion if the last argument
+       passed is an absolute path to an existing directory. This may cause  unex‐
+       pected behavior if the last argument to z begins with /.
+
 
 ENVIRONMENT
        A function _z() is defined.

diff --git a/z.1 b/z.1
@@ -72,6 +72,18 @@ will quickly have higher rank than a directory accessed frequently a long time
 ago.
 .br
 
+\fBTab Completion\fR
+.P
+\fBz\fR supports tab completion. After any number of arguments, press TAB to
+complete on directories that match each argument. Due to limitations of the
+completion implementations, only the last argument will be completed in the
+shell.
+.P
+Internally, \fBz\fR decides you've requested a completion if the last argument
+passed is an absolute path to an existing directory. This may cause unexpected
+behavior if the last argument to \fBz\fR begins with \fB/\fR.
+.br
+
 .SH ENVIRONMENT
 A function \fB_z()\fR is defined.
 .P