bundledoc - Online w chmurze

PROGRAM:

IMIĘ

bundledoc - pakuj wszystkie pliki potrzebne do dokumentu LaTeX

STRESZCZENIE

dokumentacja pakietu [--wersja] [--help] [--[Nie]gadatliwy] [--pliktekstowy=filet] [--informator=katalog]
[--[Nie]tylko lokalnie] [--wykluczać=ciąg] [--włączać=specyfikacja pliku] [--oczywisty=filet]
[--listdeps=[tak|nie|tylko|rel]...] [--[Nie]opiekunowie] [--konfig=filet] dep filet

OPIS

pakiet doc jest postprocesorem dla migawka pakiet, który łączy w sobie wszystkie
klasy, pakiety i pliki potrzebne do zbudowania danego dokumentu LaTeX. Czyta dep
zgłoś to migawka produkuje, znajduje każdy z wymienionych w nim plików i pakuje je
do pojedynczego pliku archiwum (np. a .tar.gz plik), nadaje się do przenoszenia między systemami,
przesyłanie do kolegi itp.

Jako najprostszy możliwy przykład rozważmy plik LaTeX o nazwie, powiedzmy, witam.tex:

\RequirePackage{snapshot} % Wymagane przez bundledoc
\documentclass[11pt]{artykuł}

\ Begin {document}
Witaj świecie!
\ End {document}

„\RequirePackage{migawka}” powoduje cześć.dep plik do wyprodukowania. Kiedy pakiet doc is
następnie podając "hello.dep" jako argument, lokalizuje zależne pliki -- migawka.sty,
artykul.cls, rozmiar11.clo -- i łączy je w jeden plik archiwum, wraz z
witam.tex oraz OCZYWISTY plik (opisany w "OPCJACH" poniżej).

OPCJE

W poniższych opisach jakiś plik odnosi się do nazwy twojego głównego dokumentu LaTeX (nie
rozbudowa).

pakiet doc wymaga nazwy pliku zależności produkowanego przez migawka (normalnie
jakisplik.dep). Można również podać następujące opcje:

--wersja
Wyjście pakiet doc numer wersji skryptu. To zastępuje wszystkie pozostałe
opcje.

--help
Podaj krótką wiadomość dotyczącą użytkowania. Zastępuje to wszystkie pozostałe opcje.

--[Nie]gadatliwy (domyślnie: „noverbose”)
pakiet doc normalnie nie wyświetla niczego poza komunikatami o błędach. Z "--gadatliwym",
wyświetla obszerne komunikaty o stanie.

--pliktekstowy=główny .tex filet (domyślny: jakisplik.tex)
migawkaplik zależności nie zawiera głównego pliku LaTeX (tego, który jest przekazywany)
do lateks). W celu pakiet doc znaleźć i spakować ten plik, pakiet doc zakłada to
ma taką samą nazwę jak migawka plik zależności, ale z .tex rozbudowa. Jeśli to
tak nie jest, użyj "--texfile", aby określić poprawną nazwę pliku.

--informator=archiwum katalog (domyślny: jakiś plik)
Kiedy pakiet doc tworzy archiwum (np .smoła or .zamek błyskawiczny plik) zawierający
plików dokumentu, umieszcza je wszystkie w katalogu, aby uniknąć zaśmiecania bieżącego
katalog z plikami. Jeśli podany plik zależności nazywa się jakisplik.dep a później
archiwum wynikowe będzie domyślnie przechowywać wszystkie pliki zależne w jakiś plik
informator. Aby zmienić nazwę katalogu, użyj opcji "--directory".

--[Nie]tylko lokalnie (domyślnie: "nolocalonly")
Chociaż pakiet doc zwykle archiwizuje wszystkie pliki wymienione w dep plik, plik
Opcja "--localonly" mówi pakiet doc aby wykluczyć wszystkie pliki znajdujące się w innym katalogu
niż .tex katalog pliku lub jeden z jego podkatalogów.

--wykluczać=ciąg (domyślny: Żaden)
Podczas gdy „--localonly” powoduje, że pliki spoza obszaru .tex drzewo katalogów pliku ma być
pominięte w archiwum, "--exclude" zapewnia dokładniejszą kontrolę nad plikami do
pominąć z archiwum. Opcja "--exclude", którą można powtarzać wielokrotnie na
wiersz poleceń, powoduje, że wszystkie pliki, których nazwa zawiera ciąg być pominiętym w
archiwum.

--włączać=specyfikacja pliku (domyślny: Żaden)
Opcja "--include", którą można wielokrotnie podawać w wierszu poleceń,
przesyła zlecenie pakiet doc umieścić w archiwum wszystkie pasujące pliki specyfikacja pliku, Nawet
jeśli nie ma do nich odniesienia w dep plik.

--oczywisty=manifestować filet (domyślny: OCZYWISTY)
Oprócz plików zależnych, pakiet doc zawiera w pliku archiwum jeden dodatkowy
plik o nazwie domyślnie ``OCZYWISTY''. OCZYWISTY to plik tekstowy, który zawiera listę
oryginalne nazwy plików wszystkich zależności. Aby zmienić nazwę pliku z ``OCZYWISTY''
do czegoś innego, użyj opcji "--manifest". W specjalnym przypadku "--manifest="""
mówi pakiet doc w ogóle nie dołączać pliku manifestu.

--listdeps=[tak|nie|tylko|rel]...] (domyślnie: "nie")
„--listdeps” akceptuje co najmniej jedno z „tak”, „nie”, „tylko” lub „rel” jako oddzielone przecinkami
lista. Dopóki „nie” nie pojawia się na tej liście, pakiet doc wyprowadza wszystkie główne
Zależności pliku LaTeX. Jeśli lista zawiera „rel”, to pakiet doc wyprowadza
lista zależności z względnymi ścieżkami. Jeśli lista zawiera „tylko”, to
pakiet doc kończy działanie po wyświetleniu listy, bez tworzenia archiwum.

--[Nie]opiekunowie (domyślnie: "nokeepdirs")
Zwykle plik archiwum, który pakiet doc produkuje zawiera jeden katalog -- i
podkatalogi, jeśli dokument wyraźnie do nich odwołuje się - w których wszystkie
zależne pliki leżą. Jeśli określono "--keepdirs", wszystkie zależne pliki są przechowywane
z ich oryginalnymi nazwami ścieżek. Na przykład, jeśli jakisplik.tex zależy
figury/somefigure.eps, artykul.cls, migawka.sty, a później jakiś plik archiwum będzie
zwykle zawierają następujące pliki:

· jakisplik/jakiśplik.tex

· somefile/figurs/somefigure.eps

· jakiś plik/artykuł.cls

· jakiśplik/migawka.sty

· jakiśplik/MANIFEST

Jednak „--keepdirs” spowoduje jakiś plik archiwum zawierające następujące rodzaje
nazw plików zamiast:

· home/ja/mojedokumenty/jakiśplik.tex

· home/ja/mojedokumenty/figury/somefigure.eps

· usr/share/texmf/tex/latex/base/artykuł.cls

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

"--directory" nie jest używane, gdy obowiązuje "--keepdirs". Ponadto brak manifestu
plik jest zapisywany w pliku archiwum, ponieważ zawiera nadmiarowe informacje.

--konfig=konfiguracja filet (domyślny: )
Opcja "--config" służy do wskazywania pakiet doc do odpowiedniej konfiguracji
(.cfg) dla twojej dystrybucji TeX i systemu operacyjnego. pakiet doc pochodzi z
kilka plików konfiguracyjnych i łatwo jest pisać więcej. Zobacz "PLIKI KONFIGURACJI"
(poniżej) opis formatu pliku konfiguracyjnego.

KONFIGURACJA AKTA

utworzony
Pliki konfiguracyjne mają dość prosty format. Wiersze zaczynające się od „#” to komentarze.
Puste linie są ignorowane. Wszystkie pozostałe wiersze mają postać:

zmienna: wartość

Aktualna wersja pakiet doc rozpoznaje następujące zmienne:

zapakować
Polecenie używane do spakowania zestawu plików w jeden plik archiwum

tonąć
Afiks do polecenia, aby odrzucić jego wyjście

odnaleźć
Polecenie wyszukiwania pliku w drzewie (drzewach) TeXa.

Wartości, które są zbyt długie dla jednego wiersza, można podzielić na wiele wierszy za pomocą „\" as
symbol kontynuacji linii.

Istnieją dwie zmienne środowiskowe, które pakiet doc udostępnia do użytku
polecenia pliku konfiguracyjnego: "BDBASE", który jest ustawiony na jakiś plik (jak w „OPCJACH”), oraz
"BINPUTS", który jest ustawiony na rozdzieloną spacjami listę plików, które polecenie ma operować
od. Oznacza to, że gdy polecenie powiązane z „pakietem” jest uruchomione, „BINPUTS” zawiera
lista wszystkich plików, które mają zostać zarchiwizowane. W przeciwieństwie do tego, gdy polecenie
skojarzony z "find" jest uruchomiony, "BINPUTS" zawiera nazwę pliku do wyszukania.

Przykłady
Następujące równoległe pliki konfiguracyjne pakiet docwartości domyślne różnych
zmienne pliku konfiguracyjnego, które reprezentują działającą dystrybucję TeX opartą na kpathsea
na ogólnym systemie uniksowym, który niekoniecznie zawiera żadne z narzędzi GNU, takie jak
gzip lub GNU smoła:

# "Domyślny" plik konfiguracyjny
# Autor: Scott Pakin[email chroniony]>

pakiet: (tar -cvf - $BDINPUTS | skompresuj > $BDBASE.tar.Z)
umywalka: > /dev/null 2>&1
znajdź: kpsewhich -progname=lateks $BINPUTS

Nawiasy w wierszu „bundle:” informują powłokę systemu Unix o uruchomieniu polecenia w a
podpowłoka. Ma to na celu zapewnienie poprawnego działania afiksu „sink:” (tzn. nie ma dwóch
">" jest w tym samym poleceniu).

Zwróć uwagę, jak polecenia traktują „BDBASE” i „BINPUTS” jak inne zmienne środowiskowe
w powłoce Uniksa, używając "$" do przyjęcia ich wartości. Inne systemy operacyjne używają innych
konwencje odnoszące się do zmiennych środowiskowych. Na przykład plik konfiguracyjny
dla dystrybucji TeX opartej na systemie Windows użyje zamiast tego "% BDBASE%" i "% BDIPUTS%".

Wartość „sink:” jest specyficzna dla systemu operacyjnego. Wartość „znajdź:” to
specyficzne dla dystrybucji TeX. „Bundle:” to miejsce, w którym jest najwięcej możliwości dostosowania
kłamstwa. Możesz użyć "bundle:", aby określić swój ulubiony format archiwum. Na przykład ty
może utworzyć plik współdzielony w systemie Unix z czymś takim:

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

lub plik CAB w systemie Microsoft Windows z czymś takim jak:

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

PRZYKŁADY

Zakładać, że mojplik.dep został wyprodukowany z mójplik.tex postępując zgodnie z instrukcjami w
Sekcja opisowa. Następujące polecenie tworzy .zamek błyskawiczny plik z MikTeX TeX
dystrybucja działająca w systemie Microsoft Windows:

bundledoc --config=miktex.cfg mójplik.dep

(W praktyce prawdopodobnie konieczne jest określenie w opcji „--config” pełnej ścieżki do
pakiet doc's miktex.cfg plik konfiguracyjny.)

Następujące kompilacje .tar.gz archiwum z dystrybucją TeX Live uruchomioną na systemie Unix-
jak system operacyjny. pakiet doc wygeneruje szczegółowe dane wyjściowe opisujące jego operacje.
Wszystkie pliki nie znajdują się w tym samym drzewie katalogów co mójplik.tex i wszystkie pliki zawierające „.fd” lub
".sty" w ich nazwach zostało pominięte. Jednak wszystkie .śliniaczek pliki w bieżącym katalogu będą
być włączone do archiwum, mimo że żaden z nich nie jest wymieniony przez mojplik.dep.
Wreszcie nie OCZYWISTY plik zostanie utworzony.

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

Korzystaj z bundledoc online za pomocą usług onworks.net