/[ddp]/manuals/trunk/debian-faq/support.sgml
ViewVC logotype

Contents of /manuals/trunk/debian-faq/support.sgml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 4672 - (show annotations) (download) (as text)
Wed Jul 11 17:52:04 2007 UTC (5 years, 10 months ago) by joostvb
Original Path: manuals/trunk/faq/support.sgml
File MIME type: text/x-sgml
File size: 11079 byte(s)
remove notes about sections of manpages: too much techical detail for intented audience.  give example "man ls" instead and refer to man(1)
1 <!-- retain these comments for translator revision tracking -->
2 <!-- Original version: $Revision: 1.30 $ -->
3 <chapt id="support">Getting support for &debian;
4
5 <sect id="debiandocs">What other documentation exists on and for a
6 Debian system?
7
8 <p><list>
9 <item>Installation instructions for the current release: see
10 <url id="http://www.debian.org/releases/stable/installmanual">.
11 <item>The Debian GNU/Linux reference covers many aspects of system
12 administration through shell-command examples. Basic tutorials, tips, and
13 other information are provided for many different topics ranging from
14 system administration to programming.
15 <p>Get it from the <package/debian-reference/ package, or at
16 <url id="http://www.debian.org/doc/user-manuals#quick-reference">.
17 <item>Policy manual documents the policy requirements for the
18 distribution, i.e. the structure and contents of the Debian archive,
19 several design issues of the operating system etc. It also includes
20 the technical requirements that each package must satisfy to be
21 included in the distribution, and documents the basic technical
22 aspects of Debian binary and source packages.
23 <p>Get it from the <package/debian-policy/ package, or at
24 <url id="http://www.debian.org/doc/devel-manuals#policy">.
25 <item>Documentation developed by the Debian Documentation Project.
26 It is available at <url id="http://www.debian.org/doc/"> and includes
27 user guides, administration guides and security guides for the
28 Debian GNU/Linux operating system.
29 <item>Documentation on installed Debian packages:
30 Most packages have files that are unpacked into <tt>/usr/share/doc/PACKAGE</tt>.
31 <item>Documentation on the Linux project:
32 The Debian package <package/doc-linux/ installs all of the most recent
33 versions of the HOWTOs and mini-HOWTOs from the <url name="Linux
34 Documentation Project" id="http://www.tldp.org/">.
35 <item>Unix-style `man' pages: Most commands have manual pages written in
36 the style of the original Unix 'man' files. For instance, to see
37 the manual page for the command `ls', execute <tt>man ls</tt>.
38 Execute <tt>man man</tt> for more information on finding and viewing
39 manual pages.
40 <p>New Debian users should note that the 'man' pages of many general
41 system commands are not available until they install these packages:
42 <list>
43 <item><tt>man-db</tt>, which contains the <tt>man</tt> program
44 itself, and other programs for manipulating the manual pages.
45 <item><tt>manpages</tt>, which contains the system manual pages.
46 (see <ref id="nonenglish">).
47 </list>
48 <item>GNU-style `info' pages: User documentation for many commands,
49 particularly GNU tools, is available not in `man' pages, but in `info'
50 files which can be read by the GNU tool <tt>info</tt>, by running
51 <tt>M-x info</tt> within GNU Emacs, or with some other Info page viewer.
52 <p>Its main advantage over the original `man' pages are that it is
53 a hypertext system. It does <em>not</em> require the WWW, however;
54 <tt>info</tt> can be run from a plain text console. It was designed
55 by Richard Stallman and preceded the WWW.
56 </list>
57
58 <p>Note that you may access a lot of documentation on your system by using a
59 WWW browser, through `dwww', `dhelp' or `doccentral' commands, found in
60 respective packages, or by using `yelp'.
61
62 <sect id="onlineresources">Are there any on-line resources for discussing
63 Debian?
64
65 <p>Yes. In fact, the main method of support Debian provides to our users is
66 by the way of e-mail.
67
68 <sect1>Mailing lists
69
70 <p>There are a lot of <url name="Debian-related mailing lists"
71 id="http://www.debian.org/MailingLists/">.
72
73 <p>On a system with the <package/doc-debian/ package installed there
74 is a complete list of mailing lists in
75 <file>/usr/share/doc/debian/mailing-lists.txt</file>.
76
77 <p>Debian mailing lists are named following the pattern
78 debian-<var>list-subject</var>. Examples are debian-announce,
79 debian-user, debian-news. To subscribe to any list
80 debian-<var>list-subject</var>, send mail to
81 debian-<var>list-subject</var>-request@lists.debian.org with the word
82 "subscribe" in the Subject: header. Be sure to remember to add
83 <em>-request</em> to the e-mail address when using this method to
84 subscribe or unsubscribe. Otherwise your e-mail will go to the
85 list itself, which could be embarrassing or annoying, depending on
86 your point of view.
87
88 <p>If you have a forms-capable World Wide Web browser, you can
89 subscribe to mailing lists using the <url name="WWW form"
90 id="http://www.debian.org/MailingLists/subscribe">.
91 You can also un-subscribe using a <url name="WWW form"
92 id="http://www.debian.org/MailingLists/unsubscribe">.
93
94 <p>The list manager's e-mail address is <email/listmaster@lists.debian.org/, in
95 case you have any trouble.
96
97 <p>The mailing lists are public forums. All e-mails sent to the lists are also
98 copied to the public archive, for anybody (even non-subscribers) to browse or
99 search. Please make sure you never send any confidential or unlicensed
100 material to the lists. This includes things like e-mail addresses. Of
101 particular note is the fact that spammers have been known to abuse e-mail
102 addresses posted to our mailing lists. See the <url
103 id="http://www.debian.org/MailingLists/index.en.html#disclaimer" name="Mailing
104 Lists Privacy policy"> for more information.
105
106 <p>Archives of the Debian mailing lists are available via WWW at
107 <url id="http://lists.debian.org/">.
108
109 <sect2 id="mailinglistconduct">What is the code of conduct for the mailing
110 lists?
111
112 <p>When using the Debian mailing lists, please follow these rules:
113
114 <list>
115 <item>Do not send spam. See the <url name="Debian mailing list
116 advertising policy" id="http://www.debian.org/MailingLists/#ads">.
117 <item>Do not flame; it is not polite. The people developing Debian are
118 all volunteers, donating their time, energy and money in an attempt to
119 bring the Debian project together.
120 <item>Do not use foul language; besides, some people receive the lists
121 via packet radio, where swearing is illegal.
122 <item>Make sure that you are using the proper list. <em/Never/ post your
123 (un)subscription requests to the mailing list itself<footnote>Use the
124 debian-<var>list-subject</var>-REQUEST@lists.debian.org address for that.</footnote>
125 <item>See section <ref id="bugreport"> for notes on reporting bugs.
126 </list>
127
128 <sect1>Maintainers
129
130 <p>Users can address questions to individual package maintainers using
131 e-mail. To reach a maintainer of a package called xyz, send e-mail to
132 <em>xyz@packages.debian.org</em>.
133
134 <sect1>Usenet newsgroups
135
136 <p>Users should post non-Debian-specific questions to one of the Linux
137 USENET groups, which are named comp.os.linux.* or linux.*.
138 There are several lists of Linux Usenet newsgroups and other related
139 resources on the WWW, e.g. on the <url name="Linux Online"
140 id="http://www.linux.org/docs/usenet.html"> and <url name="LinuxJournal"
141 id="http://www.linuxjournal.com/helpdesk.php"> sites.
142
143 <sect id="searchtools">Is there a quick way to search for information on
144 &debian;?
145
146 <p>There is a variety of search engines that serve documentation related
147 to Debian:
148
149 <list>
150 <item><url id="http://search.debian.org/" name="Debian WWW search site">.
151
152 <item><url id="http://groups.google.com/" name="Google Groups">: a search
153 engine for newsgroups.
154
155 <p>For example, to find out what experiences people have had with
156 finding drivers for Promise controllers under Debian, try searching on
157 the phrase <tt>Promise Linux driver</tt>. This will show you all the
158 postings that contain these strings, i.e. those where people discussed
159 these topics. If you add <tt>Debian</tt> to those search strings, you'll
160 also get the postings specifically related to Debian.
161
162 <item>Any of the common web spidering engines, such as
163 <url id="http://www.altavista.com/" name="AltaVista"> or
164 <url id="http://www.google.com/" name="Google">, as long as you use
165 the right search terms.
166
167 <p>For example, searching on the string "cgi-perl" gives a more detailed
168 explanation of this package than the brief description field in its
169 control file.
170 </list>
171
172 <sect id="buglogs">Are there logs of known bugs?
173
174 <p>Reports on unsolved (and closed) issues are publicly available: Debian
175 promissed to do so by stating "We will not hide problems" in the <url
176 id="http://www.debian.org/social_contract" name="Debian Social Contract">.
177
178 <p>The &debian; distribution has a bug tracking system (BTS) which files
179 details of bugs reported by users and developers. Each bug is given a
180 number, and is kept on file until it is marked as having been dealt with.
181
182 <p>Copies of this information are available at
183 <url id="http://www.debian.org/Bugs/">.
184
185 <p>A mail server provides access to the bug tracking system database via
186 e-mail. In order to get the instructions, send an e-mail to
187 request@bugs.debian.org with "help" in the body.
188
189 <sect id="bugreport">How do I report a bug in Debian?
190
191 <p>If you have found a bug in Debian, please read the instructions for
192 reporting a bug in Debian. These instructions can be obtained in one of
193 several ways:
194 <list>
195 <item>By anonymous FTP. Debian mirror sites contain the instructions in
196 the file <tt>doc/bug-reporting.txt</tt>.
197 <item>From the WWW. A copy of the instructions is shown at
198 <url id="http://www.debian.org/Bugs/Reporting">.
199 <item>On any Debian system with the <package/doc-debian/ package installed.
200 The instructions are in the file
201 <file>/usr/share/doc/debian/bug-reporting.txt</file>.
202 </list>
203
204 <p>You can use the package <package/reportbug/ that will guide you
205 through the reporting process and mail the message to the proper
206 address, with some extra details about your system added
207 automatically. It will also show you a list of bugs already reported
208 to the package you are reporting against in case your bug has been
209 reported previously, so that you can additional information to the
210 existing bug report.
211
212 <p>If you want to mail the report with an e-mail program, send a message to
213 <email/submit@bugs.debian.org/. The message's first line must be similar to
214 <example>Package: package-name</example>
215 (replace <var>package-name</var> with the name of the package). The next line
216 should relate the package version number in a similar way:
217 <example>Version: version-number</example>
218 The version number for any package installed on your system can be obtained
219 using the command line
220 <example>dpkg -s <var>package-name</var></example>
221 This section is referred to as the pseudo-header. The rest of the
222 message should contain the description of the bug (please make it moderately
223 detailed), the Debian release you are using, and versions of other relevant
224 packages. The Debian release number will be displayed by the command
225 <example>cat /etc/debian_version</example>
226
227 <p>Expect to get an automatic acknowledgement of your bug report. It will
228 also be automatically given a bug tracking number, entered into the bug
229 log and forwarded to the debian-bugs-dist mailing list.
230

  ViewVC Help
Powered by ViewVC 1.1.5