Differences between revisions 10 and 26 (spanning 16 versions)
Revision 10 as of 2010-01-25 17:04:10
Size: 5780
Comment: added link to italian translation
Revision 26 as of 2020-10-08 12:22:55
Size: 7157
Editor: ThiagoPezzo
Comment: Added pt_BR link
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
~-Translation(s): [[it/DebianDocumentation|Italiano]] -~ ~-Translation(s): English - [[fr/DebianDocumentation|Français]] - [[it/DebianDocumentation|Italiano]] - [[pt_BR/DebianDocumentation|Português (Brasil)]]-~
Line 5: Line 5:

Debian is a distribution, it is made of many thousands of (free) software.
Debian is a GNU/Linux distribution, made of thousands of [[FreeSoftware|free software]] packages.
Line 18: Line 17:
== For users ==
Line 19: Line 19:
 * The Installation Guide ~-<<BR>>. [[http://www.debian.org/doc/user-manuals#install]]<<BR>>. (or development version, available at [[http://d-i.alioth.debian.org/manual/]]-~
 * The Release Notes ~-<<BR>>. [[http://www.debian.org/doc/user-manuals#relnotes]]-~
 * The Debian reference ~-<<BR>>. [[http://www.debian.org/doc/user-manuals#quick-reference]]-~
 * The [[http://www.debian.org/releases/stable/installmanual|Installation Guide]] (or the [[http://d-i.alioth.debian.org/manual/|development version]].)
 * The [[http://www.debian.org/releases/stable/releasenotes|Release Notes]]
 * The [[http://www.debian.org/doc/user-manuals#quick-reference|Debian reference]]
Line 25: Line 25:
At the moment, Debian don't have a ''System Administrtor'' manual. At the moment, Debian doesn't have a ''System Administrator'' manual.
Line 27: Line 27:
== For contributors ==
The most famous for Debian contributors are :
 * the [[http://www.debian.org/social_contract|social contract]]
 * the [[http://www.debian.org/social_contract#guidelines|The Debian Free Software Guidelines (DFSG)]]
 * the [[http://www.debian.org/devel/dmup|Debian Machine Usage Policies]] (dmup)
 * the [[DebianPolicy| Debian policy]]
 * the [[http://www.debian.org/doc/devel-manuals#devref|Debian Developer's Reference Manual]]
 * the [[http://www.debian.org/doc/devel-manuals#maint-guide|Debian New Maintainers Guide]]
Line 28: Line 36:
Most documentation for Debian-developer (and package maintainer) are available from [[http://www.debian.org/devel/|www.debian.org/devel/]]
Most documentation for Debian-developer (and package maintainer) are available from [[http://www.debian.org/devel/|www.debian.org/devel/]].
Line 32: Line 39:
The Debian Project has a [[http://www.debian.org/devel/constitution|constitution]] and an [[http://www.debian.org/intro/organization|organizational structure]]
Line 33: Line 42:
Line 35: Line 45:
 * http://www.debian.org/doc/manuals/reference/ - Debian Reference Manual
 * http://www.debian.org/releases/stable/installmanual - Installation manual
Line 38: Line 46:
Line 44: Line 51:
 * http://lists.debian.org/users.html - User mailinglists  * http://lists.debian.org/users.html - User mailing lists
Line 52: Line 59:
 * http://bits.debian.org - Debian Blog
Line 53: Line 61:
 * http://planeta.debian.net - Planeta Debian, a blog aggregator in spanish  * http://planet.debian.org/es/ - Planeta Debian, a blog aggregator in spanish
Line 55: Line 63:
 * http://snapshot.debian.net - Debian packages archived daily since 2002/06/04
 * http://times.debian.net - Debian Times
 * http://www.
backports.org - Backports for the stable distribution
 * http://snapshot.debian.org - Debian packages archived daily since 2002/06/04
 * http://backports.debian.org - Backports for the stable distribution
Line 64: Line 71:
Debian Related Wikis Debian-related wikis:
Line 66: Line 73:
 * http://wiki.debconf.org - The DebConf Wiki  * http://wiki.debconf.org - The pre-2019 !DebConf (Debian Conference) Wiki. For content since 2019, see DebConf.
Line 68: Line 75:

Line 108: Line 113:
= Contribute to documentation = = Contribute to the documentation =
Line 110: Line 115:
Most of the Debian Documentation is available at http://www.debian.org/doc/ddp  {i} This is free software, __you can contribute improvements to the existing documentation__ ~-<<BR>>''(i.e. you don't have to write your own !HowTo!)''-~.
Line 112: Line 117:
if you are interested, you can read the mailing lists :
 * http://lists.debian.org/debian-www/recent
 * http://lists.debian.org/debian-doc/recent
 
 .
 
 {i} This is free software, __you can contribute improvements to the documentation__ ~-<<BR>>''(i.e you don't have to write your own Howto !)''-~.
If you are interested in contributing to documentation, please check the following resources first, to get some feel for how other people contribute:
 * http://www.debian.org/doc/ddp (most of the Debian Documentation is available here)
 * https://wiki.debian.org/ (Join this wiki and add new contents/translations)
 * http://lists.debian.org/debian-www/recent ([[DebianMailingLists|mailing-list]])
 * http://lists.debian.org/debian-doc/recent ([[DebianMailingLists|mailing-list]])

 {i} Some documentation contents are generated from the corresponding Debian package. If so, you may wish to interact with the package maintainer. Sometimes, filing a bug report for that package using the [[BTS|Debian Bug Tracking System (BTS)]] is a good idea.

If you are interested in participating in the debian-doc group, please see the [[Teams/DDP|team page on the Wiki]]

Translation(s): English - Français - Italiano - Português (Brasil)


Debian is a GNU/Linux distribution, made of thousands of free software packages.

This page is about official Debian Documentation.

There are other Debian Resources

Debian Documentation

For users

The most famous for Debian users are :

Many other Debian Documentation are available at www.debian.org/doc

At the moment, Debian doesn't have a System Administrator manual.

For contributors

The most famous for Debian contributors are :

Most documentation for Debian-developer (and package maintainer) are available from www.debian.org/devel/.

Official Websites of the Debian Project

The Debian Project has a constitution and an organizational structure

On Debian.org the official Debian site, you can find a section dedicated to documentation.

Forum

Advocacy, developers, inside information

Wiki

Debian-related wikis:

Books

Many free and non-free books are listed on Debian website.

Extra books could be listed below.

Instant Messaging

There are official Debian IRC channels.

You can also use Jabber

Program documentation

Each software provides has its own documentation.

Under Debian (Unix), a program's documentation typically consist of (one or more of):

  • A manpage (type man followed by a command name).

  • A README file, provided by upstream. (A text file located at /usr/share/doc/pkgname/README)

  • A README.Debian file, provided by the Debian package maintainer. (A text file located at /usr/share/doc/pkgname/README.Debian)

  • Programs with a graphical user interface (Gnome, KDE...) usually comes with help page (accessible through Menu > Help).

  • Some program provide their documentation as html, or info page.

Package Description

In the package description you can find some useful information, like a short description of the package, a link to the original website, a list of files contained, and more. The package description can be accessed at the url http://packages.debian.org/<package-name>. Or, try "aptitude show $PKG" (you may need to "apt-get update && apt-get aptitude && aptitude update" first).

One of the best places to look for help for a single package or application is to read stuff in /usr/share/doc/<package-name> (especially README.Debian). This is documentation written by developers or package maintainers. It is quite concise, but usually mentions most common problems and solutions, and new features and fixed bugs.

Bug tracking system

Many problems' solutions can be found as bug report responses. A search engine for bug reports is found on http://bugs.debian.org. Remember that if you want to search in archived (quite old) bugs you must chose "archived bugs" option. If you want to look at bugs of a specific package use http://bugs.debian.org/<package-name>.

Contribute to the documentation

  • {i} This is free software, you can contribute improvements to the existing documentation
    (i.e. you don't have to write your own HowTo!)
    .

If you are interested in contributing to documentation, please check the following resources first, to get some feel for how other people contribute:

If you are interested in participating in the debian-doc group, please see the team page on the Wiki

See also