Bundledoc - Trực tuyến trên Đám mây

CHƯƠNG TRÌNH:

TÊN

Bundledoc - gói tất cả các tệp cần thiết của một tài liệu LaTeX

SYNOPSIS

Bundledoc [--phiên bản] [--Cứu giúp] [--[Không]dài dòng] [--texfile=hồ sơ] [--danh mục=thư mục]
[--[Không]địa phương] [--loại trừ=chuỗi] [--bao gồm=thông số tập tin] [--rõ ràng=hồ sơ]
[--listdeps= [có | không | chỉ | rel] ...] [--[Không]người canh giữ] [--config=hồ sơ] .D.E.P hồ sơ

MÔ TẢ

Bundledoc là bộ xử lý hậu kỳ cho ảnh chụp gói gói lại với nhau tất cả
các lớp, gói và tệp cần thiết để xây dựng một tài liệu LaTeX nhất định. Nó đọc .D.E.P
nộp nó ảnh chụp tạo, tìm từng tệp được đề cập trong đó và đóng gói chúng
vào một tệp lưu trữ duy nhất (ví dụ: .tar.gz tệp), thích hợp để di chuyển giữa các hệ thống,
truyền cho một đồng nghiệp, v.v.

Ví dụ đơn giản nhất có thể, hãy xem xét một tệp LaTeX được gọi là, xin chào.tex:

\ RequestPackage {snapshot}% Cần thiết bởi Bundledoc
\ documentclass [11pt] {article}

\ Begin {document}
Chào thế giới!
\ End {document}

"\ RequestPackage {snapshot}" gây ra xin chào.dep tệp sẽ được sản xuất. Khi nào Bundledoc is
sau đó đưa ra "hello.dep" làm đối số, nó định vị các tệp phụ thuộc - ảnh chụp nhanh.sty,
bài viết.clsvà size11.clo - và nhóm chúng thành một tệp lưu trữ duy nhất, cùng với
xin chào.tex và MANIFEST tệp (được mô tả trong "TÙY CHỌN", bên dưới).

LỰA CHỌN

Trong các mô tả sau đây, tập tin nào đó đề cập đến tên của tài liệu LaTeX chính của bạn (không
gia hạn).

Bundledoc yêu cầu tên của tệp phụ thuộc được tạo bởi ảnh chụp (thông thường
somefile.dep). Các tùy chọn sau cũng có thể được đưa ra:

--phiên bản
Xuất ra Bundledoc số phiên bản của script. Điều này sẽ ghi đè tất cả những thứ còn lại
tùy chọn.

--Cứu giúp
Đưa ra một thông báo sử dụng ngắn gọn. Điều này ghi đè tất cả các tùy chọn còn lại.

--[Không]dài dòng (mặc định: "noverbose")
Bundledoc bình thường không xuất ra bất cứ thứ gì ngoại trừ thông báo lỗi. Với "--verbose",
nó xuất ra nhiều thông báo trạng thái.

--texfile=chính .tex hồ sơ (vỡ nợ: somefile.tex)
ảnh chụpTệp phụ thuộc của không liệt kê tệp LaTeX chính (tệp được chuyển
đến mủ cao su). Để cho Bundledoc để tìm và nhóm tệp đó, Bundledoc giả sử nó
có cùng tên với ảnh chụp tệp phụ thuộc nhưng với một .tex gia hạn. Nếu điều này
không phải là trường hợp, sau đó sử dụng "--texfile" để chỉ định tên tệp chính xác.

--danh mục=lưu trữ thư mục (vỡ nợ: tập tin nào đó)
Thời Gian Bundledoc tạo một kho lưu trữ (ví dụ: một .tar or .zip tệp) chứa
các tệp của tài liệu, nó đặt tất cả chúng vào một thư mục để tránh làm lộn xộn hiện tại
thư mục với các tệp. Nếu tệp phụ thuộc đã cho được gọi là somefile.dep sau đó
kết quả lưu trữ, theo mặc định, sẽ lưu trữ tất cả các tệp phụ thuộc trong một tập tin nào đó
danh mục. Để thay đổi tên thư mục, hãy sử dụng tùy chọn "--directory".

--[Không]địa phương (mặc định: "nolocalonly")
Mặc dù Bundledoc thường lưu trữ tất cả các tệp có tên trong .D.E.P tập tin
Tùy chọn "--localonly" cho biết Bundledoc để loại trừ tất cả các tệp nằm trong một thư mục khác
hơn .tex thư mục của tệp hoặc một trong các thư mục con của nó.

--loại trừ=chuỗi (vỡ nợ: không ai)
Trong khi "--localonly" gây ra các tệp bên ngoài .tex cây thư mục của tệp sẽ được
bị bỏ qua khỏi kho lưu trữ, "--exclude" cung cấp quyền kiểm soát chi tiết hơn đối với các tệp để
bỏ qua kho lưu trữ. Tùy chọn "--exclude", có thể được chỉ định nhiều lần vào
dòng lệnh, khiến tất cả các tệp có tên chứa chuỗi được bỏ qua
kho lưu trữ.

--bao gồm=thông số tập tin (vỡ nợ: không ai)
Tùy chọn "--include", có thể được chỉ định lặp lại trên dòng lệnh,
hướng dẫn Bundledoc để đưa vào kho lưu trữ tất cả các tệp phù hợp thông số tập tin, Thậm chí
nếu chúng không được tham chiếu trong .D.E.P tập tin.

--rõ ràng=biểu hiện hồ sơ (vỡ nợ: MANIFEST)
Ngoài các tệp phụ thuộc, Bundledoc bao gồm trong tệp lưu trữ thêm một
tệp được gọi, theo mặc định,MANIFEST''. MANIFEST là một tệp văn bản liệt kê
tên tệp gốc của tất cả các phụ thuộc. Để thay đổi tên tệp từ ``MANIFEST''
sang thứ khác, hãy sử dụng tùy chọn "--manifest". Là một trường hợp đặc biệt, "--manifest =" ""
nói Bundledoc không bao gồm một tệp kê khai nào cả.

--listdeps= [yes | no | only | rel] ...] (mặc định: "no")
"--listdeps" chấp nhận một hoặc nhiều "yes", "no", "only" hoặc "rel" dưới dạng dấu phẩy được phân tách
danh sách. Miễn là "không" không xuất hiện trong danh sách này, Bundledoc đầu ra tất cả các chính
Các phần phụ thuộc của tệp LaTeX. Nếu danh sách chứa "rel", thì Bundledoc xuất ra
danh sách các phụ thuộc với tên đường dẫn tương đối. Nếu danh sách chứa "only", thì
Bundledoc thoát ra sau khi hiển thị danh sách mà không tạo ra một kho lưu trữ.

--[Không]người canh giữ (mặc định: "nokeepdirs")
Thông thường, tệp lưu trữ Bundledoc sản xuất chứa một thư mục duy nhất - và
thư mục con, nếu tài liệu đề cập rõ ràng đến chúng - trong đó tất cả
các tệp phụ thuộc nói dối. Nếu "--keepdirs" được chỉ định, tất cả các tệp phụ thuộc sẽ được lưu trữ
với tên đường dẫn ban đầu của họ. Ví dụ, nếu somefile.tex phụ thuộc vào
figure / somefigure.eps, bài viết.clsvà ảnh chụp nhanh.sty, sau đó tập tin nào đó lưu trữ sẽ
thường chứa các tệp sau:

· somefile / somefile.tex

· somefile / figure / somefigure.eps

· somefile / article.cls

· somefile / snapshot.sty

· somefile / MANIFEST

Tuy nhiên, "--keepdirs" sẽ khiến tập tin nào đó kho lưu trữ để chứa các loại sau
tên tệp thay thế:

· home / me / mydocs / somefile.tex

· home / me / mydocs / figure / somefigure.eps

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

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

"--directory" không được sử dụng khi "--keepdirs" có hiệu lực. Ngoài ra, không có bản kê khai
tệp được ghi vào tệp lưu trữ vì nó chứa thông tin dư thừa.

--config=cấu hình hồ sơ (vỡ nợ: )
Tùy chọn "--config" được sử dụng để trỏ Bundledoc với cấu hình thích hợp
(.cfg) tệp cho hệ điều hành và phân phối TeX của bạn. Bundledoc đi kèm với một
ít tệp cấu hình và dễ dàng ghi thêm. Xem "CẤU HÌNH FILES"
(bên dưới) để biết mô tả về định dạng tệp cấu hình.

CẤU HÌNH CÁC TẬP TIN

Định dạng
Các tệp cấu hình tuân theo một định dạng khá đơn giản. Các dòng bắt đầu bằng "#" là nhận xét.
Các dòng trống bị bỏ qua. Tất cả các dòng khác có dạng:

giá trị biến

Phiên bản hiện tại của Bundledoc nhận ra các biến sau:

bó lại
Lệnh sử dụng để nhóm một tập hợp các tệp thành một tệp lưu trữ duy nhất

bồn rửa
Liên kết với một lệnh để loại bỏ đầu ra của nó

tìm
Lệnh tìm tệp trong (các) cây TeX.

Các giá trị quá dài cho một dòng có thể được chia thành nhiều dòng bằng cách sử dụng "\" as
biểu tượng tiếp tục dòng.

Có hai biến môi trường Bundledoc có sẵn để sử dụng bởi
lệnh tệp cấu hình: "BDBASE", được đặt thành tập tin nào đó (như trong "OPTIONS") và
"BDINPUTS", được đặt thành danh sách tệp được phân tách bằng dấu cách mà lệnh sẽ hoạt động
trên. Nghĩa là, khi lệnh được liên kết với "gói" đang chạy, "BDINPUTS" chứa
danh sách tất cả các tệp sẽ được lưu trữ. Ngược lại, khi lệnh
liên kết với "find" đang chạy, "BDINPUTS" chứa tên của tệp cần tìm.

Các ví dụ
Tệp cấu hình sau tương đương với Bundledoccác giá trị mặc định của các giá trị khác nhau
các biến tệp cấu hình, đại diện cho phân phối TeX dựa trên kpathsea đang chạy
trên một hệ thống Unix chung, không nhất thiết phải có bất kỳ công cụ GNU nào, chẳng hạn như
gzip hoặc GNU tar:

# Tệp cấu hình "Mặc định"
# Bởi Scott Pakin[email được bảo vệ]>

gói: (tar -cvf - $ BDINPUTS | nén> $ BDBASE.tar.Z)
chìm:> / dev / null 2> & 1
tìm: kpsewhich -progname = latex $ BDINPUTS

Các dấu ngoặc đơn trong dòng "pack:" cho biết trình bao Unix chạy lệnh trong một
vỏ con. Điều này là để làm cho dấu "chìm:" hoạt động bình thường (nghĩa là không có hai dấu
">" trong cùng một lệnh).

Lưu ý cách các lệnh xử lý "BDBASE" và "BDINPUTS" giống như bất kỳ biến môi trường nào khác
trong Unix shell, sử dụng "$" để nhận giá trị của chúng. Các hệ điều hành khác sử dụng
quy ước tham chiếu đến các biến môi trường. Ví dụ, một tệp cấu hình
đối với bản phân phối TeX dựa trên Windows sẽ sử dụng "% BDBASE%" và "% BDINPUTS%".

Giá trị cho "chìm:" dành riêng cho một hệ điều hành. Giá trị cho "find:" là
cụ thể cho một phân phối TeX. "pack:" là nơi có nhiều cơ hội nhất để tùy chỉnh
dối trá. Bạn có thể sử dụng "gói:" để chỉ định định dạng lưu trữ yêu thích của mình. Ví dụ, bạn
có thể tạo ra một tệp tin sắc nét trên Unix với một cái gì đó như:

gói: (shar --archive-name = "$ BDBASE" $ BDINPUTS> $ BDBASE.sh)

hoặc tệp CAB trên Microsoft Windows với một cái gì đó như:

gói: cabarc -r -p N% BDBASE% .cab% BDINPUTS%

VÍ DỤ

Giả định rằng myfile.dep được sản xuất từ myfile.tex bằng cách làm theo các hướng dẫn trong
Phần mô tả. Lệnh sau tạo ra một .zip tập tin với MikTeX TeX
phân phối chạy trên Microsoft Windows:

Bundledoc --config = miktex.cfg myfile.dep

(Trong thực tế, có lẽ cần phải chỉ định cho "--config" đường dẫn hoàn chỉnh đến
Bundledoc's miktex.cfg tập tin cấu hình.)

Sau đây xây dựng một .tar.gz lưu trữ với bản phân phối TeX Live chạy trên Unix-
như hệ điều hành. Bundledoc sẽ tạo ra đầu ra dài dòng mô tả các hoạt động của nó.
Tất cả các tệp không nằm trong cùng một cây thư mục với myfile.tex và tất cả các tệp có chứa ".fd" hoặc
".sty" trong tên của họ bị bỏ qua. Tuy nhiên, tất cả .bib các tệp trong thư mục hiện tại sẽ
được đưa vào kho lưu trữ mặc dù không ai trong số chúng được tham chiếu bởi myfile.dep.
Cuối cùng, không MANIFEST tập tin sẽ được sản xuất.

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

Sử dụng Bundledoc trực tuyến bằng các dịch vụ onworks.net