1
<chapt id="support">Getting support for &debian;
3
<sect id="debiandocs">What other documentation exists on and for a
7
<item>Installation instructions for the current release: see
8
<url id="http://www.debian.org/releases/stable/i386/install">.
9
<item>Packaging manual is the primary documentation on the technical
10
aspects of creating Debian binary and source packages.
11
<p>You can find it in the <package/packaging-manual/ package, or at
12
<url id="ftp://ftp.debian.org/debian/doc/package-developer/packaging.html.tar.gz">.
13
<item>Policy manual documents the policy requirements for the
14
distribution, i.e. the structure and contents of the Debian archive,
15
several design issues of the operating system, as well as technical
16
requirements that each package must satisfy to be included in the
18
<p>Get it from the <package/debian-policy/ package, or at
19
<url id="ftp://ftp.debian.org/debian/doc/package-developer/policy.html.tar.gz">.
20
<item>Documentation on installed Debian packages:
21
Most packages have files that are unpacked into <tt>/usr/doc/PACKAGE</tt>.
22
<item>Documentation on the Linux project:
23
The Debian package <package/doc-linux/ installs all of the most recent
24
versions of the HOWTOs and mini-HOWTOs from the <url name="Linux
25
Documentation Project" id="http://www.linuxdoc.org">.
26
<item>Unix-style `man' pages: Most commands have manual pages written in
27
the style of the original Unix 'man' files. They are referenced by the
28
section of the 'man' directory where they reside: e.g., foo(3) refers
29
to a manual page which resides in /usr/share/man/man3/, and it can be
30
called by executing the command: <tt>man 3 foo</tt>, or just
31
<tt>man foo</tt> if section 3 is the first one containing a page on
33
<p>One can learn which directory of <tt>/usr/share/man/</tt> contains
34
a certain manual page by executing <tt>man -w foo</tt>.
35
<p>New Debian users should note that the 'man' pages of many general
36
system commands are not available until they install these packages:
38
<item><tt>man-db</tt>, which contains the <tt>man</tt> program
39
itself, and other programs for manipulating the manual pages.
40
<item><tt>manpages</tt>, which contains the system manual pages.
41
(see <ref id="nonenglish">).
43
<item>GNU-style `info' pages: User documentation for many commands,
44
particularly GNU tools, is available not in `man' pages, but in `info'
45
files which can be read by the GNU tool <tt>info</tt>, by running
46
<tt>M-x info</tt> within GNU Emacs, or with some other Info page viewer.
47
<p>Its main advantage over the original `man' pages are that it is
48
a hypertext system. It does <em>not</em> require the WWW, however;
49
<tt>info</tt> can be run from a plain text console. It was designed
50
by Richard Stallman and preceded the WWW.
53
<p>Note that you may access a lot of documentation on your system by using a
54
WWW browser, through `dwww' or `dhelp' commands, found in respective
57
<sect id="onlineresources">Are there any on-line resources for discussing
60
<p>Yes. In fact, the main method of support Debian provides to our users is
65
<p>There are a lot of <url name="Debian-related mailing lists"
66
id="http://www.debian.org/MailingLists/">.
68
<p>On a system with the <package/doc-debian/ package installed there
69
is a complete list of mailing lists in
70
<file>/usr/share/doc/debian/mailing-lists.txt</file>.
72
<p>To subscribe to debian-X (for X in announce, user, etc.), send mail to
73
debian-X-request@lists.debian.org with the word "subscribe" in the Subject:
74
header. If you have a forms-capable World Wide Web browser, you can
75
subscribe the mailing lists using the <url name="WWW form"
76
id="http://www.debian.org/MailingLists/subscribe">.
77
You can also un-subscribe using a <url name="WWW form"
78
id="http://www.debian.org/MailingLists/unsubscribe">.
80
<p>The list manager's e-mail address is <email/listmaster@lists.debian.org/, in
81
case you have any trouble.
83
<p>Archives of the Debian mailing lists are available via WWW at
84
<url id="http://lists.debian.org/">.
86
<sect2 id="mailinglistconduct">What is the code of conduct for the mailing
89
<p>When using the Debian mailing lists, please follow these rules:
92
<item>Do not send spam. See the <url name="Debian mailing list
93
advertising policy" id="http://www.debian.org/MailingLists/#ads">.
94
<item>Do not flame; it is not polite. The people developing Debian are
95
all volunteers, donating their time, energy and money in an attempt to
96
bring the Debian project together.
97
<item>Do not use foul language; besides, some people receive the lists
98
via packet radio, where swearing is illegal.
99
<item>Make sure that you are using the proper list. <em/Never/ post your
100
(un)subscription requests to the mailing list itself<footnote>Use the
101
<em>listname</em>-REQUEST@lists.debian.org address for that.</footnote>
102
<item>See section <ref id="bugreport"> for notes on reporting bugs.
107
<p>Users can address questions to individual package maintainers using
108
email. To reach a maintainer of a package called xyz, send email to
109
<em>xyz@packages.debian.org</em>.
111
<sect1>Usenet newsgroups
113
<p>Users should post non-Debian-specific questions to one of the Linux
114
USENET groups, which are named comp.os.linux.* or linux.*.
115
There are several lists of Linux Usenet newsgroups and other related
116
resources on the WWW, e.g. on the <url name="Linux Online"
117
id="http://www.linux.org/docs/usenet.html"> and <url name="LinuxJournal"
118
id="http://www.linuxjournal.com/helpdesk.php"> sites.
120
<sect id="searchtools">Is there a quick way to search for information on
123
<p>There is a variety of search engines that serve documentation related
127
<item><url id="http://search.debian.org/" name="Debian WWW search site">.
129
<item><url id="http://groups.google.com/" name="Google Groups">: a search
130
engine for newsgroups.
132
<p>For example, to find out what experiences people have had with
133
finding drivers for Promise controllers under Debian, try searching on
134
the phrase <tt>Promise Linux driver</tt>. This will show you all the
135
postings that contain these strings, i.e. those where people discussed
136
these topics. If you add <tt>Debian</tt> to those search strings, you'll
137
also get the postings specifically related to Debian.
139
<item>Any of the common web spidering engines, such as
140
<url id="http://www.altavista.com/" name="AltaVista"> or
141
<url id="http://www.google.com/" name="Google">, as long as you use
142
the right search terms.
144
<p>For example, searching on the string "cgi-perl" gives a more detailed
145
explanation of this package than the brief description field in its
149
<sect id="buglogs">Are there logs of known bugs?
151
<p>The &debian; distribution has a bug tracking system (BTS) which files
152
details of bugs reported by users and developers. Each bug is given a
153
number, and is kept on file until it is marked as having been dealt with.
155
<p>Copies of this information are available at
156
<url id="http://www.debian.org/Bugs/">.
158
<p>A mail server provides access to the bug tracking system database via
159
e-mail. In order to get the instructions, send an e-mail to
160
request@bugs.debian.org with "help" in the body.
162
<sect id="bugreport">How do I report a bug in Debian?
164
<p>If you have found a bug in Debian, please read the instructions for
165
reporting a bug in Debian. These instructions can be obtained in one of
168
<item>By anonymous FTP. Debian mirror sites contain the instructions in
169
the file <tt>doc/bug-reporting.txt</tt>.
170
<item>From the WWW. A copy of the instructions is shown at
171
<url id="http://www.debian.org/Bugs/Reporting">.
172
<item>On any Debian system with the <package/doc-debian/ package installed.
173
The instructions are in the file
174
<file>/usr/doc/debian/bug-reporting.txt</file>.
177
<p>You can use the packages <package/bug/ or <package/reportbug/ that will
178
guide you through the reporting process and mail the message to the proper
179
address, with some extra details about your system added automatically.
181
<p>If you want to mail the report with a MUA, send a message to
182
<email/submit@bugs.debian.org/, first line of which containing a line like
183
<example>Package: packagename</example>
184
(replace "packagename" with the name of the package). The rest of the
185
message should contain the description of the bug (please make it moderately
186
detailed), Debian release you are using, and versions of that and relevant
189
<p>Expect to get an automatic acknowledgement of your bug report. It will
190
also be automatically given a bug tracking number, entered into the bug
191
log and forwarded to the debian-bugs-dist mailing list.
193
<p>If one were to identify a bug that was common to many programs, then
194
rather than entering dozens of very similar bug reports, one might prefer to
195
send individual bugs to <email/maintonly@bugs.debian.org/ (instead of the
196
submit@... address) to reach only the respective package maintainers, and
197
then send a summary report to debian-devel and/or debian-bugs-dist mailing
200
<p>Additionally, there exists a Debian package checker, called
201
<url name="Lintian" id="http://www.debian.org/lintian/">, which is
202
designed to mechanically check Debian packages for policy violations and
203
common packaging errors. Thus, if you detect a bug in a package which is
204
likely to appear in other packages too, it might be better to get in
205
contact with the Lintian maintainers at <email/lintian-maint@debian.org/
206
so that a new check is written for Lintian instead of reporting the bug
207
directly. This will most likely prevent the bug to appear in future versions
208
of the package again, or in any other package of the distribution.
210
<p>You can also use <email/quiet@bugs.debian.org/, to submit bug reports to
211
the BTS only, without having them sent either to debian-bugs-dist or to the
212
maintainer. This `quiet' address is used very rarely, e.g. when you want to
213
send some minor data to your report, that should just be recorded in the
214
log, or when you want to record something in the BTS log but you already
215
sent it to the maintainer.