Monday, November 19 2012
By bdjnk on Monday, November 19 2012, 08:34
This should also work with the Mac shell, but I don't know for sure. Leave a comment if it works.
Saturday, June 18 2011
By bdjnk on Saturday, June 18 2011, 02:38
Recently I was working on making my first Linux Man (Manual) Page. When I was first using Linux they were always there for me in a consistent, comprehendable format. Thus it came as a bit of a surprise how scattered and outdated the resources for man page creation were. Most are missing bits of vital information and many contradict one another.
Here are the best resources I found:
Format and Modification of a man Page - A fairly comprehensive and digestible explanation of man page formatting techniques.
The Essential Steps - An all inclusive step by step guide for going from a formatted text to an actual man page properly installed on your system.
For viewing your man page in progress, which is just a text file, you can use either of the following commands:
nroff -man text_file | less groff -man -Tascii text_file | less
This will allow you to check your formatting changes as you work.
The first link dead, 404ing. I have tried to find a copy to no avail. Apologies. It's alive again.