Rights: Copyright ©  2006-2012 Debian Live Project;
License: Aquest programa és un programari lliure: es pot redistribuir i/o modificar sota els termes de la Llicència Pública General de la GNU com és publicada per la Free Software Foundation, ja sigui la versió 3 de la Llicència, o (si ho preferiu) qualsevol versió posterior.

Aquest programa es distribueix amb l'esperança que sigui útil, però sense cap garantia, fins i tot sense la garantia implícita de COMERCIALITZACIÓ o ADEQUACIÓ PER A PROPÒSITS DETERMINATS. Vegeu la Llicència General Pública de la GNU per a més detalls.

Haurieu de rebre una còpia de la Llicència Pública General de la GNU amb aquest programa. Si no és així, consulteu http://www.gnu.org/licenses/.

El text complet de la Llicència Pública General de la GNU es pot trobar a /usr/share/common-licenses/GPL-3.


Manual Debian Live

Sobre aquest manual

1. Sobre aquest manual

1.1 Per als impacients
1.2 Termes
1.3 Autors
1.4 Contribuir en aquest document
1.4.1 Aplicar canvis
1.4.2 Traducció

2. Sobre el Projecte Debian Live

2.1 Motivació
2.1.1 Què passa amb els sistemes vius actuals
2.1.2 Per què crear el nostre pròpi sistema viu?
2.2 Filosofia
2.2.1 Només paquets Debian sense modificacions de la secció "main"
2.2.2 Paquets del sistema viu sense cap configuració
2.3 Contacte

Usuari

3. Instaŀlació

3.1 Requeriments
3.2 Instaŀlació de live-build
3.2.1 Des del repositori de Debian
3.2.2 À partir del codi font
3.2.3 A partir d'instantànies
3.3 Instal.lació de live-boot i live-config
3.3.1 Des del repositori de Debian
3.3.2 À partir del codi font
3.3.3 A partir d'instantànies

4. Conceptes bàsics

4.1 Què és un sistema viu?
4.2 Primers passos: construcció d'una imatge ISO híbrida
4.3 Usar una imatge ISO híbrida en viu
4.3.1 Gravar una imatge ISO en un medi físic
4.3.2 Còpiar una imatge ISO híbrida en un dispositiu USB
4.3.3 Arrencar els medis en viu
4.4 Utilitzar una màquina virtual per fer proves
4.4.1 Provar una imatge ISO amb QEMU
4.4.2 Provar una imatge ISO amb virtualbox-ose
4.5 Construir una imatge HDD
4.6 Utilitzar una imatge HDD
4.6.1 Provar una imatge HDD amb Qemu
4.6.2 Utilitzar l'espai lliure en una memòria USB
4.7 Construir una imatge netboot
4.7.1 Servidor DHCP
4.7.2 Servidor TFTP
4.7.3 Servidor NFS
4.7.4 Com provar l'arrencada en xarxa
4.7.5 Qemu
4.7.6 VMWare Player

5. Descripció general de les eines

5.1 El paquet live-build
5.1.1 L'ordre lb config
5.1.2 L'ordre lb build
5.1.3 L'ordre lb clean
5.2 El paquet live-boot
5.3 El paquet live-config

6. Gestió d'una configuració

6.1 Utilitzar auto per gestionar canvis de configuració
6.2 Scripts auto d'exemple

7. Personalització dels continguts

7.1 Configuració durant la construcció vs. durant l'arrencada
7.2 Etapes de la construcció
7.3 Suplementar lb config amb fitxers
7.4 Tasques de personalització

8. Personalització de la instaŀlació de paquets

8.1 Fonts dels paquets
8.1.1 Distribució, zones d'arxiu i mode
8.1.2 Miralls de distribució
8.1.3 Miralls de distribució utilitzats en temps de construcció
8.1.4 Miralls de distribució utilitzats en temps d'execució
8.1.5 Repositoris addicionals
8.2 Selecció dels paquets a instaŀlar
8.2.1 Llistes de paquets
8.2.2 Llistes predefinides de paquets
8.2.3 Llistes locals de paquets
8.2.4 Llistes locals de paquets per l'etapa binary
8.2.5 Ampliació d'una llista mitjançant includes
8.2.6 Ús de condicionals dins de les llistes de paquets
8.2.7 Tasques
8.2.8 Tasques d'escriptori i llenguatge
8.3 Instaŀlació de paquets modificats o de tercers
8.3.1 Fer servir packages.chroot per instaŀar paquets personalitzats
8.3.2 Fer servir un repositori APT per instaŀlar paquets personalitzats
8.3.3 Paquets personalitzats i APT
8.4 Configurar APT en temps de construcció
8.4.1 Seleccionar apt o aptitude
8.4.2 L'ús d'un proxy amb APT
8.4.3 Afinar APT per estalviar espai
8.4.4 Passar opcions per a apt o aptitude
8.4.5 APT pinning

9. Personalització dels continguts

9.1 Includes
9.1.1 Live/chroot local includes
9.1.2 Binary local includes
9.1.3 Binary includes
9.2 Scripts ganxo (Hooks)
9.2.1 Live/chroot local hooks
9.2.2 Scripts ganxo durant l'arrencada
9.2.3 Binary local hooks
9.3 Preconfiguració de les preguntes de Debconf

10. Customizing run time behaviours

10.1 Customizing the live user
10.2 Customizing locale and language
10.3 Persistence
10.3.1 The live-persistence.conf file
10.3.2 Using more than one persistence store

11. Customizing the binary image

11.1 Bootloader
11.2 ISO metadata

12. Customizing Debian Installer

12.1 Types of Debian Installer
12.2 Customizing Debian Installer by preseeding
12.3 Customizing Debian Installer content

Projecte

13. Reporting bugs

13.1 Known issues
13.2 Rebuild from scratch
13.3 Use up-to-date packages
13.4 Collect information
13.5 Isolate the failing case if possible
13.6 Use the correct package to report the bug against
13.6.1 At build time whilst bootstrapping
13.6.2 At build time whilst installing packages
13.6.3 At boot time
13.6.4 At run time
13.7 Do the research
13.8 Where to report bugs

14. Coding Style

14.1 Compatibility
14.2 Indenting
14.3 Wrapping
14.4 Variables
14.5 Miscellaneous

15. Procedures

15.1 Udeb Uploads
15.2 Major Releases
15.3 Point Releases
15.3.1 Last Point Release of a Debian Release
15.3.2 Point release announcement template

Exemples

16. Examples

16.1 Using the examples
16.2 Tutorial 1: A standard image
16.3 Tutorial 2: A web browser utility
16.4 Tutorial 3: A personalized image
16.4.1 First revision
16.4.2 Second revision
16.5 A VNC Kiosk Client
16.6 A base image for a 128M USB key
16.7 A localized KDE desktop and installer

Apèndix

17. Style guide

17.1 Guidelines for authors
17.1.1 Linguistic features
17.1.2 Procedures
17.2 Guidelines for translators
17.2.1 Translation hints

Manual Debian Live

Sobre aquest manual

1. Sobre aquest manual

Aquest manual serveix com a punt d'accés únic a tota la documentació relacionada amb el projecte Debian Live i en particular s'aplica al programari produït pel projecte per la versió Debian 7.0 "wheezy". Una versió actualitzada es pot trobar sempre a ‹http://live.debian.net/

Si bé live-manual es centra principalment en ajudar a construir un sistema viu i no en temes dels usuaris finals, un usuari final pot trobar informació útil en aquestes seccions: Conceptes bàsics abasta la preparació d'imatges per ser arrencadas des dels dispositius o la xarxa, i Personalització dels comportaments en temps d'execució descriu algunes de les opcions que es poden especificar durant l'arrencada del sistema, com ara la selecció de la disposició del teclat, la configuració regional i l'us de la persistència.

Algunes de les ordres esmentades en el text s'han d'executar amb privilegis de superusuari que es poden obtenir esdevenint l'usuari root amb su o mitjançant l'ús de sudo. Per distingir entre les ordres que poden ser executades per un usuari sense privilegis i aquelles que requereixen privilegis de root, s'anteposa $ o # respectivament. Aquest símbol no és part de l'ordre.

1.1 Per als impacients

Si bé creiem que tot el que hi ha en aquest manual és important si més no per alguns dels nostres usuaris, ens adonem que hi ha una gran quantitat de material per cobrir i que és possible que es vulgui experimentar l'èxit amb el programari aviat, abans d'aprofundir en els detalls. Per tant, us recomanem llegir en el següent ordre.

En primer lloc, llegiu aquest capítol, Sobre aquest manual, des del principi i acabant amb els Termes. A continuació, saltar als tres tutorials abans dels Exemples secció dissenyada per ensenyar la creació de la imatge i alguns aspectes bàsics de la personalització. Llegiu en primer lloc Usant els exemples seguit per Tutorial 1: Una imatge estàndard, Tutorial 2: Una utilitat de navegador d'Internet i finalment, Tutorial 3: Una image personalitzada. Al final d'aquests tutorials, tindreu una idea del que es pot fer amb Debian Live.

Us animem a tornar i a fer un estudi del manual en profunditat, la propera lectura pot ser Conceptes bàsics, fregant o saltant Construcció d'una imatge netboot, i acabant per la lectura de la Visió de conjunt de la personalització i els capítols que la segueixen. En aquest punt, esperem que estigueu ben emocionats pel que es pot fer amb Debian Live i motivats per llegir la resta del manual, de principi a fi.

1.2 Termes
  • Sistema viu: Un sistema operatiu que pot arrencar sense necessitat d'instaŀlació en un disc dur. Els sistemes vius no alteren el sistema operatiu local(s) o els fitxer(s) ja instaŀlats al disc dur de l'ordinador a menys que així se'ls ho indiqui. Els sistemes vius normalment s'inician des de dispositius, com ara CD, DVD o memòries USB. Alguns també poden arrencar des de la xarxa.
  • Debian Live: Un subprojecte de Debian, que manté els paquets live-boot, live-build, live-config i live-manual.
  • Sistema Debian Live: Un sistema viu que utilitza el programari del sistema operatiu Debian que es pot arrencar des d'un CD, DVD, memòries USB, o la xarxa (a través d'imatges netboot) i a través d'Internet (a través de paràmetre d'arrencada fetch=URL).
  • Sistema amfitrió: L'entorn utilitzat per crear el sistema en viu.
  • Sistema objectiu: L'entorn que s'utilitza per executar el sistema en viu.
  • live-boot: Una coŀlecció de scripts per arrencar els sistemes vius. live-boot abans havia estat part de live-initramfs.
  • live-build: Una coŀlecció de scripts utilitzats per construir sistemes personalitzats de Debian Live. live-build era anteriorment conegut com live-helper i fins i tot abans conegut com live-package.
  • live-config: Una coŀlecció de scripts utilitzats per configurar un sistema en viu durant el procés d'arrencada. live-config abans va ser part de live-initramfs.
  • live-manual: Aquest document és mantingut en un paquet anomenat live-manual
  • Instaŀlador de Debian (d-i): El sistema oficial d'instaŀlació de la distribució Debian.
  • Paràmeters d'arrencada: Els paràmetres que es poden introduir a l'indicador del carregador d'arrencada per influir en el nucli o live-config
  • chroot: El programa chroot, chroot(8), ens permet executar diferentes instàncies d'un entorn GNU/Linux a la vegada en un sol sistema sense reiniciar.
  • Imatge binaria: Un fitxer que conté el sistema en viu, com ara binary.iso o binary.img.
  • Distribució objectiu: La distribució en què es basa el sistema en viu. Que pot diferir de la distribució del sistema amfitrió.
  • stable/testing/unstable: La distribució stable conté l'última distribució de Debian llençada oficialment. La distribució testing és l'àrea d'assaig per a la pròxima versió stable. Un avantatge important de l'ús d'aquesta distribució és que té versions més recents del programari en relació amb l'edició stable. La distribució unstable és on es produeix el desenvolupament actiu de Debian. En general, aquesta distribució és utilitzada pels desenvolupadors i els que els agrada viure en risc. Al llarg del manual, es tendeix a utilitzar els seus noms en clau, com ara wheezy or sid, ja que és el que fan servir les pròpies eines.
  • 1.3 Autors

    Llistat d'autors (en ordre alfabètic)

  • Ben Armstrong
  • Brendan Sleight
  • Chris Lamb
  • Daniel Baumann
  • Franklin Piat
  • Jonas Stein
  • Kai Hendry
  • Marco Amadori
  • Mathieu Geli
  • Matthias Kirschner
  • Richard Nelson
  • Trent W. Buck
  • 1.4 Contribuir en aquest document

    Aquest manual està pensat com un projecte comunitari i totes les propostes per millorar-lo i les contribucions són molt benvingudes. La millor forma d'enviar una contribució és enviar-la a la llista de correu. Si us plau, consulteu la secció Contacte per més informació.

    Quan es presenta una contribució, si us plau, identificar clarament el titular dels drets d'autor i s'ha d'incloure la declaració de concessió de llicències. Recordar que per ser acceptada, la contribució ha de tenir una llicencia igual que la resta del document, a saber, la versió de la GPL 3 o superior.

    Les fonts d'aquest manual es mantenen utilitzant el sistema de control de versions Git. Es pot obtenir còpia actualitzada mitjançant l'execució de:

    $ git clone git://live.debian.net/git/live-manual.git

    Abans de presentar una contribució, si us plau, previsualitzar el treball. Per previsualitzar el live-manual, assegurar-se que s'han instaŀlat els paquets necessaris per a la seva construcció mitjançant l'execució de:

    # apt-get install make po4a sisu-complete libnokogiri-ruby

    Es pot crear el live-manual des del directori de nivell superior del arbre Git mitjançant l'execució de:

    $ make build

    Com es necessita un cert temps per construir el manual en tots els idiomes suportats, potser resulti convenient quan es fa una prova construir per a un sol idioma, per exemple, mitjançant l'execució de:

    $ make build LANGUAGES=en

    També es possible crear per tipus de document, per exemple:

    $ make build FORMATS=pdf

    O combinar tot dos, per exemple:

    $ make build LANGUAGES=it FORMATS=html

    1.4.1 Aplicar canvis

    Qualsevol persona pot fer un commit directament al repositori. No obstant això, demanem que s'enviïn els canvis grans a la llista de correu per parlar-ne en primer lloc. Per fer un push al repositori, s'ha de seguir el següent procediment:

  • Obtenir la clau pública:
  • $ mkdir -p ~/.ssh/identity.d
    $ wget http://live.debian.net/other/keys/git@live.debian.net \
         -O ~/.ssh/identity.d/git@live.debian.net
    $ wget http://live.debian.net/other/keys/git@live.debian.net.pub \
         -O ~/.ssh/identity.d/git@live.debian.net.pub
    $ chmod 0600 ~/.ssh/identity.d/git@live.debian.net*

  • Afegiu la següent secció a la configuració del vostre openssh-client:
  • $ cat >> ~/.ssh/config << EOF
    Host live.debian.net
         Hostname live.debian.net
         User git
         IdentityFile ~/.ssh/identity.d/git@live.debian.net
    EOF

  • Fer una ullada a una còpia del manual a través de ssh:
  • $ git clone git@live.debian.net:/live-manual.git
    $ cd live-manual && git checkout debian-next

  • Tenir en compte que s'han d'enviar els canvis a la branca debian-next, no a la branca debian.
  • No fer un make commit a menys que s'actualitzen les traduccions al mateix temps, i en aquest cas, no barrejar els canvis al manual en anglès i les traduccions en el mateix commit, fer-ne un altre separat per cada un. Veure la secció Traducció per a més detalls.
  • Escriure missatges de commit que consisteixen en oracions completes i significatives en anglès, començant amb una lletra majúscula i acabant amb un punt. En general, aquestes començaran amb la forma 'Fixing/Adding/Removing/Correcting/Translating', per exemple:
  • $ git commit -a -m "Adding a section on applying patches."

  • Fer un push al servidor:
  • $ git push

    1.4.2 Traducció

    Per començar la traducció d'un idioma nou, seguir aquests passos:

  • Traduir els fitxers about_manual.ssi.pot, about_project.ssi.pot i index.html.in.pot a la vostra llengua amb el vostre editor favorit (per exemple poedit) . Enviar els fitxers .po traduïts a la llista de correu perquè l'equip de traducció pugui comprovar la seva integritat.
  • Per activar una nova llengua al autobuild, només cal afegir els arxius inicials traduïts a manual/po/${LANGUAGE}/ i executar make commit. I llavors editar manual/_sisu/home/index.html.
  • Una vegada que s'ha afegit la nova llengua, es pot continuar traduint la resta de fitxers dins de manual/po/ a l'atzar.
  • No oblidar que es necessari fer make commit per garantir que els manuals traduïts s'actualitzen a partir del fitxers po i llavors es poden revisar els canvis executant make build abans de git add ., git commit -a -m "Translating..." i git push.
  • Nota: Es pot utilitzar make clean per netejar l'arbre git abans de fer un push. Aquest pas no és obligatori, gràcies al fitxer .gitignore, però és una bona pràctica per evitar enviar fitxers de forma involuntària.

    2. Sobre el Projecte Debian Live

    2.1 Motivació
    2.1.1 Què passa amb els sistemes vius actuals

    Quan Debian Live va començar, ja hi havia diversos sistemes vius basats en Debian disponibles i que estaven fent una gran feina. Des de la perspectiva de Debian la majoria d'ells tenien una o més de les desavantatges següents:

  • No són projectes de Debian i per tant no tenen suport des de Debian.
  • Es barregen diferents distribucions, per exemple testing i unstable.
  • Només donen suport a i386.
  • Es modifique el comportament i/o l'aparença dels paquets, per estalviar espai.
  • S'inclouen paquets de fora de l'arxiu de Debian.
  • Inclouen nuclis personalitzats amb pedaços addicionals que no són part de Debian.
  • Són grans i lents pel seu gran tamany i per tant no aptes com a sistemes de rescat.
  • No estan disponibles en diferents formats, per exemple, CD, DVD, memòries USB i imatges netboot.
  • 2.1.2 Per què crear el nostre pròpi sistema viu?

    Debian és el sistema operatiu universal: Debian té un sistema viu per mostrar arreu i per representar acuradament el sistema Debian amb els següents avantatges:

  • Es tracta d'un subprojecte de Debian.
  • Reflecteix l'estat (actual) d'una distribució.
  • Funciona en tantes arquitectures com és possible.
  • Es tracta només de paquets Debian sense modificacions.
  • No conté paquets que no són a l'arxiu de Debian.
  • S'utilitza un nucli Debian sense alteracions i sense pedaços addicionals.
  • 2.2 Filosofia
    2.2.1 Només paquets Debian sense modificacions de la secció "main"

    Només farem servir els paquets des del repositori de Debian de la secció "main". La secció non-free no és part de Debian i per tant no es pot utilitzar per les imatges oficials del sistema viu.

    No canviarem cap paquet. Cada vegada que hàgim de canviar alguna cosa, ho farem en coordinació amb el mantenidor del paquet a Debian.

    Com a excepció, els nostres propis paquets, com ara live-boot, live-build o live-config poden ser utilitzats temporalment des del nostre propi repositori per raons de desenvolupament (per exemple, per crear instantànies de desenvolupament). Aquests paquets es pujaran a Debian de forma regular.

    2.2.2 Paquets del sistema viu sense cap configuració

    En aquesta fase no es publicarà o s'instal.larà cap configuració alternativa o d'exemple. Tots els paquets són utilitzats en la seva configuració per defecte, tal com són després d'una instaŀlació normal de Debian.

    Cada vegada que ens calgui una configuració per defecte diferent, ho farem en coordinació amb el mantenidor del paquet Debian.

    S'hi inclou un sistema per configurar paquets mitjançant debconf que permet instal.lar paquets configurats de forma personalitzada dins d'una imatge Debian Live personalitzada, però per a les imatges en viu oficials només utilitzarem una configuració per defecte. Per obtenir més informació, veure Visió de conjunt de la personalització.

    Excepció: Hi ha uns pocs canvis essencials necessaris per aconseguir que un sistema funcioni en viu. Aquests canvis essencials han de ser el més mínims possible i s'han de fusionar en el repositori de Debian si és possible.

    2.3 Contacte
  • Llista de correu: El contacte principal del projecte és la llista de correu a ‹http://lists.debian.org/debian-live/›. Es pot enviar un correu directament a ‹debian-live@lists.debian.org.› Els arxius de la llista són a ‹http://lists.debian.org/debian-live/›.
  • IRC: Un nombre d'usuaris i desenvolupadors estan presents al canal #debian-live a irc.debian.org (OFTC). Quan es pregunta al IRC, s'ha de tenir paciència esperant una resposta, si no hi ha cap resposta, es pot enviar un correu a la llista.
  • BTS : El Sistema de seguiment d'errors de Debian (BTS) conté detalls d'errors notificats per usuaris i desenvolupadors. A cada error se li assigna un número i es manté a l'arxiu fins que es marca com tractat. Per obtenir més informació, vegeu Informar d'errors.
  • Usuari

    3. Instaŀlació

    3.1 Requeriments

    La construcció d'imatges Debian Live té molts pocs requeriments.

  • Accés de superusuari (root)
  • Una versió actualitzada de live-build
  • Una shell compatible amb POSIX, com ara bash o dash.
  • debootstrap o cdebootstrap
  • Linux 2.6.x
  • Tenir en compte que no cal usar Debian o una distribució derivada de Debian ja que live-build funcionarà en gairebé qualsevol distribució amb els requisits anteriors.

    3.2 Instaŀlació de live-build

    Es pot instaŀlar live-build en un nombre de maneres diferentes:

  • Des del repositori Debian
  • À partir del codi font
  • À partir d'instantànies
  • Si s'utilitza Debian, la manera recomanada és instaŀlar live-build des del repositori de Debian.

    3.2.1 Des del repositori de Debian

    Només cal instaŀlar live-build com qualsevol altre paquet:

    # apt-get install live-build

    o

    # aptitude install live-build

    3.2.2 À partir del codi font

    live-build es desenvolupa utilitzant el sistema de control de versions Git. En els sistemes basats en Debian, això és proporcionat pel paquet git. Per comprovar l'últim codi, executar:

    $ git clone git://live.debian.net/git/live-build.git

    Es pot construir i instaŀlar un paquet Debian pròpi mitjançant l'execució de:

    $ cd live-build
    $ dpkg-buildpackage -rfakeroot -b -uc -us
    $ cd ..

    Ara instaŀlar qualsevol dels fitxers .deb recent construïts que ens interessen, per exemple,

    # dpkg -i live-build_2.0.8-1_all.deb

    Es pot instaŀlar live-build directament al sistema mitjançant l'execució de:

    # make install

    i desinstaŀlar amb:

    # make uninstall

    3.2.3 A partir d'instantànies

    Si no es desitja construir o instaŀlar live-build a partir de les fonts, es pot utilitzar les instantànies. Aquestes es construeixen automàticament a partir de l'última versió del Git, i estan disponibles a ‹http://live.debian.net/debian/›.

    3.3 Instal.lació de live-boot i live-config

    Nota: No cal instaŀlar live-boot o live-config en el sistema per crear sistemes personalitzats de Debian Live. No obstant, això no farà cap mal i és útil per a fins de referència. Si només es vol la documentació, ara es poden instaŀlar els paquets live-boot-doc i live-config-doc per separat.

    3.3.1 Des del repositori de Debian

    Tots dos, live-boot i live-config, estan disponibles al arxiu de Debian, d'una manera similar a Instaŀlació de live-build.

    3.3.2 À partir del codi font

    Per utilitzar les darreres fonts del git, es pot seguir el procés seguent. Assegurar-se d'estar familiaritzat amb els termes esmentats a Termes.

  • Clonar les fonts de live-boot i live-config
  • $ git clone git://live.debian.net/git/live-boot.git
    $ git clone git://live.debian.net/git/live-config.git

    Consultar les pàgines del manual de live-boot i live-config per més detalls sobre la seva personalització si aquesta és la raó per construir aquests paquets a partir de les fonts.

  • Crear els fitxers .deb de live-boot i live-config
  • S'ha de crear ja sigui en la distribució de destinació o en un chroot que contingui la plataforma de destinació: és a dir, si el objectiu és wheezy llavors s'ha de construir contra wheezy.

    Es pot utilitzar un constructor personal, com ara pbuilder o sbuild si es necessita crear live-boot per a una distribució de destinació diferenta del sistema de construcció. Per exemple, per a les imatges en viu de wheezy, crear live-boot en un chroot wheezy. Si la distribució de destinació per casualitat coincideix amb la distribució del sistema de construcció, es pot construir directament en el sistema de construcció amb dpkg-buildpackage (proporcionat pel paquet dpkg-dev) :

    $ cd live-boot
    $ dpkg-buildpackage -b -uc -us
    $ cd ../live-config
    $ dpkg-buildpackage -b -uc -us

  • Utilitzar tots el fitxers .deb generats
  • Com live-boot i live-config són instaŀlats pel sistema live-build, instaŀlar els paquets en el sistema amfitrió no és suficient: S'han de tractar tots els fitxers .deb generats igual que qualsevol altre paquet personalitzat. Si us plau veure Personalització de l'instaŀlació de paquets per a més informació. S'ha de prestar especial atenció a Repositoris addicionals.

    3.3.3 A partir d'instantànies

    Es pot deixar que live-build utilitzi les darreres instantànies de live-boot i live-config configurant un repositori de tercers en el directori de configuració de live-build. Suposant que ja s'ha creat un arbre de configuració del directori actual amb lb config:

    $ lb config --archives live.debian.net

    4. Conceptes bàsics

    Aquest capítol conté una breu descripció del procés de construcció i les instruccions per a l'ús dels tres tipus d'imatge més comunes. El tipus d'imatge més versàtil iso-hybrid es pot utilitzar en una màquina virtual, en medis òptics o qualsevol altre dispositiu d'emmagatzematge USB portàtil. En certs casos especials, com ara l'ús de la persistència, el tipus hdd pot ser el més adequat per als dispositius USB. El capítol acaba amb instruccions per a la construcció d'una imatge tipus net, que és una mica més complicat a causa de la configuració necessària en el servidor. Aquest és un tema una mica avançat per a algú que no està familiaritzat ja amb l'arrencada en xarxa, però s'inclou aquí perquè un cop que la configuració es porta a terme, es tracta d'una forma molt convenient per provar i desplegar imatges per a l'arrencada en xarxa local sense la molèstia de tractar amb els dispositius de les imatges.

    Al llarg del capítol, sovint es fa referència als noms dels fitxers produïts per defecte per live-build. Si es descarrega una imatge prefabricada, els noms dels fitxers poden ser direrents.

    4.1 Què és un sistema viu?

    Un sistema viu és un sistema operatiu que arrenca en un equip des d'un dispositiu extraïble, com un CD-ROM o una memòria USB o des d'una xarxa, a punt per fer servir sense cap tipus d'instaŀlació en la unitat(s) habitual(s), amb una configuració automàtica feta en temps d'execució (veure Termes).

    Amb Debian Live, és un sistema operatiu Debian GNU/Linux, construït per una de les arquitectures suportades (actualment amd64, i386 powerpc i sparc). Conté les següents parts:

  • Imatge del nucli Linux, generalment s'anomena vmlinuz*
  • Imatge del disc RAM inicial (initrd): un disc RAM configurat per a l'arrencada de Linux, que conté els mòduls que possiblement es necessitaran per muntar la imatge del sistema i algunes seqüències d'ordres per fer-ho.
  • Imatge del sistema: Imatge del sistema de fitxers del sistema operatiu. Normalment, s'utilitza un sistema de fitxers comprimit SquashFS per minimitzar la mida de la imatge Debian Live. Tenir en compte que és de només lectura. Així, durant l'arrencada, el sistema Debian Live utilitzarà el disc RAM i un mecanisme de "unió" per permetre l'escriptura de fitxers en el sistema en funcionament. No obstant això, totes les modificacions es perdran en tancar si no és que s'utilitza la persistència opcional (vegeu Persistència).
  • Carregador d'arrencada : Una petita peça de codi dissenyat per arrencar des del medi triat, possiblement presentant un indicador d'arrencada o un menú per permetre la selecció d'opcions/configuració. Carrega el nucli del Linux i el seu initrd per funcionar amb un sistema de fitxers del sistema associat. Es poden utilitzar diverses solucions, en funció dels medis de destinació i el format del sistema de fitxers que conté els components esmentats anteriorment: isolinux per arrencar des de CD o DVD en format ISO9660, syslinux per una unitat USB o HDD que s'iniciarà des de particions VFAT, extlinux per particions ext2/3/4 i btrfs, pxelinux per PXE netboot, GRUB per particions ext2/3/4, etc
  • Es pot utilitzar live-build per construir la imatge del sistema amb especificacions pròpies, configurar un nucli de Linux, el initrd, i un carregador d'arrencada per executar-los, tot això en un format depenent dels dispositius (imatge ISO9660, imatge de disc, etc.)

    4.2 Primers passos: construcció d'una imatge ISO híbrida

    Independentment del tipus d'imatge, s'haurà de fer els mateixos passos bàsics per construir una imatge cada vegada. Com a primer exemple, executar la següent seqüència d'ordres live-build per crear una imatge ISO híbrida de base que conté només el sistema estàndard de Debian sense X.org. És adequat per gravar en un CD o DVD, i també per copiar en una memòria USB.

    En primer lloc, executar l'ordre lb config. Això crearà una jerarquia «config/» en el directori actual per ser utilitzada per altres ordres:

    $ lb config

    Aquí no es passa cap paràmetre a lb config, per tant s'utilitzaran les opcions per defecte. Veure L'ordre lb config per més detalls.

    Ara que la jerarquia «config/» ja existeix, crear la imatge amb l'ordre lb build:

    # lb build

    Aquest procés tardarà una mica, depenent de la velocitat de la connexió de la xarxa. Quan hagi acabat, ha d'haver un fitxer imatge binary.hybrid.iso, a punt per ser utilitzar, en el directori actual.

    4.3 Usar una imatge ISO híbrida en viu

    Després de la construcció o la descàrrega d'una imatge ISO híbrida, que pot ser obtinguda a ‹http://www.debian.org/CD/live/›, el següent pas habitual és preparar els dispositius per a l'arrencada, ja sigui medis òptics com un CD-R(W) o DVD-R(W) o una memòria USB.

    4.3.1 Gravar una imatge ISO en un medi físic

    Gravar una imatge ISO és fàcil. Simplement cal instaŀlar i utilitzar wodim des de la línia d'ordres per gravar la imatge. Per exemple:

    # apt-get install wodim

    $ wodim binary.hybrid.iso

    4.3.2 Còpiar una imatge ISO híbrida en un dispositiu USB

    Les imatges ISO preparades amb l'ordre isohybrid, com les imatges binàries del tipus iso-hybrid produïdes per defecte és poden copiar directament a una memòria USB utilitzant el programa dd o un altre d'equivalent. Connectar una memòria USB amb una mida prou gran per al fitxer de la imatge i determinar quin dispositiu és, que d'ara endavant annomenarem ${USBSTICK}. Aquest és el dispositiu de la memòria com per exemple /dev/sdb, no una partició, com ara /dev/sdb1! Es pot trobar el nom del dispositiu correcte mirant la sortida de dmesg després de connectar la memòria usb o encara millor, ls -l /dev/disk/by-id.

    Quan s'estigui segur de tenir el nom del dispositiu correcte, utilitzar l'ordre dd per a copiar la imatge a la memòria. Fent això es perdran definitivament tots els continguts anteriors de la memòria usb!

    $ dd if=binary.hybrid.iso of=${USBSTICK}

    4.3.3 Arrencar els medis en viu

    La primera vegada que s'arrenqui els medis en viu, ja sigui des de CD, DVD, memòria USB, o PXE, pot ser necessaria alguna petita configuració al BIOS del ordinador en primer lloc. Atès que les BIOS varien molt en les seves funcions i dreceres de teclat, no podem entrar en el tema en profunditat aquí. Algunes BIOS proporcionen una tecla per obrir un menú de dispositius d'arrencada, que és la manera més fàcil si es troba disponible al sistema. En cas contrari, cal entrar al menú de configuració del BIOS i canviar l'ordre d'arrencada per situar el dispositiu del sistema en viu abans que el dispositiu d'arrencada normal.

    Després d'arrencar des del dispositiu, es veurà un menu d'inici. S'ha de prémer «entrer» i el sistema s'iniciarà amb l'entrada Live i les seves opcions per defecte. Per obtenir més informació sobre les opcions d'arrencada, llegir la «ajuda» (help) al menú i també les pàgines del manual de live-boot i live-config que es troben dins del sistema en viu.

    Suposant que s'ha seleccionat Live i s'ha arrencat una imatge d'escriptori per defecte, després que els missatges d'arrencada hagin passat s'haurà iniciat una sessió com a usuari user i es veurà un escriptori, a punt per ser utilitzat. Si s'ha arrencat una imatge de la consola només, com les imatges preconfigurades standard o rescue s'iniciarà una sessió com a usuari user i es veurà el indicador de la shell, a punt per ser utilitzat.

    4.4 Utilitzar una màquina virtual per fer proves

    Pot ser un gran estalvi de temps per al desenvolupament d'imatges en viu executar-les en una màquina virtual (VM). Això no està exempt d'advertiments:

  • L'execució d'una màquina virtual requereix de suficient memòria RAM, tant per al sistema operatiu convidat i l'amfitrió i es recomana una CPU amb maquinari amb suport per a la virtualització.
  • Hi ha algunes limitacions inherents a l'execució en una màquina virtual, per exemple, rendiment de vídeo pobre, opcions limitadades de maquinari emulat.
  • En el desenvolupament per a un maquinari específic, no hi ha substitut per al propi maquinari.
  • De tant en tant hi ha errors que només sorgeixen durant l'execució en una màquina virtual. En cas de dubte, comprovar la imatge directament al maquinari.
  • Sempre que es pugui treballar dins d'aquestes limitacions, examinar el programari de màquina virtual disponible i triar un que sigui adequat per a les necessitats pròpies.

    4.4.1 Provar una imatge ISO amb QEMU

    La màquina virtual més versàtil dins Debian és QEMU. Si el processador té suport de maquinari per a la virtualització, utilitzar el paquet qemu-kvm; la descripció del paquet qemu-kvm enumera breument els requeriments.

    Primer, instaŀlar qemu-kvm si el processador ho suporta. Si no, instaŀlar qemu, en aquest cas el nom del programa és qemu en lloc de kvm en els exemples següents. El paquet qemu-utils també és valuós per a la creació d'imatges de disc virtuals amb qemu-img.

    # apt-get install qemu-kvm qemu-utils

    Arrencar una imatge ISO és senzill:

    $ kvm -cdrom binary.hybrid.iso

    Veure les pàgines del manual per a més detalls

    4.4.2 Provar una imatge ISO amb virtualbox-ose

    Per provar la ISO amb virtualbox-ose:

    # apt-get install virtualbox-ose virtualbox-ose-dkms

    $ virtualbox

    Crear una nova màquina virtual, canviar els paràmetres d'emmagatzematge per utilitzar binary.hybrid.iso com unitat de CD/DVD i arrencar la màquina.

    Nota: Per provar sistemes vius que contenen X.org amb virtualbox-ose, segurament es assenyat incloure el paquet del driver VirtualBox X.org, virtualbox-ose-guest-x11, en la configuració de live-build. En cas contrari, la resolució es limita a 800x600.

    $ echo virtualbox-ose-guest-x11 >> config/package-lists/my.list.chroot

    4.5 Construir una imatge HDD

    Construir una imatge HDD és similar a una ISO híbrida en tots els aspectes, excepte que s'especifiqua -b hdd que el nom del fitxer resultant és binary.img i que no es pot gravar en medis òptics. És adequada per arrencar des de dispositius USB, discs durs USB, i altres dispositius d'emmagatzematge portàtils. Normalment, una imatge ISO híbrida es pot utilitzar per aquest propòsit en el seu lloc, però si el BIOS no maneja adequadament les imatges híbrides, o es desitja utilitzar l'espai lliure en els medis per a algun propòsit, com una partició per a la persistència, cal una imatge HDD.

    Nota: si s'ha creat una imatge ISO híbrida amb l'exemple anterior, s'haurà de netejar el directori de treball amb l'ordre lb clean (veure L'ordre lb clean):

    # lb clean --binary

    Executar l'ordre lb config com abans, excepte que aquesta vegada especificant el tipus d'imatge HDD:

    $ lb config -b hdd

    Ara construir la imatge amb l'ordre lb build:

    # lb build

    Quan la construcció acabi, hauria d'haver un fitxer binary.img al directori actual.

    4.6 Utilitzar una imatge HDD

    La imatge binària generada conté una partició VFAT i el carregador d'arrencada syslinux, llestos per ser escrits directament a una memòria USB. Donat que l'ús d'una imatge HDD és com utilitzar una imatge ISO híbrida en un USB, seguir les instruccions de Usar una imatge ISO híbrida en viu, però amb el nom de fitxer binary.img en lloc de binary.hybrid.iso.

    4.6.1 Provar una imatge HDD amb Qemu

    Primer, instaŀlar qemu com s'ha descrit anteriorment a Provar una imatge ISO amb QEMU. A continuació, executar kvm o qemu, segons la versió instaŀlada al sistema amfitrió, especificant binary.img com a primer disc dur.

    $ kvm -hda binary.img

    4.6.2 Utilitzar l'espai lliure en una memòria USB

    Per poder utilitzar l'espai que queda lliure després de copiar binary.img en un dispositiu USB, utilitzar una eina de particionament com gparted o parted per crear una nova partició. La primera partició serà utilitzada pel sistema Debian Live.

    # gparted ${USBSTICK}

    Després de crear la partició, on ${PARTITION} és el nom de la partició, com ara /dev/sdb2, s'ha de crear un sistema de fitxers. Una opció possible seria ext4.

    # mkfs.ext4 ${PARTITION}

    Nota: Si es vol utilitzar l'espai addicional amb Windows, pel que sembla, aquest sistema operatiu normalment no pot accedir a altres particions més que a la primera. Algunes solucions a aquest problema han estat discutides a la nostra llista de correu, però sembla que no hi ha respostes fàcils.

    Recordar: Cada vegada que s'instaŀli una nova binary.img al dispositiu, es perdran totes les dades perquè la taula de particions se sobreescriu amb el contingut de la imatge, de manera que es assenyat fer una còpia de seguretat de la partició addicional per restaurar les dades de nou després d'actualitzar la imatge en viu.

    4.7 Construir una imatge netboot

    La següent seqüència d'ordres crearà una imatge netboot bàsica que conté el sistema estàndard de Debian sense X.org. És adequada per a l'arrencada en xarxa.

    Nota: si s'ha realitzat algun dels exemples anteriors, s'haurà de netejar el directori de treball amb l'ordre lb clean:

    # lb clean --binary

    Executar l'ordre següent per configurar la imatge per arrencar en xarxa:

    $ lb config -b net --net-root-path "/srv/debian-live" --net-root-server "192.168.0.1"

    A diferència de les imatges ISO i HDD, l'arrencada en xarxa no serveix el sistema de fitxers al client, per tant els fitxers han de ser servits a través de NFS. Les opcions --net-root-path y --net-root-server especifiquen la ubicació i el servidor, respectivament, del servidor NFS on es troba la imatge de sistema de fitxers a l'hora d'arrencar. Assegurar-se que aquests s'ajusten als valors adequats per la xarxa i el servidor pròpis.

    Ara construir la imatge amb l'ordre lb build:

    # lb build

    En l'arrencada en xarxa, el client executa una petita peça de programari que normalment es troba a la EPROM de la targeta Ethernet. Aquest programa envia una petició DHCP per obtenir una adreça IP i la informació sobre què fer a continuació. Per regla general, el següent pas és aconseguir un carregador d'arrencada de més alt nivell a través del protocol TFTP. Podria ser GRUB, pxelinux o fins i tot arrencar directament a un sistema operatiu com Linux.

    Per exemple, si es descomprimeix el arxiu binary.netboot.tar.xz generat al directori /srv/debian-live, es trobarà la imatge del sistema de fitxers a live/filesystem.squashfs i el nucli, initrd i carregador d'arrencada pxelinux a tftpboot/debian-live/i386.

    Ara hem de configurar els tres serveis al servidor per l'arrencada en xarxa: el servidor DHCP, servidor TFTP i el servidor NFS.

    4.7.1 Servidor DHCP

    S'ha de configurar el servidor DHCP de la xarxa per assegurar-se que dona una adreça IP per al client del sistema d'arrencada en xarxa, i per anunciar la ubicació del carregador d'arrencada PXE.

    Heus aquí un exemple per servir d'inspiració, escrit per al servidor ISC DHCP isc-dhcp-server al fitxer de configuració /etc/dhcp/dhcpd.conf:

    # /etc/dhcp/dhcpd.conf - configuration file for isc-dhcp-server

    ddns-update-style none;

    option domain-name "example.org";
    option domain-name-servers ns1.example.org, ns2.example.org;

    default-lease-time 600;
    max-lease-time 7200;

    log-facility local7;

    subnet 192.168.0.0 netmask 255.255.255.0 {
       range 192.168.0.1 192.168.0.254;
       next-server servername;
       filename "pxelinux.0";
    }

    4.7.2 Servidor TFTP

    Aquest serveix el nucli i el disc ram inicial per al sistema en temps d'execució.

    S'ha d'instaŀlar el paquet tftpd-hpa. Aquest pot servir tots els arxius continguts dins d'un directori arrel, per regla general /srv/tftp. Perquè es serveixen els arxius dins de /srv/debian-live/tftpboot, s'ha d'executar com a root la següent ordre:

    # dpkg-reconfigure -plow tftpd-hpa

    i omplir el nou directori del servidor tftp quan ho hàgim de fer.

    4.7.3 Servidor NFS

    Un cop l'ordinador ha descarregat, ha arrencat el nucli de Linux i ha carregat el initrd, intentarà muntar la imatge del sistema de fitxers en viu a través d'un servidor NFS.

    S'ha d'instaŀlar el paquet nfs-kernel-server

    Llavors, fer que la imatge del sistema de fitxers estigui disponible a través de NFS afegint una línia com la següent a /etc/exports:

    /srv/debian-live *(ro,async,no_root_squash,no_subtree_check)

    i informar al servidor NFS sobre aquesta nova exportació amb la següent ordre:

    # exportfs -rv

    La configuració d'aquests tres serveis pot ser una mica difícil. És possible que es necessiti una mica de paciència per aconseguir que tots tres funcionin plegats. Per obtenir més informació, veure el wiki de syslinux a ‹http://syslinux.zytor.com/wiki/index.php/PXELINUX› o la secció TFTP Net Booting al Manual del Instaŀlador de Debian a ‹http://d-i.alioth.debian.org/manual/en.i386/ch04s05.html›. Això pot ajudar, ja que els seus processos són molt similars.

    4.7.4 Com provar l'arrencada en xarxa

    La creació d'imatges d'arrencada en xarxa es fa fàcil amb la màgia de live-build, però provar les imatges en màquines físiques pot costar molt de temps.

    Per fer la nostra vida més fàcil, podem utilitzar la virtualització. Hi ha dues solucions.

    4.7.5 Qemu
  • Instaŀlar qemu, bridge-utils, sudo.
  • Editar /etc/qemu-ifup:

    #!/bin/sh
    sudo -p "Password for $0:" /sbin/ifconfig $1 172.20.0.1
    echo "Executing /etc/qemu-ifup"
    echo "Bringing up $1 for bridged mode..."
    sudo /sbin/ifconfig $1 0.0.0.0 promisc up
    echo "Adding $1 to br0..."
    sudo /usr/sbin/brctl addif br0 $1
    sleep 2

    Descarregar o crear un grub-floppy-netboot (al svn).

    Llançar qemu amb "-net nic,vlan=0 -net tap,vlan=0,ifname=tun0"

    4.7.6 VMWare Player
  • Instaŀlar VMWare Player (edició gratuïta «free as in beer»)
  • Crear un directory PXETester amb un fitxer de text dins anomenat pxe.vwx
  • Enganxar aquest text dins:
  • #!/usr/bin/vmware
    config.version = "8"
    virtualHW.version = "4"
    memsize = "512"
    MemAllowAutoScaleDown = "FALSE"

    ide0:0.present = "FALSE"
    ide1:0.present = "FALSE"
    floppy0.present = "FALSE"
    sound.present = "FALSE"
    tools.remindInstall = "FALSE"

    ethernet0.present = "TRUE"
    ethernet0.addressType = "generated"

    displayName = "Test Boot PXE"
    guestOS = "other"

    ethernet0.generatedAddress = "00:0c:29:8d:71:3b"
    uuid.location = "56 4d 83 72 5c c4 de 3f-ae 9e 07 91 1d 8d 71 3b"
    uuid.bios = "56 4d 83 72 5c c4 de 3f-ae 9e 07 91 1d 8d 71 3b"
    ethernet0.generatedAddressOffset = "0"

  • Es pot jugar amb aquest fitxer de configuració (per exemple, canviar el limit de memòria a 256)
  • Fer doble clic sobre aquest fitxer (o executar VMWare player i seleccionar aquest fitxer).
  • Quan està en execució només cal prémer «espai» si sorgeix aquella pregunta estranya ...
  • 5. Descripció general de les eines

    Aquest capítol conté un resum de les tres eines principals utilitzades en la construcció dels sistemes Debian Live: live-build, live-boot i live-config.

    5.1 El paquet live-build

    live-build és un conjunt de scripts per crear sistemes Debian Live. Aquests scripts també s'anomenen «ordres».

    La idea darrere de live-build és ser un marc que utilitza un directori de configuració per automatitzar completament i personalitzar tots els aspectes de la construcció d'una imatge en viu.

    Molts conceptes són similars als de les eines del paquet Debian debhelper escrit per Joey Hess:

  • Els scripts tenen una ubicació central per a la configuració del seu funcionament. Amb debhelper aquest és el subdirectori debian/ d'un arbre de paquets. Per exemple, dh_install buscarà, entre altres, un arxiu anomenat debian/install per determinar quins fitxers han d'existir en un paquet binari en particular. De la mateixa manera, live-build emmagatzema la seva configuració per complet sota un subdirectori config/.
  • Els scripts són independents - és a dir, sempre és segur executar cada ordre.
  • A diferència de debhelper, live-build conté una eina per generar un directori de configuració en esquelet, lb config. Això podria ser considerat similar a eines com ara dh-make. Per obtenir més informació sobre lb config, veure L'ordre lb config.

    La resta d'aquesta secció descriu les tres ordres més importants:

  • lb config: Responsable de crear un directori de configuració per al sistema en viu. Consultar L'ordre lb config per a més informació.
  • lb build: Responsable d'iniciar la creació d'un sistema en viu. Consultar L'ordre lb build per a més informació.
  • lb clean: Responsable d'eliminar parts de la construcció d'un sistema viu. Consultar L'ordre lb clean per a més informació.
  • 5.1.1 L'ordre lb config

    Com s'ha dit a live-build, les seqüències d'ordres que formen part de live-build llegeixen la seva configuració amb l'ordre source d'un únic directori anomenat config/. Com la construcció d'aquest directori a mà, seria molt costós i propens a errors, es pot utilitzar l'ordre lb config per crear carpetes de configuració en esquelet.

    Executar lb config sense arguments crea un subdirectori config/ que s'omple amb alguns paràmetres per defecte, i un arbre en esquelet de subdirectoris auto/.

    $ lb config
    [2012-03-19 15:17:14] lb_config
    P: Considering defaults defined in /etc/live/build.conf
    P: Creating config tree for a debian system

    Utilitzar lb config sense cap tipus d'arguments seria convenient per als usuaris que necessiten una imatge molt bàsica, o que tinguin la intenció de proporcionar una configuració més completa més tard mitjançant auto/config (Veure Gestió d'una configuració per més detalls).

    Normalment, s'haurà d'especificar algunes opcions. Per exemple, per incloure la llista de paquets 'gnome' en la configuració:

    $ lb config -p gnome

    És possible especificar diverses opcions, com ara:

    $ lb config --binary-images net --bootappend-live "hostname=live-machine username=live-user" ...

    Una llista completa d'opcions està disponible a la pàgina del manual lb_config.

    5.1.2 L'ordre lb build

    L'ordre lb build llegeix la configuració del directori config/. A continuació, executa les ordres de nivell inferior necessaries per construir el sistema en viu.

    5.1.3 L'ordre lb clean

    L'ordre lb clean s'encarrega d'eliminar diverses parts d'una construcció per que altres construccions posteriors puguin començar des d'un estat net. Per defecte, es netegen les etapes chroot, binary i source, però la memòria cau es manté intacta. A més, es poden netejar etapes individuals. Per exemple, si s'han fet canvis que només afecten a la fase binary, utilitzar lb clean --binary abans de construir un nou binary. Veure la pàgina del manual de lb_clean per a una llista completa d'opcions.

    5.2 El paquet live-boot

    live-boot és un conjunt de scripts per proporcionar hooks a initramfs-tools, que s'utilitzen per generar un initramfs capaç d'arrencar sistemes vius, com ara els creats per live-build. Això inclou les ISOs de Debian Live, netboot tarballs i imatges per a memòries USB.

    En el moment d'arrencar, buscarà medis de només lectura que continguin un directori /live/ on s'emmagatzema un sistema de fitxers arrel (sovint una imatge de un sistema de fitxers comprimit squashfs). Si el troba, crearà un entorn d'escriptura, utilitzant aufs, per que puguin arrencar sistemes com Debian o similars.

    Més informació sobre ramfs inicial a Debian es pot trobar al Debian Linux Kernel Handbook ‹http://kernel-handbook.alioth.debian.org/› al capítol sobre initramfs.

    5.3 El paquet live-config

    live-config consta dels scripts que s'executen durant l'arrencada després de live-boot per a configurar el sistema en viu de forma automàtica. S'ocupa de tasques com ara l'establiment de les locales, el nom d'amfitrió, i la zona horària, crear l'usuari en viu, l'inhibició de tasques de cron i l'inici automàtic de sessió per l'usuari en viu.

    6. Gestió d'una configuració

    En aquest capítol s'explica com gestionar una configuració en viu des de la seva creació inicial, a través de revisions i versions successives de tant el programari live-build com de la imatge en viu en si mateixa.

    6.1 Utilitzar auto per gestionar canvis de configuració

    Les configuracions dels sistemes vius poques vegades són perfectes al primer intent. És probable que s'hagi de fer una sèrie de revisions fins quedar satisfet. No obstant això, es poden introduir inconsistències a la configuració d'una versió a la següent si no se'n te cura. El principal problema és, que una vegada que a una variable se li assigna un valor per defecte, aquest valor no es torna a calcular a partir d'altres variables que poden canviar en revisions posteriors.

    Per exemple, quan la distribució s'estableix per primer cop, a moltes de les variables dependents se'ls assigna uns valors per defecte que s'adapten a aquesta distribució. No obstant això, si més endavant es decideix canviar la distribució, les variables dependents seguiran conservant els mateixos valors que ja no són apropiats.

    Un segon problema relacionat és que si s'executa lb config i després s'actualitza a una versió nova de live-build que ha canviat un dels noms de les variables, només es descobrirà això mitjantçant una revisió manual de les variables als fitxers de config/* que després s'hauran de tornar a modificar per establir l'opció corresponent de nou.

    Tot això seria una molestia terrible si no fos pels scripts auto/*, simples embolcalls per les ordres lb config, lb build i lb clean dissenyats per ajudar a gestionar una configuració. Només cal crear un script auto/config que contingui totes les opcions que es desitgin, i un auto/clean que elimini els fitxers que continguin diversos valors de variables de configuració, cada vegada que s'executi lb config i lb clean, aquests fitxers seran executats. Això assegurarà que la configuració guarda una coherència interna d'una versió a una altra i d'una versió de live-build a la següent (Tot i que encara s'haurà d'anar amb compte i llegir la documentació quan s'actualitzi live-build i fer els ajustos necessaris ).

    6.2 Scripts auto d'exemple

    Es poden utilitzar scripts auto d'exemple com ara els següents com a punt de partida per crear una nova configuració de live-build. Tenir en compte que quan s'invoca l'ordre lb que embolcalla el script auto, s'ha d'especificar noauto com a paràmetre per garantir que el script auto no es torna a executar de forma recursiva. A més, assegurar-se que els scripts són fitxers executables (e.g. chmod 755 auto/*).

    auto/config

    #!/bin/sh
    lb config noauto \
         --package-lists "standard" \
         "${@}"

    auto/clean

    #!/bin/sh
    lb clean noauto "${@}"
    rm -f config/binary config/bootstrap \
         config/chroot config/common config/source
    rm -f build.log

    auto/build

    #!/bin/sh
    lb build noauto "${@}" 2>&1 | tee build.log

    Ara incloem scripts auto d'exemple amb live-build basats en els exemples anteriors. Es poden copiar com a punt de partida.

    $ cp /usr/share/doc/live-build/examples/auto/* auto/

    Editar auto/config, canviar o afegir qualsevol opció que millor sembli. En l'exemple anterior s'estableix el valor per defecte, --package-lists standard. Canviar això a qualsevol valor vàlid per la pròpia imatge (o suprimir-ho si es vol utilitzar el valor per defecte) i afegir opcions addicionals en les línies que segueixen a continuació.

    7. Personalització dels continguts

    En aquest capítol s'ofereix una visió general de les diverses formes en què es pot personalitzar un sistema Debian Live.

    7.1 Configuració durant la construcció vs. durant l'arrencada

    La configuració de un sistema en viu es divideix en opcions en temps de constucció que són les opcions que s'apliquen durant la seva creació i les opcions d'arrencada del sistema que s'apliquen durant l'arrencada. Les opcions d'arrencada es divideixen en les què ocorren al principi de l'arrencada, aplicades pel paquet live-boot, i les que ocorren més tard en l'arrencada, aplicades per live-config. Qualsevol opció durant l'arrencada pot ser modificada per l'usuari, especificant-la a l'indicador d'arrencada. La imatge també pot ser construïda amb els paràmetres d'arrencada per defecte perquè els usuaris puguin simplement arrencar el sistema en viu sense especificar cap altra opció, ja que tots els valors per defecte són adequats. En particular, l'argument lb --bootappend-live consta de les opcions de línia d'ordres per defecte del nucli per al sistema en viu, com ara la persistència, la distribució del teclat o la zona horària. Veure Personalització de l'entorn local i el llenguatge, per exemple.

    Les opcions de configuració durant la construcció es descriuen a la pàgina del manual de lb config. Les opcions durant l'arrencada es descriuen a les pàgines del manual de live-boot i live-config. Malgrat que els paquets live-boot i live-config s'instaŀlen en el sistema en viu que s'està construint, és recomana instaŀlar-los en el sistema de construcció per a una referència fàcil quan s'està treballant en la configuració. És segur fer-ho, ja que cap dels scripts continguts en ells s'executen a menys que el sistema s'hagi configurat com a sistema viu.

    7.2 Etapes de la construcció

    El procés de construcció es divideix en etapes, amb personalitzacions diferentes aplicades successivament en cada una. La primera etapa que s'executa es la fase bootstrap. Aquesta és la fase inicial de poblar el directori chroot amb paquets per fer un sistema Debian bàsic. Això és seguit per l'etapa chroot, que completa la construcció de directori chroot, omplint-lo amb tots els paquets que s'indiquen en la configuració, juntament amb qualsevol altre material. La majoria de personalitzacions dels continguts es produeix en aquesta etapa. L'etapa final de preparació de la imatge en viu és l'etapa binary, quan es construeix una imatge capaç d'arrencar, amb el contingut del directori chroot per construir el sistema de fitxers arrel per al sistema en viu, i que inclou el programa de instaŀlació i qualsevol altre material addicional en el medi de destinació fora del sistema de fitxers del sistema en viu. Després de construir la imatge en viu, si està habilitat, el codi font original s'inclou a l'etapa source.

    Dins de cadascuna d'aquestes etapes, hi ha una seqüència particular en la qual s'apliquen les ordres. Aquestes estan disposades de manera que es garanteixi que les personalitzacions es poden superposar de manera raonable. Per exemple, dins l'etapa chroot, les preconfiguracions (preseeds) s'apliquen abans que s'instaŀlin els paquets, els paquets s'instaŀlen abans que s'apliquin els fitxers locals o pegats inclosos, i els ganxos s'executen més tard, després que tots els materials estiguin al seu lloc.

    7.3 Suplementar lb config amb fitxers

    Encara que lb config crea una configuració en esquelet al directori config/, per aconseguir els objectius, pot ser necessari proporcionar fitxers addicionals en els subdirectoris de config/. Depenent d'on s'emmagatzemen els fitxers en la configuració, poden ser copiats en el sistema d'fitxers del sistema en viu o en el sistema de fitxers de la imatge binària, o es pot proporcionar configuracions en temps de creació del sistema que serien engorroses de passar com opcions de línia d'ordres. Es pot incloure coses com ara llistes personalitzades de paquets, art personalitzat o scripts ganxo per funcionar ja sigui en temps de construcció o en temps d'arrencada, augmentant la flexibilitat ja considerable de debian-live amb codi propi.

    7.4 Tasques de personalització

    Els següents capítols s'organitzen pel tipus de tasques de personalització que els usuaris solen realitzar: Personalització de la instaŀlació de paquets, Personalització dels continguts i Personalització de l'entorn local i el llenguatge cobreixen només algunes de les coses que es poden fer.

    8. Personalització de la instaŀlació de paquets

    La personalització més bàsica d'un sistema Debian viu pot ser la selecció dels paquets que seran inclosos en la imatge. Aquest capítol explica les diverses opcions de live-build per personalitzar la instaŀlació de paquets durant la construcció. Les opcions més importants que influeixen en els paquets que estan disponibles per ser instaŀlats en la imatge són les àrees de distribució i el arxiu. Per garantir velocitats de descàrrega decents, s'ha de triar un mirall de distribució proper. També es pot incloure repositoris de backports, paquets experimentals o personalitzats, o incloure paquets directament com si fossin fitxers. Es poden definir llistes pròpies de paquets, utilitzar llistes predefinides, utilitzar tasques de tasksel, o una combinació d'aquests tres mètodes. Finalment, una sèrie d'opcions donen un cert control sobre apt o si es prefereix aptitude, quan s'instaŀlen els paquets durant la construcció. Això pot ser útil si s'utilitza un proxy, es vol desactivar la instaŀlació de paquets recomanats per estalviar espai, o hi ha la necessitat de controlar quines versions dels paquets s'instaŀlen mitjançant la tècnica pinning d'APT, per nomenar algunes possibilitats.

    8.1 Fonts dels paquets
    8.1.1 Distribució, zones d'arxiu i mode

    La distribució que es tria té una gran importància en els paquets que estan disponibles per incloure en una imatge en viu. Només cal especificar el nom en clau, que per defecte és wheezy per a la versió wheezy de live-build. Qualsevol distribució disponible a l'arxiu de Debian pot ser especificada pel seu nom en clau aquí. (Veure Termes per més detalls.) L'opció --distribution no només influeix en l'origen dels paquets dins l'arxiu, sinó que també instrueix a live-build per comportar-se segons sigui necessari per a construir cada distribució compatible. Per exemple, per construir la distribució unstable, sid, s'ha d'especificar:

    $ lb config --distribution sid

    A l'arxiu de la distribució, les àrees d'arxiu són les divisions principals de l'arxiu. A Debian, es tracta de main, contrib i non-free. Només main conté el programari que és part de la distribució Debian, pel que és el valor per defecte. Un o més valors es poden especificar, per exemple:

    $ lb config --archive-areas "main contrib"

    És dona suport experimental a alguns derivats de Debian a través de l'opció --mode. Per defecte, aquesta opció està establerta en debian, tot i que se estigui construint en un sistema que no sigui Debian. Si s'especifica --mode ubuntu o --mode emdebian, s'utilitzen els noms de distribució i les àrees dels arxius dels derivats especificats en lloc dels de Debian. El «mode» també modifica el comportament de live-build per adaptar-lo als derivats.

    Nota: Els projectes per als quals aquests modes s'han afegit són els principals responsables de donar suport als usuaris d'aquestes opcions. El projecte Debian Live, al seu torn, dona suport de desenvolupament només sobre una base de millor esforç, basada en les informacions proporcionades pels projectes derivats ja que nosaltres no desenvolupem ni donem suport a aquests derivats.

    8.1.2 Miralls de distribució

    L'arxiu de Debian es replica a través d'una àmplia xarxa de miralls a tot el món perquè la gent en cada regió pugui triar un mirall proper amb la millor velocitat de descàrrega. Cadascuna de les opcions --mirror-* governa quin mirall de distribució s'utilitzara en les diverses etapes de la construcció. Recordar de Etapes de la construcció que l'etapa bootstrap es quan el chroot s'omple inicialment per debootstrap amb un sistema mínim i l'etapa chroot és quan s'utilitza el chroot per a la construcció de sistema d'fitxers del sistema en viu. D'aquesta manera, s'utilitzan els miralls corresponents per a aquestes etapes, i més tard, durant l'etapa binary s'utilitzan els valors --mirror-binary i --mirror-binary-security substituint qualsevol mirall utilitzat en una etapa anterior.

    8.1.3 Miralls de distribució utilitzats en temps de construcció

    Per establir els miralls de la distrubució utilitzats en temps de construcció perquè apuntin a una rèplica local, és suficient establir --mirror-bootstrap, --mirror-chroot-security i --mirror-chroot-backports de la manera següent.

    $ lb config --mirror-bootstrap http://localhost/debian/ \
                 --mirror-chroot-security http://localhost/debian-security/ \
          --mirror-chroot-backports http://localhost/debian-backports/

    El mirall per al chroot, especificat per l'opció --mirror-chroot, per defecte pren el mateix valor que --mirror-bootstrap

    8.1.4 Miralls de distribució utilitzats en temps d'execució

    Les opcions --mirror-binary* governen els miralls de distribució coŀlocats a la imatge binària. Aquestes poden ser utilitzades per instaŀlar paquets addicionals mentre s'executa el sistema en viu. Els valors per defecte utilitzan cdn.debian.net, un servei que tria un mirall geogràficament a prop en funció del número IP de l'usuari. Aquesta és una opció adequada quan no es pot predir quin serà el millor mirall per tots els usuaris. O es pot especificar els valors propis com es mostra en l'exemple següent. Una imatge construïda a partir d'aquesta configuració només seria convenient per als usuaris en una xarxa on "mirror" és abastable.

    $ lb config --mirror-binary http://mirror/debian/ \
                 --mirror-binary-security http://mirror/debian-security/

    8.1.5 Repositoris addicionals

    És possible afegir més repositoris, ampliant les opcions de paquets més enllà dels disponibles en la pròpia distribució de destinació. Aquests poden ser, per exemple, per backports, experimentals o paquets personalitzats. Per configurar repositoris addicionals, crear els fitxers config/archives/your-repository.list.chroot, i/o config/archives/your-repository.list.binary. Igual que amb les opcions --mirror-* aquest regeix els repositoris utilitzats en l'étapa chroot durant la construcció de la imatge, i a l'étapa binary, és a dir, per ser utilitzades quan s'executa el sistema en viu.

    Per exemple, config/archives/live.list.chroot permet d'instaŀlar paquets des del repositori de instantànies de debian live en el moment de creació del sistema viu.

    deb http://live.debian.net/ sid-snapshots main contrib non-free

    Si s'afegeix la mateixa línia a config/archives/live.list.binary, el repositori sera afegit al directori /etc/apt/sources.list.d/ del sistema viu.

    Si aquests fitxers existeixen, seran utilitzats de forma automàtica.

    També s'ha de posar la clau GPG utilitzada per signar el repositori en fitxers config/archives/your-repository.key.{binary,chroot}.

    Nota: alguns repositoris preconfigurats de paquets estan disponibles per facilitar la selecció a través de l'opció --archives, per exemple, per habilitar instantànies en viu, una ordre simple és suficient per activar-ho:

    $ lb config --archives live.debian.net

    8.2 Selecció dels paquets a instaŀlar

    Hi ha una sèrie de formes de triar els paquets que live-build instaŀlarà en la imatge, que abasta una varietat de necessitats diferents. Es pot simplement anomenar paquets individualment per instaŀlar en una llista de paquets. També es pot optar per llistes predefinides de paquets, o utilitzar les tasques d'APT. I, finalment, es poden coŀlocar paquets com si fossin fitxers dins del arbre config/, que és un mètode que s'adapta perfectament a fer proves amb paquets nous o experimentals abans de afegirlos a un repositori.

    8.2.1 Llistes de paquets

    Les llistes de paquets són una forma eficaç d'expressar quins paquets han de ser instaŀlats. La sintaxi de la llista suporta els fitxers inclosos i seccions condicionals que fa que sigui fàcil de construir llistes a partir d'altres llistes i adaptar-ler per al propi ús en múltiples configuracions. Es poden utilitzar llistes predefinides de paquets, proporcionant una selecció de paquets de forma modular de cada un dels principals entorns d'escriptori i algunes llistes per a fins especials, així com llistes estàndard a partir de les que es basen altres. També es pot proporcionar llistes pròpies de paquets, o utilitzar una combinació d'ambdós.

    Nota: El comportament de live-build a l'hora d'especificar un paquet que no existeix està determinat per la elecció que es faci de l'eina APT. Veure Elegir apt or aptitude per més detalls.

    8.2.2 Llistes predefinides de paquets

    La forma més senzilla d'utilitzar les llistes consisteix a especificar una o més llistes predefinides amb l'opció --package-lists. Per exemple:

    $ lb config --package-lists "gnome rescue"

    La ubicació per defecte de les llistes en el sistema és /usr/share/live/build/package-lists/. Per determinar els paquets en una llista donada, llegir el fitxer corresponent, prestant atenció als fitxers inclosos i els condicionals com es descriu a les següents seccions.

    8.2.3 Llistes locals de paquets

    Es poden completar les llistes predefinides mitjançant les llistes locals de paquets emmagatzemades a config/package-lists/.

    Les llistes de paquets que es troben en aquest directori han de tenir el sufix .list per ser processades, i a més a més un sufix d'etapa adicional .chroot o .binary per indicar per a quina etapa és la llista.

    Nota: Si no s'especifica el sufix d'etapa, la llista s'utilitzarà per a ambdues etapes. Normalment, s'especifica .list.chroot de manera que els paquets només s'instaŀlaran al sistema de fitxers en viu i no hi haura una còpia extra del .deb en els medis.

    8.2.4 Llistes locals de paquets per l'etapa binary

    Per crear una llista per a l'etapa binary, crear un fitxer amb el sufix .list.binary a config/package-lists/. Aquests paquets no s'instaŀlan al sistema de fitxers en viu però s'inclouen en els medis en viu a pool/. Un ús típic d'aquesta llista seria amb una de les variants del instaŀlador non-live. Com s'ha esmentat anteriorment, si es vol que aquesta llista sigui la mateixa que la llista de l'etapa chroot, simplement utilitzar el sufix .list.

    8.2.5 Ampliació d'una llista mitjançant includes

    Les llistes de paquets que s'inclouen amb live-build fan un ús extensiu dels includes. Es poden consultar al directori /usr/share/live/build/package-lists/ ja que serveixen com a bons exemples de com escriure llistes pròpies.

    Per exemple, per fer una llista que inclogui la llista predefinida gnome més iceweasel, crear config/package-lists/my.list.chroot amb el contingut:

    #include <gnome>
    iceweasel

    8.2.6 Ús de condicionals dins de les llistes de paquets

    Qualsevol de les variables de configuració de live-build emmagatzemades a config/* (menys el prefix LB_) poden ser utilitzades en sentències condicionals en les llistes de paquets. En general, això significa qualsevol opció lb config en lletres majuscules i amb guions canviats a guions baixos. Però a la pràctica, només tenen sentit les que influeixen en la selecció de paquets, com ara DISTRIBUTION, ARCHITECTURES o ARCHIVE_AREAS.

    Per exemple, per instaŀlar ia32-libs si s'especifica --architectures amd64:

    #if ARCHITECTURES amd64
    ia32-libs
    #endif

    És possible fer un test d'un qualsevol d'un nombre de valors, per exemple per instaŀlar memtest86+ si s'especifica --architectures i386 o --architectures amd64:

    #if ARCHITECTURES i386 amd64
    memtest86+
    #endif

    També es pot provar amb variables que poden contenir més d'un valor, per exemple, per instaŀlar vrms si s'especifica o contrib o non-free a través de l'opció --archive-areas:

    #if ARCHIVE_AREAS contrib non-free
    vrms
    #endif

    Un condicional pot envoltar una directiva #include:

    #if ARCHITECTURES amd64
    #include <gnome-full>
    #endif

    No és possible el anidament dels condicionals.

    8.2.7 Tasques

    L'instaŀlador de Debian ofereix al usuari opcions d'una sèrie de llistes de paquets preseleccionats, cadascuna centrada en un tipus particular de sistema, o una tasca per a la qual es pot utilitzar un sistema, com "Graphical desktop environment", "Mail server" o "Laptop". Aquestes llistes es diuen "tasks" (tasques) i son suportades per APT a través de l'opció "Task:" es poden especificar una o més tasques a live-build posant-les en una llista a config/task-lists/, com en l'exemple següent.

    $ lb config
    $ echo "mail-server file-server" >> config/task-lists/my.list.chroot

    Es poden llistar les principals tasques disponibles al instaŀlador de Debian amb tasksel --list-tasks al sistema viu. El contingut de qualsevol tasca, fins i tot les no estan incloses en aquesta llista, poden ser examinades amb tasksel --task-packages.

    8.2.8 Tasques d'escriptori i llenguatge

    Les tasques d'escriptori i el llenguatge són casos especials que necessiten una mica de planificació i configuració extra. Les imatges en viu són diferentes de les imatges de l'instaŀlador de Debian en aquest sentit. A l'instaŀlador de Debian, si el medi es va preparar per obtenir un tipus entorn d'escriptori en particular, la tasca corresponent s'instaŀlarà automàticament. Per tant hi ha tasques internes gnome-desktop, kde-desktop, lxde-desktop and xfce-desktop cap de les quals s'ofereixen al menú de tasksel. De la mateixa manera, no hi ha cap entrada de menú per a les tasques de les llengües, però l'elecció del idioma de l'usuari durant la instaŀlació influeix en la selecció de les tasques de llengües corresponents.

    En el desenvolupament d'una imatge en viu d'escriptori, la imatge sol arrencar directament a un escriptori de treball, les opcions d'escriptori i de llengua han estat fetes en temps de construcció, no en temps d'execució com en el cas del instaŀlador de Debian. Això no vol dir que una imatge en viu no es pugui construir per donar suport a diversos equips d'escriptori o diversos idiomes i oferir a l'usuari una opció, però això no és el comportament de live-build per defecte.

    Com que no hi ha cap ajust automàtic per les tasques de llengua que incloguin coses com ara fonts específiques per a una llengua o paquets de mètode d'entrada, si es vol, cal especificar-ho en la configuració. Per exemple, una imatge d'escriptori GNOME que contingui suport per al japonés podrie incloure les següents tasques:

    $ lb config
    $ echo "gnome-desktop desktop standard laptop" >> config/task-lists/my.list.chroot
    $ echo "japanese japanese-desktop japanese-gnome-desktop" >> config/task-lists/my.list.chroot

    Com les tasques d'escriptori són "internes" per a cada tasca d'escriptori inclosa en la imatge, el valor corresponent, si aquest és diferent del valor per defecte, "gnome", s'ha de fer servir la variable de preconfiguració "tasksel/desktop" o en cas contrari tasksel no la reconeixerà i no la instaŀlarà. Així:

    $ lb config
    $ echo 'tasksel tasksel/desktop multiselect kde' >> config/preseed/my.preseed.chroot

    Aquest paràmetre pot tenir diversos valors, per exemple "lxde xfce" en lloc de "kde".

    8.3 Instaŀlació de paquets modificats o de tercers

    Si bé està en contra de la filosofia de Debian Live, de vegades pot ser necessària la construcció d'un sistema en viu amb versions modificades dels paquets que es troben al arxiu de Debian. Pot ser per modificar or donar suport a funcions addicionals, les llengües o les marques, o fins i tot per eliminar elements dels paquets existents que són indesitjables. De la mateixa manera, es poden utilitzar paquets de tercers per afegir alguna funcionalitat personalitzada i/o propietària.

    Aquesta secció no cobreix l'assessorament en matèria de construcció o manteniment de paquets modificats. Però el métode de Joachim Breitner's 'How to fork privately' a ‹http://www.joachim-breitner.de/blog/archives/282-How-to-fork-privately.html› pot ser d'interès. La creació de paquets personalitzats es tracta a Debian New Maintainers' Guide at ‹http://www.debian.org/doc/maint-guide/› i en altres llocs.

    Hi ha dues formes d'instaŀlar paquets personalitzats modificats:

  • packages.chroot
  • L'ús d'un repositori APT personalitzat
  • Utilitzar packages.chroot és més fàcil d'aconseguir i útil per a personalitzacions "ràpides", però té una sèrie d'inconvenients, mentre que l'ús d'un repositori APT personalitzat és més costós en la quantitat de temps necessari.

    8.3.1 Fer servir packages.chroot per instaŀar paquets personalitzats

    Per instaŀar un paquet personalitzat, només s'ha de copiar al directori config/packages.chroot/. Els paquets que es troben dins d'aquest directori s'instaŀlaran automàticament en el sistema en viu durant la construcció - no cal especificar res més en cap altre lloc.

    Els paquets han de ser nomenats en la forma prescrita. Una manera simple de fer això és utilitzar dpkg-name.

    Utilitzar packages.chroot per a la instaŀlació de paquets personalitzats té els seus desavantatges:

  • No és possible utilitzar APT segur.
  • Cal posar tots els paquets apropiats al directori config/packages.chroot/.
  • No es presta per a l'emmagatzematge de configuracions de Debian Live en el control de revisió.
  • 8.3.2 Fer servir un repositori APT per instaŀlar paquets personalitzats

    A diferència de packages.chroot, quan s'utilitza un repositori APT personalitzat s'ha d'assegurar que s'especifiquen els paquets en un altre lloc. Veure Selecció dels paquets a instaŀlar per més detalls.

    Si bé crear un repositori APT per instaŀlar paquets personalitzats pot semblar un esforç innecessari, la infraestructura pot ser fàcilment reutilitzada en una data posterior per oferir actualitzacions dels paquets modificats.

    8.3.3 Paquets personalitzats i APT

    live-build utilitza APT per instaŀlar tots els paquets al sistema en viu per tant, heretarà els comportaments d'aquest programa. Un exemple rellevant és que (assumint una configuració per defecte) si es dóna el cas que un paquet està disponible en dos repositoris diferents, amb diferents números de versió, APT triarà per instaŀlar el paquet amb la versió més alta.

    A causa d'això, s'aconsella augmentar el nombre de versió dels paquets personalitzats als fixers debian/changelog per assegurar-se que la versió modificada és la que s'instaŀla en lloc d'una dels repositoris oficials de Debian. Això també es pot aconseguir mitjançant l'alteració de les preferències d'APT del sistema en viu - veure APT pinning per més informació.

    8.4 Configurar APT en temps de construcció

    Es pot configurar APT a través d'una sèrie d'opcions que només s'apliquen en temps de construcció. (La configuració d'APT al sistema en funcionament en viu es pot fer de forma normal per als continguts del sistema en viu, és a dir, mitjançant la inclusió de les configuracions adequades a través de config/includes.chroot/.) Per obtenir una llista completa, buscar les opcions que comencen amb apt a la pàgina del manual de lb_config.

    8.4.1 Seleccionar apt o aptitude

    Es pot optar per utilitzar apt o aptitude a l'hora d'instaŀlar paquets en temps de construcció. Quina utilitat s'usa es configura gràcies al argument --apt de lb config. Escollir el mètode d'implementació per al comportament preferit durant la instaŀlació de paquets, la diferència notable és la forma en que es manegen els paquets que falten.

  • apt: Amb aquest mètode, si un paquet que s'especifica falta, l'instaŀlació de paquets fallarà. Aquesta és la configuració per defecte.
  • aptitude: Amb aquest mètode, si s'especifica un paquet que falta, l'instaŀlació de paquets tindrà èxit.
  • 8.4.2 L'ús d'un proxy amb APT

    Una configuració típica d'APT és per fer front a la construcció d'una imatge darrere d'un proxy. Es pot especificar el proxy per APT amb les opcions --apt-ftp-proxy o --apt-http-proxy segons sigui necessari, per exemple,

    $ lb config --apt-http-proxy http://proxy/

    8.4.3 Afinar APT per estalviar espai

    Pot ser necessari estalviar espai en els medis destinats a la imatge, en aquest cas una o altra o ambdós de les següentes opcions poden ser d'interès.

    Si no es vol incloure els índexs d'APT en la imatge, es poden omitir amb:

    $ lb config --apt-indices false

    Això no influirà en les entrades de /etc/apt/sources.list, sinó simplement si /var/lib/apt conté els fitxers dels índexs o no. El desavantatge és que APT necessita aquests índexs per tal d'operar en el sistema en viu, així que abans d'executar per exemple apt-cache search o apt-get install, l'usuari primer ha fer un apt-get update per crear aquests índexs.

    Si es considera que la instaŀlació de tots els paquets recomanats infla massa la imatge, es pot desactivar aquesta opció per defecte d'APT amb:

    $ lb config --apt-recommends false

    El desavantatge aquí és que si no s'instaŀlen els paquets recomanats per un paquet determinat, és a dir, "els paquets que es troben junts amb aquest en totes les instaŀlacions a menys que siguin inusuals" (Debian Policy Manual, secció 7.2), els paquets que en realitat són necessaris poden ser omesos. Per tant, suggerim revisar la diferència que desactivar els paquets recomanats té en la llista de paquets (veure el fitxer binary.packages generat per lb build) i tornar a incloure a la llista els paquets que falten que haurien de ser instaŀlats. D'altra banda, si només es vol un petit nombre de paquets recomanats deixats de banda, es pot deixar els paquets recomanats activat i establir una prioritat pin d'APT negativa en els paquets seleccionats per impedir la seva instaŀlació, com s'explica a APT pinning.

    8.4.4 Passar opcions per a apt o aptitude

    Si no hi ha una opció lb config per modificar el comportament d'APT tal i com es necessita, utilitzar --apt-options o --aptitude-options per passar alguna opció a través de l'eina APT configurada. Consultar les pàgines del manual de apt i aptitude per a més detalls.

    8.4.5 APT pinning

    Com a referència, llegir primer la pàgina del manual apt_preferences(5). Es pot configurar APT pinning tant pel temps de construcció, o bé per temps d'execució. En el primer cas, crear config/chroot_apt/preferences. Per aquest últim cas, crear config/includes.chroot/etc/apt/preferences.

    Suposem que s'està construint un sistema en viu wheezy però es necessita que tots els paquets en viu que acaben en la imatge binària s'instaŀlin desde sid en temps de construcció. Cal afegir sid a les fonts d'APT i fer un pin de manera que només els paquets que es vol s'instaŀlin en el moment de la construcció i tots els altres es preguin de la distribució de destinació, wheezy. El que segueix aconseguira això:

    $ echo "deb http://mirror/debian sid main" > config/archives/sid.list.chroot
    $ cat >> config/chroot_apt/preferences << END
    Package: live-boot live-boot-initramfs-tools live-config live-config-sysvinit
    Pin: release n=sid
    Pin-Priority: 600

    Package: *
    Pin: release n=sid
    Pin-Priority: 1
    END

    Nota: Es poden usar comodins en els noms dels paquets (per exemple, Package: live-*) amb la versió 0.8.14 o superior d'Apt. Això significa que funciona amb wheezy utilitzant:

    $ lb config --distribution wheezy

    Una prioritat pin negativa evitarà que un paquet s'instaŀli, com en el cas que no es vulgui un paquet que és recomanat per un altre paquet. Suposem que s'està construint una imatge LXDE amb --package-lists lxde però no es desitja que al usuari se li demani que guardi les contrasenyes wifi al clauer. Aquesta llista inclou gdm, que depèn de gksu, que al seu torn recomana gnome-keyring. Si es vol omitir el paquet recomanat gnome-keyring això es pot fer mitjançant l'addició de les següents línies al config/chroot_apt/preferences:

    Package: gnome-keyring
    Pin: version *
    Pin-Priority: -1

    9. Personalització dels continguts

    Aquest capítol tracta d'afinar la personalització dels continguts del sistema en viu més enllà de simplement triar els paquets que es desitja incloure. Els «includes» permeten afegir o reemplaçar fitxers arbitraris en la imatge Debian Live, els scripts ganxo (hooks) permeten executar ordres arbitràries en diferents etapes de la construcció i en el moment d'arrencar, i la preconfiguració permet configurar paquets quan s'instaŀlen mitjançant respostes a les preguntes de debconf .

    9.1 Includes

    Tot i que l'ideal seria un sistema Debian Live que inclogués només fitxers proporcionats per paquets Debian sense modificació, de vegades és convenient proporcionar o modificar part del contingut a través de fitxers. Amb els includes, és possible afegir (o substituir) fitxers arbitraris en la imatge Debian Live. live-build ofereix tres mecanismes per al seu ús:

  • Chroot local includes: Aquests permeten afegir o substituir fitxers dintre de chroot/Live en el sistema de fitxers. Consultar Live/chroot local includes per a més informació.
  • Binary local includes: Aquests et permeten afegir o substituir fitxers a la imatge binària. Consultar Binary local includes per a més informació.
  • Binary includes: Aquests et permeten afegir o substituir els fitxers específics de Debian a la imatge binària, com ara les plantilles i directoris d'eines. Consultar Binary includes per a més informació.
  • Consultar Termes per a més informació sobre la distinció entre les imatges "Live" and "binary".

    9.1.1 Live/chroot local includes

    Es poden utilitzar els chroot local includes per afegir o reemplaçar fitxers en el sistema de fitxers chroot/Live perquè puguin ser utilitzats en el sistema en viu. Un ús típic és per omplir l'esquelet de directori d'usuari (/etc/skel)utilitzat pel sistema en viu per crear el directori home de l'usuari en viu. Un altre és el de subministrar fitxers de configuració que poden ser simplement afegits o reemplaçats en la imatge sense processar; veure Live/chroot local hooks si es necessita processar-los.

    Per incloure fitxers, només s'han d'afegir al directori config/includes.chroot. Aquest directori es correspon amb el directori arrel / del sistema en viu. Per exemple, per afegir un fitxer /var/www/index.html en el sistema en viu, fer:

    $ mkdir -p config/includes.chroot/var/www
    $ cp /path/to/my/index.html config/includes.chroot/var/www

    La configuració tindrà llavors l'estructura següent:

    -- config
        [...]
         |-- includes.chroot
         |   `-- var
         |       `-- www
         |           `-- index.html
        [...]
         `-- templates

    Els chroot local includes s'instaŀlen després de la instaŀlació del paquets de tal manera que es sobreescriuen els fitxers instaŀlats pels paquets.

    9.1.2 Binary local includes

    Per incloure material com documentació o vídeos en el sistema de fitxers dels medis de manera que sigui accessible immediatament després de la inserció dels medis sense haver de arrencar el sistema en viu, es pot utilitzar els binary local includes. Això funciona de manera similar als chroot local includes. Per exemple, si els fitxers ~/video_demo.* són vídeos de demostració del sistema en viu descrits i lligats per una pàgina d'índex HTML. Només cal copiar el material a config/includes.binary/ de la següent manera:

    $ cp ~/video_demo.* config/includes.binary/

    Aquests fitxers apareixeran ara en el directori arrel dels medis en viu.

    9.1.3 Binary includes

    live-build té alguns fitxers estàndard (com ara la documentació) que s'inclouen en la configuració per defecte de tots els medis en viu. Això es pot desactivar amb:

    $ lb config --includes none

    En cas contrari, el material serà instaŀlat per live-build a /includes/ per defecte en el sistema de fitxers dels medis o bé es pot especificar una ruta alternativa amb l'opció --includes.

    9.2 Scripts ganxo (Hooks)

    Els scripts ganxo permeten executar ordres en les etapes de la construcció chroot i binary per tal de personalitzar la imatge.

    9.2.1 Live/chroot local hooks

    Per executar ordres en l'etapa chroot, crear un script ganxo al directori config/hooks/ amb el sufix .chroot que contingui les ordres. El ganxo s'executarà en el chroot després que la resta de la configuració del chroot s'hagi aplicat, assegurar-se que la configuració inclou tots els paquets i els fitxers que el ganxo necessita per funcionar. Veure els scripts chroot d'exemple per a diverses tasques comunes de personalització que es poden trovar a /usr/share/live/build/examples/hooks que es poden copiar o fer un enllaç simbòlic per utilitzar-los en la configuració pròpia.

    9.2.2 Scripts ganxo durant l'arrencada

    Per executar ordres durant l'arrencada, es pot proporcionar scripts ganxo live-config com s'explica a la secció "Personalització" de la seva pàgina de manual. Es poden proporcionar els ganxos de live-config a /lib/live/config/, tenint en compte la seqüència dels números. A continuació, proporcionar el script ganxo propi amb el prefix d'un número de seqüència apropiat, ja sigui com a un chroot local include a config/includes.chroot/lib/live/config/, o com un paquet personalitzat com es va discutir a Instaŀlació de paquets modificats o de tercers.

    9.2.3 Binary local hooks

    Per executar ordres a l'etapa binary, crear un script ganxo amb un sufix .binary que contingui les ordres al directori config/hooks/. El ganxo s'executarà després que s'executin totes les ordres de la etapa binary però avans dels binary_checksums, la darrera ordre de la etapa binary. Les ordres del ganxo no s'executen al chroot, per tant tenir cura de no modificar cap fitxer de fora del arbre de construcció, o es pot fer malbé el sistema de creació! Veure els scripts ganxo de binary per a diverses tasques comunes de personalització a /usr/share/live/build/examples/hooks que es poden copiar o fer un enllaç simbòlic per utilitzar-los en la configuració pròpia.

    9.3 Preconfiguració de les preguntes de Debconf

    Els fitxers del directory config/preseed/ amb el sufix .preseed seguits del sufix de la etapa (.chroot o .binary) son considerats fitxers de preconfiguració de debconf i són instaŀlats per live-build utilitzant debconf-set-selections durant l'etapa corresponent.

    Per a més informació sobre debconf, veure debconf(7) del paquet debconf.

    10. Customizing run time behaviours

    All configuration that is done during run time is done by live-config. Here are some of the most common options of live-config that users are interested in. A full list of all possibilities can be found in the manpage of live-config.

    10.1 Customizing the live user

    One important consideration is that the live user is created by live-boot at boot time, not by live-build at build time. This not only influences where materials relating to the live user are introduced in your build, as discussed in Live/chroot local includes, but also any groups and permissions associated with the live user.

    You can specify additional groups that the live user will belong to by preseeding the passwd/user-default-groups debconf value. For example, to add the live user to the fuse group, add the following preseed under config/preseed/ for the chroot stage:

    $ lb config
    $ echo user-setup passwd/user-default-groups string audio cdrom \
       dip floppy video plugdev netdev powerdev scanner bluetooth fuse \
       >> config/preseed/my.preseed.chroot

    It is also possible to change the default username "user" and the default password "live". If you want to do that for any reason, you can easily achieve it as follows:

    To change the default username you can simply specify it in your config:

    $ lb config --bootappend-live "username=live-user"

    One possible way of changing the default password is by means of a hook as described in Boot-time hooks. In order to do that you can use the "passwd" hook from /usr/share/doc/live-config/examples/hooks, prefix it accordingly (e.g. 2000-passwd) and add it to config/includes.chroot/lib/live/config/

    10.2 Customizing locale and language

    When the live system boots, language is involved in two steps:

  • the locale generation
  • setting the keyboard configuration
  • The default locale when building a Live system is locales=en_US.UTF-8. To define the locale that should be generated, use the locales parameter in the --bootappend-live option of lb config, e.g.

    $ lb config --bootappend-live "locales=de_CH.UTF-8"

    Multiple locales may be specified as a comma-delimited list.

    This parameter, as well as the keyboard configuration parameters indicated below, can also be used at the kernel command line. You can specify a locale by language_country (in which case the default encoding is used) or the full language_country.encoding word. A list of supported locales and the encoding for each can be found in /usr/share/i18n/SUPPORTED.

    Both the console and X keyboard configuration are performed by live-config using the console-setup package. To configure them, use the keyboard-layouts, keyboard-variant, keyboard-options and keyboard-model boot parameters via the --bootappend-live option. Valid options for these can be found in /usr/share/X11/xkb/rules/base.lst. To find layouts and variants for a given language, try searching for the English name of the language and/or the country where the language is spoken, e.g:

    $ egrep -i '(^!|german.*switzerland)' /usr/share/X11/xkb/rules/base.lst
    ! model
    ! layout
       ch              German (Switzerland)
    ! variant
       legacy          ch: German (Switzerland, legacy)
       de_nodeadkeys   ch: German (Switzerland, eliminate dead keys)
       de_sundeadkeys  ch: German (Switzerland, Sun dead keys)
       de_mac          ch: German (Switzerland, Macintosh)
    ! option

    Note that each variant lists the layout to which it applies in the description.

    Often, only the layout needs to be configured. For example, to get the locale files for German and Swiss German keyboard layout in X use:

    $ lb config --bootappend-live "locales=de_CH.UTF-8 keyboard-layouts=ch"

    However, for very specific use cases, you may wish to include other parameters. For example, to set up a French system with a French-Dvorak layout (called Bepo) on a TypeMatrix EZ-Reach 2030 USB keyboard, use:

    $ lb config --bootappend-live \
         "locales=fr_FR.UTF-8 keyboard-layouts=fr keyboard-variant=bepo keyboard-model=tm2030usb"

    Multiple values may be specified as comma-delimited lists for each of the keyboard-* options, with the exception of keyboard-model, which accepts only one value. Please see the keyboard(5) man page for details and examples of XKBMODEL, XKBLAYOUT, XKBVARIANT and XKBOPTIONS variables. If multiple keyboard-variant values are given, they will be matched one-to-one with keyboard-layouts values (see setxkbmap(1) -variant option). Empty values are allowed; e.g. to define two layouts, the default being US QWERTY and the other being US Dvorak, use:

    $ lb config --bootappend-live \
         "keyboard-layouts=us,us keyboard-variant=,dvorak"

    10.3 Persistence

    A live cd paradigm is a pre-installed system which runs from read-only media, like a cdrom, where writes and modifications do not survive reboots of the host hardware which runs it.

    A Debian Live system is a generalization of this paradigm and thus supports other media in addition to CDs; but still, in its default behaviour, it should be considered read-only and all the run-time evolutions of the system are lost at shutdown.

    'Persistence' is a common name for different kinds of solutions for saving across reboots some, or all, of this run-time evolution of the system. To understand how it works it would be handy to know that even if the system is booted and run from read-only media, modifications to the files and directories are written on writable media, typically a ram disk (tmpfs) and ram disks' data do not survive reboots.

    The data stored on this ramdisk should be saved on a writable persistent medium like local storage media, a network share or even a session of a multisession (re)writable CD/DVD. All these media are supported in Debian Live in different ways, and all but the last one require a special boot parameter to be specified at boot time: persistence.

    If the boot parameter persistence is set (and nopersistence is not set), local storage media (e.g. hard disks, USB drives) will be probed for persistence volumes during boot. It is possible to restrict which types of persistence volumes to use by specifying certain boot parameters described in the live-boot(7) man page. A persistence volume is any of the following:

  • a partition, identified by its GPT name.
  • a filesystem, identified by its filesystem label.
  • an image file located on the root of any readable filesystem (even an NTFS partition of a foreign OS), identified by its file name. In this case the file name must also use the containing filesystem as the file extension, e.g. "persistence.ext4".
  • The volume label for overlays must be persistence. And in order to fully customize the volume's persistence there must be a file named live-persistence.conf. See The live-persistence.conf file

    Here are some examples of how to prepare a volume to be used for persistence. It can be, for instance, an ext4 partition on a hard disk or on a usb key created with, e.g.:

    # mkfs.ext4 -L persistence /dev/sdb1

    See also Using the space left on a USB stick.

    If you already have a partition on your device, you could just change the label with one of the following:

    # tune2fs -L persistence /dev/sdb1 # for ext2,3,4 filesystems

    Here's an example of how to create an ext4-based image file used for persistence:

    $ dd if=/dev/null of=persistence bs=1G seek=1 # for a 1GB sized image file
    $ /sbin/mkfs.ext4 -F persistence

    Then copy the persistence file to the root of a writable partition.

    10.3.1 The live-persistence.conf file

    A volume with the label persistence can be configured to make arbitrary directories persistent. The file live-persistence.conf, located on the volume's filesystem root, controls which directories it makes persistent, and in which way.

    How custom overlay mounts are configured is described in full detail in the live-persistence.conf(5) man page, but a simple example should be sufficient for most uses. Let's say we want to make our home directory and APT cache persistent in an ext4 filesystem on the /dev/sdb1 partition:

    # mkfs.ext4 -L persistence /dev/sdb1
    # mount -t ext4 /dev/sdb1 /mnt
    # echo "/home" >> /mnt/live-persistence.conf
    # echo "/var/cache/apt" >> /mnt/live-persistence.conf

    Then we reboot. During the first boot the contents of /home and /var/cache/apt will be copied into the persistence volume, and from then on all changes to these directories will live in the persistence volume. Please note that any paths listed in the live-persistence.conf file cannot contain white spaces or the special . and .. path components. Also, neither /live (or any of its sub-directories) nor / can be made persistent using custom mounts.

    Several different custom overlay volumes (with their own live-persistence.conf files) can be used at the same time, but if several volumes make the same directory persistent, only one of them will be used. If any two mounts are "nested" (i.e. one is a sub-directory of the other) the parent will be mounted before the child so no mount will be hidden by the other. Nested custom mounts are problematic if they are listed in the same live-persistence.conf file. See the live-persistence.conf(5) man page for how to handle that case if you really need it (hint: you usually don't).

    10.3.2 Using more than one persistence store

    If a user would need multiple persistence store of the same type for different locations or testing, such as persistence-nonwork and persistence-work, the boot parameter persistence-label used in conjunction with the boot parameter persistence will allow for multiple but unique persistence media. An example would be if a user wanted to use a persistence partition labeled persistence-subText they would use the boot parameters of: persistence persistence-label=subText.

    11. Customizing the binary image

    11.1 Bootloader

    live-build uses syslinux and some of its derivatives (depending on the image type) as bootloaders by default. You can easily customize them in a number of ways that range from providing a full theme to changing the boot timeout or simply adding a personalized splash image. Some of the following examples of customization make use of different methods, like includes or hooks.

    If you want to use a full theme you can specify the --syslinux-theme option (see man lb_config). live-build will then retrieve the theme from the mirror and install it.

    Imagine that you want to build a progress client but you prefer to include the server's theme because you want to have the help menu. Then you would launch lb config as follows:

    $ lb config --mode progress --syslinux-theme progress-server

    You can also create your own theme or modify an already existing one and if you do not have a mirror, you can add the package to config/packages.chroot. In this case it is not necessary to specify any option.

    There is also the possibility of making smaller changes. For instance, syslinux derivatives are configured by default with a timeout of 0 (zero) which means that they will pause indefinitely at their splash screen until you press a key.

    To modify the boot timeout of a default iso-hybrid image you can edit a default isolinux.cfg file specifying the timeout in units of seconds and add it to config/includes.binary/isolinux/

    A modified isolinux.cfg to boot after five seconds would be similar to this:

    include menu.cfg
    default vesamenu.c32
    prompt 0
    timeout 50

    An alternative way of achieving the same goal could be writing a hook and adding it to config/hooks/ Remember to add the .binary suffix to run in the binary stage. A proposed example:

    #!/bin/sh

    sed -i 's|timeout 0|timeout 50|' binary/isolinux/isolinux.cfg

    Likewise, if you want to use a personalized splash.png image you can add a picture of 640x480 pixels to config/includes.binary/isolinux/

    11.2 ISO metadata

    When creating an ISO9660 binary image, you can use the following options to add various textual metadata for your image. This can help you easily identify the version or configuration of an image without booting it.

  • LB_ISO_APPLICATION/--iso-application NAME: This should describe the application that will be on the image. The maximum length for this field is 128 characters.
  • LB_ISO_PREPARER/--iso-preparer NAME: This should describe the preparer of the image, usually with some contact details. The default for this option is the live-build version you are using, which may help with debugging later. The maximum length for this field is 128 characters.
  • LB_ISO_PUBLISHER/--iso-publisher NAME: This should describe the publisher of the image, usually with some contact details. The maximum length for this field is 128 characters.
  • LB_ISO_VOLUME/--iso-volume NAME: This should specify the volume ID of the image. This is used as a user-visible label on some platforms such as Windows and Apple Mac OS. The maximum length for this field is 32 characters.
  • 12. Customizing Debian Installer

    Debian Live system images can be integrated with Debian Installer. There are a number of different types of installation, varying in what is included and how the installer operates.

    Please note the careful use of capital letters when referring to the "Debian Installer" in this section - when used like this we refer explicitly to the official installer for the Debian system, not anything else. It is often seen abbreviated to "d-i".

    12.1 Types of Debian Installer

    The three main types of installer are:

    "Regular" Debian Installer: This is a normal Debian Live image with a separate kernel and initrd which (when selected from the appropriate bootloader) launches into a standard Debian Installer instance, just as if you had downloaded a CD image of Debian and booted it. Images containing a live system and such an otherwise independent installer are often referred to as "combined images".

    On such images, Debian is installed by fetching and installing .deb packages using debootstrap or cdebootstrap, from the local media or some network-based network, resulting in a standard Debian system being installed to the hard disk.

    This whole process can be preseeded and customized in a number of ways; see the relevant pages in the Debian Installer manual for more information. Once you have a working preseeding file, live-build can automatically put it in the image and enable it for you.

    "Live" Debian Installer: This is a Debian Live image with a separate kernel and initrd which (when selected from the appropriate bootloader) launches into an instance of the Debian Installer.

    Installation will proceed in an identical fashion to the "Regular" installation described above, but at the actual package installation stage, instead of using debootstrap to fetch and install packages, the live filesystem image is copied to the target. This is achieved with a special udeb called live-installer.

    After this stage, the Debian Installer continues as normal, installing and configuring items such as bootloaders and local users, etc.

    Note: to support both normal and live installer entries in the bootloader of the same live media, you must disable live-installer by preseeding live-installer/enable=false.

    "Desktop" Debian Installer: Regardless of the type of Debian Installer included, d-i can be launched from the Desktop by clicking on an icon. This is user friendlier in some situations. In order to make use of this, the debian-installer-launcher package needs to be included.

    Note that by default, live-build does not include Debian Installer images in the images, it needs to be specifically enabled with lb config. Also, please note that for the "Desktop" installer to work, the kernel of the live system must match the kernel d-i uses for the specified architecture. For example:

    $ lb config --architectures i386 --linux-flavours 486 \
         --debian-installer live
    $ echo debian-installer-launcher >> config/package-lists/my.list.chroot

    12.2 Customizing Debian Installer by preseeding

    As described in the Debian Installer Manual, Appendix B at ‹http://www.debian.org/releases/stable/i386/apb.html›, "Preseeding provides a way to set answers to questions asked during the installation process, without having to manually enter the answers while the installation is running. This makes it possible to fully automate most types of installation and even offers some features not available during normal installations." This kind of customization is best accomplished with live-build by placing the configuration in a preseed.cfg file included in config/binary_debian-installer/. For example, to preseed setting the locale to en_US:

    $ echo "d-i debian-installer/locale string en_US" \
         >> config/binary_debian-installer/preseed.cfg

    12.3 Customizing Debian Installer content

    For experimental or debugging purposes, you might want to include locally built d-i component udeb packages. Place these in config/packages.binary/ to include them in the image. Additional or replacement files and directories may be included in the installer initrd as well, in a similar fashion to Live/chroot local includes, by placing the material in config/includes.binary_debian-installer/.

    Projecte

    13. Reporting bugs

    Debian Live is far from being perfect, but we want to make it as close as possible to perfect - with your help. Do not hesitate to report a bug: it is better to fill a report twice than never. However, this chapter includes recommendations how to file good bug reports.

    Per als impacients

  • Always check first the image status updates on our homepage at ‹http://live.debian.net/› for known issues.
  • Always try to reproduce the bug with the most recent versions of live-build, live-boot, live-config and live-tools before submitting a bug report.
  • Try to give as specific information as possible about the bug. This includes (at least) the version of live-build, live-boot, live-config, and live-tools used and the distribution of the live system you are building.
  • 13.1 Known issues

    Because Debian testing and Debian unstable distributions are a moving target, when you specify either as the target system distribution, a successful build may not always be possible.

    If this causes too much difficulty for you, do not build a system based on testing or unstable, but rather, use stable. live-build does always default to the stable release.

    Currently known issues are listed under the section 'status' on our homepage at ‹http://live.debian.net/›.

    It is out of the scope of this manual to train you to correctly identify and fix problems in packages of the development distributions, however, there are two things you can always try: If a build fails when the target distribution is testing, try unstable. If unstable does not work either, revert to testing and pin the newer version of the failing package from unstable (see APT pinning for details).

    13.2 Rebuild from scratch

    To ensure that a particular bug is not caused by an uncleanly built system, please always rebuild the whole live system from scratch to see if the bug is reproducible.

    13.3 Use up-to-date packages

    Using outdated packages can cause significant problems when trying to reproduce (and ultimately fix) your problem. Make sure your build system is up-to-date and any packages included in your image are up-to-date as well.

    13.4 Collect information

    Please provide enough information with your report. At least include the exact version of live-build version where the bug is encountered and steps to reproduce it. Please use common sense and include other relevant information if you think that it might help in solving the problem.

    To make the most out of your bug report, we require at least the following information:

  • Architecture of the host system
  • Version of live-build on the host system
  • Version of live-boot on the live system
  • Version of live-config on the live system
  • Version of live-tools on the live system
  • Version of debootstrap and/or cdebootstrap on the host system
  • Architecture of the live system
  • Distribution of the live system
  • Version of the kernel on the live system
  • You can generate a log of the build process by using the tee command. We recommend doing this automatically with an auto/build script; (see Managing a configuration for details).

    # lb build 2>&1 | tee build.log

    At boot time, live-boot stores a log in /var/log/live-boot.log.

    Additionally, to rule out other errors, it is always a good idea to tar up your config/ directory and upload it somewhere (do not send it as an attachment to the mailing list), so that we can try to reproduce the errors you encountered. If this is difficult (e.g. due to size) you can use the output of lb config --dump which produces a summary of your config tree (i.e. lists files in subdirectories of config/ but does not include them).

    Remember to send in any logs that were produced with English locale settings, e.g. run your live-build commands with a leading LC_ALL=C or LC_ALL=en_US.

    13.5 Isolate the failing case if possible

    If possible, isolate the failing case to the smallest possible change that breaks. It is not always easy to do this, so if you can't manage it for your report, don't worry. However, if you plan your development cycle well, using small enough change sets per iteration, you may be able to isolate the problem by constructing a simpler 'base' configuration that closely matches your actual configuration plus just the broken change set added to it. If you have a hard time sorting out which of your changes broke, it may be that you are including too much in each change set and should develop in smaller increments.

    13.6 Use the correct package to report the bug against

    If you don't know what component is responsible for the bug or if the bug is a general bug concerning live systems, you can fill a bug against the debian-live pseudo-package.

    However, we would appreciate if you try to narrow it down according to where the bug appears.

    13.6.1 At build time whilst bootstrapping

    live-build first bootstraps a basic Debian system with debootstrap or cdebootstrap. Depending on the bootstrapping tool used and the Debian distribution it is bootstrapping, it may fail. If a bug appears here, check if the error is related to a specific Debian package (most likely), or if it is related to bootstrapping tool itself.

    In both cases, this is not a bug in Debian Live, but rather in Debian itself which we can not fix this directly. Please report such a bug against the bootstrapping tool or the failing package.

    13.6.2 At build time whilst installing packages

    live-build installs additional packages from the Debian archive and depending on the Debian distribution used and the daily archive state, it can fail. If a bug appears here, check if the error is also reproducible on a normal system.

    If this is the case, this is not a bug in Debian Live, but rather in Debian - please report it against the failing package. Running debootstrap separately from the Live system build or running lb bootstrap --debug will give you more information.

    Also, if you are using a local mirror and/or any of sort of proxy and you are experiencing a problem, please always reproduce it first by bootstrapping from an official mirror.

    13.6.3 At boot time

    If your image does not boot, please report it to the mailing list together with the information requested in Collect information. Do not forget to mention, how/when the image failed, in Qemu, Virtualbox, VMWare or real hardware. If you are using a virtualization technology of any kind, please always run it on real hardware before reporting a bug. Providing a screenshot of the failure is also very helpful.

    13.6.4 At run time

    If a package was successfully installed, but fails while actually running the Live system, this is probably a bug in Debian Live. However,

    13.7 Do the research

    Before filing the bug, please search the web for the particular error message or symptom you are getting. As it is highly unlikely that you are the only person experiencing a particular problem, there is always a chance that it has been discussed elsewhere, and a possible solution, patch, or workaround has been proposed.

    You should pay particular attention to the Debian Live mailing list, as well as the homepage, as these are likely to contain the most up-to-date information. If such information exists, always include the references to it in your bug report.

    In addition, you should check the current bug lists for live-build, live-boot, live-config and live-tools to see whether something similar has been reported already.

    13.8 Where to report bugs

    The Debian Live project keeps track of all bugs in the Debian Bug Tracking System (BTS). For information on how to use the system, please see ‹http://bugs.debian.org/›. You can also submit the bugs by using the reportbug command from the package with the same name.

    In general, you should report build time errors against the live-build package, boot time errors against live-boot, and run time errors against live-config. If you are unsure of which package is appropriate or need more help before submitting a bug report, please report it against the debian-live pseudo-package. We will then take care about it and reassign it where appropriate.

    Please note that bugs found in distributions derived from Debian (such as Ubuntu and others) should not be reported to the Debian BTS unless they can be also reproduced on a Debian system using official Debian packages.

    14. Coding Style

    This chapter documents the coding style used in live-boot and others.

    14.1 Compatibility
  • Don't use syntax or semantics that are unique to the Bash shell. For example, the use of array constructs.
  • Only use the POSIX subset - for example, use $(foo) over `foo`.
  • You can check your scripts with 'sh -n' and 'checkbashisms'.
  • Make sure all shell code runs with 'set -e'.
  • 14.2 Indenting
  • Always use tabs over spaces.
  • 14.3 Wrapping
  • Generally, lines are 80 chars at maximum.
  • Use the "Linux style" of line breaks:
  • Bad:

    if foo; then
             bar
    fi

    Good:

    if foo
    then
             bar
    fi

  • The same holds for functions:
  • Bad:

    Foo () {
             bar
    }

    Good:

    Foo ()
    {
             bar
    }

    14.4 Variables
  • Variables are always in capital letters.
  • Variables that used in lb config always start with LB_ prefix.
  • Internal temporary variables in live-build should start with the _LB_ prefix.
  • Local variables start with live-build __LB_ prefix.
  • Variables in connection to a boot parameter in live-config start with LIVE_.
  • All other variables in live-config start with _ prefix.
  • Use braces around variables; e.g. write ${FOO} instead of $FOO.
  • Always protect variables with quotes to respect potential whitespaces: write "${FOO}" not ${FOO}.
  • For consistency reasons, always use quotes when assigning values to variables:
  • Bad:

    FOO=bar

    Good:

    FOO="bar"

  • If multiple variables are used, quote the full expression:
  • Bad:

    if [ -f "${FOO}"/foo/"${BAR}"/bar ]
    then
             foobar
    fi

    Good:

    if [ -f "${FOO}/foo/${BAR}/bar" ]
    then
             foobar
    fi

    14.5 Miscellaneous
  • Use "|" (without the surround quotes) as a separator in calls to sed, e.g. "sed -e 's|foo|bar|'" (without "").
  • Don't use the test command for comparisons or tests, use "[" "]" (without ""); e.g. "if [ -x /bin/foo ]; ..." and not "if test -x /bin/foo; ...".
  • Use case wherever possible over test, as it's easier to read and faster in execution.
  • Use capitalized names for functions to limit messing with the users environment.
  • 15. Procedures

    This chapter documents the procedures within the Debian Live project for various tasks that need cooperation with other teams in Debian.

    15.1 Udeb Uploads

    Before commiting releases of a udeb in d-i svn, one has to call:

    $ ../../scripts/l10n/output-l10n-changes . -d

    15.2 Major Releases

    Releasing a new stable major version of Debian includes a lot of different teams working together to make it happen. At some point, the Live team comes in and builds live system images. The requirements to do this are:

  • A mirror containing the released versions for the debian, debian-security and debian-volatile archive which the debian-live buildd can access.
  • The names of the image need to be known (e.g. debian-live-VERSION-ARCH-FLAVOUR.iso).
  • The packagelists need to have been updated.
  • The data from debian-cd needs to be synced (udeb exclude lists).
  • The includes from debian-cd needs to be synced (README.*, doc/*, etc.).
  • Images are built and mirrored on cdimage.debian.org.
  • 15.3 Point Releases
  • Again, we need updated mirrors of debian, debian-security and debian-volatile.
  • Images are built and mirrored on cdimage.debian.org.
  • Send announcement mail.
  • 15.3.1 Last Point Release of a Debian Release

    Remember to adjust both chroot and binary mirrors when building the last set of images for a Debian release after it has been moved away from ftp.debian.org to archive.debian.org. That way, old prebuilt live images are still useful without user modifications.

    15.3.2 Point release announcement template

    An annoucement mail for point releases can be generated using the template below and the following command:

    $ sed \
         -e 's|%major%|5.0|g' \
         -e 's|%minor%|5.0.2|g' \
         -e 's|%codename%|lenny|g' \
         -e 's|%release_mail%|2009/msg00007.html|g'

    Please check the mail carefully before sending and pass it to others for proof-reading.

    Debian Live images for Debian GNU/Linux %major% updated

    The Debian Live project is pleased to announce the availability of
    updated Live images for its stable distribution Debian GNU/Linux %major%
    (codename "%codename%").

    The images are available for download at:

         <http://cdimage.debian.org/cdimage/release/current-live/>

    This update incorporates the changes made in the %minor% point release,
    which adds corrections for security problems to the stable release
    along with a few adjustments for serious problems. A full list of the
    changes may be viewed at:

         <http://lists.debian.org/debian-announce/%release_mail%>

    It also includes the following Live-specific changes:

      * [INSERT LIVE-SPECIFIC CHANGE HERE]
      * [INSERT LIVE-SPECIFIC CHANGE HERE]
      * [LARGER ISSUES MAY DESERVE THEIR OWN SECTION]

    URLs
    ----

    Download location of updated images:

       <http://cdimage.debian.org/cdimage/release/current-live/>

    Pàgina web del Projecte Debian Live:

       <http://live.debian.net/>

    The current stable distribution:

       <http://ftp.debian.org/debian/dists/stable>

    stable distribution information (release notes, errata etc.):

       <http://www.debian.org/releases/stable/>

    Security announcements and information:

       <http://www.debian.org/security/>

    About Debian
    -------------

    The Debian Project is an association of Free Software developers who
    volunteer their time and effort in order to produce the completely free
    operating system Debian GNU/Linux.

    About Debian Live
    -----------------

    Debian Live is an official sub-project of Debian which produces Debian
    systems that do not require a classical installer. Images are available
    for CD/DVD discs, USB sticks and PXE netbooting as well as a bare
    filesystem images for booting directly from the internet.

    Contact Information
    -------------------

    For further information, please visit the Debian Live web pages at
    <http://live.debian.net/> or alternatively send mail to
    <debian-live@lists.debian.org>.

    Exemples

    16. Examples

    This chapter covers example builds for specific use cases with Debian Live. If you are new to building your own Debian Live images, we recommend you first look at the three tutorials in sequence, as each one teaches new techniques that will help you use and understand the remaining examples.

    16.1 Using the examples

    To use these examples you need a system to build them on that meets the requirements listed in Requirements and has live-build installed as described in Installing live-build.

    Note that, for the sake of brevity, in these examples we do not specify a local mirror to use for the build. You can speed up downloads considerably if you use a local mirror. You may specify the options when you use lb config, as described in Distribution mirrors used at build time, or for more convenience, set the default for your build system in /etc/live/build.conf. Simply create this file and in it, set the corresponding LB_MIRROR_* variables to your preferred mirror. All other mirrors used in the build will be defaulted from these values. For example:

    LB_MIRROR_BOOTSTRAP="http://mirror/debian"
    LB_MIRROR_CHROOT_SECURITY="http://mirror/debian-security"
    LB_MIRROR_CHROOT_BACKPORTS="http://mirror/debian-updates"

    16.2 Tutorial 1: A standard image

    Use case: Create a simple first image, learning the basics of live-build.

    In this tutorial, we will build a default ISO hybrid Debian Live image containing only base packages (no Xorg) and some Debian Live support packages, as a first exercise in using live-build.

    You can't get much simpler than this:

    $ mkdir tutorial1 ; cd tutorial1 ; lb config

    Examine the contents of the config/ directory if you wish. You will see stored here a skeletal configuration, ready to customize or, in this case, use immediately to build a default image.

    Now, as superuser, build the image, saving a log as you build with tee.

    # lb build 2>&1 | tee build.log

    Assuming all goes well, after a while, the current directory will contain binary.hybrid.iso. This ISO hybrid image can be booted directly in a virtual machine as described in Testing an ISO image with Qemu and Testing an ISO image with virtualbox-ose, or else imaged onto optical media or a USB flash device as described in Burning an ISO image to a physical medium and Copying an ISO hybrid image to a USB stick, respectively.

    16.3 Tutorial 2: A web browser utility

    Use case: Create a web browser utility image, learning how to apply customizations.

    In this tutorial, we will create an image suitable for use as a web browser utility, serving as an introduction to customizing Debian Live images.

    $ mkdir tutorial2
    $ cd tutorial2
    $ lb config -p lxde
    $ echo iceweasel >> config/package-lists/my.list.chroot

    Our choice of LXDE for this example reflects our desire to provide a minimal desktop environment, since the focus of the image is the single use we have in mind, the web browser. We could go even further and provide a default configuration for the web browser in config/includes.chroot/etc/iceweasel/profile/, or additional support packages for viewing various kinds of web content, but we leave this as an exercise for the reader.

    Build the image, again as superuser, keeping a log as in Tutorial 1:

    # lb build 2>&1 | tee build.log

    Again, verify the image is OK and test, as in Tutorial 1.

    16.4 Tutorial 3: A personalized image

    Use case: Create a project to build a personalized image, containing your favourite software to take with you on a USB stick wherever you go, and evolving in successive revisions as your needs and preferences change.

    Since we will be changing our personalized image over a number of revisions, and we want to track those changes, trying things experimentally and possibly reverting them if things don't work out, we will keep our configuration in the popular git version control system. We will also use the best practice of autoconfiguration via auto scripts as described in Managing a configuration.

    16.4.1 First revision

    $ mkdir -p tutorial3/auto
    $ cp /usr/share/doc/live-build/examples/auto/* tutorial3/auto/
    $ cd tutorial3

    Edit auto/config to read as follows:

    #!/bin/sh

    lb config noauto \
         --architectures i386 \
         --linux-flavours 686-pae \
         --package-lists lxde \
         "${@}"

    Perform lb config to generate the config tree, using the auto/config script you just created:

    $ lb config

    Now populate your local package list:

    $ echo "iceweasel xchat" >> config/package-lists/my.list.chroot

    First, --architectures i386 ensures that on our amd64 build system, we build a 32-bit version suitable for use on most machines. Second, we use --linux-flavours 686-pae because we don't anticipate using this image on much older systems. Third, we've chosen the lxde package list to give us a minimal desktop. And finally, we have added two initial favourite packages: iceweasel and xchat.

    Now, build the image:

    # lb build

    Note that unlike in the first two tutorials, we no longer have to type 2>&1 | tee build.log as that is now included in auto/build.

    Once you've tested the image (as in Tutorial 1) and are satisfied it works, it's time to initialize our git repository, adding only the auto scripts we just created, and then make the first commit:

    $ git init
    $ git add auto
    $ git commit -a -m "Initial import."

    16.4.2 Second revision

    In this revision, we're going to clean up from the first build, add the vlc package to our configuration, rebuild, test and commit.

    The lb clean command will clean up all generated files from the previous build except for the cache, which saves having to re-download packages. This ensures that the subsequent lb build will re-run all stages to regenerate the files from our new configuration.

    # lb clean

    Now append the vlc package to our local package list in config/package-lists/my.list.chroot:

    $ echo vlc >> config/package-lists/my.list.chroot

    Build again:

    # lb build

    Test, and when you're satisfied, commit the next revision:

    $ git commit -a -m "Adding vlc media player."

    Of course, more complicated changes to the configuration are possible, perhaps adding files in subdirectories of config/. When you commit new revisions, just take care not to hand edit or commit the top-level files in config containing LB_* variables, as these are build products, too, and are always cleaned up by lb clean and re-created with lb config via their respective auto scripts.

    We've come to the end of our tutorial series. While many more kinds of customization are possible, even just using the few features explored in these simple examples, an almost infinite variety of different images can be created. The remaining examples in this section cover several other use cases drawn from the collected experiences of users of Debian Live.

    16.5 A VNC Kiosk Client

    Use case: Create an image with live-build to boot directly to a VNC server.

    Make a build directory and create a skeletal configuration in it built around the standard-x11 list, including gdm3, metacity and xvnc4viewer, disabling recommends to make a minimal system:

    $ mkdir vnc_kiosk_client
    $ cd vnc_kiosk_client
    $ lb config -a i386 -k 686-pae -p standard-x11 \
         --apt-recommends false
    $ echo "gdm3 metacity xvnc4viewer" >> config/package-lists/my.list.chroot

    Create the directory /etc/skel and put a custom .xsession in it for the default user that will launch metacity and start xvncviewer, connecting to port 5901 on a server at 192.168.1.2:

    $ mkdir -p config/includes.chroot/etc/skel
    $ cat > config/includes.chroot/etc/skel/.xsession << END
    #!/bin/sh

    /usr/bin/metacity &
    /usr/bin/xvncviewer 192.168.1.2:1

    exit
    END

    Build the image:

    # lb build

    Enjoy.

    16.6 A base image for a 128M USB key

    Use case: Create a standard image with some components removed in order to fit on a 128M USB key with space left over to use as you see fit.

    When optimizing an image to fit a certain media size, you need to understand the tradeoffs you are making between size and functionality. In this example, we trim only so much as to make room for additional material within a 128M media size, but without doing anything to destroy integrity of the packages contained within, such as the purging of locale data via the localepurge package, or other such "intrusive" optimizations. Of particular note, you should not use --bootstrap-flavour minimal unless you really know what you're doing, as omitting priority important packages will most likely produce a broken live system.

    $ lb config -k 486 -p minimal --apt-indices false \
         --memtest none --apt-recommends false --includes none

    Now, build the image in the usual way:

    # lb build 2>&1 | tee build.log

    On the author's system at time of writing, the above configuration produced a 78Mbyte image. This compares favourably with the 166Mbyte image produced by the default configuration in Tutorial 1.

    The biggest space-saver here, compared to building a standard image on an i386 architecture system, is to select only the 486 kernel flavour instead of the default -k "486 686-pae". Leaving off APT's indices with --apt-indices false also saves a fair amount of space, the tradeoff being that you need to apt-get update before using apt in the live system. Choosing the minimal package list leaves out the large locales package and associated utilities. Dropping recommended packages with --apt-recommends false saves some additional space, at the expense of omitting some packages you might otherwise expect to be there, such as firmware-linux-free which may be needed to support certain hardware. The remaining options shave off additional small amounts of space. It's up to you to decide if the functionality that is sacrificed with each optimization is worth the loss in functionality.

    16.7 A localized KDE desktop and installer

    Use case: Create a KDE desktop image, localized for Brazilian Portuguese and including an installer.

    We want to make an iso-hybrid image for i386 architecture using our preferred desktop, in this case KDE, containing all of the same packages that would be installed by the standard Debian installer for KDE.

    Our initial problem is the discovery of the names of the appropriate language tasks. Currently, live-build cannot help with this. While we might get lucky and find this by trial-and-error, there is a tool, grep-dctrl, which can be used to dig it out of the task descriptions in tasksel-data, so to prepare, make sure you have both of those things:

    # apt-get install dctrl-tools tasksel-data

    Now we can search for the appropriate tasks, first with:

    $ grep-dctrl -FTest-lang pt_BR /usr/share/tasksel/descs/debian-tasks.desc -sTask
    Task: brazilian-portuguese

    By this command, we discover the task is called, plainly enough, brazilian-portuguese. Now to find the related tasks:

    $ grep-dctrl -FEnhances brazilian-portuguese /usr/share/tasksel/descs/debian-tasks.desc -sTask
    Task: brazilian-portuguese-desktop
    Task: brazilian-portuguese-kde-desktop

    At boot time we will generate the pt_BR.UTF-8 locale and select the pt-latin1 keyboard layout. We will also need to preseed our desktop choice, "kde" so that tasksel will install the correct desktop task, as it differs from the default (see Desktop and languages tasks). Now let's put the pieces together:

    $ mkdir live-pt_BR-kde
    $ cd live-pt_BR-kde
    $ lb config \
         -a i386 \
         -k 486 \
         --bootappend-live "locales=pt_BR.UTF-8 keyboard-layouts=pt-latin1" \
         --debian-installer live
    $ echo kde-desktop brazilian-portuguese brazilian-portuguese-desktop \
         brazilian-portuguese-kde-desktop >> config/task-lists/my.list.chroot
    $ echo debian-installer-launcher >> config/package-lists/my.list.chroot
    $ echo tasksel tasksel/desktop multiselect kde >> config/preseed/my.preseed.chroot

    Note that we have included the debian-installer-launcher package to launch the installer from the live desktop, and have also specified the 486 flavour kernel, as it is currently necessary to make the installer and live system kernels match for the launcher to work properly.

    Apèndix

    17. Style guide

    17.1 Guidelines for authors

    This section deals with some general considerations to be taken into account when writing technical documentation for live-manual. They are divided into linguistic features and recommended procedures.

    Note: Authors should first read Contributing to this document

    17.1.1 Linguistic features
  • Use plain English
  • Keep in mind that a high percentage of your readers are not native speakers. So as a general rule try to use short, meaningful sentences, followed by a full stop.

    This does not mean that you have to use a simplistic, naive style. It is a suggestion to try to avoid, as much as possible, complex subordinate sentences that make the text difficult to understand for non-native speakers.

  • Variety of English
  • The most widely spread varieties of English are British and American so it is very likely that most authors will use either one or the other. In a collaborative environment, the ideal variety would be "International English" but it is very difficult, not to say impossible, to decide on which variety among all the existing ones, is the best to use.

    We expect that different varieties may mix without creating misunderstandings but in general terms you should try to be coherent and before deciding on using British, American or any other English flavour at your discretion, please take a look at how other people write and try to imitate them.

  • Be balanced
  • Do not be biased. Avoid including references to ideologies completely unrelated to live-manual. Technical writing should be as neutral as possible. It is in the very nature of scientific writing.

  • Be politically correct
  • Try to avoid sexist language as much as possible. If you need to make references to the third person singular preferably use "they" rather than "he" or "she" or awkward inventions such as "s/he", "s(he)" and the like.

  • Be concise
  • Go straight to the point and do not wander around aimlessly. Give as much information as necessary but do not give more information than necessary, this is to say, do not explain unnecessary details. Your readers are intelligent. Presume some previous knowledge on their part.

  • Minimize translation work
  • Keep in mind that whatever you write will have to be translated into several other languages. This implies that a number of people will have to do an extra work if you add useless or redundant information.

  • Be coherent
  • As suggested before, it is almost impossible to standardize a collaborative document into a perfectly unified whole. However, every effort on your side to write in a coherent way with the rest of the authors will be appreciated.

  • Be cohesive
  • Use as many text-forming devices as necessary to make your text cohesive and unambiguous. (Text-forming devices are linguistic markers such as connectors).

  • Be descriptive
  • It is preferable to describe the point in one or several paragraphs than merely using a number of sentences in a typical "changelog" style. Describe it! Your readers will appreciate it.

  • Dictionary
  • Look up the meaning of words in a dictionary or encyclopedia if you do not know how to express certain concepts in English. But keep in mind that a dictionary can either be your best friend or can turn into your worst enemy if you do not know how to use it correctly.

    English has the largest vocabulary that exists (With over one million words). Many of these words are borrowings from other languages. When looking up the meaning of words in a bilingual dictionary the tendency of a non-native speaker is to choose the one that sounds more similar in their mother tongue. This often turns into an excessively formal discourse which does not sound quite natural in English.

    As a general rule, if a concept can be expressed using different synonyms, it is a good advice to choose the first word proposed by the dictionary. If in doubt, choosing words of Germanic origin (Usually monosyllabic words) is often the right thing to do. Be warned that these two techniques might produce a rather informal discourse but at least your choice of words will be of wide use and generally accepted.

    Using a dictionary of collocations is recommended. They are extremely helpful when it comes to know which words usually occur together.

    Again it is a good practice to learn from the work of others. Using a search engine to check how other authors use certain expressions may help a lot.

  • False friends, idioms and other idiomatic expressions
  • Watch out for false friends. No matter how proficient you are in a foreign language you cannot help falling from time to time in the trap of the so called "false friends", words that look similar in two languages but whose meanings or uses might be completely different.

    Try to avoid idioms as much as possible. "Idioms" are expressions that may convey a completely different meaning from what their individual words seem to mean. Sometimes, idioms are difficult to understand even for native speakers!

  • Avoid slang, abbreviations, contractions...
  • Even though you are encouraged to use plain, everyday English, technical writing belongs to the formal register of the language.

    Try to avoid slang, unusual abbreviations that are difficult to understand and above all contractions that try to imitate the spoken language. Not to mention typical irc and family friendly expressions.

    17.1.2 Procedures
  • Test before write
  • It is important that authors test their examples before adding them to live-manual to ensure that everything works as described. Testing on a clean chroot or VM can be a good starting point. Besides, it would be ideal if the tests were then carried out on different machines with different hardware to spot possible problems that may arise.

  • Examples
  • When providing an example try to be as specific as you can. An example is, after all, just an example.

    It is often better to use a line that only applies to an specific case than using abstractions that may confuse your readers. In this case you can provide a brief explanation of the effects of the proposed example.

    There may be some exceptions when the example suggests using some potentially dangerous commands that, if misused, may cause data loss or other similar undesirable effects. In this case you should provide a thorough explanation of the possible side effects.

  • External links
  • Links to external sites should only be used when the information on those sites is crucial when it comes to understanding a special point. Even so, try to use links to external sites as sparsely as possible. Internet links are likely to change from time to time resulting in broken links and leaving your arguments in an incomplete state.

    Besides, people who read the manual offline will not have the chance to follow those links.

  • Avoid branding and things that violate the license under which the manual is published
  • Try to avoid branding as much as possible. Keep in mind that other downstream projects might make use of the documentation you write. So you are complicating things for them if you add certain specific material.

    live-manual is licensed under the GNU GPL. This has a number of implications that apply to the distribution of the material (of any kind, including copyrighted graphics or logos) that is published with it.

  • Write a first draft, revise, edit, improve, redo if necessary
  • - Brainstorm!. You need to organize your ideas first in a logical sequence of events.

    - Once you have somehow organized those ideas in your mind write a first draft.

    - Revise grammar, syntax and spelling.

    - Improve your statements and redo any part if necessary.

  • Chapters
  • Use the conventional numbering system for chapters and subtitles. e.g. 1, 1.1, 1.1.1, 1.1.2 ... 1.2, 1.2.1, 1.2.2 ... 2, 2.1 ... and so on. See markup below.

    If you have to enumerate a series of steps or stages in your description, you can also use ordinal numbers: First, second, third ... or First, Then, After that, Finally ... Alternatively you can use bulleted items.

  • Markup
  • And last but not least, live-manual uses SiSU to process the text files and produce a multiple format output. It is recommended to take a look at SiSU's manual to get familiar with its markup, or else type:

    $ sisu --help markup

    Here are some markup examples that may prove useful:

    - For emphasis/bold text:

    *{foo}* or !{foo}!

    produces: foo or foo. Use it to emphasize certain key words.

    - For italics:

    /{foo}/

    produces: foo. Use them e.g. for the names of debian packages.

    - For monospace:

    #{foo}#

    produces: foo. Use it e.g. for the names of commands. And also to highlight some key words or things like paths.

    - For code blocks:

    code{

      $ foo
      # bar

    }code

    produces:

    $ foo
    # bar

    Use code{ to open and }code to close the tags. It is important to remember to leave a space at the beginning of each line of code.

    17.2 Guidelines for translators

    This section deals with some general considerations to be taken into account when translating the contents of live-manual.

    As a general recommendation, translators should have read and understood the translation rules that apply to their specific languages. Usually, translation groups and mailing lists provide information on how to produce translated work that complies with Debian quality standards.

    Note: Translators should also read Contributing to this document. In particular the section Translation

    17.2.1 Translation hints
  • Comments
  • The role of the translator is to convey as faithfully as possible the meaning of words, sentences, paragraphs and texts as written by the original authors into their target language.

    So they should refrain from adding personal comments or extra bits of information of their own. If they want to add a comment for other translators working on the same documents, they can leave it in the space reserved for that. That is, the header of the strings in the po files preceded by a number sign #. Most graphical translation programs can automatically handle those types of comments.

  • TN, Translator's Note
  • It is perfectly acceptable however, to include a word or an expression in brackets in the translated text if, and only if, that makes the meaning of a difficult word or expression clearer to the reader. Inside the brackets the translator should make evident that the addition was theirs using the abbreviation "TN" or "Translator's Note".

  • Impersonal sentences
  • Documents written in English make an extensive use of the impersonal form "you". In some other languages that do not share this characteristic, this might give the false impression that the original texts are directly addressing the reader when they are actually not doing so. Translators must be aware of that fact and reflect it in their language as accurately as possible.

  • False friends
  • The trap of "false friends" explained before especially applies to translators. Double check the meaning of suspicious false friends if in doubt.

  • Markup
  • Translators working initially with pot files and later on with po files will find many markup features in the strings. They can translate the text anyway, as long as it is translatable, but it is extremely important that they use exactly the same markup as the original English version.

  • Code blocks
  • Some translators decide to include the code blocks in the translated files because it is easier for them to identify what has already been translated and what has not by looking at the percentages if they use a graphical translation program.

    Include the code blocks if you want to score a 100% complete translation.

    On the other hand some translators prefer to leave the code blocks "untranslated" (i.e. not including them). This makes the translation easier to maintain once finished because it does not require translators intervention if the code changes.

    Leave the code blocks empty (they will be automatically added then) if you want to make your translation easier to maintain.

  • Newlines
  • The translated texts need to have the exact same newlines as the original texts. Be careful to press the "Enter" key or type \n if they appear in the original files. These newlines often appear, for instance, in the code blocks.

    Make no mistake, this does not mean that the translated text needs to have the same length as the English version. That is nearly impossible.

  • Untranslatable strings
  • Translators should never translate:

    - The code names of releases

    - The names of programs

    - The commands given as examples

    - Metadata (often between colons :metadata:)

    - Links

    - Paths