bundledoc - Online nel cloud

PROGRAMMA:

NOME

bundledoc - raggruppa tutti i file necessari per un documento LaTeX

SINOSSI

bundledoc [--versione] [--Aiuto] [--[no]verboso] [--filetex=filetto] [--directory=elenco]
[--[no]solo locale] [--escludere=stringa] [--includere=specifica file] [--manifesto=filetto]
[--listdeps=[sì|no|solo|rel]...] [--[no]custode] [--config=filetto] .dip filetto

DESCRIZIONE

bundledoc è un post-processore per il istantanea pacchetto che raggruppa tutte le
classi, pacchetti e file necessari per creare un determinato documento LaTeX. Si legge il .dip
archiviarlo istantanea produce, trova ciascuno dei file ivi menzionati e li impacchetta
in un singolo file di archivio (ad es. a .tar.gz file), adatto per lo spostamento tra sistemi,
trasmettere a un collega, ecc.

Come esempio più semplice possibile, considera un file LaTeX chiamato, diciamo, ciao.tex:

\RequirePackage{snapshot} % richiesto da bundledoc
\documentclass[11pt]{articolo}

\ Begin {document}
Ciao mondo!
\ End {document}

Il "\RequirePackage{snapshot}" causa a ciao.dep file da produrre. quando bundledoc is
quindi dato "hello.dep" come argomento, individua i file dipendenti - istantanea.sty,
articolo.clse taglia11.clo -- e li raggruppa in un singolo file di archivio, insieme a
ciao.tex e MANIFESTO file (descritto in "OPZIONI", di seguito).

VERSIONI

Nelle seguenti descrizioni, qualche file si riferisce al nome del documento LaTeX principale (no
estensione).

bundledoc richiede il nome del file di dipendenza prodotto da istantanea (normalmente
qualchefile.dep). Possono essere fornite anche le seguenti opzioni:

--versione
Uscita il bundledoc numero di versione dello script. Questo sovrascrive tutto il resto
opzioni.

--Aiuto
Dai un breve messaggio di utilizzo. Questo sovrascrive tutte le opzioni rimanenti.

--[no]verboso (predefinito: "noverbose")
bundledoc normalmente non emette nulla tranne i messaggi di errore. Con "--verbose",
emette numerosi messaggi di stato.

--filetex=principale .tex filetto (predefinito: qualchefile.tex)
istantaneail file delle dipendenze di non elenca il file LaTeX principale (quello che viene passato
a latice). In ordine per bundledoc per trovare e raggruppare quel file, bundledoc lo presuppone
ha lo stesso nome di istantanea file di dipendenza ma con a .tex estensione. Se questo
non è il caso, quindi utilizzare "--texfile" per specificare il nome file corretto.

--directory=archiviare elenco (predefinito: qualche file)
Quando bundledoc crea un archivio (es. a .catrame or file .zip file) contenente il
i file del documento, li mette tutti in una directory per evitare di ingombrare la corrente
directory con i file. Se viene chiamato il file di dipendenza specificato qualchefile.dep poi il
l'archivio risultante, per impostazione predefinita, memorizzerà tutti i file dipendenti in a qualche file
directory. Per cambiare il nome della directory usa l'opzione "--directory".

--[no]solo locale (predefinito: "nolocalonly")
Sebbene il bundledoc normalmente archivia tutti i file nominati nel .dip file, il
L'opzione "--localonly" dice bundledoc per escludere tutti i file che si trovano in una directory altra
rispetto .tex directory del file o una delle sue sottodirectory.

--escludere=stringa (predefinito: nessuna)
Mentre "--localonly" causa file al di fuori del .tex albero di directory del file da essere
omesso dall'archivio, "--exclude" fornisce un controllo più preciso sui file per
omettere dall'archivio. L'opzione "--exclude", che può essere specificata ripetutamente su
la riga di comando, causa tutti i file il cui nome contiene stringa essere omesso dal
archivio.

--includere=specifica file (predefinito: nessuna)
L'opzione "--include", che può essere specificata ripetutamente sulla riga di comando,
istruisce bundledoc per includere nell'archivio tutti i file corrispondenti specifica file, Anche
se non sono referenziati nel .dip file.

--manifesto=manifesto filetto (predefinito: MANIFESTO)
Oltre ai file dipendenti, bundledoc include nel file di archivio un extra
file chiamato, per impostazione predefinita, ``MANIFESTO''. MANIFESTO è un file di testo che elenca i
nomi di file originali di tutte le dipendenze. Per cambiare il nome del file da ``MANIFESTO''
a qualcos'altro, usa l'opzione "--manifest". Come caso speciale, "--manifest="""
dice bundledoc per non includere affatto un file manifest.

--listdeps=[sì|no|solo|rel]...] (predefinito: "no")
"--listdeps" accetta uno o più tra "yes", "no", "only" o "rel" separati da virgole
elenco. Finché "no" non appare in questo elenco, bundledoc emette tutte le principali
Dipendenze del file LaTeX. Se l'elenco contiene "rel", allora bundledoc restituisce il file
elenco di dipendenze con relativi percorsi. Se l'elenco contiene "solo", allora
bundledoc esce dopo aver visualizzato la lista, senza produrre un archivio.

--[no]custode (predefinito: "nokeepdirs")
Normalmente, il file di archivio che bundledoc produce contiene una singola directory -- e
sottodirectory, se il documento vi fa esplicito riferimento -- in cui tutte le
i file dipendenti mentono. Se viene specificato "--keepdirs", tutti i file dipendenti vengono memorizzati
con i loro percorsi originali. Ad esempio, se qualchefile.tex dipende
figure/qualcosa.eps, articolo.clse istantanea.sty, Allora l' qualche file archivio sarà
normalmente contengono i seguenti file:

· qualchefile/qualchefile.tex

· qualche file/figure/qualcosa.eps

· file/articolo.cls

· qualche file/snapshot.sty

· qualche file/MANIFEST

Tuttavia, "--keepdirs" causerà il qualche file archivio per contenere i seguenti tipi
di nomi di file invece:

· home/io/mydocs/somefile.tex

· home/me/mydocs/figures/somefigure.eps

· usr/share/texmf/tex/latex/base/article.cls

· usr/share/texmf/tex/latex/snapshot/snapshot.sty

"--directory" non viene utilizzato quando è attivo "--keepdirs". Inoltre, nessun manifesto
file viene scritto nel file di archivio in quanto contiene informazioni ridondanti.

--config=configurazione filetto (predefinito: )
L'opzione "--config" è usata per puntare bundledoc alla configurazione appropriata
(.cfg) per la tua distribuzione e sistema operativo TeX. bundledoc viene fornito con un
pochi file di configurazione ed è facile scriverne di più. Vedi "FILE DI CONFIGURAZIONE"
(sotto) per una descrizione del formato del file di configurazione.

CONFIGURAZIONE FILE

Formato
I file di configurazione seguono un formato abbastanza semplice. Le righe che iniziano con "#" sono commenti.
Le righe vuote vengono ignorate. Tutte le altre righe sono della forma:

variabile: valore

La versione corrente di bundledoc riconosce le seguenti variabili:

fascio
Il comando da utilizzare per raggruppare un insieme di file in un singolo file di archivio

Lavello
L'affisso a un comando per scartare il suo output

Find
Il comando per trovare un file all'interno degli alberi TeX.

I valori troppo lunghi per una riga possono essere divisi su più righe utilizzando "\" come
il simbolo di continuazione della linea.

Ci sono due variabili d'ambiente che bundledoc mette a disposizione di
comandi del file di configurazione: "BDBASE", che è impostato su qualche file (come in "OPZIONI"), e
"BDINPUTS", che è impostato su un elenco di file separati da spazi che un comando deve operare
su. Cioè, quando il comando associato a "bundle" è in esecuzione, "BDINPUTS" contiene
l'elenco di tutti i file che devono essere archiviati. Al contrario, quando il comando
associato a "trova" è in esecuzione, "BDINPUTS" contiene il nome del file da cercare.

Esempi
Il seguente file di configurazione è parallelo bundledoci valori di default dei vari
variabili del file di configurazione, che rappresenta una distribuzione TeX basata su kpathsea in esecuzione
su un sistema Unix generico, che non ha necessariamente nessuno degli strumenti GNU, come
gzip o GNU tar:

# File di configurazione "predefinito"
# Di Scott Pakin[email protected]>

bundle: (tar -cvf - $BDINPUTS | compress > $BDBASE.tar.Z)
sink: > /dev/null 2>&1
trova: kpsewhich -progname=latex $BDINPUTS

Le parentesi nella riga "bundle:" dicono alla shell Unix di eseguire il comando in a
sottoscala. Questo serve per far funzionare correttamente l'affisso "sink:" (cioè, quindi non ce ne sono due
">" è nello stesso comando).

Nota come i comandi trattano "BDBASE" e "BDINPUTS" come qualsiasi altra variabile di ambiente
in una shell Unix, usando "$" per prendere il loro valore. Altri sistemi operativi utilizzano diversi
convenzioni per fare riferimento a variabili d'ambiente. Ad esempio, un file di configurazione
per una distribuzione TeX basata su Windows userebbe invece "%BDBASE%" e "%BDINPUTS%".

Il valore di "sink:" è specifico di un sistema operativo. Il valore per "trova:" è
specifico per una distribuzione TeX. "bundle:" è dove la maggior parte delle opportunità di personalizzazione
bugie. Puoi usare "bundle:" per specificare il tuo formato di archivio preferito. Ad esempio, tu
può produrre un file shar su Unix con qualcosa del tipo:

bundle: (shar --archive-name="$BDBASE" $BDINPUTS > $BDBASE.sh)

o un file CAB su Microsoft Windows con qualcosa del tipo:

bundle: cabarc -r -p N %BDBASE%.cab %BDINPUTS%

ESEMPI

Supponiamo che miofile.dep è stato prodotto da miofile.tex seguendo le istruzioni in
Sezione descrizione. Il seguente comando produce a file .zip file con il MikTeX TeX
distribuzione in esecuzione su Microsoft Windows:

bundledoc --config=miktex.cfg miofile.dep

(In pratica, è probabilmente necessario specificare in "--config" il percorso completo per
bundledoc's miktex.cfg file di configurazione.)

Le seguenti build a .tar.gz archivio con la distribuzione TeX Live in esecuzione su Unix-
come il sistema operativo. bundledoc produrrà un output dettagliato che descrive le sue operazioni.
Tutti i file non nella stessa struttura di directory come miofile.tex e tutti i file contenenti ".fd" o
".sty" nei loro nomi sono omessi. Tuttavia, tutto .bavaglino i file nella directory corrente saranno
essere inclusi nell'archivio anche se nessuno di essi è referenziato da miofile.dep.
Infine, no MANIFESTO file verrà prodotto.

bundledoc --config=texlive-unix.cfg --verbose --localonly \
--exclude=.fd --exclude=.cfg --include="*.bib" --manifest="" \
miofile.dep

Usa bundledoc online utilizzando i servizi onworks.net