Hi, On Thu, Nov 14, 2002 at 08:18:35PM +0300, Sergey Vlasov wrote: > Also, there is another problem: according to my man(7) documentation, > the NAME section in all *.man files is wrong. Here is the relevant part > of man(7): > > ... The only required heading is NAME, which > should be the first section and be followed on the next > line by a one line description of the program: > > .SH NAME > chess \- the game of chess > > It is extremely important that this format is followed, > and that there is a backslash before the single dash which > follows the command name. This syntax is used by the > makewhatis(8) or mandb(8) programs to create a database of > short command descriptions for the whatis(1) and apro- > pos(1) commands. > > Our *.man files don't have a backslash in this place.
Most of them don't, that's right. I haven't seen any problems caused by this until now, however. On my system, about 90 % of the man pages follow this convention, the others either use "-" or just a line break. While we are looking at the man pages, does it make sense to add the version number of sane to them, e.g. .TH sane-mustek 5 "9 Nov 2002" @PACKAGEVERSION@ resulting in a footer like this: sane-backends-1.0.9-cvs 9 Nov 2002 sane-mustek(5) Bye, Henning
