bundledoc - онлайн у хмарі

ПРОГРАМА:

ІМ'Я

bundledoc - об'єднати всі файли, необхідні для документа LaTeX

СИНТАКСИС

bundledoc [-- версія] [--допомога] [--[немає]докладний] [--тексфайл=файл] [--каталог=каталог]
[--[немає]тільки локально] [--виключити=рядок] [--включати=спец. файлу] [-- явний=файл]
[--listdeps=[так|ні|тільки|відносно]...] [--[немає]keepdirs] [--config=файл] .dep файл

ОПИС

bundledoc є постпроцесором для знімок пакет, який об’єднує все
класи, пакунки та файли, необхідні для створення даного документа LaTeX. Воно читає .dep
файл це знімок створює, знаходить кожен із згаданих у ньому файлів і пакує їх
в один архівний файл (наприклад, a .tar.gz файл), придатний для переміщення між системами,
передача колезі тощо.

Як найпростіший приклад розглянемо файл LaTeX під назвою, скажімо, привіт.tex:

\RequirePackage{snapshot} % Потрібний bundledoc
\documentclass[11pt]{стаття}

\ Begin {документ}
Привіт Світ!
\ End {документ}

"\RequirePackage{snapshot}" викликає а привіт.деп файл, який буде створено. Коли bundledoc is
потім, надавши "hello.dep" як аргумент, він знаходить залежні файли -- знімок.сти,
article.cls та розмір 11.clo -- і об’єднує їх в один архівний файл разом із
привіт.tex і MANIFEST файл (описаний у розділі "ПАРАЦІЇ" нижче).

ВАРІАНТИ

У наступних описах деякий файл посилається на назву вашого основного документа LaTeX (№
розширення).

bundledoc вимагає імені файлу залежностей, створеного знімок (як правило
somefile.dep). Також можуть бути запропоновані такі варіанти:

-- версія
Вивести bundledoc номер версії сценарію. Це перекриває все, що залишилося
Варіанти.

--допомога
Дайте коротке повідомлення про використання. Це замінює всі інші параметри.

--[немає]докладний (за замовчуванням: "noverbose")
bundledoc зазвичай не виводить нічого, крім повідомлень про помилки. З "--verbose",
він виводить велику кількість повідомлень про статус.

--тексфайл=основний .tex файл (за замовчуванням: somefile.tex)
знімокУ файлі залежностей не вказано основний файл LaTeX (той, який передається
до латекс). Для того, щоб bundledoc щоб знайти та об’єднати цей файл, bundledoc припускає це
має ту саму назву, що й знімок файл залежностей, але з a .tex розширення. Якщо це
це не так, то використовуйте "--texfile", щоб вказати правильне ім'я файлу.

--каталог=архів каталог (за замовчуванням: деякий файл)
Коли bundledoc створює архів (наприклад, a .Тар or ZIP. файл), що містить
документа, він поміщає їх усі в каталог, щоб уникнути захаращення поточного
каталог з файлами. Якщо даний файл залежностей викликається somefile.dep потім
отриманий архів за замовчуванням зберігатиме всі залежні файли в a деякий файл
каталог. Щоб змінити назву каталогу, використовуйте параметр «--directory».

--[немає]тільки локально (за замовчуванням: "nolocalonly")
хоча bundledoc зазвичай архівує всі файли, названі в .dep файл,
Вказує параметр "--localonly". bundledoc щоб виключити всі файли, розташовані в каталозі інший
ніж .tex каталог файлу або один з його підкаталогів.

--виключити=рядок (за замовчуванням: ніхто)
Тоді як "--localonly" викликає файли за межами .tex дерево каталогів файлу
пропущений з архіву, "--exclude" забезпечує більш детальний контроль над файлами до
виключити з архіву. Параметр "--exclude", який можна вказувати багаторазово
командний рядок викликає всі файли, ім'я яких містить рядок бути опущеним з
архів

--включати=спец. файлу (за замовчуванням: ніхто)
Параметр "--include", який можна вказувати багаторазово в командному рядку,
інструктує bundledoc щоб включити до архіву всі відповідні файли спец. файлу, Навіть
якщо вони не згадуються в .dep файлу.

-- явний=проявляється файл (за замовчуванням: MANIFEST)
На додаток до залежних файлів, bundledoc включає в архів один додатковий
За замовчуванням файл називається ``MANIFEST''. MANIFEST є текстовим файлом, який містить перелік
оригінальні імена файлів усіх залежностей. Щоб змінити назву файлу з ``MANIFEST''
для чогось іншого скористайтеся параметром "--manifest". Як окремий випадок, "--manifest="""
розповідає bundledoc не включати файл маніфесту взагалі.

--listdeps=[так|ні|тільки|rel]...] (за замовчуванням: "ні")
"--listdeps" приймає один або кілька "так", "ні", "тільки" або "rel" як розділені комами
список. Поки "ні" не з'являється в цьому списку, bundledoc виводить всі основні
Залежності файлу LaTeX. Якщо список містить "rel", то bundledoc виводить
список залежностей з відносними іменами шляху. Якщо список містить «тільки», то
bundledoc виходить після відображення списку, не створюючи архів.

--[немає]keepdirs (за замовчуванням: "nokeepdirs")
Як правило, архівний файл, що bundledoc виробляє містить один каталог -- і
підкаталогів, якщо документ явно посилається на них -- у якому всі файли
залежні файли лежать. Якщо вказано «--keepdirs», усі залежні файли зберігаються
з їх оригінальними іменами шляху. Наприклад, якщо somefile.tex залежить від
figures/somefigure.eps, article.cls та знімок.сти, А потім деякий файл архів буде
зазвичай містять такі файли:

· somefile/somefile.tex

· somefile/figures/somefigure.eps

· somefile/article.cls

· somefile/snapshot.sty

· somefile/MANIFEST

Однак "--keepdirs" спричинить деякий файл архів містити такі види
замість імен файлів:

· home/me/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» не використовується, коли діє «--keepdirs». Крім того, жодного маніфесту
файл записується в архівний файл, оскільки він містить зайву інформацію.

--config=конфігурація файл (за замовчуванням: )
Для вказівки використовується параметр «--config». bundledoc до відповідної конфігурації
(.cfg) для вашого дистрибутива та операційної системи TeX. bundledoc поставляється з a
мало конфігураційних файлів і легко написати більше. Дивіться «ФАЙЛИ КОНФІГУРАЦІЇ»
(нижче) для опису формату файлу конфігурації.

КОНФІГУРАЦІЯ ФАЙЛИ

сформований
Файли конфігурації мають досить простий формат. Рядки, що починаються з "#", є коментарями.
Порожні рядки ігноруються. Усі інші рядки мають вигляд:

змінна: значення

Поточна версія bundledoc розпізнає такі змінні:

пакет
Команда для об’єднання набору файлів в один архівний файл

раковина
Афікс до команди для відкидання її результату

знаходити
Команда для пошуку файлу в дереві (деревах) TeX.

Значення, які є занадто довгими для одного рядка, можна розділити на кілька рядків за допомогою "\" as
символ продовження рядка.

Є дві змінні середовища, які bundledoc робить доступними для використання
команди файлу конфігурації: "BDBASE", для якого встановлено значення деякий файл (як у "ПАРАЦІЇ"), і
"BDINPUTS", який встановлюється як список файлів, розділених пробілами, з якими має працювати команда
на. Тобто, коли виконується команда, пов’язана з «bundle», «BDINPUTS» містить
список усіх файлів, які потрібно заархівувати. Навпаки, коли команда
пов’язаний із «знайти», запущено, «BDINPUTS» містить ім’я файлу для пошуку.

прикладів
Наступний файл конфігурації паралельний bundledocЗначення за замовчуванням для різних
змінні конфігураційного файлу, що представляє запущений дистрибутив TeX на основі kpathsea
на загальній системі Unix, яка не обов'язково має інструменти GNU, наприклад
gzip або GNU дьоготь:

# Конфігураційний файл "за замовчуванням".
# Скотт Пакін[захищено електронною поштою]>

пакет: (tar -cvf - $BDINPUTS | стиснути > $BDBASE.tar.Z)
приймач: > /dev/null 2>&1
знайти: kpsewhich -progname=latex $BDINPUTS

Дужки в рядку "bundle:" повідомляють оболонці Unix запустити команду в a
підоболонка. Це потрібно для того, щоб афікс "sink:" працював належним чином (тобто, щоб їх не було двох
">" в тій самій команді).

Зверніть увагу на те, як команди розглядають "BDBASE" і "BDINPUTS", як і будь-які інші змінні середовища
в оболонці Unix, використовуючи "$", щоб прийняти їх значення. Інші операційні системи використовують інші
умовні угоди щодо посилання на змінні середовища. Наприклад, файл конфігурації
для дистрибутива TeX на базі Windows замість цього використовуватиметься "%BDBASE%" і "%BDINPUTS%".

Значення «sink:» є специфічним для операційної системи. Значення для "знайти:" таке
специфічні для дистрибутива TeX. "bundle:" - це місце, де найбільше можливостей для налаштування
брехня. Ви можете використовувати "bundle:", щоб вказати свій улюблений формат архіву. Наприклад, ви
може створити shar-файл на Unix з чимось на кшталт:

пакет: (shar --archive-name="$BDBASE" $BDINPUTS > $BDBASE.sh)

або файл CAB у Microsoft Windows із чимось на кшталт:

пакет: cabarc -r -p N %BDBASE%.cab %BDINPUTS%

ПРИКЛАДИ

Припустимо, що myfile.dep було виготовлено з мій файл.tex дотримуючись інструкцій у
Розділ опису. Наступна команда створює a ZIP. файл з MikTeX TeX
дистрибутив, що працює на Microsoft Windows:

bundledoc --config=miktex.cfg myfile.dep

(На практиці, ймовірно, необхідно вказати в "--config" повний шлях до
bundledoc's miktex.cfg конфігураційний файл.)

Наступні побудови a .tar.gz архів з дистрибутивом TeX Live, що працює на Unix-
як операційна система. bundledoc створить докладний висновок з описом його операцій.
Усі файли не в тому самому дереві каталогів, що й мій файл.tex і всі файли, що містять ".fd" або
".sty" в їхніх назвах пропущено. Проте все .нагрудник файли в поточному каталозі будуть
бути включені до архіву, навіть якщо на жодне з них не посилається myfile.dep.
Зрештою, ні MANIFEST буде створено файл.

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

Використовуйте bundledoc онлайн за допомогою служб onworks.net