From 9dcd49e2dade1637d920158b0390eb99615430a4 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Wed, 2 Dec 2015 10:18:26 +0100 Subject: add rationale and man page MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/man/auto-auto-complete.1 | 59 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 doc/man/auto-auto-complete.1 (limited to 'doc') diff --git a/doc/man/auto-auto-complete.1 b/doc/man/auto-auto-complete.1 new file mode 100644 index 0000000..9c79c26 --- /dev/null +++ b/doc/man/auto-auto-complete.1 @@ -0,0 +1,59 @@ +.TH AUTO-AUTO-COMPLETE 1 AUTO-AUTO-COMPLETE +.SH NAME +auto-auto-complete - Autogenerate shell auto-completion scripts +.SH SYNOPSIS +.B auto-auto-complete +.I SHELL +.B \-\-output +.I OUTPUT +.B \-\-source +.I SOURCE +.RI [ VARIABLE \fB=\fP VALUE ]... +.br +.B auto-auto-complete +.I SHELL +.B \-\-where +.I COMMAND +.SH DESCRIPTION +.B auto-auto-complete +generates a shell auto-completion script for the shell +.IR SHELL , +from the file +.IR SOURCE , +and stores it to +.IR OUTPUT . +Or, if +.B \-\-where +is used, print to stdout where such generate file should +be installed for the command +.IR COMMAND , +and the shell +.IR SHELL . +.PP +When generating a file, a series of variables can defined +using the argument pattern \(aq'\fIVARIABLE\fP\fB=\fP\fIVALUE\fP\(aq. +.SH RATIONALE +Noone really wants to write shell auto-completion scripts, +especially not for more than one shell. But of course we +want to have it. +.SH "SEE ALSO" +.BR bash-completion , +.BR bash (1), +.BR fish (1), +.BR zsh (1) +.PP +Full documentation available locally via: info \(aq(auto-auto-complete)\(aq +.SH AUTHORS +Principal author, Mattias Andrée. See the COPYING file for the full +list of authors. +.SH LICENSE +Copyright \(co 2013, 2015 Mattias Andrée +.br +License GPLv3+: GNU GPL version 3 or later . +.br +This is free software: you are free to change and redistribute it. +.br +There is NO WARRANTY, to the extent permitted by law. +.SH BUGS +Please report bugs to https://github.com/maandree/auto-auto-complete/issues or to +maandree@member.fsf.org -- cgit v1.2.3-70-g09d2