update-yorickdoc - Online nel cloud

PROGRAMMA:

NOME

update-yorickdoc - Crea documentazione HTML per Yorick

SINOSSI

aggiornamento-yorickdoc [--conf=file] [--auto] [--auto-ora] [--da=elenco] [--a=elenco]
[--xref-dir=elenco] [--dir-src=elenco] [--template =file]

DESCRIZIONE

update-yorickdoc è un wrapper per htmldoc.i, uno script Yorick che estrae DOCUMENT
commenti dai file sorgente di Yorick e li trasforma in un insieme di file HTML.
update-yorickdoc unisce i file da una "directory di origine" (predefinito: /usr/share/yorick-doc,
opzione della riga di comando: --src-dir), elimina la directory di destinazione (impostazione predefinita:
/usr/share/doc/yorick-doc/html_xref) e, se Yorick è installato, chiama "yorick -batch
htmldoc.i" per compilare la documentazione HTML per tutte le funzioni attualmente installate (o
dal pacchetto Yorick principale o dai pacchetti aggiuntivi).

update-yorickdoc è pensato per essere chiamato automaticamente ogni volta che un pacchetto Yorick è
installato o rimosso. È possibile impedire gli aggiornamenti automatici impostando "ENABLE_AUTO"
a 0 in /etc/yorick-doc. È anche possibile utilizzare update-yorickdoc manualmente per creare
documentazione da directory personalizzate (ad es. quella di un utente ~/Yorick/ directory) o ad a
luogo personalizzato, per esempio.

update-yorickdoc ha una serie di parametri predefiniti con cui funzionare. Questi parametri sono
sovrascritto in ordine cronologico dal contenuto /etc/yorick-doc, $HOME/.yorick-doc e
la riga di comando.

Per il funzionamento di questo script sono necessari alcuni file. I file predefiniti sono forniti in
directory dei sorgenti predefinita e i pacchetti aggiuntivi dovrebbero fornire informazioni aggiuntive nella
stesso posto. Vedere FILE sotto così come /usr/share/doc/yorick-dev/yorick-policy.gz.

VERSIONI

--auto | -a
Questo flag è stato deprecato dall'avvento dei trigger in dpkg. Sui sistemi in cui dpkg
supporta i trigger, -a trasforma update-yorickdoc in un no-op. Sui sistemi più vecchi, è
si comporta come -A sotto.

--auto-ora | -A
Questo flag è pensato per essere usato solo nello script postinst del pacchetto yorick-doc,
che dovrebbe essere attivato ogni volta che viene attivato un pacchetto aggiuntivo Yorick
installato, aggiornato o rimosso. È possibile trasformare update-yorickdoc in un no-op
quando questo flag è impostato impostando ENABLE_AUTO su 0 in /etc/yorick-doc.

--conf=filetto
Leggi la configurazione da questo file. Questo file viene analizzato non appena l'opzione si trova su
riga di comando, sovrascrivendo le opzioni precedenti.

--da=directory1:directory2...
Elenco di directory separate da due punti per la scansione dei file Yorick. Predefinito:
/usr/share/yorick/i:/usr/share/yorick/i0.

--epurazione | -p
Elimina solo /usr/share/doc/yorick-doc/html_xref (o la directory impostata usando --to e
--xref-dir, o le variabili equivalenti in /etc/yorick-doc), non ricostruire il file
documentazione in seguito.

--silenzioso | -q
Stai zitto, dicendo solo brevemente cosa fa update-yorickdoc. Questo è il built-in
predefinito ma potrebbe essere stato sovrascritto in un file di configurazione.

--dir-src=elenco
Directory contenente i file .packinfo, .keywords e .aliases durante la creazione del
documentazione. Ciascuno di questi tre tipi di file verrà concatenato in
ordine lessicografico e inserito in htmldoc.i utilizzando --packinfo, --keywords e
--opzioni di alias (vedi htmldoc.i). Predefinito: /usr/share/yorick-doc.

--template =filetto
File modello per htmldoc.i. Il formato corretto è dettagliato htmldoc.i. Predefinito:
/usr/share/yorick-doc/template.html.

--a=elenco
Directory di primo livello della gerarchia HTML Yorick da aggiornare. Questo è un livello sopra
la directory che verrà eliminata e/o (ricostruita). Il valore predefinito è
/usr/share/doc/yorick-doc.

--verboso | -v
Sii prolisso, generando molte informazioni di debug. L'impostazione predefinita è essere
tranquillo, dicendo brevemente cosa fa update-yorickdoc.

--xref-dir=parola
La sottodirectory della directory "TO" in cui compilare la documentazione. Certo
i collegamenti ipertestuali nella documentazione utilizzeranno questo valore. Questo non dovrebbe essere impostato su a
directory di cui apprezzi il contenuto, poiché questa directory verrà prima cancellata. Predefinito:
html_xrif.

Usa update-yorickdoc online usando i servizi onworks.net