.\" Process this file with .\" groff -man -Tascii linuxdoc.1 .\" .TH LINUXDOC 1 "27 Jul 2000" .SH NOME linuxdoc \- LinuxDoc DTD SGML convertitore ad altri formati di uscita .SH SINTASSI .B linuxdoc .I \fB\--backend=\fP\fIformato\fP .br .I \fB\--papersize=\fP\fIsize\fP .I \fB\--language=\fP\fIlang\fP .I \fB\--charset=\fP\fIchar\fP .I \fB\--style=\fP\fIfile\fP .I \fB\--debug\fP .I \fB\--define\fP\ \fIattributo=valore\fP .I \fB\--include\fP\ \fIentity\fP .B "[opzioni-backend...]" .I file(.sgml)\fP .PP o (Uso vechio, obsoleto) .br .B sgmlxxxx [opzioni-generiche...] [opzioni-backend...] \ \ \fIfile(.sgml)\fP .SH DESCRIZIONE La suite .B linuxdoc e` una collezione di formatatori di testo che comprendono un file sorgente SGML di LinuxDoc DTD. Ogni formattatore (o "back-end") converte il file sorgente in una varieta` di formati di uscita, includendo HTML, TeX, DVI, PostScript, testo semplice, e il sorgente .BR groff (1) nel formato delle pagine di manuale. La suite linuxdoc e` fornita di retro compatibilita`, dato che ci sono ancora molti documenti utili scritti in sorgente sgml di LinuxDoc DTD. .LP Il liguaggio di macatuta accettato da questi formattatori e` descritto nella .IR Linuxdoc-Tools "Guida dell'Utente". Ci sono delle varianti di una document type definition SGML sviluppate originariamente da Matt Welsh per la documentazione di Linux. .SH OPZIONI-GENERICHE La maggior parte delle opzioni da riga di comando sono accettate da tutti i back-end. Alcuni back-end hanno opzioni specifiche per controllare la loro resa al proprio particolare formato di uscita. Queste sono le opzioni piu` comuni: .IP "--backend=\fIformato\fR, -B Imposta il back-end per un formato specifico. Il formato predefinito e` nessuno dei formati attuali, ma solo l'uscita dell'uso di questa suites. I formati disponibili sono: html, info, latex, lyx, rtf, txt, check. .IP "--papersize=\fIsize\fR, -p Imposta le dimensioni della pagina. Il formato prdefinito e` ``a4'' (pagina Europea 297x210mm). Si puo` specificare amche il formato ``letter''. .IP "--language=\fIlang\fR, -l" Specifica la lingua del documento (questo puo` cambiare dipendentemente da quale file di stile e` usato da un back-end per la formattazione). La lingua predefinita e` l'Inglese. Per vedere la lista dei codici di lingua validi eseguire un comando LinuxDoc-tools senza argomenti. .IP "--charset=\fIchars\fR, -c" Specifica la codifica del carattere di uscita. La codifica predefinita a ``ascii'' seleziona il set di caratteri ASCII; si puo` specificare "latin" per specificare il set di caratteri ISO 8859-1 (Latin-1). Inoltre, ``nippon'' e ``euc-kr'' sono richiesti per gestire le rispettive codifiche euc-jp e euc-kr del file sgml. .IP "--style=\fIfile\fR, -S" Include un DTD (Document Type Definition) ausiliario da /usr/share/linuxdoc-tools/dtd. .IP "--tabsize=\fIn\fR, -t" Imposta gli spazi di tabulazione (tab) assunti per la generazione del documento di uscita. Il valore perdefinito degli spazi di tabulazione e` 8. .IP "--debug, -d" Non elimina i file intermedi (come i file .TeX generati sul passaggio a un .dvi, o i file .man eliminati sul passaggio al testo semplice). .IP "--define, -D" Passa la coppia attributo/valore per essere corrisposta su i condizionali "if" e "unless". Vedere la Guida dell'Utente per una discussione estesa di di questa caratteristica. Questa condizionalizzazione e` gestita dal comando sgmlpre. Vedere la pagina di manuale di sgmlpre(1) cosi` come la Guida dell'Utente. .IP "--include, -i" Passa una opzione -i al comando .BR nsgmls (1). Questo puo` essere usato per l'inclusione di condizionali. Vedere la pagina di manuale di .BR nsgmls (1) per i dettagli. .IP "--pass, -P" Passa una stringa di opzioni al back-end. L'esatta semantica di queste opzioni e` dipendente dal back-end e dovrebbe essere spiegata nella pagina di manuale relativa a ogni back-end. .IP file Il file sorgente SGML, chiamato .I file o .IR file.sgml. .LP L'esecuzione di un back-end senza alcun argomento produrra` una lista di tutte le sue opzioni (Il messaggio di errore riguardo a "no filenames given" in questo caso puo` essere sicuramente ignorato). I back-end disponibili includono (i nomi tra parentesi sono la forma vecchia & osoleta): .IP linuxdoc\ \-B\ html\ (sgml2html) traduce in HTML .IP linuxdoc\ \-B\ info\ (sgml2info) traduce in GNU info .IP linuxdoc\ \-B\ lyx\ (sgml2lyx) traduce in macro di Lyx .IP linuxdoc\ \-B\ latex\ (sgml2latex) traduce in LaTeX 2e .IP linuxdoc\ \-B\ rtf\ (sgml2rtf) traduce in Microsoft Rich Text Format .IP linuxdoc\ \-B\ txt\ (sgml2txt) traduce in testo semplice o nel markup delle pagine di manuale Unix .LP C'e` anche .BR linuxdoc -B check (sgmlcheck) uno strumento disponibile per verificare la sintassi LinuxDoc DTD SGML dei documenti sorgenti attualmente senza generare una versione tradotta. .SH DRIVER DI BACKEND Di seguito c'e` la descrizione per ogni driver di backend: .LP **************************************************** .LP .B linuxdoc -B html \fP (sgml2html) converte un file sorgente SGML di LinuxDoc DTD in file HTML di uscita. L'uscita apparirà nel file di livello piu` alto .I file.html e .I file-n.html per ogni sezione (azione predefinita, ma puo` essere cambiata con un'opzione), dove .I file e` il nome del file sorgente SGML e .I n e` il nome della sezione. .LP La coppia attributo/valore "output=html" e` impostata per i condizionali. .LP .B linuxdoc -B html accetta le seguenti opzioni: .B [--split .I 0|1|2 .B ] [--dosnames] [--imagebuttons] .B [--toc .I 0|1|2 .B ] .LP Il significato di queste opzioni e`: .IP "--split, -s" A quale livello dividere i documenti sorgenti. 0 = non dividere, 1 = dividere attraverso le sezioni principali, 2 = dividere attraverso le sottosezioni. .IP "--toc, -T" A quale livello generare la toc (table of contents). 0 = non generare la toc, 1 = include le sezioni principali(/capitoli/parti), 2 = include le sottosezioni. .IP "--dosnames, -h" Usa ".htm" invece di ".html" come estensione dei file .IP "--imagebuttons, -I" Usa le icone delle immagini "next" (successivo), "previous" (precedente), e "contents" (contenuti) incluse nella directory /usr/share/linuxdoc-tools come pulsanti di navigazione. .IP "--footer, -F" Usa il file specificato come il footer in ogni file html ottenuto. Il footer predefinito e` solo il semplice .nh .nf .ad l \\n \\n .hy .fi .IP "--header, -H" Usa il file specificato come la parte piu` alta dell'intestazione in ogni file html ottenuto. Notare che questo non e` la parte completa dell'intestazione. (per esempio, il titolo e i links (next,previous,contents) non sono tenuti nell'intestazione predefinita. L'intestazione predefinita e` .nh .nf .ad l \\n \\n \\n .hy .fi .LP **************************************************** .LP .B linuxdoc -B info \fP (sgml2info) converte un file sorgente SGML di LinuxDoc DTD al formato info GNU. L'uscita apparira` nel .I file.info dove .I file e` il nome del file sorgente SGML. .LP La coppia attributo/valore "output=info" e` impostata per i condizionali. .LP .B linuxdoc -B info non ha opzioni specifiche di backend. .LP **************************************************** .LP .B linuxdoc -B latex \fP (sgml2latex) converte un file sorgente SGML di LinuxDoc DTD in un file di uscita LaTeX, usando l'analizzatore .BR nsgmls (1) o .BR onsgmls (1), e il traduttore .BR sgmlsasp (1). Usando l'uscita LaTeX, e il formattatore di testo .BR latex (1), si puo` creare un'uscita DVI, e un'uscita PostScript usando il convertitore .BR dvips (1). L'uscita apparira` nel .I file.tex per l'uscita LaTeX, .I file.dvi per l'uscita DVI, o .I file.ps per l'uscita PostScript, dove .I file e` il nome del file sorgente SGML. .LP Usando l'uscita LaTeX, e il formattatore di testo .BR pdflatex (1), poi si puo` creare un file di uscita PDF piacevole, adatto per essere visualizzato con visualizzatori di PDF come .BR xpdf (1), .BR acroread (1) o .BR ghostview (1). .LP La coppia attributo/valore "output=latex2e" e` impostata per i condizionali. .LP .B linuxdoc -B latex accetta le seguenti opzioni specifiche di backend: .BI [--output= tex | dvi | ps | pdf] .B [--bibtex] [--makeindex] .BI [--pagenumber= n ] .B --quick .BI [--latex= latex | hlatexp | platex | jlatex] .BI [--dvips= dvips | dvi2ps] .LP Il significato di queste opzioni e`: .IP "--output=\fIfmt\fR, -o" Specifica il formato di uscita voluto. Il formato specificato .I fmt puo` essere ``tex'', ``dvi'', ``ps'', o ``pdf''. .PP Nota: Questa versione non sovrascrive/rimuove i file intermedi: il file per l'uscita dvi, o i file per l'uscita ps. Questo comportamento e` differente dall'SGML-Tools 1.0.9 originale, cosi` si e` avvertiti. .IP "--bibtex, -b" Elabora il file TeX generato con .BR bibtex (1). .IP "--makeindex, -m" Genera un file index TeX adatto per l'elaborazione con .BR makeindex (1) dai tag e presenti nel sorgente SGML. .IP "--pagenumber, -n" Imposta il numero della pagina iniziale nel file di uscita DVI o PS. .IP "--quick, -q" Fa solamente un passaggio della formattazione. Spesso questo non e` sufficiente per produrre un'uscita finale (dovuta ai riferimenti, ecc.) ma e` utile per mostrare gli errori di TeX e i problemi di giustificazione. .IP "--pass, -P" L'argomento dell'opzione pass e` inserito subito dopo il preambolo di LaTeX generato dal tag del tipo di documento. Specifica il formato di uscita voluto. Il formato specificato .I fmt puo` essere ``tex'', ``dvi'', ``ps'', o ``pdf''. .IP "--latex=\fIcomando_latex_alternativo\fR, -x" Questa opzione correntemente e` per il coreano e il giapponese. Il .I comando_latex_alternativo puo` essere ``latex'' (predefinito), ``hlatexp'' (per il coreano), ``platex'' o ``jlatex'' (per il giapponese). Questa opzione puo` essere usata per ottenere un documento coreano usando HLaTeXp, o per ottenere un documento giapponese usando pLaTeX/jLaTeX. Altrimenti, HLaTeX dovrebbe essere installato per ottenere un documento coreano. In altre parole, un documento giapponese puo` essere ottenuto con jLaTeX (che e` il predefinito quando e` specificato ``-c nippon''), cosi` se si ha gia` installato jLaTeX, non e` necessario installare pLaTeX. .IP "--dvips=\fIcomando_dvips_alternativo\fR, -s" Questa opzione e` correntemente per il giapponese. Il .I comando_dvips_alternativo puo` essere ``dvips'' o ``dvi2ps''. Se non si conosce questo, allora questo non e' necessario. .LP **************************************************** .LP .B linuxdoc -B lyx \fP (sgml2lyx) converte un file sorgente SGML di LinuxDoc DTD a un file di uscita LyX. L'uscita apparira` nel .I file.lyx dove .I file e` il nome del file sorgente SGML. .LP La coppia attributo/valore "output=lyx" e` impostata per i condizionali. .LP .B linuxdoc -B lyx non ha opzioni specifiche di backend. .LP **************************************************** .LP .B linuxdoc -B rtf \fP (sgml2rtf) converte un file sorgente SGML di LinuxDoc DTD a RTF, il Rich Text Format usato dal sistema di aiuto di Microsoft Windows. L'uscita apparira` nel file di piu` alto livello .I file.rtf e .I file-n.rtf per ogni sezione, dove .I file e` il nome del file sorgente SGML. L'uscita RTF e` adatta alla compilazione con il Compilatore dell'Help di Windows Help (hc31.exe). .LP La coppia attributo/valore "output=rtf" e` impostata per i condizionali. .LP .B linuxdoc -B rtf accetta .B [--twosplit] come un'opzione specifica di backend. Il significato di questa opzione e` il seguente: .IP "--twosplit, -2" Divide i file sia a n. seczioni che a n.m. sottosezioni .LP **************************************************** .LP .B linuxdoc -B txt \fP (sgml2txt) converte un file sorgente SGML di LinuxDoc DTD a file di uscita ASCII, ISO-8859-1, o EUC-JP. L'uscita apparira` nel .I file.txt dove .I file e` il nome del file sorgente SGML. .LP La coppia attributo/valore "output=txt" e` impostata per i condizionali. .LP .B linuxdoc -B txt accetta le seguenti opzioni di backend: .B [--manpage] [--filter] [--blanks=\fIn\fB] .LP Il significato di queste opzioni e`: .IP "--manpage, -m" Produce in uscita un file sorgente di groff, adatto per la formattazione con .B groff -man per le pagine di manuale .IP "--filter, -f" Rimuove gli backspace-overstrikes dai file intermediari generati da \fBgroff\fR(1). .IP "--pass, -P" L'argomento dell'opzione pass e` aggiunto alle opzioni della riga di comando gestite da .BR groff (1). .IP "--blanks=\fIn\fR, -b" Imposta il limite delle linee bianche consecutive per la generazione del documento di uscita. Il limite predefinito e` 3. Se e` specificato 0 (zero), il risultato avra` molte linee bianche consecutive. .LP **************************************************** .LP .B linuxdoc -B check \fP (sgmlcheck) esegue un analizzatore SGML sul documento sorgente specificato. Ogni errore e` riportato sullo standard output. Nessuna versione formattata del sorgente e` prodotta. .LP Notare che .B linuxdoc -B check pre-elabora il sorgente SGML di LinuxDoc DTD, facendo la condizionalizzazione descritta da ogni tag <#if> e <#unless>. I documenti sorgenti che contengono questi tag confonderanno un analizzatore SGML standalone. .B linuxdoc -B check non ha opzioni specifiche di backend. **************************************************** .SH FILE Sono usati molti file ed eseguibili nelle directory /usr/share/linuxdoc-tools e /usr/bin. .SH BUG Potrebbe essercene qualcuno. Ci si senta liberi di inviare il proprio report al corrente manutentore. .SH MANUTENTORE Questa pagina di manuale e` stata mantenuta da Cees de Groot in SGML-Tools (v1). Attualmente e` mantenuta da Taketoshi Sano per Linuxdoc-Tools. Traduzione ed adattamenti a cura di Hugh Hartmann . Revisione a cura di Beatrice Torracca .