Differences between revisions 1 and 6 (spanning 5 versions)
Revision 1 as of 2005-01-11 18:42:24
Size: 97
Editor: anonymous
Comment:
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 1: Line 1:
## Auto-converted by kwiki2moinmoin v2005-10-07
See:
 * http://znik.wbc.lublin.pl/dwww/menu.html
#language en

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

 1. 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 ''[[WikiPedia:Info_(Unix)|info]]'' page.

<<Anchor(debian-docs)>>
== Debian Documentation ==

The most famous for Debian users are :
 * 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]]-~

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 !)''-~.

## SIMILAR PAGES (ideas to attract more contributors ??)
## - http://www.ubuntulinux.org/community/participate#documentation
## - http://www.gentoo.org/doc/en/index.xml

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 !)
    .