bundledoc - Online na nuvem

PROGRAMA:

NOME

bundledoc - agrupa todos os arquivos necessários para um documento LaTeX

SINOPSE

pacotedoc [--versão] [--Socorro] [--[não]detalhado] [--arquivotex=lima] [--diretório=anuário]
[--[não]apenas localmente] [--excluir=corda] [--incluir=especificação de arquivo] [--manifesto=lima]
[--listdeps= [sim | não | apenas | rel] ...] [--[não]Keepdirs] [--config=lima] .dep lima

DESCRIÇÃO

pacotedoc é um pós-processador para o instantâneo pacote que reúne todos os
classes, pacotes e arquivos necessários para construir um determinado documento LaTeX. Lê o .dep
arquivar isso instantâneo produz, encontra cada um dos arquivos mencionados nele e os empacota
em um único arquivo (por exemplo, um .tar.gz arquivo), adequado para mover entre sistemas,
transmitindo para um colega, etc.

Como o exemplo mais simples possível, considere um arquivo LaTeX chamado, digamos, ola.tex:

\ RequirePackage {snapshot}% necessário para bundledoc
\ documentclass [11pt] {artigo}

\ Begin {document}
Olá mundo!
\ End {document}

O "\ RequirePackage {snapshot}" causa um ola.dep arquivo a ser produzido. Quando pacotedoc is
em seguida, dado "hello.dep" como um argumento, ele localiza os arquivos dependentes - instantâneo.sty,
artigo.cls e tamanho11.clo - e os agrupa em um único arquivo, junto com
ola.tex e de um MANIFESTO (descrito em "OPÇÕES", abaixo).

OPÇÕES

Nas descrições a seguir, somefile refere-se ao nome do seu documento LaTeX principal (não
extensão).

pacotedoc requer o nome do arquivo de dependência produzido por instantâneo (normalmente
algumarquivo.dep) As seguintes opções também podem ser fornecidas:

--versão
Produza o pacotedoc número da versão do script. Isso substitui todos os restantes
opções.

--Socorro
Dê uma breve mensagem de uso. Isso substitui todas as opções restantes.

--[não]detalhado (padrão: "noverbose")
pacotedoc normalmente não produz nada, exceto mensagens de erro. Com "--verbose",
ele emite mensagens de status copiosas.

--arquivotex=principal .tex lima (padrão: algum arquivo.tex)
instantâneoo arquivo de dependência de não lista o arquivo LaTeX principal (aquele que é passado
para látex) Em ordem para pacotedoc para encontrar e empacotar esse arquivo, pacotedoc assume
tem o mesmo nome que o instantâneo arquivo de dependência, mas com um .tex extensão. Se este
não é o caso, então use "--texfile" para especificar o nome do arquivo correto.

--diretório=arquivo anuário (padrão: somefile)
Quando pacotedoc cria um arquivo (por exemplo, um .alcatrão or . Zip arquivo) contendo o
arquivos do documento, ele os coloca em um diretório para evitar confundir o atual
diretório com arquivos. Se o arquivo de dependência fornecido for chamado algumarquivo.dep então o
arquivo resultante irá, por padrão, armazenar todos os arquivos dependentes em um somefile
diretório. Para alterar o nome do diretório, use a opção "--directory".

--[não]apenas localmente (padrão: "nolocalonly")
Apesar pacotedoc normalmente arquiva todos os arquivos nomeados no .dep arquivo, o
A opção "--localonly" diz pacotedoc para excluir todos os arquivos localizados em um diretório outro
que o .tex diretório do arquivo ou um de seus subdiretórios.

--excluir=corda (padrão: Nenhum)
Enquanto "--localonly" causa arquivos fora do .tex árvore de diretório do arquivo para ser
omitido do arquivo, "--exclude" fornece controle mais refinado sobre os arquivos para
omitir do arquivo. A opção "--exclude", que pode ser especificada repetidamente em
a linha de comando, faz com que todos os arquivos cujo nome contenha corda para ser omitido do
arquivo.

--incluir=especificação de arquivo (padrão: Nenhum)
A opção "--include", que pode ser especificada repetidamente na linha de comando,
instrui pacotedoc incluir no arquivo todos os arquivos correspondentes especificação de arquivo, Mesmo
se eles não são referenciados no .dep arquivo.

--manifesto=manifestar lima (padrão: MANIFESTO)
Além dos arquivos dependentes, pacotedoc inclui no arquivo um extra
arquivo chamado, por padrão, ``MANIFESTO''. MANIFESTO é um arquivo de texto que lista o
nomes de arquivo originais de todas as dependências. Para mudar o nome do arquivo de ``MANIFESTO''
para outra coisa, use a opção "--manifest". Como um caso especial, "--manifest =" ""
conta pacotedoc não incluir um arquivo de manifesto.

--listdeps= [sim | não | apenas | rel] ...] (padrão: "não")
"--listdeps" aceita um ou mais de "yes", "no", "only" ou "rel" separados por vírgulas
Lista. Contanto que "não" não apareça nesta lista, pacotedoc produz todos os principais
Dependências do arquivo LaTeX. Se a lista contiver "rel", então pacotedoc produz o
lista de dependências com nomes de caminho relativos. Se a lista contiver "apenas", então
pacotedoc sai após exibir a lista, sem produzir um arquivo.

--[não]Keepdirs (padrão: "nokeepdirs")
Normalmente, o arquivo que pacotedoc produz contém um único diretório - e
subdiretórios, se o documento se referir explicitamente a eles - em que todos os
arquivos dependentes mentem. Se "--keepdirs" for especificado, todos os arquivos dependentes serão armazenados
com seus nomes de caminho originais. Por exemplo, se algum arquivo.tex depende
figuras / somefigure.eps, artigo.cls e instantâneo.sty, Em seguida, o somefile arquivo vai
normalmente contém os seguintes arquivos:

· somefile / somefile.tex

· somefile / Figures / somefigure.eps

· somefile / article.cls

· somefile / snapshot.sty

· somefile / MANIFEST

No entanto, "--keepdirs" causará o somefile arquivo para conter os seguintes tipos
de nomes de arquivo em vez disso:

· 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" não é usado quando "--keepdirs" está em vigor. Além disso, nenhum manifesto
O arquivo é gravado no arquivo porque contém informações redundantes.

--config=• Configuração lima (predefinição: )
A opção "--config" é usada para apontar pacotedoc para a configuração apropriada
(.cfg) para sua distribuição TeX e sistema operacional. pacotedoc vem com um
poucos arquivos de configuração e é fácil escrever mais. Veja "ARQUIVOS DE CONFIGURAÇÃO"
(abaixo) para uma descrição do formato do arquivo de configuração.

CONFIGURAÇÃO ARQUIVOS

Formato
Os arquivos de configuração seguem um formato bastante simples. As linhas que começam com "#" são comentários.
As linhas em branco são ignoradas. Todas as outras linhas têm o formato:

variável: valor

A versão atual do pacotedoc reconhece as seguintes variáveis:

empacotar
O comando a ser usado para agrupar um conjunto de arquivos em um único arquivo

lavatório
O afixo de um comando para descartar sua saída

find
O comando para localizar um arquivo na (s) árvore (s) TeX.

Valores que são muito longos para uma linha podem ser divididos em várias linhas usando "\" como
o símbolo de continuação de linha.

Existem duas variáveis ​​de ambiente que pacotedoc disponibiliza para uso por
comandos do arquivo de configuração: "BDBASE", que é definido como somefile (como em "OPÇÕES"), e
"BDINPUTS", que é definido como uma lista de arquivos separados por espaço que um comando deve operar
sobre. Ou seja, quando o comando associado a "bundle" está em execução, "BDINPUTS" contém
a lista de todos os arquivos que devem ser arquivados. Em contraste, quando o comando
associado a "find" em execução, "BDINPUTS" contém o nome do arquivo a ser pesquisado.

Exemplos
O seguinte arquivo de configuração é paralelo pacotedocvalores padrão dos vários
variáveis ​​de arquivo de configuração, que representam uma distribuição TeX baseada em kpathsea em execução
em um sistema Unix genérico, que não tem necessariamente nenhuma das ferramentas GNU, como
gzip ou GNU alcatrão:

# Arquivo de configuração "padrão"
# Por Scott Pakin[email protegido]>

pacote: (tar -cvf - $ BDINPUTS | compress> $ BDBASE.tar.Z)
coletor:> / dev / null 2> & 1
find: kpsewhich -progname = latex $ BDINPUTS

Os parênteses na linha "bundle:" dizem ao shell Unix para executar o comando em um
subcamada. Isso é para fazer o afixo "coletor:" funcionar corretamente (ou seja, para que não haja dois
">" está no mesmo comando).

Observe como os comandos tratam "BDBASE" e "BDINPUTS" como quaisquer outras variáveis ​​de ambiente
em um shell Unix, usando "$" para obter seu valor. Outros sistemas operacionais usam diferentes
convenções para se referir a variáveis ​​de ambiente. Por exemplo, um arquivo de configuração
para uma distribuição TeX baseada em Windows, usaria "% BDBASE%" e "% BDINPUTS%" em seu lugar.

O valor para "dissipador:" é específico para um sistema operacional. O valor para "encontrar:" é
específico para uma distribuição TeX. "pacote:" é onde a maior oportunidade para personalização
mentiras. Você pode usar "bundle:" para especificar seu formato de arquivo favorito. Por exemplo, você
pode produzir um arquivo shar no Unix com algo como:

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

ou um arquivo CAB no Microsoft Windows com algo como:

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

EXEMPLOS

Assuma isso meuarquivo.dep foi produzido a partir de meuarquivo.tex seguindo as instruções no
Seção de descrição. O seguinte comando produz um . Zip arquivo com o MikTeX TeX
distribuição em execução no Microsoft Windows:

bundledoc --config = miktex.cfg meuarquivo.dep

(Na prática, provavelmente é necessário especificar para "--config" o caminho completo para
pacotedoc's miktex.cfg arquivo de configuração.)

O seguinte constrói um .tar.gz arquivo com a distribuição TeX Live rodando em um Unix-
como sistema operacional. pacotedoc irá produzir uma saída detalhada descrevendo suas operações.
Todos os arquivos que não estão na mesma árvore de diretórios que meuarquivo.tex e todos os arquivos contendo ".fd" ou
".sty" em seus nomes são omitidos. No entanto, todos .babador arquivos no diretório atual irão
ser incluído no arquivo, mesmo que nenhum deles seja referenciado por meuarquivo.dep.
Enfim não MANIFESTO arquivo será produzido.

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

Use bundledoc online usando serviços onworks.net