bundeldoc - Online in de Cloud

PROGRAMMA:

NAAM

bundeldoc - bundel alle bestanden die nodig zijn voor een LaTeX-document

KORTE INHOUD

bundeldoc [--versie] [--help] [--[geen]breedsprakig] [--texbestand=filet] [--map=directory]
[--[geen]alleen lokaal] [--uitsluiten=snaar] [--erbij betrekken=bestandsspecificatie] [--manifest=filet]
[--lijstdeps=[ja|nee|alleen|rel]...] [--[geen]bewaar dirs] [--config=filet] .dep filet

PRODUCTBESCHRIJVING

bundeldoc is een postprocessor voor de momentopname pakket dat alle
klassen, pakketten en bestanden die nodig zijn om een ​​bepaald LaTeX-document te bouwen. Het leest de .dep
bestand dat momentopname produceert, vindt elk van de daarin genoemde bestanden en verpakt ze
in één enkel archiefbestand (bijvoorbeeld een .tar.gz bestand), geschikt voor het verplaatsen tussen systemen,
doorgeven aan een collega, enz.

Beschouw als het eenvoudigst mogelijke voorbeeld een LaTeX-bestand met de naam hallo.tex:

\RequirePackage{snapshot} % Nodig door bundeldoc
\documentclass[11pt]{artikel}

\ Begin {document}
Hallo Wereld!
\ End {document}

De "\RequirePackage{snapshot}" veroorzaakt een hallo.dep bestand te produceren. Wanneer bundeldoc is
en vervolgens "hello.dep" als argument gegeven, lokaliseert het de afhankelijke bestanden -- momentopname.sty,
artikel.cls en maat11.clo -- en bundelt ze in een enkel archiefbestand, samen met
hallo.tex en MANIFESTEREN bestand (beschreven in "OPTIES", hieronder).

OPTIES

In de volgende beschrijvingen, eenbestand verwijst naar de naam van uw belangrijkste LaTeX-document (nr
uitbreiding).

bundeldoc vereist de naam van het afhankelijkheidsbestand geproduceerd door momentopname (normaal gesproken
eenbestand.dep). De volgende opties kunnen ook worden gegeven:

--versie
Voer de bundeldoc versienummer van het script. Dit overschrijft alle overige
opties.

--help
Geef een kort gebruiksbericht. Dit heeft voorrang op alle overige opties.

--[geen]breedsprakig (standaard: "noverbose")
bundeldoc normaal gesproken geeft het niets uit, behalve foutmeldingen. Met "--uitgebreid",
het geeft overvloedige statusberichten weer.

--texbestand=hoofd- .tex filet (standaard: eenbestand.tex)
momentopname's afhankelijkheidsbestand vermeldt niet het belangrijkste LaTeX-bestand (het bestand dat wordt doorgegeven
naar latex). Om voor bundeldoc om dat bestand te vinden en te bundelen, bundeldoc veronderstelt het
heeft dezelfde naam als de momentopname afhankelijkheidsbestand maar met een .tex verlenging. Als dit
is dit niet het geval, gebruik dan "--texfile" om de juiste bestandsnaam op te geven.

--map=archief directory (standaard: eenbestand)
. bundeldoc maakt een archief aan (bijv .teer or .zip bestand) met daarin de
documentbestanden, plaatst het ze allemaal in een map om te voorkomen dat het huidige document onoverzichtelijk wordt
map met bestanden. Als het opgegeven afhankelijkheidsbestand wordt aangeroepen eenbestand.dep dan de
Het resulterende archief zal standaard alle afhankelijke bestanden opslaan in een eenbestand
map. Gebruik de optie "--directory" om de mapnaam te wijzigen.

--[geen]alleen lokaal (standaard: "nolocalonly")
Hoewel bundeldoc archiveert normaal gesproken alle bestanden genoemd in de .dep bestand, het
"--localonly" optie vertelt bundeldoc om alle bestanden uit te sluiten die zich in een andere map bevinden
dan .tex map van het bestand of een van de submappen ervan.

--uitsluiten=snaar (standaard: geen)
Terwijl "--localonly" ervoor zorgt dat bestanden buiten de .tex mapstructuur van het bestand moet zijn
weggelaten uit het archief, biedt "--exclude" een fijnmaziger controle over bestanden
weglaten uit het archief. De optie "--exclude", die herhaaldelijk kan worden opgegeven
de opdrachtregel zorgt ervoor dat alle bestanden waarvan de naam bevat snaar weg te laten uit de
archief.

--erbij betrekken=bestandsspecificatie (standaard: geen)
De optie "--include", die herhaaldelijk op de opdrachtregel kan worden opgegeven,
instrueert bundeldoc om alle overeenkomende bestanden in het archief op te nemen bestandsspecificatieZelfs
als er niet naar wordt verwezen in de .dep bestand.

--manifest=manifesteren filet (standaard: MANIFESTEREN)
Naast de afhankelijke bestanden, bundeldoc neemt in het archiefbestand één extra op
bestand met de standaardnaam ``MANIFESTEREN''. MANIFESTEREN is een tekstbestand met de
originele bestandsnamen van alle afhankelijkheden. Om de bestandsnaam te wijzigen van ``MANIFESTEREN''
voor iets anders gebruikt u de optie "--manifest". In een speciaal geval: "--manifest="""
vertelt bundeldoc om helemaal geen manifestbestand op te nemen.

--lijstdeps=[ja|nee|alleen|rel]...] (standaard: "nee")
"--listdeps" accepteert een of meer van "yes", "no", "only" of "rel" als een door komma's gescheiden
lijst. Zolang "nee" niet in deze lijst voorkomt, bundeldoc geeft alle hoofduitgangen weer
De afhankelijkheden van het LaTeX-bestand. Als de lijst "rel" bevat, dan bundeldoc voert de
lijst met afhankelijkheden met relatieve padnamen. Als de lijst "alleen" bevat, dan
bundeldoc wordt afgesloten na het weergeven van de lijst, zonder een archief te produceren.

--[geen]bewaar dirs (standaard: "nokeepdirs")
Normaal gesproken is het archiefbestand dat bundeldoc produceert bevat een enkele map -- en
submappen, als het document er expliciet naar verwijst - waarin alle
afhankelijke bestanden liegen. Als "--keepdirs" is opgegeven, worden alle afhankelijke bestanden opgeslagen
met hun oorspronkelijke padnamen. Als bijvoorbeeld eenbestand.tex hangt af van
cijfers/somefigure.eps, artikel.cls en momentopname.sty, dan de eenbestand archief wil
bevatten normaal gesproken de volgende bestanden:

· een bestand/een bestand.tex

· eenbestand/figuren/eencijfer.eps

· een bestand/artikel.cls

· een bestand/snapshot.sty

· een bestand/MANIFEST

Echter, "--keepdirs" zal ervoor zorgen dat de eenbestand archief om de volgende soorten te bevatten
van bestandsnamen in plaats daarvan:

· home/me/mijndocs/eenbestand.tex

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

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

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

"--directory" wordt niet gebruikt wanneer "--keepdirs" actief is. Bovendien geen manifest
bestand wordt naar het archiefbestand geschreven omdat het overbodige informatie bevat.

--config=configuratie filet (standaard: )
De optie "--config" wordt gebruikt om te wijzen bundeldoc naar de juiste configuratie
(.cfg) bestand voor uw TeX-distributie en besturingssysteem. bundeldoc wordt geleverd met een
weinig configuratiebestanden en het is gemakkelijk om meer te schrijven. Zie "CONFIGURATIEBESTANDEN"
(hieronder) voor een beschrijving van het configuratiebestandsformaat.

CONFIGURATIE FILES

Formaat
Configuratiebestanden volgen een vrij eenvoudig formaat. Regels die beginnen met "#" zijn commentaar.
Lege regels worden genegeerd. Alle andere regels hebben de vorm:

variabele: waarde

De huidige versie van bundeldoc herkent de volgende variabelen:

bundel
De opdracht die moet worden gebruikt om een ​​set bestanden te bundelen in één archiefbestand

wastafel
De toevoeging aan een opdracht om de uitvoer ervan te verwijderen

vinden
Het commando om een ​​bestand binnen de TeX-boom(en) te vinden.

Waarden die te lang zijn voor één regel, kunnen over meerdere regels worden verdeeld door "\" as te gebruiken
het lijnvervolgsymbool.

Er zijn twee omgevingsvariabelen die bundeldoc beschikbaar stelt voor gebruik door
configuratiebestandsopdrachten: "BDBASE", die is ingesteld op eenbestand (zoals in "OPTIES"), en
"BDINPUTS", dat is ingesteld op een door spaties gescheiden lijst met bestanden die met een opdracht moeten worden uitgevoerd
bij. Dat wil zeggen, wanneer de opdracht die is gekoppeld aan "bundle" wordt uitgevoerd, bevat "BDINPUTS".
de lijst met alle bestanden die moeten worden gearchiveerd. Wanneer daarentegen het commando
geassocieerd met "find" actief is, bevat "BDINPUTS" de naam van het bestand waarnaar moet worden gezocht.

Voorbeelden
Het volgende configuratiebestand loopt parallel bundeldoc's standaardwaarden van de verschillende
configuratiebestandvariabelen, die een op kpathsea gebaseerde TeX-distributie vertegenwoordigen
op een generiek Unix-systeem, dat niet noodzakelijkerwijs over GNU-tools beschikt, zoals
gzip of GNU teer:

# "Standaard" configuratiebestand
# Door Scott Pakin[e-mail beveiligd]>

bundel: (tar -cvf - $BDINPUTS | comprimeren > $BDBASE.tar.Z)
sink: > /dev/null 2>&1
zoek: kpse Which -progname=latex $BDINPUTS

De haakjes in de regel "bundle:" vertellen de Unix-shell om de opdracht uit te voeren in a
onderschaal. Dit is om ervoor te zorgen dat de toevoeging "sink:" goed werkt (dat wil zeggen, zodat er geen twee zijn
">" staat in hetzelfde commando).

Merk op hoe de commando's "BDBASE" en "BDINPUTS" behandelen zoals alle andere omgevingsvariabelen
in een Unix-shell, waarbij "$" wordt gebruikt om hun waarde over te nemen. Andere besturingssystemen gebruiken andere
conventies voor het verwijzen naar omgevingsvariabelen. Bijvoorbeeld een configuratiebestand
voor een op Windows gebaseerde TeX-distributie zou in plaats daarvan "%BDBASE%" en "%BDINPUTS%" worden gebruikt.

De waarde voor "sink:" is specifiek voor een besturingssysteem. De waarde voor "vinden:" is
specifiek voor een TeX-distributie. "bundel:" biedt de meeste mogelijkheden voor maatwerk
leugens. U kunt "bundel:" gebruiken om uw favoriete archiefformaat op te geven. Jij bijvoorbeeld
kan een shar-bestand op Unix produceren met zoiets als:

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

of een CAB-bestand op Microsoft Windows met zoiets als:

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

Voorbeelden

Aannemen dat mijnbestand.dep is gemaakt van mijnbestand.tex door de instructies in de te volgen
Beschrijving sectie. Het volgende commando produceert een .zip bestand met de MikTeX TeX
distributie draait op Microsoft Windows:

bundeldoc --config=miktex.cfg mijnbestand.dep

(In de praktijk is het waarschijnlijk nodig om het volledige pad naar "--config" op te geven
bundeldoc's miktex.cfg configuratiebestand.)

Het volgende bouwt a .tar.gz archief waarbij de TeX Live-distributie draait op een Unix-
zoals besturingssysteem. bundeldoc zal een uitgebreide uitvoer produceren die de werking ervan beschrijft.
Alle bestanden die niet in dezelfde directorystructuur staan ​​als mijnbestand.tex en alle bestanden die ".fd" of
".sty" in hun naam wordt weggelaten. Echter allemaal .slab bestanden in de huidige map wel
worden opgenomen in het archief, ook al wordt er niet naar verwezen mijnbestand.dep.
Eindelijk, nee MANIFESTEREN bestand zal worden geproduceerd.

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

Gebruik Bundledoc online met behulp van onworks.net-services