a2x - Online na nuvem

PROGRAMA:

NOME

a2x - Um gerenciador de conjunto de ferramentas para AsciiDoc (converte arquivos de texto Asciidoc para outro arquivo
formatos)

SINOPSE

a2x [OPÇÕES] ARQUIVO FONTE

DESCRIÇÃO

Um gerenciador de conjunto de ferramentas DocBook que traduz um arquivo de texto AsciiDoc ARQUIVO FONTE para PDF,
EPUB, DVI, PS, LaTeX, XHTML (página única ou em partes), página de manual, Ajuda em HTML ou texto simples
formatos usando ascidoco(1) e outros aplicativos (consulte a seção REQUISITOS). ARQUIVO FONTE pode
também pode ser um arquivo DocBook com uma extensão .xml.

OPÇÕES

-uma, --atributo=ATRIBUTO
Conjunto ascidoco(1) valor do atributo (atalho para --asciidoc-opts="-uma ATRIBUTO" opção).
Esta opção pode ser especificada mais de uma vez.

--asciidoc-opts=ASCIIDOC_OPTS
Adicional ascidoco(1) opções. Esta opção pode ser especificada mais de uma vez.

--conf-arquivo=CONF_FILE
Carregue o arquivo de configuração. Consulte a seção CONF FILES.

-D, --destino-dir=DESTINO_DIR
Diretório de saída. Padrões para ARQUIVO FONTE diretório. Esta opção só se aplica a
Formatos de saída baseados em HTML (em pedaços, epub, htmlajuda, xhtml).

-d, --doctype=DOCTYPE
Tipo de documento DocBook: artigo, página de manual or livro. O tipo de documento padrão é artigo
a menos que o formato seja página de manual (nesse caso, o padrão é página de manual).

-b, --Processo interno=PROCESSO INTERNO
PROCESSO INTERNO é o nome de um plugin de backend instalado. Quando esta opção é especificada a2x
tentativas de carregar um nome de arquivo a2x-backend.py do PROCESSO INTERNO diretório de plugins então
converte o ARQUIVO FONTE para uma PROCESSO INTERNO arquivo de saída formatado usando uma função global
definido em a2x-backend.py chamado para_BACKEND.

-f, --formato=FORMATO
Formatos de saída: em pedaços, livro de documentos, Dvi, epub, htmlajuda, página de manual, pdf (Padrão) ps,
tex, texto, xhtml. O AsciiDoc formato a2x o valor do atributo é definido como FORMATO.

-h, --Socorro
Imprime sintaxe de linha de comando e opções de programa em stdout.

--ícones
Use imagens de advertência ou de ícone de navegação em documentos de saída. O comportamento padrão é
para usar texto no lugar de ícones.

--icons-dir=PATH
Um caminho (relativo aos arquivos de saída) contendo ícones de advertência e navegação. Padrões
para imagens / ícones. o --ícones opção está implícita se esta opção for usada.

-k, --manter artefatos
Não exclua arquivos de construção temporários.

--lince
Use lince(1) para gerar saída formatada em texto. O comportamento padrão é usar w3m(1).

-EU, --no-xmllint
Não verifique a saída asciidoc com xmllint(1).

--- epubcheck
Verifique a saída EPUB com epubcheck(1).

-n, --funcionamento a seco
Não faça nada, apenas imprima o que teria sido feito.

-r, --recurso=RESOURCE_SPEC
Especifique um recurso. Esta opção pode ser especificada mais de uma vez. Veja o RECURSOS
seção para mais detalhes.

-m, --recurso-manifesto=ARQUIVO
ARQUIVO contém uma lista de recursos (um por linha). Manifesto ARQUIVO entradas são formatadas
Assim como --recurso argumentos de opção. Variáveis ​​de ambiente e casa de til
diretórios são permitidos.

--folha de estilo=FOLHA DE ESTILO
Uma lista delimitada por espaço de um ou mais nomes de arquivo de folha de estilo CSS que são usados ​​para estilizar
Saída HTML gerada por DocBook XSL Stylesheets. Padrões para docbook-xsl.css. O
as folhas de estilo são processadas em ordem de lista. As folhas de estilo devem residir em um
localização do arquivo de recursos. Aplica-se a formatos HTML: xhtml, epub, em pedaços, htmlajuda
formatos.

-dentro, --verbose
Imprima detalhes operacionais em stderr. Um segundo -v opção aplica a opção detalhada para
comandos do conjunto de ferramentas.

--versão
Imprime a versão do programa em stdout.

--xsltproc-opts=XSLTPROC_OPTS
Adicional xsltproc(1) opções. Esta opção pode ser especificada mais de uma vez.

--xsl-arquivo=XSL_FILE
Substitua a folha de estilo XSL integrada pela folha de estilo XSL personalizada XSL_FILE.

--fop
Use FOP para gerar PDFs. O comportamento padrão é usar dblatex(1). O --fop opção
está implícito se esta opção for usada.

--fop-opções=FOP_OPTS
Adicional Fop(1) opções. Se esta opção for especificada, o FOP será usado para gerar PDFs.
Esta opção pode ser especificada mais de uma vez.

--dblatex-opts=DBLATEX_OPTS
Adicional dblatex(1) opções. Esta opção pode ser especificada mais de uma vez.

--backend-opts=VOLTAREND_OPTS
Opções para o plugin de backend especificado pelo --Processo interno opção. Esta opção pode ser
especificado mais de uma vez.

As opções também podem ser definidas no arquivo de origem AsciiDoc. Se ARQUIVO FONTE contém um comentário
linha começando com // a2x: então o restante da linha será tratado como a2x
opções de linha de comando. Por exemplo:

// opções padrão a2x.
//a2x: -dbook --epubcheck
// Suprime o histórico de revisão nas saídas dblatex.
// a2x: --dblatex-opts "-P latex.output.revhistory = 0"

· As opções que abrangem várias dessas linhas de comentário serão concatenadas.

· Zero ou mais caracteres de espaço em branco podem aparecer entre os // e a2x:.

· As opções da linha de comando têm precedência sobre as opções definidas no arquivo de origem.

SAÍDA ARQUIVOS

Os arquivos de saída são gravados no diretório especificado pelo --destino-dir opção. Se não
--destino-dir opção é definida, os arquivos de saída são gravados no ARQUIVO FONTE diretório.

Os arquivos de saída têm o mesmo nome que o ARQUIVO FONTE mas com um nome de arquivo apropriado
extensão: .html para xhtml; .epub para epub; .hhp para htmlajuda; .pdf para pdf; .text para
texto, .xml para livro de documentos. Por convenção, as páginas do manual não têm extensão .man (seção da página do manual
número apenas). Nomes de diretórios HTML fragmentados possuem uma extensão .chunked; Ajuda HTML fragmentada
os nomes dos diretórios têm uma extensão .htmlhelp.

Os arquivos existentes com o mesmo nome são substituídos.

Além de gerar arquivos HTML, o xhtml, epub, em pedaços e htmlajuda formatos asseguram
os arquivos de recursos são copiados para seus locais de diretório de destino corretos.

RECURSOS

Recursos são arquivos (normalmente CSS e imagens) que são exigidos por saídas baseadas em HTML
(xhtml, epub, em pedaços, htmlajuda Formatos). a2x verifica os arquivos HTML gerados e cria um
lista de arquivos CSS e de imagem necessários. Arquivos de recursos adicionais podem ser especificados
usando explicitamente o --recurso opção.

a2x procura por arquivos de recursos nos seguintes locais na seguinte ordem:

1. A ARQUIVO FONTE diretório.

2. Diretórios de recursos especificados pelo --recurso opção (pesquisada recursivamente).

3. Diretórios de recursos especificados pelo --recurso-manifesto opção (pesquisado recursivamente
na ordem em que aparecem no arquivo de manifesto).

4. Os diretórios de imagens e folhas de estilo no ascidoco(1) arquivos de configuração
diretórios (pesquisados ​​recursivamente).

5. O diretório de destino.

Quando um arquivo de recurso é encontrado, ele é copiado para o diretório de destino relativo correto.
Os subdiretórios de destino ausentes são criados automaticamente.

Existem dois mecanismos distintos para especificar recursos adicionais:

1. Um diretório de recursos que será pesquisado recursivamente em busca de arquivos de recursos ausentes.

2. Um arquivo de recurso que será copiado para o diretório de destino de saída.

Os recursos são especificados com --recurso valores de opção que podem ser um dos seguintes
formatos:


[= ]
. =

Onde:


Especifica um diretório (absoluto ou relativo ao ARQUIVO FONTE) que é pesquisado
recursivamente para arquivos de recursos ausentes. Para eliminar a ambigüidade, o nome
deve terminar com um caractere separador de diretório.


Especifica um arquivo de recurso (absoluto ou relativo ao ARQUIVO FONTE) que será
copiado para . Se não é especificado, então é o
o mesmo que o .


Especifica o destino do arquivo de origem copiado. o caminho é
relativo ao diretório de destino (caminhos absolutos não são permitidos). A localização
do diretório de destino depende da saída FORMATO (Ver a SAÍDA ARQUIVOS
seção para detalhes):

em pedaços, htmlhelp
O diretório de saída fragmentado.

epub
O diretório OEBPS arquivado.

xhtml
A saída DESTINO_DIR.

. =
Ao adicionar recursos aos arquivos EPUB, o tipo MIME é inferido do
arquivo> extensão, se o tipo MIME não puder ser adivinhado, ocorre um erro. o
. = A sintaxe do recurso pode ser usada para definir explicitamente os tipos MIME. é
a extensão do nome do arquivo, é o tipo MIME correspondente.

Exemplos de opções de recursos:

--recurso ../imagens/
--resource doc / README.txt = README.txt
--recurso ~ / images / tiger.png= images / tiger.png
--resource .ttf = application / x-font-ttf

EXEMPLOS

a2x -f pdf doc / source-realce-filter.txt
Gera o arquivo doc / source-highlight-filter.pdf.

a2x -f xhtml -D ../doc --icons -r ../images/ team.txt
Cria arquivo HTML ../doc/team.html, usa ícones de advertência e pesquisa recursivamente o
../images/ diretório para quaisquer recursos ausentes.

a2x -f manpage doc / asciidoc.1.txt
Gere a página de manual doc / asciidoc.1.

REQUISITOS

a2x usa os seguintes programas:

· AsciidocName: http://asciidoc.org/

· xsltproc: (todos os formatos exceto texto): http://xmlsoft.org/XSLT/

· DocBook XSL Folhas de estilo (todos os formatos exceto texto):
http://docbook.sourceforge.net/projects/xsl/

· dblatex (formatos pdf, dvi, ps, tex): http://dblatex.sourceforge.net/

· extensão FOP (formato pdf - gerador de arquivo PDF alternativo): http://xmlgraphics.apache.org/fop/

· w3m (formato de texto): http://w3m.sourceforge.net/index.en.html

· Lince (formato de texto - gerador de arquivo de texto alternativo): http://lynx.isc.org/

· epubcheck (formato epub - validador de arquivo EPUB): http://code.google.com/p/epubcheck/

Veja também o arquivo README mais recente.

CONF. ARQUIVOS

Um arquivo de configuração contém código Python executável que substitui o global
parâmetros de configuração em a2x.py. Arquivos de configuração opcionais são carregados no
seguinte ordem:

1. a2x.conf do diretório que contém o a2x.py executável.

2. a2x.conf do diretório de configuração global AsciiDoc. Pule esta etapa se estivermos
executar uma cópia instalada localmente (não em todo o sistema).

3. a2x.conf do diretório de configuração AsciiDoc $ HOME / .asciidoc.

4. A CONF_FILE especificado no --conf-arquivo opção.

Aqui estão os valores de opção do arquivo de configuração padrão:

# Dicionário de variável de ambiente opcional passado para
# executando programas. Se definido como Nenhum, o existente
# ambiente é usado.
ENV = Nenhum

# Executáveis ​​externos.
ASCIIDOC = 'asciidoc'
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # geração de pdf.
FOP = 'fop' # geração de pdf (opção --fop).
W3M = 'w3m' # geração de texto.
LYNX = 'lynx' # geração de texto (se não houver w3m).
XMLLINT = 'xmllint' # Defina como '' para desativar.
EPUBCHECK = 'epubcheck' # Defina como '' para desabilitar.
# Opções padrão do executável externo.
ASCIIDOC_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
XSLTPROC_OPTS = ''

Use a2x online usando serviços onworks.net