The Webcam HOWTO

Howard Shane


Diario delle Revisioni
Revisione 1.612005-02-21Revisionato da: jhs
Aggionamenti circa la ripresa dello sviluppo di un driver per Webcam Philips
Revisione 1.62005-01-02Revisionato da: jhs
Corretti alcuni errori, migliorata la leggibilità, aggiunti nuovi chipset e aggiornamenti
Revisione 1.12004-01-12Revisionato da: jhs
Aggiornamento dopo il rilascio della serie 2.6 del kernel e informazioni sulle webcam basate su NW802
Revisione 1.02003-12-04Revisionato da: JP
Primo rilascio / Revisionato da TLDP
Revisione 0.52003-11-07Revisionato da: jhs
Revisione finale dopo il feedback della mailing-list del gruppo v4l
Revisione 0.12003-10-12Revisionato da: jhs
Invio prima bozza

Il presente documento è stato scritto per assistere il lettore durante i passi necessari alla configurazione e all'uso di webcam sotto il sistema operativo Linux Traduzione a cura di Stefano Picchiotti Revisione a cura di Daniele A.

Sommario
1. Introduzione
1.1. Informazioni di Copyright
1.2. Liberatoria
1.3. Nuove Versioni
1.4. Ringraziamenti
1.5. Comunicazioni
1.6. Convenzioni utilizzate in questo documento
2. Attivazione del supporto per il vostro dipositivo (Webcam) sotto Linux
2.1. Driver e Moduli
2.2. Supporto al tipo di connessione
2.3. Modelli di Webcam specifici
3. Accedere al dispositivo video
3.1. Il Video Device Node
3.2. Gruppi e permessi
4. Applicazioni per la cattura di immagini
4.1. Programmi da linea di comando
4.2. Programmi basati su interfaccia grafica (GUI)
5. Risoluzione dei problemi
5.1. Aiuto, ho una webcam USB ma non so esattamente qual è il modello e/o il produttore. Che faccio?
5.2. Aiuto, non trovo la webcam in /dev!
5.3. Aiuto, vedo il dispositivo (fisicamente e in /dev), ma non riesco ad accedervi!
5.4. Aiuto, il driver per la mia webcam è disponibile solo come sorgente! Da dove comincio?
5.5. Uso Debian GNU/Linux. C'è un modo più semplice per compilare il driver?
5.6. Aiuto, la mia webcam è supportata da un driver che va aggiunto come patch al kernel! Che faccio?
5.7. Voglio contribuire. Dove posso trovare più informazioni?
5.8. Voglio contribuire a Video4Linux! Con chi mi metto in contatto?
A. Gnu Free Documentation License

1. Introduzione

Questo documento è stato scritto per assistere il lettore nell'installazione e nella configurazione di webcam, macchine fotografiche digitali o altri dispositivi video sotto il sistema operativo Linux. Sarà mostrato come attivare il necessario supporto a livello kernel o software e saranno descritte varie applicazioni di cattura delle immagini tramite le quali accedere al proprio dispositivo. Non saranno esaminate le differenze esistenti tra i vari formati utilizzati per la codifica di immagini o filmati, le caratteristiche e/o le funzioni di dispositivi particolari nè la codifica o la conversione tra formati video.

1.1. Informazioni di Copyright

Questo documento è protetto da Copyright 2004-2005, di Howard Shane.

E' garantito il permesso di copiare, distribuire e/o modificare questo documento secondo i termini della GNU Free Documentation License, Versione 1.2 o ogni versione successiva pubblicata dalla Free Software Foundation; senza Sezioni non Modificabili, nessun Testo Copertina e nessun Testo di Retro Copertina. Una copia della licenza può essere trovata in Appendice A.

1.2. Liberatoria

L'autore non si assume alcuna responsabilità per il contenuto di questo documento. Il lettore utilizza i concetti, gli esempi o gli altri contenuti del testo a proprio rischio. Dal momento che questa è una nuova edizione, le imprecisioni di carattere tecnico (o di altra natura) eventualmente presenti potrebbero portare alla perdita irrimediabile di dati. Si consiglia di procedere con cautela e di tenere presente che, sebbene la presenza di errori sia altamente improbabile, l'autore non se ne assume la responsabilità.

Tutti i diritti sono riservati ai rispettivi autori, salvo diversa indicazione. L'uso di un termine all'interno di questo documento non deve essere considerato lesivo di alcun marchio o servizio. Il fatto che possano essere nominati particolari prodotti o marche non deve essere considerato una forma di sponsorizzazione.

1.3. Nuove Versioni

Questa è la quarta edizione.

L'ultima versione di questo documento può essere trovata qui.

1.4. Ringraziamenti

Vorrei ringraziare tutte le persone che, per prime, si sono dedicate al supporto video sotto Linux, in particolare i gruppi v41 e v412, Gerd Knorr e soprattutto i fratelli Metzler.

Inoltre, vorrei ringraziare Marla, che ha la gentilezza di accettare incondizionatamente i miei difetti e le mie idiosincrasie, nonché la mia ossessione per progetti come questo.

1.5. Comunicazioni

Eventuali commenti o aggiunte riguardanti questo documento possono essere inviati al seguente indirizzo: . In particolare, se avete informazioni riguardo nuovi dispositivi o interfacce supportate o volete segnalare eventuali errori, siete pregati di contattarmi cosicché io possa mantenere aggiornato il documento!

1.6. Convenzioni utilizzate in questo documento

Di seguito vengono riportate le convenzioni utilizzate in questo documento, a vantaggio di coloro che non hanno ancora acquisito una completa conoscenza dei meccanismi di accesso e controllo propri del sistema operativo Linux, che si avvalgono, in genere, della shell Bash.

In primo luogo, i nomi dei file citati nel testo sono riportati come segue: /path/file

Sotto Linux, i comandi vengono eseguiti (o 'chiamati') al prompt dei comandi, meglio nota come 'linea di comando'. Se si è in modalità non grafica (ambiente testuale), verrà presentato il prompt della shell; nel caso della shell Bash si tratta, in genere, del simbolo del dollaro:

   $

...o di quello del 'cancelletto':

   #

...nel caso si sia effettuato l'accesso come utente root o si siano acquisiti i privilegi di root o 'superuser'. L'accesso alla shell Bash può essere effettuato anche dal sistema grafico, altrimenti noto come X o X11, tramite xterm o un emulatore di terminale simile. I comandi che devono essere inseriti al prompt della shell appariranno, all'interno di questo documento, in questo modo: fare questo

I comandi così come l'output da essi risultante possono essere presentati in forma di schermata: 

   $  date
   Sun Jul 27 22:37:11 CDT 2003

Quando (come nell'esempio precendente di $ date) si riporta il prompt della shell seguito da un comando, si assume che, dopo averlo digitato, venga premuto il tasto [Invio] o [Enter], con conseguente visualizzazione, su una nuova linea, dell'output eventualmente associato al comando stesso.

2. Attivazione del supporto per il vostro dipositivo (Webcam) sotto Linux

2.1. Driver e Moduli

Affinché la webcam funzioni correttamente è necessario il supporto per il tipo di connessione che si intende utilizzare e per il particolare apparecchio che si vuole collegare. Chi sa già come caricare i moduli nel kernel può passare alla sezione la Sezione 2.2, che si occupa del supporto per il tipo di connessione. Nel caso in cui il bus tramite cui si intende collegare l'apparecchio (USB, IEEE 1394 o altre) sia già configurato e funzionante, si può passare alla lista delle webcam riportata in la Sezione 2.3.

I driver per webcam sono in genere disponibili in una delle seguenti forme: compresi all'interno del kernel, come moduli separati da compilare o come driver binario precompilato fornito con la distribuzione Linux.

2.1.1. Modulo o compilato nel kernel?

In genere, il kernel (cioè il cuore del sistema operativo) fornito con la distribuzione Linux potrebbe già essere configurato per le vostre necessità. Probabilmente il distributore ha già attivato le opzioni di configurazione più comuni, ivi compresi il bus, il tipo di connessione e i driver per i modelli più diffusi. Il driver può essere disponibile sia all'interno del kernel che come modulo da caricare separatamente.

Un modo semplice per verificare se il driver è stato caricato è quello di usare il comando dmesg in pipe con less (allo scopo di rendere più agevole la lettura) per avere conferma che esso è stato caricato all'avvio del sistema:

   $  dmesg | less

...che può restituire, a seconda della configurazione del sistema, qualcosa di simile a questo:

   Dec 18 17:35:18 localhost kernel: hub 5-0:1.0: USB hub found
   Dec 18 17:35:18 localhost kernel: hub 5-0:1.0: 2 ports detected
   Dec 18 17:35:18 localhost kernel: Linux video capture interface: v1.00
   Dec 18 17:35:18 localhost kernel: quickcam: QuickCam USB camera found (driver version QuickCam USB $Date: 2005/01/07 13:29:53 $)
   Dec 18 17:35:18 localhost kernel: quickcam: Kernel:2.6.7 bus:1 class:FF subclass:FF vendor:046D product:0840
   Dec 18 17:35:18 localhost kernel: quickcam: Sensor HDCS-1000/1100 detected
   Dec 18 17:35:18 localhost kernel: quickcam: Registered device: /dev/video0
   Dec 18 17:35:18 localhost kernel: usbcore: registered new driver quickcam

Se non lo si trova, il driver potrebbe essere stato caricato come modulo. Nel caso in cui si conosca il nome di tale modulo, si può provare ad usare find; nell'esempio che segue, si cercherà il modulo 'ibmcam':

  $  find /lib/modules -name ibmcam.o

Si noti che sino alla versione 2.4 del kernel i moduli avevano il suffisso .o; dalla versione 2.6 in poi tale estensione è stata sostituita con .ko.

E' possibile trovare una lista di tutti i moduli disponibili digitando il seguente comando:

  $  ls -R /lib/modules/`uname -r`/kernel

in cui `uname -r`, circondato dagli apici, è la versione del kernel. Il seguente output mostra un esempio di ciò che si potrebbe trovare nel caso di un kernel con supporto per webcam USB ottenuto tramite il caricamento di moduli (le linee non rilevanti sono state rimosse):

   ./usb: usbvideo.o usbcore.o ibmcam.o

Una volta noto il nome del modulo necessario per il funzionamento della webcam, è possibile controllare se sia già stato caricato digitando il seguente comando:

   #  lsmod

Come si può notare dal prompt, è necessario possedere i privilegi di root per eseguire tale comando. L'output dovrebbe essere simile a questo:

   cdrom                  29312   0  (autoclean) [sr_mod]
   usb-ohci               17888   0  (unused) 
   usbcore                56768   0  [scanner ibmcam usbvideo usb-ohci] 
   ibmcam                 39680   0

La maggior parte dei kernel forniti con le distribuzioni è compilata con kmod, che consente di caricare i moduli nel momento in cui il sistema rileva i dispositivi che li richiedono. Dato che non sempre è così, se non si trova il modulo che si sta cercando ma si pensa che esso sia disponibile, si provi a caricarlo manualmente con modprobe, come nell'esempio che segue, in cui si cerca, ad esempio, il modulo ibmcam:

   # modprobe -v ibmcam

I driver per modelli specifici, o i collegamenti a pagine web relative ad essi, sono riportate in la Sezione 2.3. In genere, i driver sono disponibili in una delle seguenti forme: compilati nel kernel, moduli separati compilabili, binari pre-compilati forniti con la distribuzione Linux.

Se il supporto per il proprio dispositivo non è presente né nel kernel né come modulo da caricare, non è il caso di disperarsi. I driver per molti modelli sono presenti o nel codice sorgente del kernel di Linux (disponibile all'indirizzo kernel.org) o nel codice offerto separatamente dal kernel e che può essere configurato per funzionare sul proprio sistema come illustrato in la Sezione 2.1.2. Se il driver è disponibile nel codice sorgente del kernel ma non è stato compilato staticamente o come modulo, è possibile ricompilare il kernel a partire dal codice sorgente che si possiede oppure ottenere una nuova versione del codice sorgente dal fornitore della propria distribuzione o direttamente dal collegamento fornito in precendenza (il cosiddetto kernel "vanilla"). Se non si ha dimestichezza con la procedura di compilazione del kernel ed i relativi requisiti, si consulti il Kernel HOWTO per maggiori informazioni.

2.1.2. Patch, sorgente o binario pre-compilato?

Può darsi che la webcam che si vuole utilizzare sia supportata da una patch per il kernel, da un driver di cui viene distribuito il codice sorgente e che non richiede la ricompilazione del kernel oppure, se si è abbastanza fortunati, da un driver binario pre-compilato adatto all'architettura del proprio sistema. La procedura da seguire in questi casi va ben oltre lo scopo di questo documento ed è probabilmente descritta meglio nelle pagine web riguardanti i driver per un determinato modello (si veda la Sezione 2.3). E' possibile comunque trovare alcune informazioni di carattere generale nella sezione la Sezione 5.

2.2. Supporto al tipo di connessione

2.2.1. Webcam USB

Se si possiede una webcam USB, è molto probabile che esista un driver Linux per tale dispositivo. Il supporto ai dispositivi USB sotto Linux avviene in due modi. Il primo, tradizionale, è il supporto nel kernel, l'altro si avvale di libusb. Per almeno una tipologia di webcam, che comprende i modelli basati su STV0680, il supporto tramite libusb è raccomandato, almeno secondo quanto si può leggere su Sourceforge al riguardo.

A meno che non si sappia per certo che il proprio driver richiede il supporto libusb, si dovrebbe fare affidamento sul supporto a livello di kernel, trattato in la Sezione 2.2.1.2.

2.2.1.1. Libusb

Libusb è una libreria che consente l'accesso alle periferiche USB attraverso lo spazio utente, senza la necessità di abilitare il supporto a livello del kernel o di caricare moduli. Oggi la maggior parte delle distribuzioni include libusb nella versione stabile (a volte viene installato di default) per cui, se non si ha il supporto USB nel kernel, può essere sufficiente installare il pacchetto di libusb per poter utilizzare il proprio dispositivo. Si tenga presente che è necessario che il supporto per filesystem USB del kernel sia attivo, cosa che avviene per gran parte delle distribuzioni. Per accertarsene, si digiti il seguente comando:

   $  cat /proc/filesystems

Si dovrebbe poter leggere (tra l'altro):

   nodev    usbdevfs 
   nodev    usbfs

Può essere necessario montare usbdevfs per attivarlo e vedere i file del dispositivo; ciò può essere fatto con il comando mount -t usbdevfs none /proc/bus/usb. Non si utilizzi libusb se il supporto per la propria webcam è già attivo nel kernel; se ne può usare solo uno alla volta.

Il pacchetto libusb si può trovare sotto forma di .rpm, .tgz or .deb all'interno della propria distribuzione.

2.2.1.2. Supporto USB nel kernel

Se non si usa libusb (descritto sopra), è necessario attivare il supporto per la webcam USB nel kernel.

Per i kernel delle serie 2.2 e 2.4, può essere necessario caricare il modulo usbvideo. A partire dalla versione 2.6, ciò non è più richiesto.

Per disporre del supporto USB in Linux, bisogna attivare il supporto al sottosistema USB nel kernel utilizzando i driver usb-ohci, usb-ehci o quelli più adatti al proprio sistema. Il supporto USB a livello del kernel è stato introdotto a partire dalle ultime versioni della serie 2.2. Per una trattazione più dettagliata del supporto USB, si rimanda al Linux-usb project site. Se si vuole sapere quali moduli sono stati caricati nel kernel, si può digitare il seguente comando:

   #  lsmod

Come si vede dal prompt, è necessario avere i privilegi i root per usarlo. L'output dovrebbe essere simile a questo:

   cdrom	       29312   0  (autoclean) [sr_mod]
   usb-ohci	       17888   0  (unused) 
   usbcore             56768   0  [scanner ibmcam usbvideo usb-ohci] 
   ibmcam              39680   0

Se il modulo che si sta cercando non è stato caricato ma si pensa che esso sia disponibile, si provi a caricarlo direttamente (nell'esempio che segue si proverà a caricare il modulo libcam):

   #  modprobe -v ibmcam

...al che si dovrebbe poter vedere qualcosa del genere:

   Using /lib/modules/2.4.20/kernel/drivers/usb/ibmcam.o

Inserendo la voce ibmcam (ad esempio) in /etc/modules (potrebbe variare a seconda della distribuzione), se ne abilita il caricamento automatico all'avvio del sistema. Si può avere conferma dell'avvenuto caricamento del modulo controllando il syslog o il registro di avvio con dmesg | less), per vedere se compare qualcosa del tipo:

   Oct 18 12:43:12 K7 kernel: hub.c: new USB device 00:02.3-2, assigned address 3 
   Oct 18 12:43:12 K7 kernel: ibmcam.c: IBM PC Camera USB camera found (model 2, rev. 0x030a) 
   Oct 18 12:43:12 K7 kernel: usbvideo.c: ibmcam on /dev/video1: canvas=352x240 videosize=352x240

2.2.2. IEEE 1394 (Firewire™, i.Link™)

Le webcam che usano lo standard IEEE 1394 richiedono una scheda PCI IEEE 1394 o una porta IEEE 1394 sulla scheda madre. Il supporto dell'interfaccia IEEE 1394 è disponibile sotto Linux a partire dalle prime versioni della serie 2.4 del kernel. Se si è così fortunati da possedere un dispositivo del genere, si possono trovare ulteriori informazioni sul relativo supporto su www.linux1394.org. Se si ha un kernel antecedente al 2.4.2, è necessario installare una delle patch disponibili a questo indirizzo, facendo attenzione a scaricare quella adatta alla versione del kernel che si possiede. Sarà inoltre necessario installare libraw1394. Il sito linux1394.org mette a disposizione una eccellente guida all'installazione.

La lista IEEE1394 Digital Camera, curata da Damien Douxchamps, offre un'eccellente panoramica delle funzionalità delle webcam IEEE 1394 e dello stato attuale relativo al supporto dei singoli modelli

2.2.3. Supporto per webcam collegate tramite porta parallela

Per i sistemi basati sui kernel delle serie 2.2 e 2.4, il supporto per la porta parallela deve essere attivato o staticamente o come modulo (nei kernel forniti con le distribuzioni il supporto è in genere attivo di default). E' consigliabile, prima di procedere oltre, acquisire altre informazioni riguardanti il supporto di dispositivi collegati alla porta parallela sotto Linux. Per assicurarsi che il modulo parport sia stato caricato, si può controllare il file dmesg o usare il comando lsmod come indicato in precedenza. Tramite dmesg | less, si dovrebbe poter vedere (tra l'altro) qualcosa di simile a questo:

   Mar  3 08:00:25 K7 kernel: parport0: PC-style at 0x378 (0x778) [PCSPP,TRISTATE] 
   Mar  3 08:00:25 K7 kernel: parport0: irq 7 detected

Nel caso si stia ricompilando il proprio kernel, si attivi il supporto per porta parallela ('Parallel Port Support'). Si dovrebbe attivare anche l'opzione 'IEEE 1284 transfer mode' (modalità di trasferimento IEEE 1284) e, se si possiede un sistema basato su x86, anche 'PC-style hardware'.

In caso di errore nel caricamento del modulo, si tenga presente che potrebbe essere necessario determinare l'indirizzo dell'hardware e passarlo a modprobe quando lo si esegue. L'indirizzo più comune sui sistemi x86 è 0x378; per le porte parallele integrate o ISA, si può provare anche con 0x278 oppure 0x38C. Le porte PCI aggiunte possono avere indirizzi insoliti. Si può anche provare a gestire dispositivi multipli con i moduli parport_pc o parport_arc, ma l'argomento esula dagli obiettivi di questo HOWTO.

Avvertimento

ATTENZIONE: Ci si assicuri di conoscere l'indirizzo corretto prima di inserirlo alla linea di comando, altrimenti il sistema potrebbe diventare instabile, bloccarsi o implodere.

La porta parallela dovrebbe essere impostata in modalità "EPP" o, in alternativa, "ECP/EPP". La modalità "Bi-direzionale" (detta anche "BPP" o "PS/2") può andare bene, sebbene sia più lenta. La modalità "Unidirezionale" non è adatta per la scansione. Le impostazioni appena discusse possono essere impostate accedendo al menu di configurazione del BIOS, almeno sui sistemi x86.

2.3. Modelli di Webcam specifici

Si tenga presente che le informazioni di seguito riportate sono soggette a cambiamenti frequenti. Il sito Linux-USB Device Overview è un ottimo posto dove guardare se si possiede una webcam USB. Inoltre si può cercare la pagina relativa al proprio modello su http://www.exploits.org/v4l/. Le informazioni riportate di seguito provengono dalla stessa fonte, ed è possibile trovarne di più aggiornate all'indirizzo appena fornito. Nel caso non si riesca a trovare la voce relativa al proprio dispositivo, si verrà se non altro indirizzati verso risorse che spiegano come scrivere da soli il driver necessario!

Importante

E' importante notare che, se la propria webcam non è nell'elenco, il modo più semplice per scoprire se è supportata consiste nello scoprire con che chipset è equipaggiata.

Questa informazione è in genere riportata nelle specifiche dell'apparecchio, rintracciabili nel manuale o sul sito del produttore.

Se la webcam non compare nell'elenco e non si è sicuri di avere individuato il chipset, si può provare a consultare e/o iscriversi alla mailing list di video4linux gestita da RedHat.

2.3.1. Webcam digitale 3com HomeConnect PC

Questo driver è disponibile sotto forma di patch per il kernel ed è scaricabile dal sito del progetto homeconnectusb. A seconda della versione del kernel, può essere necessario procedere alla ricompilazione di quest'ultimo.

2.3.2. Webcam basate su CPiA

Si consulti la pagina del progetto per informazioni più aggiornate. Questo chipset è stato impiegato per produrre sia webcam con interfaccia USB che parallela, compresi i seguenti modelli:

  • Aiptek HyperVcam Fun USB (non basata su OV511)

  • Creative Video Blaster WebCam II, USB e parallela

  • CVideo-Mail Express, parallela

  • Digicom Galileo USB e Digicom Galileo Plus

  • Dynalink Digital Camera

  • Ezonics EZCam (non Pro o Plus)

  • I-View NetView NV200M

  • Microtek EyeStar USB

  • Pace Color Video Camera USB

  • SuperCam WonderEye

  • TCE Netcam 310 USB

  • Terracam USB (non basata su OV511 o Terracam Pro)

  • Trust SpaceC@m Lite USB e SpaceC@m 100

  • Utopia USB Camera

  • ZoomCam USB e parallela

2.3.3. Webcam USB basate su SE401, SE402 e EP800

Questo progetto è ancora in fase di avanzamento. I driver e altre informazioni utili sono disponibili visitando la homepage del progetto. Al momento della stesura di questo documento, l'attivazione del supporto per questi modelli prevede l'installazione di una patch per il kernel e la successiva ricompilazione di quest'ultimo. Il driver fornisce il supporto per i seguenti modelli:

Chipset SE401 tramite il driver 'se401':

  • Aox SE401 camera

  • Philips PCVC665 USB VGA webcam 'Vesta Fun'

  • Kensington VideoCAM PC Camera (Modelli 67014-67017)

Chipset SE402 e EP800 tramite il driver 'epcam':

  • Spypen Actor

  • Rimax Slim Multicam

  • Concord Eye-Q Easy

  • Creative PD1001

  • Chicony DC-100

  • Endpoints SE402 e EP800

2.3.4. Webcam OmniVision

Questa categoria comprende un gran numero di webcam e di dispositivi per l'acquisizione video prodotti da OmniVision, compresi i modelli OV511(+), OV518(+), OV6620, OV6630, OV7610, e OV7620AE. La homepage del progetto è disponibile a questo indirizzo. I modelli supportati comprendono:

  • Aiptek HyperVcam Home e Mobile

  • Amitech AWK-300

  • I-view NetView NV300M

  • TEVion MD9308

  • Intel Me2Cam

  • Dlink DSB C100, C300

  • Hawking Tech. UC-110, UC-300 and UC-310

  • Puretek PT-6007

  • Alpha Vision Tech AlphaCam SE modello AC-520

  • Creative Labs WebCam modello PD1001 con OV518 chipset

  • Creative Labs WebCam 3, WebCam Go, Webcam Go Plus

  • Elecom UCAM-C1C20

  • Elta WEBCam 8211 PCC

  • Ezonics EZPhone Cam

  • Philips ToUCam XS (vecchia versione con OV518)

  • LG Electronics LPC-UM10

  • Vari modelli Lifeview USB Life TV

  • Genius VideoCam Express

  • AverMedia Intercam Elite

  • Maxxtro Cam22U

  • MediaForte MV300, PC Vision 300

  • Terratec TerraCam PRO e alcuni modelli TerraCam

  • OmniVision (tranne quelle con OV519)

  • TRENDNet TV-PC301

  • Trust Sp@ceC@m USB

  • Lifetec LT9388

  • BestBuy EasyCam U

  • Maxell Maxcam

  • TCE NetCam 310u

  • Medion MD9388

  • Webeye 2000B

  • Suma eON

  • Prochips PCA-3100

  • Ezonics EZ USB Cam II (i modelli OV511 e successivi)

  • Waytech I-Pac VIC-30

  • Zoom Telephonics ZoomCam III USB (model 1598)

2.3.5. Supporto per Logitech (ex Connectix) Quickcam

Le webcam Quickcam VC con interfaccia parallela o USB sono supportate tramite il driver scaricabile da qui. E' necessario installare una patch per il kernel e procedere alla ricompilazione.

Il driver Quickcam è mantenuto da due diversi progetti i quali offrono, per alcuni modelli Quickcam, due versioni dello stesso driver che non richiedono né patch né ricompilazione. I driver qce-ga e qc-usb offrono supporto per i seguenti modelli:

  • Logitech (i primi modelli di) Quickcam Express

  • Quickcam Web

  • Legocam

  • Dexxa Webcam

  • Labtec Webcam

Il driver qc-usb è più sperimentale dell'altro ma sembra funzionare meglio con alcuni modelli come, ad esempio, la Quickcam Web. Inoltre, ho ricevuto comunicazione che i nuovi modelli di Logitech Quickcam Express non funzionano più con i driver di cui sopra; da questa pagina è possibile scaricare un driver che sembra in grado di supportare i nuovi modelli.

Nota per gli utenti RedHat: il driver qce-ga non viene compilato correttamente se si usa il codice sorgente del kernel fornito con RedHat 9, ma è disponibile un rimedio qui.

Alcuni modelli della Logitech sono supportati dai driver Philips in la Sezione 2.3.8.

2.3.6. Webcam basate su ICM532

Uno dei driver per questo chipset, la cui homepage è a questo indirizzo, è incorporato nel sorgente del kernel 2.6; un altro è, per ammissione del suo stesso sviluppatore, in fase sperimentale, ed è disponibile qui. I modelli supportati da uno od entrambi i driver comprendono:

  • IC-Media Corp Pencam

  • I modelli più recenti di Logitech Quickcam Express

  • I modelli più recenti di Labtec Webcam

  • Biolux 654 microscope

  • Ezonics EZCam USB II (uvt8532)

  • Ezonics EZCam USB III

  • TerraCam USB

  • Stick Webcam

  • Mini WebCam

  • Tucan PenCam

  • Che-ez! Webbie

  • SNAKE EYE SI-8480/8481

  • PC CAM CP03

  • WEB Camera PBC0006

  • Clipcam

2.3.7. Webcam basate su NW802

Questo chipset, prodotto dalla DIVIO, è supportato da un driver che si può scaricare da qui. I modelli supportati comprendono:

  • BTC SurfCam CMOS300k

  • Mustek WCam 300

  • Logitech QuickCam Pro USB (il modello con l'anello di regolazione del fuoco scuro)

2.3.8. Webcam USB Philips

A causa della fine dell'accordo di non divulgazione tra Philips e il precedente responsabile del driver pwc, il progetto di supporto per le webcam basate su chip PWC si è interrotto. Fortunatamente, è iniziato lo sviluppo di un driver sperimentale che non richiede l'impiego di un modulo proprietario. Il vecchio sito, con le informazioni circa i cambiamenti, si può visitare al seguente indirizzo http://www.smcc.demon.nl/webcam/. Il nuovo driver può essere scaricato da saillard.org mentre, per maggiori informazioni, si veda PWC Documentation Project.

I modelli Philips supportati da driver di cui sopra comprendono:

  • PCA645VC

  • PCA646VC

  • PCVC675K Vesta, Vesta Pro e Vesta Scan

  • PCVC720K/40 ToUCam XS, ToUCam Fun, ToUCam Pro e ToUCam Scan

  • Askey VC010

  • Creative Labs Webcam 5, Pro Ex

  • Logitech 3000 e 4000 Pro, Notebook Pro, e Zoom

  • Samsung MPC-C10 e MPC-C30

  • Sotec Afina Eye

  • Visionite VCS UM100 e UC300

2.3.9. Driver Linux per webcam USB basate su SPCA50X

Alcune informazioni riguardanti questo chipset sono disponibili a questo indirizzo. Il driver è in fase di notevole sviluppo e comprende il supporto parziale o copleto per i modelli che seguono:

  • Kodak DVC-325 e EZ200

  • Creative PC-CAM 300, 600, 750

  • Genius VideoCAM Express V2

  • Micro Innovation IC 200/IC 150

  • Logitech ClickSmart 310, 420, 510, 820 e modelli senza fili (Cordless)

  • Logitech Pocket750

  • Benq DC 1016, 1300, 1500, 3410

  • Flexcam 100

  • Aiptek MegaCam, [1.3 Megapixel] Mini PenCam e PocketCam 1.3M Smart

  • Finet Technology Palmpix DC-85

  • Pure DigitalDakota

  • 3Com Home Connect lite

  • Megapix V4

  • Mustek gSmart: Mini, Mini2, Mini3, LCD 2, LCD 3

  • Digital Dream Enigma 1.3, Epsilon 1.3

  • Maxwell Compact Pc PM3

  • modelli Jenoptik

  • Minton S-Cam F5

  • D-Link DSC-350

  • Trust FamilyC@m 300 Movie

  • Aiptek Pocket DV, PocketDVII, DV3100+, mini PenCam 2, PocketCam 3M, Pencam SD 2, Pocket DV3500

  • Hama Sightcam 100

  • Micro Innovations IC50C, IC400c

  • FlyCam USB100

  • Arowana USB Camera 300 K

  • Intel Easy PC Camera, CS120 (Easy PC Share), PC Camera Pro (CS431), Pocket PC Camera (CS630)

  • Grandtec V.cap

  • Sigma-Apo Petcam

2.3.10. Modelli basati su STV0680

Le versioni USB delle webcam basate su questo chipset sono supportate dai kernel a partire dal 2.4.18 e successivi, tramite il modulo stv680.o. In alternativa, si può ottenere il codice sorgente scaricandolo dalla homepage del progetto. Il driver supporta anche le Pencam Aiptek e la Nisis Quickpix 2.

Se si possiede un modello con interfaccia seriale, come la Scan e-Studio, si dia un'occhiata qui.

2.3.11. Winbond w9966cf

Questo è un driver per interfaccia tramite porta parallela per il supporto del chip di controllo CCD SAA7111 della Philips, che equipaggia la webcam Lifeview Flycam SUPRA. E' incluso nei kernel a partire dalla fine della serie 2.4 all'interno della categoria 'video4linux'. La homepage del progetto è qui.

2.3.12. Webcam basate su Xirlink C-it™ HDCS-1000

Questo è un driver per webcam USB prodotte da Xirlink e IBM (PC Camera), e per il modello Stingray della Veo Il supporto è disponibile sin dalla versione 2.2.12 del kernel di Linux. La homepage è all'indirizzo http://www.linux-usb.org/ibmcam.

3. Accedere al dispositivo video

Il paragrafo che segue si riferisce a tutti i tipi di connessione.

3.1. Il Video Device Node

Il kernel di Linux deve creare un dispositivo virtuale per poter accedere al dispositivo video e controllarlo. Esso può essere stato già creato automaticamente all'avvio del sistema; ls -l /dev/video* (con l'asterisco) o, in alternativa, find /dev -name video* oppure un'occhiata alla directory /dev con il proprio file manager preferito possono servire ad accertarsi che il dispositivo virtuale esista. In caso affermativo, si può passare alla la Sezione 3.2; altrimenti sarà necessario crearlo manualmente.

Un modo semplice per creare questo tipo di file è usare lo script MAKEDEV che, se disponibile nella propria distribuzione, dovrebbe trovarsi in /dev, oppure nelle cartelle solitamente contenenti i comandi (/bin,/sbin e simili). Le pagine di manuale relative a MAKEDEV (man MAKEDEV) possono essere d'aiuto, ma si faccia attenzione alle opzioni proprie di ciascun tipo di dispositivo. Se MAKEDEV non funziona o non esiste, o se si preferisce un approccio di basso livello, si passi al paragrafo successivo.

Un dispositivo può essere creato come blocco (come ad esempio un disco), una fifo (file-in-file-out, come per xconsole) o come un dispositivo a carattere, che rappresenta altro hardware. Ciascun dispositivo possiede una coppia di "coordinate", dette numero primario e secondario (major/minor), che dicono al kernel a cosa accedere e dove accedervi. Tali numeri non sono arbitrari. Il numero primario 81 con numeri secondari pari a 0, 1, 2 e così via, è assegnato convenzionalmente ai dispositivi Video4linux, compresi sintonizzatori TV e webcam. Per creare il dispositivo video /dev/video0, si usi il comando mknod al prompt:

   #  mknod /dev/video0 c 81 0

dove c rappresenta un dispositivo a caratteri.

Si può anche usare il seguente script, preso dal sorgente del kernel (si trova in linux/Documentation/video4linux/bttv/MAKEDEV dalla directory in cui si trovano i sorgenti):

   #!/bin/bash
   function makedev () {
	for dev in 0 1 2 3; do echo "/dev/$1$dev:
	char 81 $[ $2 + $dev ]" rm -f /dev/$1$dev
	mknod /dev/$1$dev c 81 $[ $2 + $dev ] chmod
	666 /dev/$1$dev
   	done

   	# symlink for default device
	rm -f /dev/$1 ln -s /dev/${1}0 /dev/$1
   	}

	# see http://roadrunner.swansea.uk.linux.org/v4lapi.shtml
	echo "*** new device names ***" makedev video
	0 makedev radio 64 makedev vtx 192 makedev vbi 224
	# "*** old device names (for compatibility only) ***"
	#makedev bttv 0 #makedev bttv-fm 64 #makedev bttv-vbi 224

E' sufficiente copiare e incollare quanto scritto sopra in un qualsiasi editor di testo, salvare il file chiamandolo MAKEDEV o anche in un altro modo, renderlo eseguibile (ad esempio con: chmod u+x MAKEDEV) e eseguirlo come root:

   #  ./MAKEDEV

3.2. Gruppi e permessi

E' buona norma assicurarsi di avere i privilegi necessari per accedere al dispositivo una volta caricati i moduli e creati i nodi necessari. Il modo più sicuro per fare questo consiste nel garantire l'accesso per un gruppo specifico. Sul mio sistema, i membri del gruppo 'video' hanno il permesso di usare la webcam, lo scanner e altri dispositivi fotografici. Per ottenere questo risultato è necessario per prima cosa assegnare un nuovo proprietario ai dispositivi nella directory /dev (occorre essere root):

   #  chown root.video /dev/usb/video*

...dove root.video sono rispettivamente il proprietario e il gruppo al quale appartengono i dispositivi. Ovviamente, il comando varia a seconda del sistema sul quale lo si esegue e del tipo di dispositivi interessati. E' importante assicurarsi di modificare i permessi dei nodi veri e propri e non quelli dei relativi collegamenti simbolici; i permessi di questi ultimi vengono modificati solo agendo sui corrispondenti permessi dei nodi a cui puntano.

Per vedere se il proprio account è membro del gruppo in questione, si esegua come root il seguente comando: grep -e video /etc/group. Si dovrebbe vedere qualcosa del genere:

   video:x:44:

...dove '44' è il numero del gruppo. Dal momento che nessun membro è inserito dopo i due punti finali, si può aggiungere, ad esempio, l'utente 'jhs' con il comando:

   #  adduser jhs  video

Dopodiché occorre solo garantire l'accesso in lettura e scrittura per l'utente in questione, ad esempio così:

   #  chmod g+rw /dev/v4l/video0

... dove g+rw significa aggiungere i flag read e write per il gruppo. Si veda la documentazione di chmod (man chmod o info chmod per ulteriori informazioni.

4. Applicazioni per la cattura di immagini

4.1. Programmi da linea di comando

Come si può intuire dal titolo, questi programmi non richiedono il sistema X Window per acquisire le immagini.

4.1.1. Streamer

Streamer è un programma molto versatile che consente di catturare le immagini da una webcam o da una periferica video usando soltanto la linea di comando. Può essere fornito con la propria distribuzione all'interno del pacchetto Xawtv, oppure, come per Debian, può trovarsi in un pacchetto a parte. Questo si può trovare, assieme ad altre informazioni utili, nella homepage di Xawtv di Gerd Knorr.

Per scaricare una fotografia in formato JPEG da linea di comando, ipotizzando di accedere al dispositivo tramite /dev/video0 si esegue: 

   $  streamer -c /dev/video0 -b 16 -o outfile.jpeg

...dove -b è il numero di colori (che, espresso in bpp, può assumere valori pari a 15, 16, 24 o 32) e -o è il nome del file di output che verrà creato nella directory corrente (occorre specificare l'opzione -o /path/outfile.jpg per specificare una destinazione diversa). Se si ha intenzione di catturare più immagini, ci si assicuri di inserire alcuni zeri alla fine del nome del file che si passa al comando, perché streamer è in grado di generare i nomi dei file in sequenza. Ad esempio, -o outfile000.jpeg diventa outfile001.jpeg, outfile002.jpeg, e così via.

Per creare un file .avi:

   $  streamer -q -c /dev/video0 -f rgb24 -r 3 -t 00:30:00 -o /home/jhs/outfile.avi

...dove -q sta per esecuzione 'silenziosa' (nessun messaggio in output), -f è il 'formato' (rgb24 è un avi TrueColor), -r stabilisce il numero di fotogrammi al secondo e -t è la durata della registrazione (30 minuti). Streamer è in grado di acquisire video in formato raw e Quicktime™ (non-Sorensen) e può acquisire anche l'audio. Per ulteriori informazioni si può digitare streamer --help

4.1.2. camE

CamE è un programma da linea di comando che funziona in modalità demone per catturare fotogrammi dal proprio dispositivo v4l, con funzioni di archiviazione o caricamento (su un server web, ad esempio) via ftp o scp. E' possibile sovrapporre altri elementi grafici, sovra-imprimere la data o aggiungere del testo dinamico, semplicemente modificando opportunamente il file di configurazione. Si veda la homepage di camE per ulteriori dettagli.

4.1.3. Motion

Motion è un ottimo programma in grado di controllare il segnale video proveniente da una o più webcam. Può acquisire immagini periodicamente e, nel caso venga rilevato un movimento, registrare un file mpeg e/o eseguire un'altra azione come mandare un'email o lanciare un comando. Può tenere traccia e marcare graficamente il movimento rilevato, inviare i file ad un sito tramite server web, inviarli ad un'altra applicazione e molto altro ancora. Il numero di opzioni che è possibile passare da linea di comando può facilmente intimidire; è tuttavia disponibile una pagina Wiki che riassume le varie opzioni del comando e quelle disponibili nei file di configurazione. L'homepage di Motion è qui.

4.1.4. Webcam

Webcam è uno strumento da linea di comando scaricabile dalla homepage di Xawtv. E' eccellente per l'esecuzione di operazioni automatizzate, ad esempio tramite cron, dal momento che non necessita di opzioni da linea di comando, ma solo di un file di configurazione (in genere ~/.webcamrc). E' simile a camE dal momento che può catturare immagini e caricarle su un server web per mezzo di ftp o ssh.

4.1.5. SANE

SANE, o Scanner Access Now Easy, supporta l'accesso a dispositivi v4l, come le webcam, nelle ultime versioni. Se si ha familiarità con l'impiego di scanner sotto Linux, si può provare ad usare SANE per acquisire immagini, specialmente da quando sono disponibili dispositivi che funzionano sia da scanner che da fotocamere digitali. Si faccia riferimento allo Scanner-HOWTO disponibile qui.

4.2. Programmi basati su interfaccia grafica (GUI)

4.2.1. Xawtv

Xawtv è un programma basato su X-window per l'accesso ai dispositivi video, tra cui sintonizzatori TV e webcam, sotto Linux. La homepage è questa: http://bytesex.org/xawtv. Quando si prova la webcam per la prima volta, e si ritiene che tutto sia stato configurato a dovere, si può usare l'opzione -hwscan:

   $  xawtv -hwscan This is xawtv-3.72, running on Linux/i686 (2.4.21) looking for available devices
      
   /dev/v4l/video0: OK		[ -device /dev/v4l/video0 ] type : v4l name : BT878(Hauppauge (bt878)) flags: overlay capture tuner
   /dev/v4l/video1: OK		[ -device /dev/v4l/video1 ] type : v4l name : IBM USB Camera           flags: capture

...in modo da poter vedere l'hardware a disposizione (l'output può variare considerevolmente a seconda del sistema). Si provi ad aprire xterm e ad eseguire xawtv, catturando dalla webcam:

   $  xawtv -c /dev/video1 This is xawtv-3.72, running on Linux/i686 (2.4.21)

...e (si spera) la webcam inizierà ad acquisire e a mostrare le immagini in una finestra sul desktop. Nel caso qualcosa non funzioni, i messaggi d'errore generati in xterm potranno servire a rilevare eventuali problemi di configurazione. Se tutto questo non interessa, e tutto funziona correttamente, gli avvii successivi possono essere fatti direttamente dal menu del window manager. Si può trovare qualcosa in più sulle opzioni di xawtv usando man xawtv.

4.2.2. Gqcam

Gqcam è un'applicazione grafica basata su GTK+, originariamente dedicata alle webcam Quickcam della Connectix, che ora supporta quasi tutte le webcam Video4Linux-compatibili. Ha un'interfaccia grafica molto intuitiva che rende veramente facile visualizzare, acquisire immagini, e configurare la webcam. E' fortemente raccomandata per coloro che desiderano unicamente scattare qualche foto ogni tanto senza bisogno di dover modificare un file di configurazione o usare la linea di comando.

4.2.3. Camorama

Camorama è una applicazione grafica basata su GTK+2.0 molto simile a gqcam e scritta per il desktop Gnome2. La homepage è qui.

4.2.4. GnomeMeeting

GnomeMeeting è un programma per telefonia VOIP/IP scritto per il desktop Gnome2 e che supporta anche la videoconferenza tramite webcam. La home page è gnomemeeting.org.

5. Risoluzione dei problemi

5.1. Aiuto, ho una webcam USB ma non so esattamente qual è il modello e/o il produttore. Che faccio?

Usare il comando lsusb; può fornire anche informazioni sugli altri dispositivi USB installati sul proprio sistema:

   $  lsusb
   Bus 007 Device 001: ID 0000:0000
   Bus 006 Device 001: ID 0000:0000
   Bus 005 Device 001: ID 0000:0000
   Bus 004 Device 001: ID 0000:0000
   Bus 003 Device 003: ID 0545:8080 Xirlink, Inc. IBM C-It WebCam
   Bus 003 Device 002: ID 046d:0840 Logitech, Inc. QuickCam Express
   Bus 003 Device 001: ID 0000:0000
   Bus 002 Device 003: ID 051d:0002 American Power Conversion Back-UPS Pro 500/1000/1500
   Bus 002 Device 001: ID 0000:0000
   Bus 001 Device 001: ID 0000:0000

I numeri dopo 'ID' sono i numeri del produttore e del prodotto. Si possono confrontare con quelli presenti nel Linux USB ID catalog.

Se lsusb non è disponibile, e si possiede il supporto per i filesystem /proc e USB, si può provare con il seguente comando:

   $  cat /proc/bus/usb/devices

Si dovrebbe vedere un output che comprende anche (ma non solo) ciò che segue:

   T:  Bus=01 Lev=01 Prnt=01 Port=01 Cnt=01 Dev#=3 Spd=12 MxCh=0 
   D:  Ver= 1.01 Cls=ff(vend.) Sub=ff Prot=ff MxPS=8 #Cfgs=1 
   P:  Vendor=0545 ProdID=8080 Rev= 3.0a 
   S:  Product=USB IMAGING DEVICE

La linea che inizia con "T:" indica il bus al quale è connesso il dispositivo USB. "P:" indica (ovviamente) il produttore e l'ID del prodotto, che sono elencati su linux USB Project homepage.

5.2. Aiuto, non trovo la webcam in /dev!

Assumendo che il tipo di interfaccia sia supportato, e che la webcam funzioni, si rimanda a la Sezione 3.1.

5.3. Aiuto, vedo il dispositivo (fisicamente e in /dev), ma non riesco ad accedervi!

Si veda la Sezione 3.2.

5.4. Aiuto, il driver per la mia webcam è disponibile solo come sorgente! Da dove comincio?

Per prima cosa, verificare se nella propria distribuzione c'è il driver pre-compilato. In tal caso si può caricarlo come si farebbe con un modulo. Se non c'è, ci si assicuri di avere i sorgenti del kernel installati. Serviranno anche, come minimo, GNU make, gcc, binutils e forse altri programmi, a seconda della distribuzione che si sta utilizzando. (Gli utenti Debian dovrebbero consultare la prossima sezione per istruzioni specifiche per tale distribuzione).

Si scarichi il codice sorgente del driver (che in questo esempio si chiamerà src.tar.gz) e lo si decomprima/estragga dall'archivio:

   $  tar -xvzf src.tar.gz

Dopodiché, si passi nella directory dei sorgenti del kernel:

   #  cd /usr/src/linux

Si esegua make:

   #  make oldconfig # make dep

Ora si passi nella directory in cui si è estratto il sorgente del driver e si legga con attenzione il file README e/o INSTALL per sapere come effettuare la compilazione. In genere questa operazione richiede qualcosa del tipo "make", "make all" o "make install". Se tutto viene compilato correttamente, resta soltanto da caricare il nuovo modulo con modprobe. in caso di problemi, si veda la la Sezione 5.7.

5.5. Uso Debian GNU/Linux. C'è un modo più semplice per compilare il driver?

Secondo il modesto avviso di chi scrive, è molto più semplice usare kernel-package. Innanzitutto, si installi il relativo pacchetto e tutte le dipendenze usando apt-get. Fatto questo, si installino i sorgenti del kernel che si vuole usare (ad esempio: apt-get install kernel-source-2.X.X). Si estragga tale sorgente con tar -xvjf e si crei un link simbolico chiamato linux che punti ad esso:

   #  ln -s /usr/src/kernel-source-2.X.X /usr/src/linux

A questo punto, si cambi directory con cd /usr/src/linux e si esegua make-kpkg clean, seguito da make menuconfig oppure make xconfig se si sta compilando un nuovo kernel. Si può quindi usare make-kpkg kernel_image e installare il nuovo pacchetto del kernel, creato in /usr/src, con il comando dpkg -i ../kernel-image-2.X.X. Ora, si può prelevare il sorgente del driver usando apt. Nel caso della Quickcam Express ad esempio, il pacchetto è qc-usb-source:

   #  apt-get install qc-usb-source

...si scompatti l'archivio:

   #  tar -xvzf qc-usb-modules.tar.gz

In tal modo il sorgente verrà estratto e messo nella directory /usr/src/modules. Il passo finale, mentre si è ancora in /usr/src/linux, è quello di compilare i moduli con kernel-package:

   #  make-kpkg modules_image

Si installi il nuovo pacchetto, che si trova in /usr/src/ e si chiama qc-usb-modules-[arch].deb, usando dpkg -i. Infine, si carichi il modulo:

   #  modprobe quickcam

In caso di problemi, si consulti la documentazione in /usr/share/doc/kernel-package

5.6. Aiuto, la mia webcam è supportata da un driver che va aggiunto come patch al kernel! Che faccio?

Si consulti la sezione relativa all'applicazione delle patch nel Kernel-HOWTO messo a disposizione da The Linux Documentation Project.

Secondo chi scrive, l'applicazione della patch può avvenire nel seguente modo, veloce ma non garantito: ci si assicuri che tutti i requisiti riassunti nella la Sezione 5.4 siano soddisfatti. Da linea di comando o da un terminale grafico come xterm, si passi nella directory contenente il sorgente del kernel che si sta utilizzando (o che si userà) e a cui si vuole applicare la patch.

   #  cd /usr/src/linux 
   #  patch -p1 -E patch.diff

Si dovrebbe ricevere conferma del successo dell'operazione. A questo punto si può usare make menuconfig, o qualunque altro modo si preferisca, per ricompilare il kernel abilitando il supporto per l'hardware che si possiede. Se qualche modifica non è andata a buon fine, o si incontrano problemi, si può consultare, oltre ai documenti citati in precedenza, anche man patch e la la Sezione 5.7.

5.7. Voglio contribuire. Dove posso trovare più informazioni?

Si può consultare il sito delle mailing-list di Video4Linux su https://listman.redhat.com/mailman/listinfo/video4linux-list.

5.8. Voglio contribuire a Video4Linux! Con chi mi metto in contatto?

Si consulti questa pagina.

A. Gnu Free Documentation License

Version 1.2, November 2002

Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document but changing it is not allowed.

0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft cense designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works in which its purpose is instruction or reference.

1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee and is addressed as "you". You accept the license if you copy, modify, or distribute the work in a way, thus requiring permission under copyright law.

A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical, or political position regarding them.

The "Invariant Sections" are certain Secondary Sections in which titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary, then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections, then there are none.

The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most five words, and a Back-Cover Text may be at most 25 words.

A "Transparent" copy of the Document means a machine-readable copy, represented in a format where its specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format in which its markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF, and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats, which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.

A section "Entitled XYZ" means a named subunit of the Document in which its title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section, when you modify the Document, means that it remains a section "Entitled XYZ", according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

3. COPYING IN QUANTITY

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.

B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.

C. State on the Title page the name of the publisher of the Modified Version, as the publisher.

D. Preserve all the copyright notices of the Document.

E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.

F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.

G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.

H. Include an unaltered copy of this License.

I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.

J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.

K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.

L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.

M. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.

N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.

O. Preserve any Warranty Disclaimers. If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles. You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".

6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection and distribute it individually under this License, provided you insert a copy of this License into the extracted document and follow this License in all other respects regarding verbatim copying of that document.

7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise, they must appear on printed covers that bracket the whole aggregate.

8. TRANSLATION

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense, or distribute the Document is void and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

Copyright (c) YEAR YOUR NAME. Permission is granted to copy, distribute, and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the "with...Texts." line with this: with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.