Differences between revisions 10 and 12 (spanning 2 versions)
Revision 10 as of 2010-01-25 17:04:10
Size: 5780
Comment: added link to italian translation
Revision 12 as of 2010-06-29 14:35:08
Size: 6305
Editor: HenriLeFoll
Comment: add for contributors
Deletions are marked like this. Additions are marked like this.
Line 18: Line 18:
== For users ==
Line 19: Line 20:
 * 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 26:
At the moment, Debian don't have a ''System Administrtor'' manual. At the moment, Debian don't have a ''System Administrator'' manual.
Line 27: Line 28:
== 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 Reference Manual]]
 * the [[http://www.debian.org/doc/devel-manuals#maint-guide|Debian New Maintainers Guide]]
Line 28: Line 37:
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 41:
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 44:
Line 35: Line 47:
 * http://www.debian.org/doc/manuals/reference/ - Debian Reference Manual
 * http://www.debian.org/releases/stable/installmanual - Installation manual
Line 38: Line 48:

Translation(s): Italiano


Debian is a distribution, it is made of many thousands of (free) software.

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 don'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 documentation

Most of the Debian Documentation is available at http://www.debian.org/doc/ddp

if you are interested, you can read the mailing lists :

See also