Documentazione Debian

Debian mette a disposizione una vastissima documentazione riguardante sia la comunità Debian, sia il sistema operativo Debian sia ogni singola applicazione presente nei repository ufficiali della distribuzione.
Tutti (e non solo i membri della comunità Debian) sono caldamente invitati a leggerla sia per apprendere conoscenze che non si hanno (e di cui non si sospetta nemmeno l'esistenza) sia per cercare risposte che possano risolvere problemi più o meno comuni.
Tutta la documentazione è stata scritta nel corso degli anni e modificata o integrata per seguire i cambiamenti che Debian (e le applicazioni) hanno subìto nel tempo.
Probabilmente tutte le curiosità e i problemi sono già stati vissuti da qualcun altro e tempestivamente documentati nello spirito di collaborazione e libera diffusione della conoscenza che contraddistingue Debian; non resta che leggere!

Tutta la documentazione è completamente libera e modificabile, chiunque può suggerire cambiamenti.

Versioni Compatibili Tutte le versioni supportate di Debian

Introduzione

Questa guida cercherà di raggruppare il maggior numero possibile di link e informazioni riguardanti la documentazione ufficiale presente in Debian. Se qualcosa manca, basta aggiungerla!
Tutti sono liberi di modificare questa pagina per fare in modo che chi si trovasse a leggerla possa ottenere il maggior numero possibile di informazioni su Debian e poter restituire in seguito un po' della conoscenza acquisita alla comunità a cui appartiene (non necessariamente Debian :) )

Il progetto Debian

Contratto sociale

Il contratto sociale che è alla base della comunità Debian e la filosofia che ne muove le scelte e i passi.
Il contratto sociale di Debian
Debian Free Software Guidelines
Queste pagine sono contenute anche nel pacchetto doc-debian .

Debian Project History

Questo manuale tratta la storia, gli scopi e le problematiche del Progetto Debian.
Storia del progetto Debian
Il manuale è contenuto anche nel pacchetto debian-history .

Il sistema operativo Debian

Guida all'installazione

Contiene le informazioni che è necessario leggere per installare Debian o per risolvere problemi legati all'installazione.
Guida all'installazione di Debian
Questa guida è disponibile come pacchetto per diverse architetture. Ad esempio per leggere la guida sull'installazione per amd64:

# apt-get install installation-guide-amd64

altri pacchetti disponibili: installation-guide-ia64, installation-guide-mipsel, installation-guide-sparc, installation-guide-armel, installation-guide-kfreebsd-amd64, installation-guide-powerpc, installation-guide-armhf, installation-guide-kfreebsd-i386, installation-guide-s390, installation-guide-i386, installation-guide-mips, installation-guide-s390x.

Debian release notes

Le note di rilascio di Debian. Vengono scritte quando una nuova versione di Debian è disponibile per il download.
Note di rilascio di Debian

Debian reference guide

La guida di riferimento per chiunque utilizzi Debian.
Debian reference guide
la guida è disponibile nei pacchetti debian-reference (versione inglese) e debian-reference-it (in italiano).

Debian FAQ

Le domande (e le risposte) più ricorrenti che si pone un utente Debian.
Debian FAQ
Le FAQ sono disponibili nei pacchetti debian-faq (versione inglese) e debian-faq-it (versione italiana).

Debian Policy

Questo documento contiene tutto ciò che c'è da sapere sulla distribuzione Debian, il suo utilizzo del filesystem e i requisiti richiesti affinché un pacchetto possa aderire alle regole che Debian si è data.
Debian Policy
La policy di Debian è consultabile anche installando il pacchetto debian-policy.

The Debian Administrator's Handbook

Libro che spiega come amministrare una macchina Debian. Leggere anche qui.

Securing Debian Manual

Il manuale per configurare correttamente Debian dal punto di vista della sicurezza e per utilizzare le applicazioni necessarie a renderlo più sicuro e stabile.
Securing Debian Manual
Il manuale è incluso anche nel pacchetto harden-doc.

Documentazione dei pacchetti

Ciascun pacchetto installa i propri file di documentazione nella directory /usr/share/doc/ o nella directory /usr/share/doc-base/.
In queste directory sono presenti, e divisi in sottodirectory, tutti i file che ciascun pacchetto mette a disposizione per documentare il proprio funzionamento.
Per conoscere quali sono i file che un pacchetto installa sul filesystem, si può ricorrere a dpkg:

$ dpkg -L nomepacchetto

Changelog.gz e Changelog.Debian.gz

È il file in cui sono contenuti tutti i cambiamenti apportati al pacchetto .deb dal suo maintainer o dall'upstreamer. Può essere visualizzato con zless:

$ zless Changelog.gz

Copyright

È il file che contiene informazioni sulla licenza e il copyright del contenuto del pacchetto.

News

È il file in cui il maintainer può inserire le novità introdotte dalle varie versioni del pacchetto.

Readme

Il nome può trovarsi in diverse forme, ma l'unica cosa importante è che questo è un file da leggere assolutamente se si hanno problemi con un determinato pacchetto.
Questi file sono tipicamente scritti dall'upstreamer del programma. Se il maintainer del pacchetto Debian è una persona diversa, è facile che esista anche un file README.Debian o con nome simile.

Pacchetti di documentazione

Ulteriore documentazione può essere contenuta in pacchetti separati che hanno, tipicamente ma non necessariamente, nel nome l'indicazione "-doc". È caso ad esempio di "linux-doc" o di "apt-doc"; ma ne esistono tantissimi altri.
La lista può essere ottenuta a partire dal tag "role:documentation" che accompagna pacchetti di questo tipo:

$ aptitude search ~Gdocumentation

Notare che per effettuare una ricerca basata su tag servirà il pacchetto "debtags".
Lo stesso output si ottiene con:

$ debtags search role::documentation

Le pagine di manuale

Anche note come man pages o manpages o pagine man, sono probabilmente il tipo di documentazione più conosciuto e immediatamente accessibile a chiunque si trovi a che fare con una distribuzione Debian.
La policy di Debian impone che qualunque pacchetto o funzione o libreria utilizzata debba essere accompagnata da una pagina di manuale, per cui è sufficiente un:

$ man apt-get

per aprire, ad esempio, la pagina di manuale di "apt-get".
Le pagine di manuale si trovano nella directory /usr/share/man/ .

I file info

Alcuni pacchetti possono prevedere una documentazione molto corposa oppure includere diversi comandi, ciascuno dei quali con una propria documentazione. In questo caso, accanto alla pagina di manuale, viene installato anche un file "info" che è possibile leggere con il comando "info". Ad esempio il comando:

$ info grep

permetterà di leggere il file "info" associato a grep.
I file info si trovano nella directory /usr/share/info/ .

Il kernel Linux

linux-doc

Questo pacchetto contiene tutte le informazioni sulla struttura del kernel e le specifiche dei driver.
Esistono diversi pacchetti in base alla versione del kernel: linux-doc-3.2, linux-doc-3.9. linux-doc-2.6.

Kernel Hacker's Guide

Contiene, sotto forma di manpage, la documentazione sulle API del kernel Linux. I pacchetti sono: linux-manual-3.2, linux-manual-3.10, linux-manual .

Debian Kernel Handbook

Probabilmente la guida che bisogna assolutamente leggere se si vuol compilare un kernel per Debian, pacchettizzarlo in formato .deb o applicare una patch.
Debian Kernel Handbook
La guida è contenuta anche nel pacchetto debian-kernel-handbook.

Pacchettizzazione

Se si vuol imparare a creare un pacchetto .deb, non si può prescindere dal leggere le seguenti guide.

Guida per il nuovo Maintainer

Scritta per coloro vogliono manutenere un pacchetto Debian e che si apprestano a diventare Debian Maintainers. Spiega i passi necessari per creare un pacchetto Debian in modo che soddisfi tutti gli standard necessari per essere incluso nella distribuzione.
Guida per il nuovo maintainer
La documentazione è presente anche nei pacchetti maint-guide (in inglese) e maint-guide-it (in italiano).

Debian Developer's Reference

Scritta per i Debian Developers ma consultabile, ovviamente, da chiunque. Copre tutti gli aspetti necessari da conoscere per essere un buon DD.
Debian Developer's Reference
la guida è presente nel pacchetto developers-reference ed è disponibile in diverse lingue (inglese, tedesco, francese e giapponese).

Debian Packaging Tutorial

Semplice guida sulla pacchettizzazione in Debian. Il tutorial è corredato da molti link ed esempi e la sua lettura è fortemente consigliata per chi si accinge a creare un pacchetto Debian per la prima volta.
La documentazione si trova in formato PDF nel pacchetto packaging-tutorial ed è disponibile in diverse lingue.
I file PDF possono essere scaricati anche da qui.

Wiki Debian

Il Wiki è un ulteriore strumento messo a disposizione per fornire documentazione, howto, guide e informazioni su tutti gli aspetti che riguardano il progetto Debian, i progetti ad esso collegati e la configurazione del sistema operativo.
Il Wiki di Debian

Pagine web dei pacchetti

Ciascun pacchetto ha una pagina web in cui vengono riportate molte informazioni sulla sua funzione, sul suo stato, sui maintainers, sui bug e tanto altro.
È disponibile anche, se esiste, la homepage del programma se esso è il risultato di progetti esterni a Debian.
Ad esempio questa è la pagina web del pacchetto apt. Per effettuare una ricerca dei pacchetti o nei pacchetti, si può utilizzare http://www.debian.org/distrib/packages .

Documentazione esterna

Ogni pacchetto di Debian può essere il risultato degli sforzi degli sviluppatori per consentire alle applicazioni, non specificatamente pensate per Debian, di poter tranquillamente essere installate su una macchina Debian.
In questo caso è disponibile sempre una documentazione esterna a Debian.
Per poterla leggere, in genere è consigliabile far riferimento alle homepage dei progetti di ciascuna applicazione.

Link utili

http://www.debian.org/doc/