| 1 |
#use wml::templ::template title="Man pages" author="Martin Michlmayr"
|
| 2 |
|
| 3 |
<P>As per Debian's Policy, every executable file in Debian has to
|
| 4 |
supply a man page. However, many packages don't follow this
|
| 5 |
requirement yet. Below is a listing of all executables for which no
|
| 6 |
corresponding man page is available yet. If you use any of these
|
| 7 |
packages listed below, please consider writing a man page for its
|
| 8 |
executable files and submit it to the
|
| 9 |
<A HREF="http://bugs.debian.org/">Bug Tracking System</A> (BTS).
|
| 10 |
For those man pages listed in <B>bold</B>, a bug report has already
|
| 11 |
been filed so these pages should be given priority.
|
| 12 |
|
| 13 |
<P>Writing man pages is not very difficult. You can simply look at
|
| 14 |
some man pages in /usr/share/man and follow their structure (also see the
|
| 15 |
file /usr/share/doc/man-db/examples/manpage.example). Furthermore, some
|
| 16 |
information about the format of man pages is available
|
| 17 |
in the
|
| 18 |
<A HREF="http://gmanedit.sourceforge.net/man7.html">man</A>
|
| 19 |
(man 7 man) and
|
| 20 |
<A HREF="http://www.perldoc.com/perl5.8.0/bin/pod2man.html">pod2man</A>
|
| 21 |
(man 1 pod2man) man pages. You can also install any of various packages
|
| 22 |
which provide tools to help you write basic man pages, and then tweak
|
| 23 |
the output if necessary: help2man, txt2man, xml2man (in the kdelibs-bin
|
| 24 |
package), or docbook-to-man.
|
| 25 |
|
| 26 |
<P>When you decide to help out, please write the man pages for a whole
|
| 27 |
package. Send e-mail to man-pages@qa.debian.org and tell us which
|
| 28 |
package you are working on. We can then add you to this web site so other
|
| 29 |
people know that someone is working on that particular package already.
|
| 30 |
Please also send your man page to the
|
| 31 |
<A HREF="http://www.netmeister.org/misc/m2p2/index.html">Missing Man
|
| 32 |
Pages Project</A>.
|
| 33 |
|
| 34 |
<P>When you have written a man page, please let us know at
|
| 35 |
man-pages@qa.debian.org and submit the man page to the BTS.
|
| 36 |
Before submitting a new bug, please check the bug listing (linked from
|
| 37 |
the package name) for an existing bug. If a bug exists already,
|
| 38 |
send your man page to <I>nnn</I>@bugs.debian.org where <I>nnn</I> is
|
| 39 |
the bug number (e.g. 92423@bugs.debian.org). If there is no bug yet,
|
| 40 |
file a new one by sending a message to submit@bugs.debian.org.
|
| 41 |
|
| 42 |
<P>If you have written a man page for the executable file <I>foobar</I>
|
| 43 |
in the package <I>bar</I>, you would send a bug report like this:
|
| 44 |
|
| 45 |
<PRE>
|
| 46 |
To: <nnn or submit>@bugs.debian.org
|
| 47 |
Subject: man page for foobar
|
| 48 |
|
| 49 |
Package: bar
|
| 50 |
Tags: patch
|
| 51 |
|
| 52 |
<attach foobar.1 here>
|
| 53 |
</PRE>
|
| 54 |
|
| 55 |
<:
|
| 56 |
|
| 57 |
use POSIX qw(strftime);
|
| 58 |
use HTML::Entities;
|
| 59 |
|
| 60 |
sub protect {
|
| 61 |
"<protect pass=4->" . encode_entities($_[0], "\"&'<>") . "</protect>";
|
| 62 |
}
|
| 63 |
|
| 64 |
$missing = 0;
|
| 65 |
open(LINTIAN, "/org/qa.debian.org/data/lintian.log") || die "Cannot open lintian report";
|
| 66 |
$lintian_date = (stat LINTIAN)[9];
|
| 67 |
while(<LINTIAN>) {
|
| 68 |
(undef, $package, $error) = split(/: /);
|
| 69 |
|
| 70 |
if ($error =~ /^(link-to-undocumented-manpage|binary-without-manpage)/) {
|
| 71 |
(undef, $file) = split(/ /, $error);
|
| 72 |
push(@{$man{$package}}, $file);
|
| 73 |
$missing++;
|
| 74 |
}
|
| 75 |
}
|
| 76 |
close(LINTIAN);
|
| 77 |
|
| 78 |
$in_work = 0;
|
| 79 |
open(HELPERS, "/org/qa.debian.org/data/man-page-help.txt") || die "Cannot open helpers file";
|
| 80 |
while($package = <HELPERS>) {
|
| 81 |
chomp($package);
|
| 82 |
$who = <HELPERS>;
|
| 83 |
$who =~ s/\<.+\>//;
|
| 84 |
chomp($who);
|
| 85 |
$who =~ s/\s+$//;
|
| 86 |
<HELPERS>; # ignore starting date
|
| 87 |
# helpers don't get removed from the man-page-help.txt file so check if
|
| 88 |
# the package is still listed in the lintian report.
|
| 89 |
if (exists($man{$package})) {
|
| 90 |
$worked_on{$package} = $who;
|
| 91 |
$in_work += $#{$man{$package}} + 1;
|
| 92 |
}
|
| 93 |
<HELPERS>; # blank line
|
| 94 |
}
|
| 95 |
close(HELPERS);
|
| 96 |
|
| 97 |
print "<P>In total $missing man pages are missing at the moment. ";
|
| 98 |
print scalar(keys %worked_on);
|
| 99 |
print " packages ($in_work man pages) are being worked on. ";
|
| 100 |
print "This listing was generated from a Lintian report published on ";
|
| 101 |
print strftime '%a, %d %b %Y', gmtime $lintian_date;
|
| 102 |
print ".</P>\n";
|
| 103 |
|
| 104 |
foreach $package (sort keys %man) {
|
| 105 |
print "<H2><A HREF = \"http://bugs.debian.org/", protect($package), "\">",
|
| 106 |
protect($package), "</A></H2>";
|
| 107 |
if (exists($worked_on{$package})) {
|
| 108 |
print "<PRE>\n";
|
| 109 |
print protect($worked_on{$package}), " is working on this package\n";
|
| 110 |
print "</PRE>\n";
|
| 111 |
}
|
| 112 |
print " <UL>\n";
|
| 113 |
foreach (@{$man{$package}}) {
|
| 114 |
print " <LI>";
|
| 115 |
if (s/\.gz$//) {
|
| 116 |
s#.*/##;
|
| 117 |
print "<B>", protect($_), "</B>\n";
|
| 118 |
} else {
|
| 119 |
print protect($_), "\n";
|
| 120 |
}
|
| 121 |
}
|
| 122 |
print " </UL>\n";
|
| 123 |
}
|
| 124 |
|
| 125 |
:>
|
| 126 |
|
Parent Directory
| 
Revision Log