Creating Custom Man Pages
Sep 09, 2010, 22:35 (0 Talkback[s])
(Other stories by Pete Vargas)
WEBINAR: On-demand webcast
How to Boost Database Development Productivity on Linux, Docker, and Kubernetes with Microsoft SQL Server 2017 REGISTER >
"Man pages have been the primary source for UN*x documentation
for a long time. Whenever I create a script that's going to be
around for a while, I create documentation in the form of a section
1 man page. This stops my cell phone from ringing on the weekends
when the junior sysadmins are looking for my notes.
"Some people I know tend to shy away from writing man pages
because they believe it's too difficult to learn how to correctly
format man pages using troff or groff. Lucky for me, there's a much
easier way to get the job done.
"Marc Vertes (firstname.lastname@example.org) has written an excellent GNU AWK
script called txt2man..."