Index: en_US.ISO8859-1/books/fdp-primer/manpages/chapter.xml =================================================================== --- en_US.ISO8859-1/books/fdp-primer/manpages/chapter.xml +++ en_US.ISO8859-1/books/fdp-primer/manpages/chapter.xml @@ -115,21 +115,6 @@ including PostScript for printing or PDF generation. See &man.man.1;. - - Testing a new manual page can be challenging when it is - not located in the normal manual page search path. - &man.man.1; also does not look in the current directory. If - the new manual page is in the current directory, prefix - the filename with a ./: - - &prompt.user; man ./mynewmanpage.8 - - An absolute path can also be used: - - &prompt.user; man /home/xsmith/mynewmanpage.8 - - - Manual Page Sections @@ -643,6 +628,49 @@ .Sh AUTHORS .An Firstname Lastname Aq Mt flastname@example.com + + + + Testing + + Testing a new manual page can be challenging. Fortunately + there are some tools that can assist in the task. Some of them, + like &man.man.1;, do not look in the current directory. It is a + good idea to prefix the filename with ./ if + the new manual page is in the current directory. An absolute + path can also be used. + Use &man.mandoc.1;'s linter to check for parsing + errors: + + &prompt.user; mandoc -T lint ./mynewmanpage.8 + + Use textproc/igor to proofread the + manual page: + + &prompt.user; igor ./mynewmanpage.8 + + Use &man.man.1; to check the final result of your + changes: + + &prompt.user; man ./mynewmanpage.8 + + You can use &man.col.1; to filter the output of + &man.man.1; and get rid of the backspaces characters before + loading the result in your favorite editor for + spell checking: + + &prompt.user; man ./mynewmanpage.8 | col -b | vim -R - + + Spell-checking with fully-featured dictionaries is + encouraged, and can be accomplished by using + textproc/hunspell or + textproc/aspell combined with + textproc/en-hunspell or + textproc/en-aspell, respectively. + For instance: + + &prompt.user; aspell check --lang=en --mode=nroff ./mynewmanpage.8 +