bundledoc - Dalam Talian di Awan

JADUAL:

NAMA

bundledoc - himpunkan semua fail yang diperlukan oleh dokumen LaTeX

SINOPSIS

bundledoc [--versi] [- membantu] [--[tidak]kata kerja] [--texfile=fail] [--direktori=direktori]
[--[tidak]setempat sahaja] [--kecualikan=rentetan] [--termasuk=filespec] [--nyata=fail]
[--listdeps=[ya|tidak|sahaja|rel]...] [--[tidak]keepdirs] [--config=fail] .dep fail

DESCRIPTION

bundledoc ialah pemproses pasca untuk gambar pakej yang menggabungkan semua
kelas, pakej dan fail yang diperlukan untuk membina dokumen LaTeX yang diberikan. Ia membaca .dep
failkan itu gambar menghasilkan, mencari setiap fail yang disebut di dalamnya, dan membungkusnya
ke dalam satu fail arkib (cth, a .tar.gz fail), sesuai untuk bergerak merentasi sistem,
menghantar kepada rakan sekerja, dsb.

Sebagai contoh paling mudah, pertimbangkan fail LaTeX yang dipanggil, katakan, hello.tex:

\RequirePackage{snapshot} % Diperlukan oleh bundledoc
\documentclass[11pt]{article}

\ Mula {dokumen}
Hai dunia!
\ End {dokumen}

"\RequirePackage{snapshot}" menyebabkan a hello.dep fail untuk dihasilkan. Bila bundledoc is
kemudian diberi "hello.dep" sebagai hujah, ia mencari fail bergantung -- snapshot.sty,
artikel.cls, dan saiz11.clo -- dan menghimpunkannya ke dalam satu fail arkib, bersama-sama dengan
hello.tex dan NYATA fail (diterangkan dalam "OPTIONS", di bawah).

PILIHAN

Dalam huraian berikut, sesuatu fail merujuk kepada nama dokumen LaTeX utama anda (no
sambungan).

bundledoc memerlukan nama fail pergantungan yang dihasilkan oleh gambar (biasanya
somefile.dep). Pilihan berikut juga boleh diberikan:

--versi
Keluarkan bundledoc nombor versi skrip. Ini mengatasi semua yang selebihnya
pilihan.

- membantu
Berikan mesej penggunaan ringkas. Ini mengatasi semua pilihan yang tinggal.

--[tidak]kata kerja (lalai: "noverbose")
bundledoc biasanya tidak mengeluarkan apa-apa kecuali mesej ralat. Dengan "--verbose",
ia mengeluarkan mesej status yang banyak.

--texfile=utama .tex fail (lalai: somefile.tex)
gambarFail pergantungan tidak menyenaraikan fail LaTeX utama (yang diluluskan
kepada getah). Agar bundledoc untuk mencari dan menggabungkan fail itu, bundledoc menganggapnya
mempunyai nama yang sama dengan gambar fail pergantungan tetapi dengan a .tex sambungan. Jika ini
tidak demikian, kemudian gunakan "--texfile" untuk menentukan nama fail yang betul.

--direktori=arkib direktori (lalai: sesuatu fail)
Bila bundledoc mencipta arkib (cth, a .tar or . Zip fail) yang mengandungi
fail dokumen, ia meletakkan kesemuanya dalam direktori untuk mengelakkan kekacauan semasa
direktori dengan fail. Jika fail pergantungan yang diberikan dipanggil somefile.dep maka
arkib yang terhasil akan, secara lalai, menyimpan semua fail bergantung dalam a sesuatu fail
direktori. Untuk menukar nama direktori gunakan pilihan "--directory".

--[tidak]setempat sahaja (lalai: "nolocalonly")
Walaupun bundledoc biasanya mengarkibkan semua fail yang dinamakan dalam .dep fail, yang
Pilihan "--localonly" memberitahu bundledoc untuk mengecualikan semua fail yang terdapat dalam direktori lain
daripada .tex direktori fail atau salah satu subdirektorinya.

--kecualikan=rentetan (lalai: tiada)
Walaupun "--localonly" menyebabkan fail di luar fail .tex pokok direktori fail menjadi
ditinggalkan daripada arkib, "--exclude" menyediakan kawalan yang lebih terperinci ke atas fail kepada
tinggalkan daripada arkib. Pilihan "--exclude", yang boleh ditentukan berulang kali pada
baris arahan, menyebabkan semua fail yang namanya mengandungi rentetan untuk dikecualikan daripada
arkib.

--termasuk=filespec (lalai: tiada)
Pilihan "--include", yang boleh ditentukan berulang kali pada baris arahan,
memberi arahan bundledoc untuk memasukkan dalam arkib semua fail yang sepadan filespec, walaupun
jika mereka tidak dirujuk dalam .dep fail.

--nyata=nyata fail (lalai: NYATA)
Sebagai tambahan kepada fail bergantung, bundledoc termasuk dalam fail arkib satu tambahan
fail dipanggil, secara lalai, ``NYATA''. NYATA ialah fail teks yang menyenaraikan
nama fail asal semua kebergantungan. Untuk menukar nama fail daripada ``NYATA''
kepada sesuatu yang lain, gunakan pilihan "--manifest". Sebagai kes khas, "--manifest="""
memberitahu bundledoc untuk tidak memasukkan fail manifes sama sekali.

--listdeps=[ya|tidak|sahaja|rel]...] (lalai: "tidak")
"--listdeps" menerima satu atau lebih daripada "ya", "tidak", "sahaja", atau "rel" sebagai dipisahkan koma
senarai. Selagi "tidak" tidak muncul dalam senarai ini, bundledoc mengeluarkan semua yang utama
Kebergantungan fail LaTeX. Jika senarai mengandungi "rel", maka bundledoc mengeluarkan
senarai kebergantungan dengan nama laluan relatif. Jika senarai mengandungi "sahaja", maka
bundledoc keluar selepas memaparkan senarai, tanpa menghasilkan arkib.

--[tidak]keepdirs (lalai: "nokeepdirs")
Biasanya, fail arkib itu bundledoc menghasilkan mengandungi satu direktori -- dan
subdirektori, jika dokumen itu merujuk secara eksplisit kepada mereka -- di mana semua
fail bergantung berbohong. Jika "--keepdirs" ditentukan, semua fail bergantung disimpan
dengan nama laluan asal mereka. Sebagai contoh, jika somefile.tex bergantung kepada
figures/somefigure.eps, artikel.cls, dan snapshot.sty, maka sesuatu fail kehendak arkib
biasanya mengandungi fail berikut:

· somefile/somefile.tex

· somefile/figures/somefigure.eps

· somefile/article.cls

· somefile/snapshot.sty

· somefile/MANIFEST

Walau bagaimanapun, "--keepdirs" akan menyebabkan sesuatu fail arkib untuk mengandungi jenis berikut
nama fail sebaliknya:

· 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" tidak digunakan apabila "--keepdirs" berkuat kuasa. Di samping itu, tiada nyata
fail ditulis pada fail arkib kerana ia mengandungi maklumat berlebihan.

--config=konfigurasi fail (lalai: )
Pilihan "--config" digunakan untuk menunjuk bundledoc kepada konfigurasi yang sesuai
(.cfg) fail untuk sistem pengedaran dan pengendalian TeX anda. bundledoc datang dengan a
beberapa fail konfigurasi dan mudah untuk menulis lebih banyak lagi. Lihat "FAIL KONFIGURASI"
(di bawah) untuk penerangan tentang format fail konfigurasi.

CONFIGURATION FILES

format
Fail konfigurasi mengikut format yang agak mudah. Baris yang bermula dengan "#" ialah ulasan.
Garis kosong diabaikan. Semua baris lain adalah dalam bentuk:

pembolehubah: nilai

Versi semasa bundledoc mengenali pembolehubah berikut:

bundle
Perintah untuk digunakan untuk menggabungkan satu set fail ke dalam satu fail arkib

sink
Imbuhan pada perintah untuk membuang outputnya

mencari
Perintah untuk mencari fail dalam pepohon TeX.

Nilai yang terlalu panjang untuk satu baris boleh dipisahkan merentasi berbilang baris dengan menggunakan "\" sebagai
simbol baris-sambungan.

Terdapat dua pembolehubah persekitaran yang bundledoc menyediakan untuk digunakan oleh
arahan fail konfigurasi: "BDBASE", yang ditetapkan kepada sesuatu fail (seperti dalam "PILIHAN"), dan
"BDINPUTS", yang ditetapkan kepada senarai fail yang dipisahkan dengan ruang yang akan dikendalikan oleh arahan
atas. Iaitu, apabila arahan yang dikaitkan dengan "bundle" sedang berjalan, "BDINPUTS" mengandungi
senarai semua fail yang akan diarkibkan. Sebaliknya, apabila arahan
dikaitkan dengan "cari" sedang berjalan, "BDINPUTS" mengandungi nama fail untuk dicari.

Contoh
Fail konfigurasi berikut selari bundledocnilai lalai daripada pelbagai
pembolehubah fail konfigurasi, yang mewakili pengedaran TeX berasaskan kpathsea berjalan
pada sistem Unix generik, yang tidak semestinya mempunyai sebarang alat GNU, seperti
gzip atau GNU tar:

# Fail konfigurasi "Lalai".
# Oleh Scott Pakin[e-mel dilindungi]>

berkas: (tar -cvf - $BDINPUTS | mampat > $BDBASE.tar.Z)
sink: > /dev/null 2>&1
cari: kpsewhich -progname=lateks $BDINPUTS

Tanda kurung dalam baris "bundle:" memberitahu shell Unix untuk menjalankan arahan dalam a
subkulit. Ini adalah untuk menjadikan imbuhan "sink:" berfungsi dengan betul (iaitu, tidak ada dua
">" dalam arahan yang sama).

Perhatikan cara arahan merawat "BDBASE" dan "BDINPUTS" seperti mana-mana pembolehubah persekitaran yang lain
dalam cangkerang Unix, menggunakan "$" untuk mengambil nilainya. Sistem pengendalian lain menggunakan berbeza
konvensyen untuk merujuk kepada pembolehubah persekitaran. Sebagai contoh, fail konfigurasi
untuk pengedaran TeX berasaskan Windows akan menggunakan "%BDBASE%" dan "%BDINPUTS%" sebaliknya.

Nilai untuk "sink:" adalah khusus untuk sistem pengendalian. Nilai untuk "cari:" ialah
khusus untuk pengedaran TeX. "bundle:" ialah tempat paling banyak peluang untuk penyesuaian
pembohongan. Anda boleh menggunakan "bundle:" untuk menentukan format arkib kegemaran anda. Sebagai contoh, anda
boleh menghasilkan fail shar pada Unix dengan sesuatu seperti:

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

atau fail CAB pada Microsoft Windows dengan sesuatu seperti:

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

CONTOH

Anggap bahawa myfile.dep dihasilkan daripada myfile.tex dengan mengikut arahan dalam
Bahagian penerangan. Perintah berikut menghasilkan a . Zip fail dengan MikTeX TeX
pengedaran berjalan pada Microsoft Windows:

bundledoc --config=miktex.cfg myfile.dep

(Dalam amalan, mungkin perlu untuk menentukan "--config" laluan lengkap ke
bundledoc's miktex.cfg fail konfigurasi.)

Binaan berikut a .tar.gz arkib dengan pengedaran TeX Live yang dijalankan pada Unix-
seperti sistem pengendalian. bundledoc akan menghasilkan keluaran verbose yang menerangkan operasinya.
Semua fail tidak dalam pepohon direktori yang sama seperti myfile.tex dan semua fail yang mengandungi ".fd" atau
".sty" dalam nama mereka ditinggalkan. Namun, semua .bib fail dalam direktori semasa akan
dimasukkan ke dalam arkib walaupun tiada satu pun daripada mereka dirujuk oleh myfile.dep.
Akhirnya, tidak NYATA fail akan dihasilkan.

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

Gunakan bundledoc dalam talian menggunakan perkhidmatan onworks.net