packagedoc - Bulutta Çevrimiçi

Program:

ADI

bundledoc - bir LaTeX belgesinin ihtiyaç duyduğu tüm dosyaları bir araya toplar

SİNOPSİS

paket belgesi [--versiyon] [--yardım et] [--[yok hayır]gereksiz sözlerle dolu] [--tex dosyası=dosya] [--dizin=rehber]
[--[yok hayır]Sadece yerel] [--hariç tutmak=dizi] [--Dahil etmek=dosya özelliği] [--belirgin=dosya]
[--listdeps=[evet|hayır|yalnızca|rel]...] [--[yok hayır]Keepdirs] [--yapılandırma=dosya] .dep dosya

TANIM

paket belgesi için bir post-işlemcidir. enstantane hepsini bir araya toplayan paket
Belirli bir LaTeX belgesini oluşturmak için gereken sınıflar, paketler ve dosyalar. okur .dep
bunu dosyala enstantane burada belirtilen dosyaların her birini üretir, bulur ve paketler.
tek bir arşiv dosyasına (örn. .tar.gz dosya), sistemler arasında hareket etmeye uygun,
bir meslektaşına iletme, vb.

Mümkün olan en basit örnek olarak, adında bir LaTeX dosyası düşünün: merhaba.tex:

\RequirePackage{snapshot} % Buckdoc tarafından gerekli
\documentclass[11pt]{makale}

\ {Belgeyi} başlayın
Merhaba dünya!
\ Sonuç {belge}

"\RequirePackage{snapshot}", bir merhaba.dep dosya üretilecek. Ne zaman paket belgesi is
sonra argüman olarak "merhaba.dep" verildiğinde, bağımlı dosyaları bulur -- anlık görüntü.sty,
makale.cls, ve size11.clo -- ve bunları tek bir arşiv dosyasında toplar.
merhaba.tex ve MANIFEST dosyası (aşağıdaki "SEÇENEKLER" bölümünde açıklanmıştır).

SEÇENEKLER

Aşağıdaki açıklamalarda, bir dosya ana LaTeX belgenizin adını ifade eder (hayır
eklenti).

paket belgesi tarafından üretilen bağımlılık dosyasının adını gerektirir enstantane (normalde
bir dosya.dep). Aşağıdaki seçenekler de verilebilir:

--versiyon
Çıktı paket belgesi komut dosyasının sürüm numarası. Bu, kalanların tümünü geçersiz kılar
seçenekleri.

--yardım et
Kısa bir kullanım mesajı verin. Bu, kalan tüm seçenekleri geçersiz kılar.

--[yok hayır]gereksiz sözlerle dolu (varsayılan: "noverbose")
paket belgesi normalde hata mesajları dışında hiçbir şey vermez. "--ayrıntılı" ile,
çok sayıda durum mesajı verir.

--tex dosyası=ana .tex dosya (varsayılan: bir dosya.tex)
enstantane'nin bağımlılık dosyası ana LaTeX dosyasını (geçilen dosya) listelemiyor.
için lateks). için paket belgesi o dosyayı bulmak ve paketlemek için, paket belgesi varsayar
ile aynı isme sahip enstantane bağımlılık dosyası ancak bir .tex uzantı. Eğer bu
değilse, doğru dosya adını belirtmek için "--texfile" kullanın.

--dizin=arşiv rehber (varsayılan: bir dosya)
Ne zaman paket belgesi bir arşiv oluşturur (örn. .katran or .zip dosya) içeren
belgenin dosyaları, mevcut dosyanın dağınıklığını önlemek için hepsini bir dizine koyar.
dosyaları içeren dizin. Verilen bağımlılık dosyası çağrılırsa bir dosya.dep sonra
sonuçta ortaya çıkan arşiv, varsayılan olarak, tüm bağımlı dosyaları bir bir dosya
dizin. Dizin adını değiştirmek için "--directory" seçeneğini kullanın.

--[yok hayır]Sadece yerel (varsayılan: "yalnızca yerel olmayan")
Rağmen paket belgesi normalde içinde belirtilen tüm dosyaları arşivler. .dep dosya,
"--localonly" seçeneği söyler paket belgesi diğer bir dizinde bulunan tüm dosyaları dışlamak için
daha .tex dosyanın dizini veya alt dizinlerinden biri.

--hariç tutmak=dizi (varsayılan: Yok)
"--localonly", dosyanın dışındaki dosyalara neden olurken .tex dosyanın dizin ağacı olacak
arşivden çıkarılmış olan "--exclude", dosyalar üzerinde daha ayrıntılı kontrol sağlar.
arşivden çıkar. üzerinde tekrar tekrar belirtilebilen "--exclude" seçeneği
komut satırı, adı içeren tüm dosyalara neden olur dizi kapsamından çıkarılması
Arşiv.

--Dahil etmek=dosya özelliği (varsayılan: Yok)
Komut satırında tekrar tekrar belirtilebilen "--include" seçeneği,
talimatını paket belgesi eşleşen tüm dosyaları arşive eklemek için dosya özelliği, Hatta
eğer referansta bulunmuyorlarsa .dep dosyası.

--belirgin=apaçık dosya (varsayılan: MANIFEST)
Bağımlı dosyalara ek olarak, paket belgesi arşiv dosyasına bir tane daha ekler
varsayılan olarak `` olarak adlandırılan dosyaMANIFEST''. MANIFEST listeleyen bir metin dosyasıdır.
tüm bağımlılıkların orijinal dosya adları. Dosya adını `` olarak değiştirmek içinMANIFEST''
başka bir şey için "--manifest" seçeneğini kullanın. Özel bir durum olarak, "--manifest="""
anlatır paket belgesi hiç bir bildirim dosyası eklememek.

--listdeps=[evet|hayır|yalnızca|rel]...] (varsayılan: "hayır")
"--listdeps", "evet", "hayır", "yalnızca" veya "rel"den birini veya daha fazlasını virgülle ayrılmış olarak kabul eder
liste. Bu listede "hayır" görünmediği sürece, paket belgesi tüm ana çıktıları
LaTeX dosyasının bağımlılıkları. Liste "rel" içeriyorsa, o zaman paket belgesi çıktılar
göreli yol adlarına sahip bağımlılıkların listesi. Liste "yalnızca" içeriyorsa, o zaman
paket belgesi bir arşiv oluşturmadan listeyi görüntüledikten sonra çıkar.

--[yok hayır]Keepdirs (varsayılan: "nokeepdirs")
Normalde, arşiv dosyası paket belgesi üretir tek bir dizin içerir -- ve
alt dizinler, eğer belge açıkça onlara atıfta bulunuyorsa -- içinde tüm
bağımlı dosyalar yalan. "--keepdirs" belirtilirse, tüm bağımlı dosyalar saklanır
orijinal yol adlarıyla. örneğin, eğer bir dosya.tex göre değişir
rakamlar/somefigure.eps, makale.cls, ve anlık görüntü.sty, sonra bir dosya arşiv olacak
normalde aşağıdaki dosyaları içerir:

· bir dosya/bir dosya.tex

· bir dosya/figürler/bir şekil.eps

· bir dosya/makale.cls

· bir dosya/snapshot.sty

· bir dosya/MANIFEST

Ancak, "--keepdirs" bir dosya aşağıdaki türleri içerecek şekilde arşiv
bunun yerine dosya adları:

· ana sayfa/ben/dokümanlarım/somefile.tex

· ana sayfa/ben/belgelerim/figürler/somefigure.eps

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

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

"--directory", "--keepdirs" etkinken kullanılmaz. Ayrıca hiçbir manifesto
dosya gereksiz bilgiler içerdiğinden arşiv dosyasına yazılır.

--yapılandırma=yapılandırma dosya (varsayılan: )
"--config" seçeneği işaret etmek için kullanılır paket belgesi uygun konfigürasyona
(.cfg) TeX dağıtımınız ve işletim sisteminiz için dosya. paket belgesi ile gelir
birkaç yapılandırma dosyası ve daha fazlasını yazmak kolaydır. Bkz. "KONFIGÜRASYON DOSYALARI"
(aşağıda) yapılandırma dosyası biçiminin açıklaması için.

YAPILANDIRMA DOSYALAR

oluşturulan
Konfigürasyon dosyaları oldukça basit bir formatı takip eder. "#" ile başlayan satırlar yorumlardır.
Boş satırlar yoksayılır. Diğer tüm satırlar şu şekildedir:

değişken: değer

Geçerli sürümü paket belgesi aşağıdaki değişkenleri tanır:

demet
Bir dizi dosyayı tek bir arşiv dosyasında paketlemek için kullanılacak komut

lavabo
Çıktısını atmak için bir komutun eki

bulmak
TeX ağaç(lar)ında bir dosya bulma komutu.

Bir satır için çok uzun olan değerler, "\" kullanılarak birden çok satıra bölünebilir.
satır devam sembolü.

iki ortam değişkeni vardır paket belgesi tarafından kullanıma sunulur
yapılandırma dosyası komutları: olarak ayarlanan "BDBASE" bir dosya ("SEÇENEKLER" bölümünde olduğu gibi) ve
Bir komutun çalıştıracağı boşlukla ayrılmış bir dosya listesine ayarlanan "BDINPUTS"
üzerine. Yani, "bundle" ile ilişkili komut çalışırken, "BDINPUTS" şunları içerir:
arşivlenecek tüm dosyaların listesi. Buna karşılık, komut ne zaman
ile ilişkili "find" çalışıyor, "BDINPUTS" aranacak dosyanın adını içerir.

Örnekler
Aşağıdaki yapılandırma dosyası paralellikleri paket belgesiçeşitli varsayılan değerleri
çalışan bir kpathsea tabanlı TeX dağıtımını temsil eden yapılandırma dosyası değişkenleri
gibi GNU araçlarından herhangi birine sahip olması gerekmeyen genel bir Unix sisteminde
gzip veya GNU katran:

# "Varsayılan" yapılandırma dosyası
# Scott Pakin tarafından[e-posta korumalı]>

paket: (tar -cvf - $BDINPUTS | sıkıştır > $BDBASE.tar.Z)
havuz: > /dev/null 2>&1
bul: kpsewhat -progname=lateks $BDINPUTS

"Paket:" satırındaki parantezler, Unix kabuğuna komutu bir
alt kabuk. Bu, "sink:" ekinin düzgün çalışmasını sağlamak içindir (yani, iki
">" aynı komutta).

Komutların "BDBASE" ve "BDINPUTS" öğelerini diğer ortam değişkenleri gibi nasıl ele aldığına dikkat edin.
bir Unix kabuğunda, değerlerini almak için "$" kullanarak. Diğer işletim sistemleri farklı kullanır
ortam değişkenlerine atıfta bulunmak için kurallar. Örneğin, bir yapılandırma dosyası
Windows tabanlı bir TeX dağıtımı için bunun yerine "%BDBASE%" ve "%BDINPUTS%" kullanılır.

"sink:" değeri bir işletim sistemine özeldir. "Bul:" değeri
TeX dağıtımına özel. "paket:" özelleştirme için en fazla fırsatın olduğu yerdir
yalanlar. Favori arşiv biçiminizi belirtmek için "paket:" kullanabilirsiniz. örneğin, sen
Unix'te aşağıdaki gibi bir shar dosyası üretebilir:

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

veya Microsoft Windows'ta aşağıdaki gibi bir CAB dosyası:

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

ÖRNEKLER

Varsayalım dosyam.dep ... dan üretildi dosyam.tex bölümündeki talimatları izleyerek
Açıklama bölümü. Aşağıdaki komut bir .zip MikTeX TeX ile dosya
Microsoft Windows üzerinde çalışan dağıtım:

paketdoc --config=miktex.cfg dosyam.dep

(Pratikte, tam yolu "--config" olarak belirtmek muhtemelen gereklidir.
paket belgesi's miktex.cfg yapılandırma dosyası.)

Aşağıdakiler bir .tar.gz bir Unix üzerinde çalışan TeX Live dağıtımıyla arşivleyin.
işletim sistemi gibi. paket belgesi işlemlerini açıklayan ayrıntılı çıktı üretecektir.
Aynı dizin ağacında olmayan tüm dosyalar dosyam.tex ve ".fd" içeren tüm dosyalar veya
adlarında ".sty" kullanılmamıştır. Ancak, hepsi .önlük geçerli dizindeki dosyalar
hiçbirine atıfta bulunulmamasına rağmen arşive dahil edilmemelidir. dosyam.dep.
Son olarak, hayır MANIFEST dosya üretilecektir.

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

onworks.net hizmetlerini kullanarak bunddoc'u çevrimiçi kullanın