Bundledoc - Online in der Cloud

PROGRAMM:

NAME/FUNKTION

Bundledoc - bündelt alle Dateien, die von einem LaTeX-Dokument benötigt werden

ZUSAMMENFASSUNG

Bundledoc [--Version] [--help] [--[nicht]ausführlich] [--texfile=Datei] [--Verzeichnis=Verzeichnis]
[--[nicht]nur lokal] [--ausschließen=Schnur] [--enthalten=Dateispezifikation] [--Manifest=Datei]
[--listdeps=[ja|nein|nur|rel]...] [--[nicht]Keepdirs] [--config=Datei] .D.E.P Datei

BESCHREIBUNG

Bundledoc ist ein Postprozessor für die Schnappschuss Paket, das alle zusammen bündelt
Klassen, Pakete und Dateien, die zum Erstellen eines bestimmten LaTeX-Dokuments benötigt werden. Es liest die .D.E.P
Datei das Schnappschuss produziert, findet jede der darin erwähnten Dateien und verpackt sie
in eine einzelne Archivdatei (z. B. a .tar.gz Datei), geeignet zum Verschieben zwischen Systemen,
an einen Kollegen weiterleiten usw.

Betrachten Sie als einfachstes Beispiel eine LaTeX-Datei mit dem Namen, sagen wir, hallo.tex:

\RequirePackage{snapshot} % Wird von Bundledoc benötigt
\documentclass[11pt]{article}

\begin{Dokument}
Hallo Welt!
\end{Dokument}

Das "\RequirePackage{snapshot}" verursacht ein hallo.dep Datei erstellt werden. Wann Bundledoc is
dann "hello.dep" als Argument gegeben, sucht es die abhängigen Dateien -- Schnappschuss.sty,
artikel.cls und Größe11.clo -- und bündelt sie in einer einzigen Archivdatei zusammen mit
hallo.tex und einem MANIFEST Datei (beschrieben in "OPTIONEN", unten).

OPTIONAL

In den folgenden Beschreibungen, Irgendeine Datei bezieht sich auf den Namen Ihres LaTeX-Hauptdokuments (kein
Erweiterung).

Bundledoc erfordert den Namen der Abhängigkeitsdatei, die von . erzeugt wird Schnappschuss (normalerweise
irgendeine Datei.dep). Es können auch folgende Optionen angegeben werden:

--Version
Ausgabe der Bundledoc Versionsnummer des Skripts. Dies überschreibt alle verbleibenden
Optionen.

--help
Geben Sie eine kurze Verwendungsmeldung. Dies überschreibt alle verbleibenden Optionen.

--[nicht]ausführlich (Standard: "noverbose")
Bundledoc gibt normalerweise nichts aus, außer Fehlermeldungen. Mit "--verbose"
es gibt zahlreiche Statusmeldungen aus.

--texfile=Haupt- .tex Datei (Standard: IrgendeineDatei.tex)
Schnappschuss's Abhängigkeitsdatei listet nicht die Haupt-LaTeX-Datei auf (diejenige, die übergeben wird
zu Latex). Damit Bundledoc um diese Datei zu finden und zu bündeln, Bundledoc geht davon aus
hat den gleichen Namen wie die Schnappschuss Abhängigkeitsdatei, aber mit a .tex Verlängerung. Wenn das
nicht der Fall ist, verwenden Sie "--texfile", um den korrekten Dateinamen anzugeben.

--Verzeichnis=Archiv Verzeichnis (Standard: Irgendeine Datei)
Wann Bundledoc erstellt ein Archiv (z. B. a .Teer or .zip Datei) mit der
Dateien des Dokuments werden alle in einem Verzeichnis abgelegt, um zu vermeiden, dass die aktuelle Datei überladen wird
Verzeichnis mit Dateien. Wenn die angegebene Abhängigkeitsdatei aufgerufen wird irgendeine Datei.dep dann ist die
Das resultierende Archiv speichert standardmäßig alle abhängigen Dateien in einem Irgendeine Datei
Verzeichnis. Um den Verzeichnisnamen zu ändern, verwenden Sie die Option "--directory".

--[nicht]nur lokal (Standard: "nolocalonly")
Obwohl Bundledoc archiviert normalerweise alle Dateien, die in der .D.E.P Datei, die
Die Option "--localonly" sagt Bundledoc alle Dateien ausschließen, die sich in einem anderen Verzeichnis befinden
als die .tex das Verzeichnis der Datei oder eines seiner Unterverzeichnisse.

--ausschließen=Schnur (Standard: keine)
Während "--localonly" Dateien außerhalb des .tex der Verzeichnisbaum der Datei zu sein
aus dem Archiv weggelassen, bietet "--exclude" eine feinere Kontrolle über Dateien zu
aus dem Archiv weglassen. Die Option "--exclude", die wiederholt angegeben werden kann auf
die Befehlszeile, bewirkt, dass alle Dateien, deren Name enthält Schnur weggelassen werden
Archiv.

--enthalten=Dateispezifikation (Standard: keine)
Die Option "--include", die wiederholt auf der Kommandozeile angegeben werden kann,
weist an Bundledoc um alle übereinstimmenden Dateien in das Archiv aufzunehmen DateispezifikationSelbst
wenn sie nicht in der referenziert sind .D.E.P Datei.

--Manifest=Manifest Datei (Standard: MANIFEST)
Zusätzlich zu den abhängigen Dateien, Bundledoc enthält in der Archivdatei ein Extra
Datei heißt standardmäßig ``MANIFEST''. MANIFEST ist eine Textdatei, die die
Originaldateinamen aller Abhängigkeiten. Um den Dateinamen von `` . zu ändernMANIFEST''
zu etwas anderem verwenden Sie die Option "--manifest". Als Sonderfall "--manifest="""
erzählt Bundledoc überhaupt keine Manifestdatei einzuschließen.

--listdeps=[ja|nein|nur|rel]...] (Standard: "nein")
"--listdeps" akzeptiert eines oder mehrere von "yes", "no", "only" oder "rel" durch Kommas getrennt
aufführen. Solange "nein" in dieser Liste nicht vorkommt, Bundledoc gibt alle wichtigen
Abhängigkeiten der LaTeX-Datei. Wenn die Liste "rel" enthält, dann Bundledoc gibt die aus
Liste der Abhängigkeiten mit relativen Pfadnamen. Wenn die Liste "nur" enthält, dann
Bundledoc wird nach Anzeige der Liste beendet, ohne ein Archiv zu erstellen.

--[nicht]Keepdirs (Standard: "nokeepdirs")
Normalerweise ist die Archivdatei, die Bundledoc produziert enthält ein einzelnes Verzeichnis -- und
Unterverzeichnisse, wenn das Dokument explizit darauf verweist -- in denen alle
abhängige Dateien liegen. Wenn "--keepdirs" angegeben ist, werden alle abhängigen Dateien gespeichert
mit ihren ursprünglichen Pfadnamen. Zum Beispiel, wenn IrgendeineDatei.tex hängt
figuren/somefigure.eps, artikel.cls und Schnappschuss.sty, dann ist die Irgendeine Datei Archiv wird
enthalten normalerweise die folgenden Dateien:

· IrgendeineDatei/IrgendeineDatei.tex

· somefile/figures/somefigure.eps

· IrgendeineDatei/Artikel.cls

· Irgendeinedatei/snapshot.sty

· Irgendeine Datei/MANIFEST

"--keepdirs" führt jedoch dazu, dass die Irgendeine Datei Archiv, um die folgenden Sortierungen zu enthalten
von Dateinamen stattdessen:

· home/mich/meinedocs/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" wird nicht verwendet, wenn "--keepdirs" aktiv ist. Außerdem kein Manifest
Datei wird in die Archivdatei geschrieben, da sie redundante Informationen enthält.

--config=Konfiguration Datei (Ursprünglich: )
Die Option "--config" wird verwendet, um auf Bundledoc zur passenden Konfiguration
(.cfg) Datei für Ihre TeX-Distribution und Ihr Betriebssystem. Bundledoc Kommt mit einem
wenige Konfigurationsdateien und es ist einfach, mehr zu schreiben. Siehe "KONFIGURATIONSDATEIEN"
(unten) für eine Beschreibung des Konfigurationsdateiformats.

CONFIGURATION DATEIEN

Format
Konfigurationsdateien folgen einem ziemlich einfachen Format. Zeilen, die mit "#" beginnen, sind Kommentare.
Leerzeilen werden ignoriert. Alle anderen Zeilen haben die Form:

Variable: Wert

Die aktuelle Version von Bundledoc erkennt folgende Variablen:

bündeln
Der Befehl, der verwendet wird, um eine Reihe von Dateien in einer einzigen Archivdatei zu bündeln

Waschbecken
Das Affix an einen Befehl, um seine Ausgabe zu verwerfen

gefunden
Der Befehl, um eine Datei innerhalb des/der TeX-Baum(s) zu finden.

Werte, die für eine Zeile zu lang sind, können auf mehrere Zeilen aufgeteilt werden, indem "\" als verwendet wird
das Zeilenfortsetzungssymbol.

Es gibt zwei Umgebungsvariablen, die Bundledoc macht zur Nutzung durch
Konfigurationsdateibefehle: "BDBASE", die auf gesetzt ist Irgendeine Datei (wie in "OPTIONEN"), und
"BDINPUTS", das auf eine durch Leerzeichen getrennte Liste von Dateien gesetzt wird, die ein Befehl ausführen soll
auf. Das heißt, wenn der mit "bundle" verknüpfte Befehl ausgeführt wird, enthält "BDINPUTS"
die Liste aller zu archivierenden Dateien. Im Gegensatz dazu, wenn der Befehl
mit "find" verknüpft ist, enthält "BDINPUTS" den Namen der Datei, nach der gesucht werden soll.

Beispiele
Die folgende Konfigurationsdatei weist Parallelen auf Bundledoc's Standardwerte der verschiedenen
Konfigurationsdatei-Variablen, die eine laufende kpathsea-basierte TeX-Distribution darstellen
auf einem generischen Unix-System, das nicht unbedingt über eines der GNU-Tools verfügt, wie z
gzip oder GNU Teer:

# Konfigurationsdatei "Standard"
# Von Scott Pakin[E-Mail geschützt] >

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

Die Klammern in der Zeile "bundle:" weisen die Unix-Shell an, den Befehl in a . auszuführen
Unterschale. Dies dient dazu, dass das Affix "sink:" ordnungsgemäß funktioniert (dh es gibt nicht zwei
">" ist im selben Befehl).

Beachten Sie, wie die Befehle "BDBASE" und "BDINPUTS" wie alle anderen Umgebungsvariablen behandeln
in einer Unix-Shell, mit "$", um ihren Wert zu nehmen. Andere Betriebssysteme verwenden andere
Konventionen für den Verweis auf Umgebungsvariablen. Zum Beispiel eine Konfigurationsdatei
für eine Windows-basierte TeX-Distribution würde stattdessen "%BDBASE%" und "%BDINPUTS%" verwenden.

Der Wert für "sink:" ist betriebssystemspezifisch. Der Wert für "find:" ist
spezifisch für eine TeX-Distribution. "Bundle:" bietet die meisten Möglichkeiten zur Anpassung
Lügen. Sie können "bundle:" verwenden, um Ihr bevorzugtes Archivformat anzugeben. Zum Beispiel du
kann unter Unix eine Shar-Datei erstellen mit etwas wie:

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

oder eine CAB-Datei unter Microsoft Windows mit etwas wie:

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

Beispiele:

Annehmen, dass meinedatei.dep wurde hergestellt aus meinedatei.tex indem Sie den Anweisungen in der
Abschnitt Beschreibung. Der folgende Befehl erzeugt a .zip Datei mit dem MikTeX TeX
Verteilung unter Microsoft Windows:

Bundledoc --config=miktex.cfg myfile.dep

(In der Praxis ist es wahrscheinlich notwendig, in "--config" den vollständigen Pfad zu anzugeben
Bundledoc's miktex.cfg Konfigurationsdatei.)

Die folgenden Builds a .tar.gz Archiv mit der TeX Live-Distribution auf einem Unix-
wie Betriebssystem. Bundledoc erzeugt eine ausführliche Ausgabe, die seine Operationen beschreibt.
Alle Dateien nicht im selben Verzeichnisbaum wie meinedatei.tex und alle Dateien, die ".fd" enthalten oder
".sty" in ihren Namen wird weggelassen. Allerdings alle .Lätzchen Dateien im aktuellen Verzeichnis werden
in das Archiv aufgenommen werden, obwohl keiner von ihnen referenziert wird von meinedatei.dep.
Endlich, nein MANIFEST Datei erstellt wird.

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

Verwenden Sie Bundledoc online mit den onworks.net-Diensten