Differences between revisions 4 and 5
⇤ ← Revision 4 as of 2008-11-25 22:32:39 →
Size: 2481
Editor: FranklinPiat
Comment: Rewrite page (almost completly).
← Revision 5 as of 2008-11-26 20:35:53 → ⇥
Size: 2476
Editor: FranklinPiat
Comment: minor rephrase
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
Debian is a distribution, made of many thousands (free) software :
 1. Most softwares provided in Debian comes with their own documentation ([#progs-docs more below]).		 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]).
Line 7: Line 7:
 1. At the bottom of the page, there are some pointers if you want to contribute improvement to documentation ([#contribute more below]).  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 :

  1. Each software provides has its own documentation ([#progs-docs more below]).

  2. Debian has some own documentation too ([#debian-docs more below]).

  3. At the bottom of the page, there are some pointers if you want to contribute improvement to documentation ([#contribute more below]).

?BR ?BR ?BR

?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 [wiki:Info_(Unix) info] page.

?Anchor(debian-docs)

Debian Documentation

The most famous for Debian users are :

Many other Debian Documentation are available at [http://www.debian.org/doc www.debian.org/doc]

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].

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

?Anchor(contribute)

Contribute to documentation

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 documentation ~-?BR(i.e you don't have to write your own Howto !).