Current unassigned doc problem reports

Vikram Dhillon dhillonv10 at gmail.com
Tue Dec 29 20:46:17 UTC 2009


Thanks a lot, I'll get working on that then :D

Regards,
Vikram Dhillon

~~~
There are lots of Linux users who don't care how the kernel works, but
only want to use it. That is a tribute to how good Linux is.
-- Linus Torvalds



On Tue, Dec 29, 2009 at 2:38 PM, Doug Barton <dougb at freebsd.org> wrote:
> Vikram Dhillon wrote:
>> Thanks a lot for getting back to me, I see that there are some
>> problems that involve writing a man-page. I don't know how to do that,
>> can you please point me to some links that can help me in doing so.
>
> There are example man page files in /usr/share/examples/mdoc. They
> form a good basis to get you started. That's what I use whenever I
> have to write one from scratch. Of course you can always read the
> nroff and mdoc man pages, although they are pretty dense. There are
> also a lot of good examples for "how do I do <something>?" in the man
> pages in the base. In general it's better to avoid using the pages in
> src/contrib as examples since they are not always "the state of the art."
>
> To check the output of the page you're writing, you do this:
> nroff -mdoc example.1 | more
>
> After that it's basically a process of trial and error. :)  We have
> some people who are quite good with nroff/mdoc who are always glad to
> help.
>
> Writing man pages is something that not a lot of people are willing to
> tackle, so this is an area where help is particularly welcome.
>
>
> Good luck,
>
> Doug
>
> --
>
>        Improve the effectiveness of your Internet presence with
>        a domain name makeover!    http://SupersetSolutions.com/
>
>



More information about the freebsd-doc mailing list