NAME real/mdoc_migrate — translate a manual to mdoc(7)
If there is a software, ideally not too complex and with a limited number of features, that you maintain or just care about and that has a manual in a language different from mdoc(7)
, start translating the manual to mdoc(7)
. Working on this exercise is particularly useful if you have reason to believe that the maintainer might be willing to switch the format.
Be sure to keep a copy of the original.
If there is more material to cover than you can finish during the tutorial, don't fear leaving blanks in the middle. Try to work on as many different parts as possible and take advantage of the chance to ask questions that arise.
If the original was a man(7)
page, compare the output of mandoc(1)
from your version with the output mandoc -Omdoc
produces from the original version.
Consider submitting the result to the software maintainer for inclusion, possibly after finishing it at home if time is insufficient during the tutorial.