-
Notifications
You must be signed in to change notification settings - Fork 427
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#121 Initial version of autocomplete user manual page (work in progress)
- Loading branch information
Showing
1 changed file
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
= Autocomplete for your Java command line application | ||
//:author: Remko Popma | ||
//:email: rpopma@apache.org | ||
:revnumber: 0.9.8-SNAPSHOT | ||
:revdate: 2017-06-08 | ||
:toc: left | ||
:numbered: | ||
:toclevels: 2 | ||
:toc-title: Table of Contents | ||
:source-highlighter: coderay | ||
:icons: font | ||
:imagesdir: images | ||
|
||
[link=https://github.com/remkop/picocli] | ||
image::https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png[Fork me on GitHub,float="right"] | ||
[quote] | ||
Every main method deserves picocli! | ||
|
||
== Introduction | ||
Picocli-based applications can now have command line completion in the Unix Bash or Zsh shell. | ||
Picocli can generate an autocompletion script tailored to your application. | ||
|
||
With this script installed, users can type the first few letters of a subcommand or an option, | ||
then press the TAB key, and the Unix shell will complete the subcommand or option. | ||
|
||
In the case of multiple possible completions, the Unix shell will display all subcommands or options beginning | ||
with those few characters. The user can type more characters and press TAB again to see a new, narrowed-down | ||
list if the typed characters are still ambiguous, or else complete the subcommand or option. | ||
|
||
=== Example | ||
|
||
|
||
== Generating the Completion Script | ||
|
||
== Installing the Completion Script | ||
|
||
== Supported Platforms | ||
|
||
|
||
== Picocli User Manual | ||
The http://picocli.info[picocli user manual] explains how to build Java command line applications with picocli. | ||
|
||
== GitHub Project | ||
The https://github.com/remkop/picocli[GitHub project] has the source code, tests, build scripts, etc. | ||
|
||
Star icon:star-o[] or fork icon:code-fork[] this project on GitHub if you like it! | ||
(Projects with many icon:code-fork[] forks are easier to find on GitHub Search.) | ||
|
||
== Issue Tracker | ||
Please use the https://github.com/remkop/picocli/issues[Issue Tracker] to report bugs or request features. | ||
|
||
== License | ||
Picocli is licensed under the https://github.com/remkop/picocli/blob/master/LICENSE[Apache License 2.0]. | ||
|
||
== Releases | ||
Previous versions are available from the GitHub project https://github.com/remkop/picocli/releases[Releases]. |