Differences between revisions 6 and 10 (spanning 4 versions)
⇤ ← Revision 6 as of 2009-03-16 03:35:47 →
Size: 2494
Editor: anonymous
Comment: converted to 1.6 markup
← Revision 10 as of 2010-01-25 17:04:10 → ⇥
Size: 5780
Editor: FrancescaCiceri
Comment: added link to italian translation
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
~-Translation(s): [[it/DebianDocumentation|Italiano]] -~
----
Line 3: Line 5:
Debian is a distribution, it is made of many thousands of (free) software :
 1. Each software provides has its own documentation ([[#progs-docs|more below]]).
 1. Debian has some ''own'' documentation too ([[#debian-docs|more below]]).
Line 7: Line 6:
 1. At the bottom of the page, there are some pointers if you want to '''contribute improvement''' to documentation ([[#contribute|more below]]). Debian is a distribution, it is made of many thousands of (free) software.
 
 . <<TableOfContents(3)>>
Line 9: Line 10:
<<BR>>
<<BR>>
<<BR>>		 This page is about official Debian Documentation.
Line 13: Line 12:
<<Anchor(progs-docs)>>
== Programs documentations ==
Under Debian (Unix), a program's documentation typically consist of (one or more of):
 * A [[ManPage|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 ''[[WikiPedia:Info_(Unix)|info]]'' page.		 There are other [[DebianResources|Debian Resources]]
Line 22: Line 14:
<<Anchor(debian-docs)>>
== Debian Documentation ==
<<Anchor(debian-documentation)>>
= Debian Documentation =
Line 32: Line 25:
At the moment, Debian don't have a ''System Administrtor'' manual. However, there are some books about Debian, see: [[http://www.debian.org/doc/books|www.debian.org/doc/books]]. At the moment, Debian don't have a ''System Administrtor'' manual.
Line 38: Line 31:
== Official Websites of the Debian Project ==
On [[http://www.debian.org|Debian.org]] the official Debian site, you can find a section dedicated to documentation.
## By alphabetical order
 * http://www.debian.org/doc - Debian documentation home
 * http://www.debian.org/doc/manuals/reference/ - Debian Reference Manual
 * http://www.debian.org/releases/stable/installmanual - Installation manual
 * http://www.debian.org/support - support home


<<Anchor(forums)>>
=== Forum ===
## By alphabetical order
 * [[DebianMailingLists|Mailinglists]] are the main way of Debian communication
 * http://lists.debian.org/users.html - User mailinglists
 * http://forums.debian.net - Debian.net Forums
 
=== Advocacy, developers, inside information ===
## By alphabetical order
 * UnofficialRepositories - a list of non official package repositories. They can be very useful.
 * http://alioth.debian.org - Project hosting for Open Source developers
 * http://mentors.debian.net - Public package repository
 * http://planet.debian.org - Planet Debian, aggregating lots of Developer blogs
 * http://planeta.debian.net - Planeta Debian, a blog aggregator in spanish
 * http://release.debian.org - Debian Release Management pages
 * 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://www.debian.org/News - Official news
 * http://db.debian.org - Debian Developer Database
 * http://udd.debian.org/ - Ultimate Debian Database
 
<<Anchor(wikis)>>
=== Wiki ===
Debian Related Wikis
## By alphabetical order
 * http://wiki.debconf.org - The DebConf Wiki
 * http://wiki.debian.org - The Official Debian Wiki



<<Anchor(books)>>
== Books ==
Many free and non-free books are listed on Debian website.
 * http://www.debian.org/doc/books - Debian Book Library
Extra books could be listed below.
## DO NOT DUPLICATE entries from debian.org/doc/books !

<<Anchor(irc)>>

== Instant Messaging ==
There are official Debian [[IRC]] channels.

You can also use [[Jabber]]


<<Anchor(progs-docs)>>
= 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|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 ''[[WikiPedia:Info_(Unix)|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>}}}.
Line 39: Line 108:
== Contribute to documentation == = Contribute to documentation =
Line 43: Line 112:
if you are interested, you can read the mailing lists :
 * http://lists.debian.org/debian-www/recent
 * http://lists.debian.org/debian-doc/recent
 
 .
 
Line 48: Line 123:

= See also =

 * [[DebianResources]]

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

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 Administrtor manual.

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

Official Websites of the Debian Project

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