bundledoc - En ligne dans le Cloud

PROGRAMME:

Nom

bundledoc - regroupe tous les fichiers nécessaires à un document LaTeX

SYNOPSIS

paquetdoc [--version] [--Aidez-moi] [--[aucune]verbeux] [--fichiertex=filet] [--annuaire=annuaire]
[--[aucune]en local seulement] [--exclure=un magnifique] [--comprendre=spécif_fichier] [--manifeste=filet]
[--listdeps=[oui|non|seulement|rel]...] [--[aucune]répertoires] [--config=filet] .D.E.P filet

DESCRIPTION

paquetdoc est un post-processeur pour le instantané package qui regroupe tous les
classes, packages et fichiers nécessaires pour construire un document LaTeX donné. Il lit le .D.E.P
déposer cela instantané produit, trouve chacun des fichiers qui y sont mentionnés et les conditionne
dans un seul fichier d'archive (par exemple, un .tar.gz fichier), adapté au déplacement entre les systèmes,
transmettre à un collègue, etc.

Comme exemple le plus simple possible, considérons un fichier LaTeX appelé, disons, bonjour.tex:

\RequirePackage{snapshot} % requis par bundledoc
\documentclass[11pt]{article}

\ Begin {document}
Bonjour le monde!
\ End {document}

Le "\RequirePackage{snapshot}" provoque un bonjour.dep dossier à produire. Lorsque paquetdoc is
puis donné "hello.dep" comme argument, il localise les fichiers dépendants -- instantané.sty,
article.clset taille11.clo -- et les regroupe dans un seul fichier d'archive, avec
bonjour.tex et MANIFESTE (décrit dans "OPTIONS", ci-dessous).

OPTIONS

Dans les descriptions suivantes, un fichier fait référence au nom de votre document LaTeX principal (pas
extension).

paquetdoc requiert le nom du fichier de dépendance produit par instantané (normalement
unfichier.dep). Les options suivantes peuvent également être proposées :

--version
Sortir le paquetdoc le numéro de version du script. Cela remplace tous les autres
options.

--Aidez-moi
Donnez un bref message d'utilisation. Cela remplace toutes les options restantes.

--[aucune]verbeux (par défaut : "noverbose")
paquetdoc n'affiche normalement rien d'autre que des messages d'erreur. Avec "--verbose",
il émet de nombreux messages d'état.

--fichiertex=principal .Texas filet (défaut: unfichier.tex)
instantanéle fichier de dépendances de ne répertorie pas le fichier LaTeX principal (celui qui est transmis
à latex). Afin de paquetdoc pour trouver et regrouper ce fichier, paquetdoc l'assume
a le même nom que le instantané fichier de dépendance mais avec un .Texas extension. Si ce
n'est pas le cas, alors utilisez "--texfile" pour spécifier le nom de fichier correct.

--annuaire=archives annuaire (défaut: un fichier)
Quand paquetdoc crée une archive (par exemple, un .le goudron or .zip fichier) contenant le
les fichiers du document, il les met tous dans un répertoire pour éviter d'encombrer le
répertoire avec des fichiers. Si le fichier de dépendances donné est appelé unfichier.dep puis le
l'archive résultante stockera, par défaut, tous les fichiers dépendants dans un un fichier
annuaire. Pour changer le nom du répertoire, utilisez l'option "--directory".

--[aucune]en local seulement (par défaut : "nolocalonly")
Bien que paquetdoc archive normalement tous les fichiers nommés dans le .D.E.P fichier, le
L'option "--localonly" indique paquetdoc pour exclure tous les fichiers situés dans un autre répertoire
que le .Texas répertoire du fichier ou l'un de ses sous-répertoires.

--exclure=un magnifique (défaut: aucun)
Alors que "--localonly" provoque des fichiers en dehors du .Texas l'arborescence des répertoires du fichier doit être
omis de l'archive, "--exclude" fournit un contrôle plus fin sur les fichiers à
omettre de l'archive. L'option "--exclude", qui peut être spécifiée à plusieurs reprises sur
la ligne de commande, provoque tous les fichiers dont le nom contient un magnifique à omettre de la
archiver.

--comprendre=spécif_fichier (défaut: aucun)
L'option "--include", qui peut être spécifiée à plusieurs reprises sur la ligne de commande,
instruit paquetdoc d'inclure dans l'archive tous les fichiers correspondants spécif_fichier, Même
s'ils ne sont pas référencés dans le .D.E.P fichier.

--manifeste=manifeste filet (défaut: MANIFESTE)
En plus des fichiers dépendants, paquetdoc inclut dans le fichier d'archive un extra
fichier appelé, par défaut, ``MANIFESTE''. MANIFESTE est un fichier texte qui répertorie les
les noms de fichiers originaux de toutes les dépendances. Pour changer le nom de fichier de ``MANIFESTE''
à autre chose, utilisez l'option "--manifest". Comme cas particulier, "--manifest="""
raconte paquetdoc de ne pas inclure de fichier manifeste du tout.

--listdeps=[yes|no|only|rel]...] (défaut : "no")
"--listdeps" accepte un ou plusieurs des "oui", "non", "seulement" ou "rel" séparés par des virgules
liste. Tant que "non" n'apparaît pas dans cette liste, paquetdoc produit tous les principaux
Dépendances du fichier LaTeX. Si la liste contient "rel", alors paquetdoc sort le
liste des dépendances avec des chemins relatifs. Si la liste contient "seulement", alors
paquetdoc se ferme après l'affichage de la liste, sans produire d'archive.

--[aucune]répertoires (par défaut : "nokeepdirs")
Normalement, le fichier d'archive qui paquetdoc produit contient un seul répertoire -- et
sous-répertoires, si le document y fait explicitement référence -- dans lesquels tous les
les fichiers dépendants se trouvent. Si "--keepdirs" est spécifié, tous les fichiers dépendants sont stockés
avec leurs chemins d'accès d'origine. Par exemple, si unfichier.tex dépend
chiffres/quelquefigure.eps, article.clset instantané.sty, puis le un fichier les archives seront
contiennent normalement les fichiers suivants :

· unfichier/unfichier.tex

· unfichier/figures/unefigure.eps

· unfichier/article.cls

· unfichier/snapshot.sty

· unfichier/MANIFESTE

Cependant, "--keepdirs" provoquera le un fichier archive pour contenir les tris suivants
des noms de fichiers à la place :

· home/moi/mesdocs/unfichier.tex

· accueil/moi/mesdocs/figures/somefigure.eps

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

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

"--directory" n'est pas utilisé lorsque "--keepdirs" est actif. De plus, aucun manifeste
est écrit dans le fichier d'archive car il contient des informations redondantes.

--config=paramétrage filet (défaut: )
L'option "--config" est utilisée pour pointer paquetdoc à la configuration appropriée
(.cfg) pour votre distribution TeX et votre système d'exploitation. paquetdoc vient avec un
quelques fichiers de configuration et il est facile d'en écrire plus. Voir "FICHIERS DE CONFIGURATION"
(ci-dessous) pour une description du format du fichier de configuration.

CONFIGURATION DES DOSSIERS

Format
Les fichiers de configuration suivent un format assez simple. Les lignes commençant par "#" sont des commentaires.
Les lignes vides sont ignorées. Toutes les autres lignes sont de la forme :

variable : valeur

La version actuelle de paquetdoc reconnaît les variables suivantes :

pack
La commande à utiliser pour regrouper un ensemble de fichiers dans un seul fichier d'archive

lavabo
L'affixe à une commande pour supprimer sa sortie

trouver
La commande pour trouver un fichier dans les arborescences TeX.

Les valeurs trop longues pour une ligne peuvent être réparties sur plusieurs lignes en utilisant "\" comme
le symbole de continuation de ligne.

Il existe deux variables d'environnement qui paquetdoc met à la disposition de
commandes du fichier de configuration : "BDBASE", qui est défini sur un fichier (comme dans "OPTIONS"), et
"BDINPUTS", qui est défini sur une liste de fichiers séparés par des espaces qu'une commande doit exécuter
sur. C'est-à-dire que lorsque la commande associée à "bundle" est en cours d'exécution, "BDINPUTS" contient
la liste de tous les fichiers à archiver. En revanche, lorsque la commande
associé à "find" est en cours d'exécution, "BDINPUTS" contient le nom du fichier à rechercher.

Exemples
Le fichier de configuration suivant est parallèle paquetdocles valeurs par défaut des différents
variables du fichier de configuration, qui représentent une distribution TeX basée sur kpathsea en cours d'exécution
sur un système Unix générique, qui n'a pas nécessairement l'un des outils GNU, tels que
gzip ou GNU goudron:

# Fichier de configuration "par défaut"
# Par Scott Pakin[email protected]>

bundle : (tar -cvf - $BDINPUTS | compresser > $BDBASE.tar.Z)
récepteur : > /dev/null 2>&1
trouver : kpsewhich -progname=latex $BDINPUTS

Les parenthèses dans la ligne "bundle:" indiquent au shell Unix d'exécuter la commande dans un
sous-coque. C'est pour que l'affixe "sink:" fonctionne correctement (c'est-à-dire qu'il n'y ait pas deux
">" est dans la même commande).

Remarquez comment les commandes traitent "BDBASE" et "BDINPUTS" comme toutes les autres variables d'environnement
dans un shell Unix, en utilisant "$" pour prendre leur valeur. D'autres systèmes d'exploitation utilisent des
conventions pour faire référence aux variables d'environnement. Par exemple, un fichier de configuration
pour une distribution TeX basée sur Windows utiliserait "%BDBASE%" et "%BDINPUTS%" à la place.

La valeur de « sink : » est spécifique à un système d'exploitation. La valeur pour « rechercher : » est
spécifique à une distribution TeX. "bundle :" est l'endroit où le plus d'opportunités de personnalisation
mensonges. Vous pouvez utiliser "bundle:" pour spécifier votre format d'archive préféré. Par exemple, vous
peut produire un fichier shar sur Unix avec quelque chose comme :

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

ou un fichier CAB sur Microsoft Windows avec quelque chose comme :

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

EXEMPLES

Suppose que monfichier.dep a été produit à partir de monfichier.tex en suivant les instructions du
Rubrique descriptif. La commande suivante produit un .zip fichier avec le MikTeX TeX
distribution fonctionnant sous Microsoft Windows :

bundledoc --config=miktex.cfg monfichier.dep

(En pratique, il est probablement nécessaire de spécifier à "--config" le chemin complet vers
paquetdoc's miktex.cfg fichier de configuration.)

Ce qui suit construit un .tar.gz archive avec la distribution TeX Live fonctionnant sous Unix-
comme le système d'exploitation. paquetdoc produira une sortie détaillée décrivant ses opérations.
Tous les fichiers ne se trouvent pas dans la même arborescence de répertoires que monfichier.tex et tous les fichiers contenant ".fd" ou
".sty" dans leurs noms sont omis. Cependant, tout .bavoir les fichiers du répertoire courant seront
être inclus dans l'archive même si aucun d'entre eux n'est référencé par monfichier.dep.
enfin non MANIFESTE fichier sera produit.

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

Utilisez bundledoc en ligne à l'aide des services onworks.net