Re: How to create a man page?
On Jun 8, 2005, at 9:53 AM, [EMAIL PROTECTED] wrote: Hi all. I am writing a program with hopes to submit it for inclusion to the ports collection. My last step is to include a man page for my program. Man pages look to be some sort of markup language. What is the standard way to create a man page? Is there some sort of wysiwyg or some other program that makes them easy to create? If your program implements the standard --version and --help long options, the misc/help2man port will create an adequate manpage from the information your program provides. Someone who knows NROFF can do a better job writing of the manpage by hand, but it's at least a starting point. -- -Chuck ___ freebsd-questions@freebsd.org mailing list http://lists.freebsd.org/mailman/listinfo/freebsd-questions To unsubscribe, send any mail to "[EMAIL PROTECTED]"
Re: How to create a man page?
On 2005-06-08 09:53, [EMAIL PROTECTED] wrote: > Hi all. I am writing a program with hopes to submit it for inclusion > to the ports collection. My last step is to include a man page for my > program. Man pages look to be some sort of markup language. What is > the standard way to create a man page? Just typing the text in a plain ASCII file is sufficient. > Is there some sort of wysiwyg or some other program that makes them > easy to create? Not really. Most of the "rules" for writing a well formatted manpage are picked up by osmosis; by reading existing manpages and looking at the diffs committed by more experienced manpage authors. FYI, The reference for groff mdoc macros, which are the preferred way of writing manpages for FreeBSD, is the groff_mdoc(7) manpage. If you have the text of the manpage, you can always ask the freebsd-doc people to review the manpage text and/or formatting. ___ freebsd-questions@freebsd.org mailing list http://lists.freebsd.org/mailman/listinfo/freebsd-questions To unsubscribe, send any mail to "[EMAIL PROTECTED]"
How to create a man page?
Hi all. I am writing a program with hopes to submit it for inclusion to the ports collection. My last step is to include a man page for my program. Man pages look to be some sort of markup language. What is the standard way to create a man page? Is there some sort of wysiwyg or some other program that makes them easy to create? Thanks, Brian ___ freebsd-questions@freebsd.org mailing list http://lists.freebsd.org/mailman/listinfo/freebsd-questions To unsubscribe, send any mail to "[EMAIL PROTECTED]"
