eglefin - Online în cloud

PROGRAM:

NUME

eglefin - instrument de documentare pentru codul sursă Haskell adnotat

REZUMAT

egrefin [Opțiuni] fişier...

DESCRIERE

Această pagină de manual documentează pe scurt egrefin comanda. Documentația extinsă este
disponibil în diverse alte formate, inclusiv DVI, PostScript și HTML; Vezi mai jos.

fişier este un nume de fișier care conține un modul sursă Haskell. Toate modulele specificate pe
linia de comandă va fi procesată împreună. Când un modul se referă la o entitate din altul
modul în curs de procesare, documentația se va lega direct la acea entitate.

Entități care nu pot fi găsite, de exemplu pentru că se află într-un modul care nu este
procesate ca parte a lotului curent, pur și simplu nu vor fi hyperlink în formatul generat
documentație. egrefin va emite avertismente care listează toți identificatorii pe care nu i-a putut
rezolva.

Modulele nu ar trebui să fie reciproc recursive, așa cum egrefin nu-i place să înoate
cercuri.

OPŢIUNI

Programele urmează sintaxa obișnuită a liniei de comandă GNU, cu opțiuni lungi care încep cu două
liniuțe (`--'). Un rezumat al opțiunilor este inclus mai jos. Pentru o descriere completă, vezi
cealaltă documentație.

-o DIR, --odir=DIR
directorul în care să pună fișierele de ieșire

-i FILE, --read-interface=FILE
citește o interfață din FILE.

-D FILE, --dump-interface=FILE
aruncați o interfață pentru aceste module în FILE.

-l DIR, --lib=DIR
locația fișierelor auxiliare ale lui Haddock

-h, --html
Generați documentație în format HTML. Mai multe fișiere vor fi generate în
directorul curent (sau directorul specificat dacă -o este dată opțiunea), inclusiv
următoarele:

index.html
Pagina de nivel superior a documentației: listează modulele disponibile, folosind
indentare pentru a reprezenta ierarhia dacă modulele sunt ierarhice.

eglefin.css
Foaia de stil folosită de HTML-ul generat. Simțiți-vă liber să modificați acest lucru la
schimbați culorile sau aspectul sau chiar specificați propria foaie de stil folosind
--css opțiune.

module.html
O pagină HTML pentru fiecare modul.

doc-index.html, doc-index-XX.html
Indexul, împărțit în două (funcții/constructori și tipuri/clase, conform per
spații de nume Haskell) și împărțiți în continuare alfabetic.

--hoogle
ieșire pentru Hoogle

--html-help=format
produce index și cuprins în format mshelp, mshelp2 sau devhelp (cu -h)

--source-base=URL-ul
Includeți linkuri către fișierele sursă în documentația generată, unde URL este adresa
URL de bază unde pot fi găsite fișierele sursă.

-s URL-ul, --source-module=URL-ul
Includeți linkuri către fișierele sursă în documentația generată, unde URL este a
Legătura codului sursă pentru fiecare modul (folosind variantele %{FILE} sau %{MODULE}).

--source-entity=URL-ul
Includeți linkuri către fișierele sursă în documentația generată, unde URL este a
link de cod sursă pentru fiecare entitate (folosind variantele %{FILE}, %{MODULE} sau %{NAME}).

--comments-base=URL-ul
URL pentru un link de comentarii pe paginile de conținut și index.

--comments-module=URL-ul
URL pentru un link de comentarii pentru fiecare modul (folosind varul %{MODULE}).

--comments-entity=URL-ul
Adresa URL pentru un link de comentarii pentru fiecare entitate (folosind %{FILE}, %{MODULE} sau %{NAME}
vars).

--css=FILE
Utilizați CSS-ul FILE în loc de foaia de stil implicită care vine cu egrefin pentru HTML
ieșire. Ar trebui să specifice anumite clase: vezi foaia de stil implicită pentru detalii.

-p FILE, --prolog=FILE
Specificați un fișier care conține text de prolog.

-t TITLUL, --titlu=TITLUL
Utilizare TITLUL ca titlu de pagină pentru fiecare pagină din documentație. Asta va
în mod normal să fie numele bibliotecii care este documentată.

Titlul ar trebui să fie un șir simplu (fără markup, vă rog!).

-k NUME, --pachet=NUME
Specificați numele pachetului (opțional).

-n, --fara-preludiu-implicit
nu presupuneți că Prelude este importat

-d, --depanare
Activați ieșirea suplimentară de depanare.

-?, --Ajutor
Afișează ajutor.

-V, --versiune
Versiunea de afișare.

-v, --verbos
Raportare de stare cuprinzătoare.

--use-contents=URL-ul
Utilizați o pagină de conținut HTML generată separat.

--gen-conținut
Generați un conținut HTML de la interfețele specificate.

--use-index=URL-ul
Utilizați un index HTML generat separat.

--gen-index
Generați un index HTML din interfețele specificate.

--ignora-toate-exporturile
Comportați-vă ca și cum toate modulele au atributul ignore-exports

--ascunde=MODULUL
Comportă-te ca și cum MODULUL are atributul ascunde.

--use-package=PACHET
Modulele procesate depind de PACHET.

Utilizați eglefinul online folosind serviciile onworks.net