Differences between revisions 4 and 6 (spanning 2 versions)
Revision 4 as of 2008-11-25 22:32:39
Size: 2481
Editor: FranklinPiat
Comment: Rewrite page (almost completly).
Revision 6 as of 2009-03-16 03:35:47
Size: 2494
Editor: anonymous
Comment: converted to 1.6 markup
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]).
 1. Debian has some ''own'' documentation too ([#debian-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]]).
 1. Debian has some ''own'' documentation too ([[#debian-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]]).
Line 9: Line 9:
[[BR]]
[[BR]]
[[BR]]
<<BR>>
<<BR>>
<<BR>>
Line 13: Line 13:
[[Anchor(progs-docs)]] <<Anchor(progs-docs)>>
Line 16: Line 16:
 * A [:ManPage:manpage] (type {{{man}}} followed by a command name).  * A [[ManPage|manpage]] (type {{{man}}} followed by a command name).
Line 20: Line 20:
 * Some program provide their documentation as html, or ''[wiki:WikiPedia:Info_(Unix) info]'' page.  * Some program provide their documentation as html, or ''[[WikiPedia:Info_(Unix)|info]]'' page.
Line 22: Line 22:
[[Anchor(debian-docs)]] <<Anchor(debian-docs)>>
Line 26: Line 26:
 * 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 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]]-~
Line 30: Line 30:
Many other Debian Documentation are available at [http://www.debian.org/doc www.debian.org/doc] Many other Debian Documentation are available at [[http://www.debian.org/doc|www.debian.org/doc]]
Line 32: Line 32:
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. However, there are some books about Debian, see: [[http://www.debian.org/doc/books|www.debian.org/doc/books]].
Line 35: Line 35:
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 38: Line 38:
[[Anchor(contribute)]] <<Anchor(contribute)>>
Line 43: Line 43:
 {i} This is free software, __you can contribute improvements to the documentation__ ~-[[BR]]''(i.e you don't have to write your own Howto !)''-~.  {i} This is free software, __you can contribute improvements to the documentation__ ~-<<BR>>''(i.e you don't have to write your own Howto !)''-~.

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

  1. Each software provides has its own documentation (more below).

  2. Debian has some own documentation too (more below).

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




Programs documentations

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.

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. However, there are some books about Debian, see: www.debian.org/doc/books.

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

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