Home / HELP (vHELP)
ecosystem Linux utilities
HELP (vHELP)
An OpenVMS-style help subsystem: a Markdown librarian and a browser.
| Version | X01-35 |
|---|---|
| Status | Active development |
| Platforms | Linux |
| Licence | Apache License 2.0 |
| For whom | Authors of command line utilities who want hierarchical HELP as in OpenVMS. |
What it is
vhelptran translates Markdown into a help library, vhelp walks it by topics. The reverse operation (/EXTRACT) gives the text back, and after the first pass the extract-translate cycle is stable.
Why
All our packages ship their help through it.
Quick start Example
vhelptran doc/helplib.md /OUTPUT=helplib.hlb /IDENT=X-01
vhelp submit /after
vhelptran /EXTRACT helplib.hlb /KEY="VHELPTRAN SOURCE FORMAT"
Source: vHELP/README.md
Download
Releases by tag.