On Sun, Aug 21, 2005 at 05:44:56PM +1000, Rod.. Whitworth wrote:
> What format(s) are acceptable for submitting minor changes to man
> pages?
>
> I assume unified diff - but against what? The man page as distributed
> (e.g. in /usr/share/man/cat?/ ?) or the file that produced that? If the
> file should be the one input to the -mdoc process, where can it be
> found?
>
unified diff is preferred, yes. always diff against the source (in
/usr/src). if you don't have a copy of the source, you can download
single pages from the web interface (and use diff -u, rather than cvs
diff -u).
stuart's advice about `locate man_page.section' is probably the best for
finding stuff.
>
> My other guess is that an entirely new man page should be submitted as
> the -mdoc input file. Is that true?
>
yes
> I suppose that I'm going to have to try to remember something about the
> [gnt]roff things I had very small experience with back in the '70s....
>
> So apart from the mdoc-samples man page are there other
> required/recommended documents for rust-removal / new learning please?
>
mdoc.samples(7) is the right page to read. other than that, just look at
similar pages and see how they work.
btw, it is a good idea to run your stuff through groff to see how it
will look when formatted:
nroff -Tascii -mandoc <file> | less
jmc
