eglefino - Online nel cloud

PROGRAMMA:

NOME

eglefino - strumento di documentazione per il codice sorgente Haskell annotato

SINOSSI

eglefino [Opzioni] filetto...

DESCRIZIONE

Questa pagina di manuale documenta brevemente il eglefino comando. Ampia documentazione è
disponibile in vari altri formati tra cui DVI, PostScript e HTML; vedi sotto.

filetto è un nome file contenente un modulo sorgente Haskell. Tutti i moduli specificati sul
la riga di comando verrà elaborata insieme. Quando un modulo fa riferimento a un'entità in un altro
modulo in elaborazione, la documentazione si collegherà direttamente a tale entità.

Entità che non si trovano, ad esempio perché si trovano in un modulo che non è in corso
elaborato come parte del batch corrente, semplicemente non sarà collegato ipertestuale nel generato
documentazione. eglefino emetterà avvisi che elencano tutti gli identificatori che non potrebbe
risolvere.

I moduli non dovrebbero essere reciprocamente ricorsivi, come eglefino non gli piace nuotare dentro
cerchi.

VERSIONI

I programmi seguono la consueta sintassi della riga di comando GNU, con opzioni lunghe che iniziano con due
trattini (`--'). Di seguito è riportato un riepilogo delle opzioni. Per una descrizione completa, vedere
l'altra documentazione.

-o DIR, --dir=DIR
directory in cui mettere i file di output

-i RISORSE, --read-interfaccia=RISORSE
leggere un'interfaccia da RISORSE.

-D RISORSE, --dump-interfaccia=RISORSE
scarica un'interfaccia per questi moduli in RISORSE.

-l DIR, --lib=DIR
posizione dei file ausiliari di Haddock

-h, --html
Genera documentazione in formato HTML. Diversi file verranno generati nel
directory corrente (o la directory specificata se il -o l'opzione è data), includendo
il seguente:

index.html
La pagina di primo livello della documentazione: elenca i moduli disponibili, utilizzando
rientro per rappresentare la gerarchia se i moduli sono gerarchici.

eglefino.css
Il foglio di stile utilizzato dall'HTML generato. Sentiti libero di modificare questo per
cambia i colori o il layout, o anche specifica il tuo foglio di stile usando il
--css opzione.

modulo.html
Una pagina HTML per ogni modulo.

doc-index.html, doc-indice-XX.html
L'indice, diviso in due (funzioni/costruttori e tipi/classi, come per
spazi dei nomi Haskell) e ulteriormente suddivisi in ordine alfabetico.

--hoogle
uscita per Hoogle

--html-aiuto=formato
produrre indice e sommario in formato mshelp, mshelp2 o devhelp (con -h)

--source-base=URL
Includere collegamenti ai file di origine nella documentazione generata, dove URL è il
URL di base in cui è possibile trovare i file di origine.

-s Url, --modulo-sorgente=URL
Includere collegamenti ai file sorgente nella documentazione generata, dove URL è a
collegamento al codice sorgente per ogni modulo (usando le variabili %{FILE} o %{MODULE}).

--entità-origine=URL
Includere collegamenti ai file sorgente nella documentazione generata, dove URL è a
collegamento al codice sorgente per ogni entità (usando le variabili %{FILE}, %{MODULE} o %{NAME}).

--base-commenti=URL
URL per un collegamento ai commenti sui contenuti e sulle pagine dell'indice.

--commenti-modulo=URL
URL per un collegamento ai commenti per ogni modulo (usando la var %{MODULE}).

--entità-commenti=URL
URL per un collegamento ai commenti per ogni entità (usando %{FILE}, %{MODULE} o %{NAME}
var).

--css=RISORSE
Usa il CSS RISORSE invece del foglio di stile predefinito fornito con eglefino per HTML
produzione. Dovrebbe specificare alcune classi: vedere il foglio di stile predefinito per i dettagli.

-p RISORSE, --prologo=RISORSE
Specificare un file contenente il testo del prologo.

-t TITOLO, --titolo=TITOLO
Usa il TITOLO come intestazione di ogni pagina della documentazione. Questo sarà
normalmente è il nome della biblioteca che viene documentata.

Il titolo dovrebbe essere una stringa semplice (nessun markup per favore!).

-k NOME, --pacchetto=NOME
Specificare il nome del pacchetto (facoltativo).

-n, --no-preludio-implicito
non dare per scontato che Prelude sia importato

-d, - debug
Abilita output di debug aggiuntivo.

-?, --Aiuto
Mostra aiuto.

-V, --versione
Visualizza la versione.

-v, --verboso
Rapporto dettagliato sullo stato.

--use-content=URL
Utilizzare una pagina di contenuti HTML generata separatamente.

--gen-contenuti
Genera un contenuto HTML da interfacce specificate.

--use-indice=URL
Utilizza un indice HTML generato separatamente.

--gen-indice
Genera un indice HTML dalle interfacce specificate.

--ignora-tutte-le-esportazioni
Comportati come se tutti i moduli avessero l'attributo ignore-exports

--nascondi=MODULO
Comportati come se MODULO ha l'attributo nascondi.

--use-pacchetto=PACCHETTO
I moduli in elaborazione dipendono da PACCHETTO.

Usa l'eglefino online usando i servizi onworks.net