Dit is de opdracht update-yorickdoc die kan worden uitgevoerd in de gratis hostingprovider van OnWorks met behulp van een van onze meerdere gratis online werkstations zoals Ubuntu Online, Fedora Online, Windows online emulator of MAC OS online emulator
PROGRAMMA:
NAAM
update-yorickdoc - Bouw HTML-documentatie voor Yorick
KORTE INHOUD
update-yorickdoc [--conf=het dossier] [--auto] [--auto-nu] [--van=map] [--naar=map]
[--xref-dir=map] [--src-dir=map] [--sjabloon=het dossier]
PRODUCTBESCHRIJVING
update-yorickdoc is een wrapper rond htmldoc.i, een Yorick-script dat DOCUMENT extraheert
opmerkingen uit Yorick-bronbestanden en verandert deze in een reeks HTML-bestanden.
update-yorickdoc voegt bestanden samen uit een "bronmap" (standaard: /usr/share/yorick-doc,
opdrachtregeloptie: --src-dir), verwijdert de doelmap (standaard:
/usr/share/doc/yorick-doc/html_xref), en, als Yorick is geïnstalleerd, wordt "yorick -batch
htmldoc.i" om HTML-documentatie samen te stellen voor alle momenteel geïnstalleerde functies (ofwel
uit het hoofdpakket van Yorick of uit aanvullende pakketten).
update-yorickdoc is bedoeld om automatisch te worden aangeroepen wanneer er een Yorick-pakket is
geïnstalleerd of verwijderd. Het is mogelijk om automatische updates te voorkomen door "ENABLE_AUTO" in te stellen
naar 0 in /etc/yorick-doc. Het is ook mogelijk om update-yorickdoc handmatig aan te maken
documentatie uit aangepaste mappen (bijvoorbeeld die van een gebruiker ~/Yorick/ directory) of naar a
aangepaste plek, bijvoorbeeld.
update-yorickdoc heeft een set standaardparameters om mee te werken. Deze parameters zijn
in chronologische volgorde overschreven door de inhoud /etc/yorick-doc, $HOME/.yorick-doc, en
de opdrachtregel.
Er zijn enkele bestanden vereist om dit script te laten functioneren. Standaardbestanden worden geleverd in de
standaardbronmap en add-onpakketten moeten aanvullende informatie bieden in de
dezelfde plaats. Zien FILES hieronder, evenals /usr/share/doc/yorick-dev/yorick-policy.gz.
OPTIES
--auto | -a
Deze vlag wordt verouderd door de komst van triggers in dpkg. Op systemen waarop dpkg
ondersteunt triggers, -a verandert update-yorickdoc in een no-op. Op oudere systemen is dit wel het geval
gedraagt zich als -A hieronder.
--auto-nu | -A
Deze vlag is alleen bedoeld om te worden gebruikt in het postinst-script van het yorick-doc-pakket,
Dit is de beurt die elke keer dat een Yorick add-on-pakket wordt geactiveerd, moet worden geactiveerd
geïnstalleerd, geüpgraded of verwijderd. Het is mogelijk om van update-yorickdoc een no-op te maken
wanneer deze vlag wordt ingesteld door ENABLE_AUTO op 0 te zetten in /etc/yorick-doc.
--conf=filet
Lees de configuratie uit dit bestand. Dit bestand wordt geparseerd omdat de optie te vinden is in het
opdrachtregel, waarbij de voorgaande opties worden overschreven.
--van=map1:map2...
Door dubbele punten gescheiden lijst met mappen die moeten worden gescand op Yorick-bestanden. Standaard:
/usr/share/yorick/i:/usr/share/yorick/i0.
--zuiveren | -p
Verwijder alleen /usr/share/doc/yorick-doc/html_xref (of de map die is ingesteld met --to en
--xref-dir, of de equivalente variabelen in /etc/yorick-doc), bouw het
documentatie achteraf.
--stil | -q
Wees stil en vertel slechts kort wat update-yorickdoc doet. Dit is de ingebouwde
standaard, maar is mogelijk overschreven in een configuratiebestand.
--src-dir=directory
Directory met .packinfo-, .keywords- en .aliases-bestanden bij het bouwen van de .packinfo-, .keywords- en .aliases-bestanden
documentatie. Elk van deze drie typen bestanden wordt samengevoegd
lexicografische volgorde en ingevoerd in htmldoc.i met behulp van de --packinfo, --keywords, en
--aliases opties (zie htmldoc.i). Standaard: /usr/share/yorick-doc.
--sjabloon=filet
Sjabloonbestand voor htmldoc.i. Het juiste formaat is gedetailleerd htmldoc.i. Standaard:
/usr/share/yorick-doc/template.html.
--naar=directory
Directory op het hoogste niveau van de Yorick HTML-hiërarchie die moet worden bijgewerkt. Dit is een niveau hoger
de map die zal worden verwijderd en/of (opnieuw) opgebouwd. Standaard ingesteld op
/usr/share/doc/yorick-doc.
--uitgebreid | -v
Wees uitgebreid en geef veel foutopsporingsinformatie weer. De ingebouwde standaard is om
rustig, ik vertel even kort wat update-yorickdoc doet.
--xref-dir=woord
De submap van de map "TO" waarin de documentatie moet worden gecompileerd. Zeker
hyperlinks in de documentatie zullen deze waarde gebruiken. Dit mag niet op a worden ingesteld
map waarvan u de inhoud waardeert, aangezien deze map eerst zal worden gewist. Standaard:
html_xref.
Gebruik update-yorickdoc online met behulp van onworks.net-services
