https://github.com/sfuhrm/args2all
Converts args4j/JCommander descriptor classes to markdown or manpages
https://github.com/sfuhrm/args2all
args4j java jcommander manpage manpages manual markdown
Last synced: 3 months ago
JSON representation
Converts args4j/JCommander descriptor classes to markdown or manpages
- Host: GitHub
- URL: https://github.com/sfuhrm/args2all
- Owner: sfuhrm
- License: gpl-2.0
- Created: 2017-11-14T21:51:40.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-18T21:42:07.000Z (over 7 years ago)
- Last Synced: 2025-04-09T11:50:18.464Z (6 months ago)
- Topics: args4j, java, jcommander, manpage, manpages, manual, markdown
- Language: Java
- Size: 167 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Args2All
===================
[](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
Converts machine readable command line parser library class annotations (args4j, JCommander)
into a variety of human readable text documents. To put it in other words: You document
your options for i.e. args4j, and then you can extract the information for other documents
using this tool from your Java classes.
The main purpose is to reduce overhead when documenting software.
Two examples can be seen [below](#output-formats-supported).
#### Command line parsing libraries supported
Currently the following command line libraries are supported:
* [Args4j](https://github.com/kohsuke/args4j)
* [JCommander](https://github.com/cbeust/jcommander)
* [PicoCLI](https://github.com/remkop/picocli)
## Command line options
Usage is as follows:
java -jar target/args2all-0.0.1-jar-with-dependencies.jar
Where the possible options are listed here (args2all-generated):
* **-charset, -C** *=* *CHARSET*
The charset encoding to use for the output file.
* **-class, -c** *=* *CLASS*
Name of the annotated class to read. The annotations are from a library like args4j or JCommander. Note that the class must be loadable from the programs context, meaning reachable from the classpath.
*Required*
* **-help, -h**
Show the command line help.
* **-out, -o** *=* *FILE*
The output where to write the result to.
*Required*
* **-template, -t**
The template to use for output. This is the output flavor you are desiring to generate.
### Output formats supported
The *all* in Args2all is quite limited at the moment. Please
read the current options in the next sections.
#### Markdown
Outputs a markdown text that is inspired by the layout of UN*X manual pages.
Here's an example of the program itself:
Markdown code can be seen [here](https://raw.githubusercontent.com/sfuhrm/args2all/master/examples/args2all.md).
#### Manpage
Outputs a partial manual page / troff page that can be used as a
template. The parts of the file that need to be filled are
marked as pseudo-variables, for example `$DESCRIPTION`.
Here's an example of the program itself:
Manpage code can be seen [here](https://raw.githubusercontent.com/sfuhrm/args2all/master/examples/args2all.1).
#### XML
Outputs a XML dump that can be used for example in XML stylesheets.
XML page example is located [here](https://raw.githubusercontent.com/sfuhrm/args2all/master/examples/args2all.xml).
### Warnings
It is possible that the library versions used with Args2all are not
compatible with the versions you're using in the classes you've compiled.
To get around this problem, adjust the problematic library versions to
be the same on both sides.
## License
Copyright 2017 Stephan Fuhrmann
Licensed under the GNU GENERAL PUBLIC LICENSE 2.0.
Please see the licensing conditions under [LICENSE](./LICENSE)
or at [https://www.gnu.org/licenses/gpl-2.0.html](https://www.gnu.org/licenses/gpl-2.0.html).