Tool descriptions and instructions

man2markdown.tcl

Command

tclsh man2markdown.tcl version

example:

tclsh man2markdown.tcl 9.0

Input

./nroff/tcl+version

./nroff/tk+version

Output

./markdown-output
├── tcl9.0
│   ├── API
│   ├── Commands
│   └── User
└── tk9.0
    ├── API
    ├── Commands
    └── User

Script Execution Steps

Man to AST:

AST to Markdown:

Markdown file creation:

• All the nroff files are stored in a tree structure which is then walked.

• The contents of the file are then converted to markdown.

• The file is then categorised based on its extension, 1 = User, 3 = API, n = Commands.

• A new markdown file with the same name as the nroff file is created in the markdown-output dir in the correct category.

• The nroff-markdown conversion output is then stored in that file.

Docs Maker

tclsh make_docs.tcl