From: Jean-Noël Avila <jn.avila@free.fr>
Date: Mon, 05 Jan 2026 10:01:07 GMT
Subject: Re: Documentation options: Code or not?
Message-ID: <eaf31f3d-83ab-4afc-8b78-0d017de6b580@free.fr>
In-Reply-To: <2076768.usQuhbGJ8B@debian-mbp>

Hi,

The process of converting all the manpages to the `synopsis` style

is ongoing.

The aim is to use the "smart" synopsis format (using backticks for

 inline code), for which a parser makes the special formatting for

 keywords, placeholders and grammatical marks.


I took the path of converting the pages in the order of appearance

on git-scm.com.

For a good idea of the final rendering, you can check git-commit or

git-add. I'm always open to a helping hand in this task, with enough

communication to not duplicate work. To be honest, the conversion process

is far from being completely formalized, so you may need a couple

iterations before the rules are completely clear.


Let me know if you are interested.


JN