support.sgml 10.6 KB
Newer Older
1
<!-- retain these comments for translator revision tracking -->
2
<!-- Original version: $Revision: 1.30 $ -->
3 4 5 6 7
<chapt id="support">Getting support for &debian;

<sect id="debiandocs">What other documentation exists on and for a
  Debian system?

Josip Rodin's avatar
Josip Rodin committed
8
<p><list>
9
  <item>Installation instructions for the current release:  see
10
    <url id="http://www.debian.org/releases/stable/installmanual">.
11 12 13 14 15 16
  <item>The Debian GNU/Linux reference covers many aspects of system
   administration through shell-command examples. Basic tutorials, tips, and
   other information are provided for many different topics ranging from 
   system administration to programming.
    <p>Get it from the <package/debian-reference/ package, or at
    <url id="http://www.debian.org/doc/user-manuals#quick-reference">.
17
  <item>The Debian Policy manual documents the policy requirements for the
Josip Rodin's avatar
Josip Rodin committed
18
    distribution, i.e. the structure and contents of the Debian archive,
Josip Rodin's avatar
Josip Rodin committed
19 20 21 22
    several design issues of the operating system etc. It also includes
    the technical requirements that each package must satisfy to be
    included in the distribution, and documents the basic technical
    aspects of Debian binary and source packages.
Josip Rodin's avatar
Josip Rodin committed
23
    <p>Get it from the <package/debian-policy/ package, or at
Josip Rodin's avatar
Josip Rodin committed
24
    <url id="http://www.debian.org/doc/devel-manuals#policy">.
25 26 27 28
  <item>Documentation developed by the Debian Documentation Project.
    It is available at <url id="http://www.debian.org/doc/"> and includes
    user guides, administration guides and security guides for the
    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 37 38 39
    the style of the original Unix 'man' files.  For instance, to see
    the manual page for the command `ls', execute <tt>man ls</tt>.
    Execute <tt>man man</tt> for more information on finding and viewing
    manual pages.
Josip Rodin's avatar
Josip Rodin committed
40
    <p>New Debian users should note that the 'man' pages of many general
41 42 43 44 45 46 47 48 49 50 51
    system commands are not available until they install these packages:
    <list>
      <item><tt>man-db</tt>, which contains the <tt>man</tt> program
        itself, and other programs for manipulating the manual pages.
      <item><tt>manpages</tt>, which contains the system manual pages.
        (see <ref id="nonenglish">).
    </list>
  <item>GNU-style `info' pages:  User documentation for many commands,
    particularly GNU tools, is available not in `man' pages, but in `info'
    files which can be read by the GNU tool <tt>info</tt>, by running
    <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 is that it is
53 54 55 56 57 58
    a hypertext system.  It does <em>not</em> require the WWW, however;
    <tt>info</tt> can be run from a plain text console.  It was designed
    by Richard Stallman and preceded the WWW.
</list>

<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 63 64

<sect id="onlineresources">Are there any on-line resources for discussing
  Debian?

65 66 67 68
<p>Yes. In fact, the main method of support Debian provides to our users is by
the way of e-mail.  We'll give some details on that, and mention some other
useful resources.  Even more resources are listed at the <url name="Debian
Support webpage" id="http://www.debian.org/support">.
69 70 71 72 73

<sect1>Mailing lists

<p>There are a lot of <url name="Debian-related mailing lists"
id="http://www.debian.org/MailingLists/">.
74

75
<p>On a system with the <package/doc-debian/ package installed there
76 77
is a complete list of mailing lists in
<file>/usr/share/doc/debian/mailing-lists.txt</file>.
78

79 80 81 82 83 84
<p>Debian mailing lists are named following the pattern
debian-<var>list-subject</var>. Examples are debian-announce,
debian-user, debian-news.  To subscribe to any list
debian-<var>list-subject</var>, send mail to
debian-<var>list-subject</var>-request@lists.debian.org with the word
"subscribe" in the Subject: header. Be sure to remember to add
85 86
<em>-request</em> to the e-mail address when using this method to
subscribe or unsubscribe. Otherwise your e-mail will go to the
87 88 89
list itself, which could be embarrassing or annoying, depending on
your point of view.

90
<p>You can
91
subscribe to mailing lists using the <url name="WWW form"
92
id="http://www.debian.org/MailingLists/subscribe">.
93 94
You can also un-subscribe using a <url name="WWW form"
id="http://www.debian.org/MailingLists/unsubscribe">.
95 96 97 98

<p>The list manager's e-mail address is <email/listmaster@lists.debian.org/, in
case you have any trouble.

99
<p>The mailing lists are public forums.  All e-mails sent to the lists are also
100 101 102 103 104
copied to the public archive, for anybody (even non-subscribers) to browse or
search.  Please make sure you never send any confidential or unlicensed
material to the lists. This includes things like e-mail addresses. Of
particular note is the fact that spammers have been known to abuse e-mail
addresses posted to our mailing lists.  See the <url
105
id="http://www.debian.org/MailingLists/#disclaimer" name="Mailing
106 107
Lists Privacy policy"> for more information.

108
<p>Archives of the Debian mailing lists are available via WWW at
109
<url id="http://lists.debian.org/">.
110

111
<sect2 id="mailinglistconduct">What is the code of conduct for the mailing
112 113
  lists?

Josip Rodin's avatar
Josip Rodin committed
114
<p>When using the Debian mailing lists, please follow these rules:
115 116

<list>
117 118
  <item>Do not send spam. See the <url name="Debian mailing list
    advertising policy" id="http://www.debian.org/MailingLists/#ads">.
119 120 121
  <item>Do not flame; it is not polite. The people developing Debian are
    all volunteers, donating their time, energy and money in an attempt to
    bring the Debian project together.
122
  <item>Do not use foul language; besides, some people receive the lists
123 124
    via packet radio, where swearing is illegal.
  <item>Make sure that you are using the proper list. <em/Never/ post your
125
    (un)subscription requests to the mailing list itself.<footnote>Use the
126
    debian-<var>list-subject</var>-REQUEST@lists.debian.org address for that.</footnote>
127 128 129
  <item>See section <ref id="bugreport"> for notes on reporting bugs.
</list>

130 131 132 133 134 135 136 137 138
<sect1>Web forums

<p><url name="debianHELP" id="http://debianhelp.org/"> and <url name="Debian
User Forums" id="http://forums.debian.net/"> are web forums on which you can
submit questions about Debian and have them answered by other users.  (These
are not officially part of the Debian project.)

<sect1>Wiki

139
<p>Solutions to common problems, howtos, guides, tips and other documentation
140 141 142
can be found at the constantly changing <url name="Debian Wiki"
id="http://wiki.debian.org/">.

143 144 145
<sect1>Maintainers

<p>Users can address questions to individual package maintainers using
146
e-mail. To reach a maintainer of a package called xyz, send e-mail to
147 148 149 150 151 152 153 154 155
<em>xyz@packages.debian.org</em>.

<sect1>Usenet newsgroups

<p>Users should post non-Debian-specific questions to one of the Linux
USENET groups, which are named comp.os.linux.* or linux.*.
There are several lists of Linux Usenet newsgroups and other related
resources on the WWW, e.g. on the <url name="Linux Online"
id="http://www.linux.org/docs/usenet.html"> and <url name="LinuxJournal"
156
id="http://www.linuxjournal.com/helpdesk.php"> sites.
157 158 159 160

<sect id="searchtools">Is there a quick way to search for information on
  &debian;?

161
<p>There is a variety of search engines that serve documentation related
Josip Rodin's avatar
Josip Rodin committed
162
to Debian:
163 164

<list>
165 166 167 168 169 170
  <item><url id="http://search.debian.org/" name="Debian WWW search site">.

  <item><url id="http://groups.google.com/" name="Google Groups">: a search
    engine for newsgroups.

    <p>For example, to find out what experiences people have had with
171 172 173
    finding drivers for NVIDIA graphic cards under Debian, try searching
    the phrase <tt>NVIDIA Linux driver</tt>. This will show you all the
    posts that contain these strings, i.e. those where people discussed
174
    these topics. If you add <tt>Debian</tt> to those search strings, you'll
175
    also get the posts specifically related to Debian.
176 177

  <item>Any of the common web spidering engines, such as
178
    <url id="https://duckduckgo.com/" name="DuckDuckGo"> or
179 180 181
    <url id="http://www.google.com/" name="Google">, as long as you use
    the right search terms.

182
    <p>For example, searching on the string "evince" gives a more detailed
183 184 185
    explanation of this package than the brief description field in its
    control file.
</list>
Josip Rodin's avatar
Josip Rodin committed
186 187 188

<sect id="buglogs">Are there logs of known bugs?

189 190 191 192
<p>Reports on unsolved (and closed) issues are publicly available: Debian
promissed to do so by stating "We will not hide problems" in the <url
id="http://www.debian.org/social_contract" name="Debian Social Contract">.

Josip Rodin's avatar
Josip Rodin committed
193 194
<p>The &debian; distribution has a bug tracking system (BTS) which files
details of bugs reported by users and developers. Each bug is given a
195
number, and is kept on file.  Once it has been dealt with, it is marked as such.
Josip Rodin's avatar
Josip Rodin committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210

<p>Copies of this information are available at
<url id="http://www.debian.org/Bugs/">.

<p>A mail server provides access to the bug tracking system database via
e-mail.  In order to get the instructions, send an e-mail to
request@bugs.debian.org with "help" in the body.

<sect id="bugreport">How do I report a bug in Debian?

<p>If you have found a bug in Debian, please read the instructions for
reporting a bug in Debian.  These instructions can be obtained in one of
several ways:
<list>
  <item>From the WWW.  A copy of the instructions is shown at
211
  <url id="http://www.debian.org/Bugs/Reporting">.
212
  <item>On any Debian system with the <package/doc-debian/ package installed.
213
  The instructions are in the file
214
  <file>/usr/share/doc/debian/bug-reporting.txt</file>.
215 216
  <item>By anonymous FTP.  Debian mirror sites contain the instructions in
  the file <tt>doc/bug-reporting.txt</tt>.
Josip Rodin's avatar
Josip Rodin committed
217 218
</list>

219 220 221 222 223
<p>You can use the package <package/reportbug/ that will guide you
through the reporting process and mail the message to the proper
address, with some extra details about your system added
automatically. It will also show you a list of bugs already reported
to the package you are reporting against in case your bug has been
Joost van Baal's avatar
Joost van Baal committed
224
reported previously, so that you can add additional information to the
225
existing bug report.
226 227 228 229

<p>Expect to get an automatic acknowledgement of your bug report. It will
also be automatically given a bug tracking number, entered into the bug
log and forwarded to the debian-bugs-dist mailing list.
Josip Rodin's avatar
Josip Rodin committed
230