update-yorickdoc - Online în cloud

PROGRAM:

NUME

update-yorickdoc - Creați documentație HTML pentru Yorick

REZUMAT

update-yorickdoc [--conf=fisier] [--auto] [--auto-acum] [--de la=director] [--la=director]
[--xref-dir=director] [--src-dir=director] [--template=fişier]

DESCRIERE

update-yorickdoc este un înveliș în jurul htmldoc.i, un script Yorick care extrage DOCUMENT
comentarii din fișierele sursă Yorick și le transformă într-un set de fișiere HTML.
update-yorickdoc îmbină fișierele dintr-un „director sursă” (implicit: /usr/share/yorick-doc,
opțiunea de linie de comandă: --src-dir), șterge directorul țintă (implicit:
/usr/share/doc/yorick-doc/html_xref) și, dacă Yorick este instalat, apelează „yorick -batch
htmldoc.i" pentru a compila documentația HTML pentru toate funcțiile instalate curent (fie
din pachetul principal Yorick sau din pachetele suplimentare).

update-yorickdoc este menit să fie apelat automat ori de câte ori este un pachet Yorick
instalat sau demontat. Este posibil să împiedicați actualizările automate setând „ENABLE_AUTO”
la 0 în /etc/yorick-doc. De asemenea, este posibil să utilizați manual update-yorickdoc pentru a crea
documentație din directoare personalizate (de exemplu, propriul utilizator ~/Yorick/ director) sau la a
loc personalizat, de exemplu.

update-yorickdoc are un set de parametri impliciti cu care să funcționeze. Acești parametri sunt
suprascris în ordine cronologică de conținutul /etc/yorick-doc, $HOME/.yorick-doc și
linia de comandă.

Sunt necesare câteva fișiere pentru ca acest script să funcționeze. Fișierele implicite sunt furnizate în
directorul sursă implicit și pachetele suplimentare ar trebui să ofere informații suplimentare în
același loc. Vedea DOSARE mai jos, precum și /usr/share/doc/yorick-dev/yorick-policy.gz.

OPŢIUNI

--auto | -a
Acest indicator este depreciat de apariția declanșatorilor în dpkg. Pe sistemele în care dpkg
acceptă declanșatoare, -a transformă update-yorickdoc într-un no-op. Pe sistemele mai vechi, asta
se comportă ca -A de mai jos.

--auto-acum | -A
Acest steag este menit să fie folosit numai în scriptul postinst al pachetului yorick-doc,
care este rândul său ar trebui să fie declanșat de fiecare dată când un pachet de suplimente yorick este
instalat, actualizat sau eliminat. Este posibil să transformați update-yorickdoc într-un no-op
când acest flag este setat prin setarea ENABLE_AUTO la 0 în /etc/yorick-doc.

--conf=fişier
Citiți configurația din acest fișier. Acest fișier este analizat deoarece opțiunea se găsește pe
linia de comandă, suprascriind opțiunile care vin înainte.

--de la=director1:director2...
Listă de directoare separate prin două puncte de scanat pentru fișiere Yorick. Mod implicit:
/usr/share/yorick/i:/usr/share/yorick/i0.

--epurare | -p
Ștergeți numai /usr/share/doc/yorick-doc/html_xref (sau directorul setat folosind --to și
--xref-dir, sau variabilele echivalente din /etc/yorick-doc), nu reconstruiți
documentatie ulterior.

--Liniște | -q
Stai liniștit, spunând doar în scurt timp ce face update-yorickdoc. Acesta este încorporat
implicit, dar este posibil să fi fost suprascris într-un fișier de configurare.

--src-dir=director
Director care conține fișiere .packinfo, .keywords și .aliases la construirea fișierului
documentație. Fiecare dintre aceste trei tipuri de fișiere va fi concatenat în
ordine lexicografică și transmisă la htmldoc.i folosind --packinfo, --keywords și
--aliases opțiuni (vezi htmldoc.i). Implicit: /usr/share/yorick-doc.

--template=fişier
Fișier șablon pentru htmldoc.i. Formatul corect este detaliat htmldoc.i. Mod implicit:
/usr/share/yorick-doc/template.html.

--la=director
Directorul de nivel superior al ierarhiei HTML Yorick de actualizat. Acesta este un nivel mai sus
directorul care va fi șters și/sau (re)construit. Implicit la
/usr/share/doc/yorick-doc.

--verbos | -v
Fiți cuprinzător, oferind o mulțime de informații de depanare. Valoarea implicită încorporată este să fie
liniște, spun doar în scurt timp ce face update-yorickdoc.

--xref-dir=cuvânt
Subdirectorul directorului „TO” în care să compilați documentația. Anumit
hyperlinkurile din documentație vor folosi această valoare. Acesta nu ar trebui setat la a
director al cărui conținut îl apreciați, deoarece acest director va fi mai întâi șters. Mod implicit:
html_xref.

Utilizați update-yorickdoc online folosind serviciile onworks.net