Abans de poder entendre què passa realment quan hi ha un problema, heu de conèixer el rol teòric que exerceix cada programa implicat en el problema. Per fer-ho, el millor reflex és consultar la seva documentació; però com que la documentació pot ser molta i poden estar escampada arreu, hauríeu de saber tots els llocs on es pot trobar.
Les pàgines de manual, tot i que relativament d'estil breu, contenen molta informació essencial. Ràpidament passarem per sobre de l'ordre per a veure'ls, proporcionada pel paquet
man-db. Escriviu simplement
man pàgina-de-manual — la pàgina manual sol tenir el mateix nom que l'ordre la documentació de la qual es busca. Per exemple, per aprendre sobre les possibles opcions per a l'ordre
cp, hauríeu d'escriure l'ordre
man cp a l'indicador de la «shell» (vegeu la barra lateral
TORNAR A LES BASES La «shell», l'intèrpret de la línia d'ordres).
Les pàgines de manual no només documenten ordres i programes accessibles des de la línia d'ordres, sinó també fitxers de configuració, crides al sistema, funcions de biblioteca, etc. De vegades els noms poden coincidir. Per exemple, l'ordre read de l'intèrpret de comandes té el mateix nom que la crida al sistemaread. Per això les pàgines de manual s'organitzen en seccions numerades:
- 1
ordres que es poden executar des de la línia d'ordres;
- 2
crides al sistema (funcions proporcionades pel nucli);
- 3
funcions de biblioteca (proporcionades per biblioteques del sistema);
- 4
dispositius (en sistemes de tipus Unix aquests són fitxers especials, normalment situats al directori /dev/);
- 5
fitxers de configuració (formats i convencions);
- 6
jocs;
- 7
conjunts de “macros” i estàndards;
- 8
ordres d'administració del sistema;
- 9
rutines del nucli.
És possible especificar la secció de la pàgina de manual que esteu cercant: per veure la documentació per a la crida al sistema read escriureu man 2 read. Quan no s'especifica explícitament cap secció, es mostrarà la primera secció que tingui una pàgina manual amb el nom sol·licitat. Per tant, man shadow mostrarà shadow(5) perquè no hi ha pàgines de manual de shadow en les seccions 1 a 4.
Per descomptat, si no coneixeu els noms de les ordres, el manual no us servirà de molt. Aquest és el propòsit de l'ordre apropos, que us ajuda a realitzar una cerca a les pàgines de manual, o més específicament en les seves descripcions curtes. Cada pàgina de manual comença normalment amb un resum d'una línia. apropos retorna una llista de pàgines de manual el resum de les quals menciona les paraules clau sol·licitades. Si les trieu bé, trobareu el nom de l'ordre que necessiteu.
Exemple 7.1. Trobar cp amb apropos
$ apropos "copy file"
cp (1) - copy files and directories
cp (1posix) - copy files
cpio (1) - copy files to and from archives
exec (1posix) - execute commands and open, close, or copy file descriptors
install (1) - copy files and set attributes
ntfscp (8) - copy file to an NTFS volume.
L'ordre
man no és l'únic mitjà de consultar les pàgines de manual, ja que els programes
khelpcenter i
konqueror (de KDE) i
yelp (sota GNOME) també ofereixen aquesta possibilitat. També hi ha una interfície web, proporcionada pel paquet
man2html, que permet veure pàgines manuals en un navegador web. En un ordinador on aquest paquet està instal·lat, utilitzeu aquest URL després de seguir les instruccions a
/usr/share/doc/man2html/README. Debian:
Aquesta utilitat requereix un servidor web. Per això hauríeu de triar instal·lar aquest paquet en un dels vostres servidors: tots els usuaris de la xarxa local podrien beneficiar-se d'aquest servei (incloent màquines no Linux), i això us permetrà no haver de configurar un servidor HTTP a cada estació de treball. Si el vostre servidor també és accessible des d'altres xarxes, pot ser desitjable restringir l'accés a aquest servei només als usuaris de la xarxa local.
Finalment, però no menys important, podeu veure totes les pàgines de manual disponibles a Debian (fins i tot les que no estan instal·lades a la vostra màquina) al servei
manpages.debian.org. Ofereix cada pàgina de manual en múltiples versions, una per a cada versió de Debian.
El projecte GNU ha escrit manuals per a la majoria dels seus programes en el format info; per això moltes pàgines manuals es refereixen a la documentació info corresponent. Aquest format ofereix alguns avantatges, però el programa per defecte per veure aquests documents (que s'anomena info) també és una mica més complex. Us convindria utilitzar pinfo en el seu lloc (el podeu trobar al paquet pinfo).
La documentació info té una estructura jeràrquica, i si invoqueu pinfo sense paràmetres, mostrarà una llista dels nodes disponibles al primer nivell. Normalment, els nodes porten el nom de les ordres corresponents.
Amb
pinfo, la navegació entre aquests nodes és fàcil d'aconseguir amb les tecles de fletxa. Alternativament, també podeu utilitzar un navegador gràfic, que és molt més fàcil d'usar. Una vegada més, el
konqueror i el
yelp funcionen; el paquet
info2www també proporciona una interfície web.
Tingueu en compte que el sistema info no és adequat per a la traducció, a diferència del sistema de pàgines man. Els documents info estan, per tant, gairebé sempre en anglès. No obstant això, quan demaneu al programa pinfo que mostri una pàgina info no existent, acabarà anant a la pàgina man amb el mateix nom (si existeix) que, aquesta, sí que podria estar traduïda.
7.1.3. Documentació específica
Cada paquet inclou la seva pròpia documentació. Fins i tot els programes menys ben documentats generalment tenen un fitxer README que conté alguna informació interessant i/o important. Aquesta documentació està instal·lada al directori /usr/share/doc/paquet/ (on paquet representa el nom del paquet). Si la documentació és particularment gran, pot no ser inclosa en el paquet principal del programa, sinó que pot estar separada en un paquet dedicat que normalment s'anomena paquet-doc. El paquet principal generalment recomana el paquet de documentació perquè el pugueu trobar fàcilment.
El directori
/usr/share/doc/paquet/ també conté alguns fitxers proporcionats per Debian que completen la documentació especificant les particularitats o millores del paquet en comparació amb una instal·lació tradicional del programari. El fitxer
README.Debian també indica totes les adaptacions fetes per a complir amb la Normativa de Debian. El fitxer
changelog.Debian.gz permet a l'usuari seguir les modificacions fetes al paquet amb el temps: és molt útil intentar entendre què ha canviat entre dues versions instal·lades que no tenen el mateix comportament. Finalment, a vegades hi ha un fitxer
NEWS.Debian.gz que documenta els principals canvis del programa que poden afectar directament l'administrador (vegeu
Secció 6.7.2, «Gestió de problemes després d'una actualització»).
In most cases, free software programs have websites that are used to distribute it and to bring together the community of its developers and users. These sites are frequently loaded with relevant information in various forms: official documentation,
FAQ (Frequently Asked Questions), mailing list archives, etc. Problems that you may encounter have often already been the subject of many questions; the FAQ or mailing list archives may have a solution for it. A good mastery of search engines will prove immensely valuable to find relevant pages quickly (by restricting the search to the Internet domain or sub-domain dedicated to the program). If the search returns too many pages or if the results do not match what you seek, you can add the keyword
debian to limit results and target relevant information.
Si no sabeu l'adreça del lloc web del programa, hi ha diversos mitjans per obtenir-la. Primer, comproveu si hi ha un camp
Homepage a la metainformació del paquet (
apt show paquet). Alternativament, la descripció del paquet pot contenir un enllaç al lloc web oficial del programa. Si no s'indica cap URL, consulteu
/usr/share/doc/paquet/copyright. El mantenidor de Debian generalment indica en aquest fitxer on va obtenir el codi font del programa, i és probable que sigui el lloc web que heu de trobar. Si en aquesta etapa la vostra cerca encara no és fructífera, consulteu un directori de programari lliure, com el Directori de Programari Lliure de FSF, o cerqueu directament amb un motor de cerca, com ara Google, DuckDuckGo, Yahoo, etc.
You might also want to check the Debian wiki, a collaborative website where anybody, even new visitors, can make suggestions directly from their browsers. It is used equally by developers who design and specify their projects, and by users who share their knowledge by writing documents collaboratively.
Un HOWTO és un document que descriu, en termes concrets i pas a pas, com (de l'anglès «how to...”) arribar a un objectiu predefinit. Els objectius coberts són relativament variats, però sovint tenen naturalesa tècnica: per exemple, la configuració de l'emmascarament IP, la configuració de RAID via programari, la instal·lació d'un servidor Samba, etc. Aquests documents sovint intenten cobrir tots els possibles problemes que poden ocórrer durant l'aplicació d'una determinada tecnologia.
Many such tutorials are managed by the Linux Documentation Project (
LDP), whose website hosts all of these documents:
Debian també proporciona tutorials per als seus usuaris:
All these documents should be taken with a grain of salt. They are often several years old; the information they contain is sometimes obsolete. This phenomenon is even more frequent for their translations, since updates are neither systematic nor instant after the publication of a new version of the original documents. Further many tutorials nowadays are provided by bloggers, sharing their individual solution with the interested reader. They often lack important information, i.e. the reason why some configuration has been chosen over another, or why some option has been enabled or disabled. Because blogging and creating personal websites made it so easy to share, many of these often short tutorials exist, but only a few are actively maintained and well-kept. This can make it hard to find the "right" one for you. This is all part of the joys of working in a volunteer environment and without constraints…
