Comando troff do Linux
Em sistemas operacionais do tipo Unix, o comando troff executa funções de digitação e formata documentos. É o principal componente do sistema de processamento de documentos desenvolvido pela AT&T para Unix .
Este documento cobre a versão GNU / Linux do troff .
Sintaxe
troff [-abcivzCERU] [-d cs ] [-f fam ] [-F dir ] [-I dir ] [-m name ] [-M dir ]
[-n num ] [-o list ] [-r cn ] [-T name ] [-w name ] [-W name ] [ arquivo ...]
Descrição
O troff formata o texto para impressoras e terminais de caracteres e é uma das mais importantes peças de software da história do Unix .
Como roff , nroff e groff , troff é descendente de um programa de formatação de texto chamado RUNOFF escrito por Jerome Saltzer para MIT sistema operativo CTSS ‘s em meados dos anos 1960. O nome RUNOFF vem da frase “executar um documento”, que significa finalizar um documento ou prepará-lo para publicação ou apresentação.
As iterações posteriores do RUNOFF foram chamadas de rf e, em seguida , roff , e uma versão do roff acabou sendo escrita para o Unix em um PDP -7. Eventualmente, evoluiu para nroff (“new roff”) e depois troff (“typesetter roff”). O lendário Brian Kernighan finalmente reescreveu o troff , dando-lhe uma sintaxe mais flexível e projetando-o para ser independente do dispositivo.
Embora outros pacotes de software de digitação, como o LaTeX, tenham ganhado destaque ao longo dos anos, o troff ainda é amplamente utilizado no Unix e é o formatador de tipos padrão para o homem .
Esta documentação é para a versão GNU do comando troff , que faz parte do pacote groff e é comumente usado no Linux.
Opções
| -uma | Gere uma aproximação ASCII da saída digitada. |
| -b | Imprima um backtrace com cada aviso ou mensagem de erro. Esse backtrace deve ajudar a rastrear a causa do erro. Os números das linhas dadas no registo de chamadas pode não ser sempre correto, para troff ideia ‘s de números de linha fica confuso por como ou sou pedidos. |
| -c | Desativar saída colorida (sempre desativada no modo de compatibilidade). |
| -C | Ative o modo de compatibilidade. |
| -d cs , -dname = s | Defina c ou name para ser uma string s ; c deve ser um nome de uma letra. |
| -E | Inibir todas as mensagens de erro do troff . Observe que isso não afeta as mensagens enviadas para erro padrão pelos pacotes de macro usando as solicitações tm ou tm1 . |
| -f fam | Use fam como a família de fontes padrão . |
| -F dir | Procure no diretório (ou caminho do diretório ) dir por subdiretórios dev name (em que name é o nome do dispositivo) e pelo arquivo DESC e arquivos de fonte. O diretório é verificado antes de todos os outros diretórios de fontes. |
| -Eu | Leia a entrada padrão depois que todos os arquivos de entrada nomeados forem processados. |
| -I dir | Essa opção pode ser usada para adicionar um diretório ao caminho de pesquisa de arquivos (aqueles na linha de comando e aqueles nomeados em solicitações .psbb ). O caminho da pesquisa é inicializado com o diretório atual. Esta opção pode ser especificada mais de uma vez; os diretórios são pesquisados na ordem especificada (mas antes do diretório atual). Se você quiser que o diretório atual seja lido antes de outros diretórios, adicione -I. no local apropriado.
Nenhuma pesquisa de diretório é realizada para arquivos com um nome absoluto . |
| -m nome | Leia o arquivo ” name .tmac “. Se não for encontrado, ” tmac. Name ” é tentado. Será pesquisado primeiro em:
|
| -M dir | Diretório de pesquisa (ou caminho do diretório) dir para arquivos macro Isso é verificado antes de todos os outros diretórios de macro. |
| -n num | Numerar a primeira página num . |
| -o list | Saída apenas de páginas na lista , que é uma lista separada por vírgula de intervalos de páginas; n significa imprimir página n , m – n significa imprimir todas as páginas entre m e n , – n significa imprimir todas as páginas até n , n – significa imprimir todas as páginas a partir de n . o troff será encerrado após a impressão da última página da lista. |
| -r cn -rname = n | Defina o registro numérico c ou nome como n ; c deve ser um nome de um caractere; n pode ser qualquer expressão numérica de troff . |
| -R | Não carregue troffrc e troffrc-end . |
| -T name | Prepare a saída para o nome do dispositivo , em vez do ps padrão . |
| -VOCÊ | Modo inseguro. Isso permitirá que os seguintes pedidos: aberto , opena , PSO , sy , e pi . Por motivos de segurança, essas solicitações potencialmente perigosas são desativadas de outra forma. Ele também adicionará o diretório atual ao caminho de pesquisa da macro. |
| -v | Imprima o número da versão. |
| -w nome | Ative o nome do aviso . Os avisos disponíveis estão descritos na seção AVISOS abaixo. Por exemplo, para ativar todos os avisos, use -w all . Várias opções -w são permitidas. |
| -W name | Inibir nome do aviso . Várias opções -W são permitidas. |
| -z | Suprimir a saída formatada. |
Advertências
Os avisos que podem ser dados pelo troff estão divididos nas seguintes categorias. O nome associado a cada aviso é usado pelas opções -w e -W ; o número é usado pela solicitação de aviso e pelo registro .warn ; é sempre uma potência de 2 para permitir a composição bit a bit (quaisquer dois códigos podem ser combinados de forma aditiva para criar um número único).
Avisos, listados por bit:
| mordeu | código | Aviso |
|---|---|---|
| 0 0 | 1 | Caracteres |
| 1 | 2 | número |
| 2 | 4 | pausa |
| 3 | 8 | delimitar |
| 4 | 16 | el |
| 5 | 32. | escala |
| 6 | 64 | alcance |
| 7 | 128 | sintaxe |
| 8 | 256 | di |
| 9 | 512 | Mac |
| 10 | 1024 | reg |
| 11 | 2048 | aba |
| 12 | 4096 | cinta direita |
| 13 | 8192 | ausência de |
| 14 | 16384 | entrada |
| 15 | 32768 | fuga |
| 16 | 65536 | espaço |
| 17 | 131072 | Fonte |
| 18 | 262144 | ig |
| 19 | 524288 | cor |
| 20 | 1048576 | Arquivo |
Descrições:
| Aviso | código | descrição |
|---|---|---|
| pausa | 4 | No modo de preenchimento, linhas que não puderam ser quebradas para que seu comprimento fosse menor que o comprimento da linha. Isso é ativado por padrão. |
| Caracteres | 1 | Caracteres inexistentes. Isso é ativado por padrão. |
| cor | 524288 | Avisos relacionados a cores. |
| delimitar | 8 | Delimitadores de fechamento ausentes ou incompatíveis . |
| di | 256 | Uso de di ou da sem argumento quando não há desvio atual. |
| el | 16 | Uso da solicitação el sem correspondência, ou seja, solicitação. |
| fuga | 32768 | Sequências de escape não reconhecidas . Quando uma sequência de escape não reconhecida é encontrada, o caractere de escape é ignorado. |
| Arquivo | 1048576 | Indica um arquivo ausente para a solicitação mso . Ativado por padrão. |
| Fonte | 131072 | Fontes inexistentes. Isso é ativado por padrão. |
| ig | 262144 | Escapes inválidos no texto ignorado com a solicitação ig . Essas são condições que são erros quando não ocorrem no texto ignorado. |
| entrada | 16384 | Caracteres de entrada inválidos. |
| Mac | 512 | Uso de strings , macros e diversões indefinidas . Quando uma sequência, macro ou desvio indefinida é usada, essa sequência é automaticamente definida como vazia. Portanto, na maioria dos casos, no máximo um aviso será dado para cada nome. |
| ausência de | 8192 | Solicitações que estão faltando argumentos não opcionais. |
| número | 2 | Expressões numéricas inválidas . Isso é ativado por padrão. |
| alcance | 64 | Argumentos fora do intervalo. |
| reg | 1024 | Uso de registradores de números indefinidos . Quando um registro de número indefinido é usado, esse registro é definido automaticamente para ter um valor de 0 . Portanto, na maioria dos casos, no máximo um aviso será dado para o uso de um nome específico. |
| cinta direita | 4096 | Uso de \} onde um número era esperado. |
| escala | 32. | Indicadores de escala sem sentido. |
| espaço | 65536 | Falta espaço entre uma solicitação ou macro e seu argumento. Este aviso será dado quando um nome indefinido com mais de dois caracteres for encontrado e os dois primeiros caracteres do nome criarem um nome definido. A solicitação ou macro não será chamada. Quando esse aviso é dado, nenhuma macro é definida automaticamente. Isso é ativado por padrão. Este aviso nunca ocorrerá no modo de compatibilidade. |
| sintaxe | 128 | Sintaxe duvidosa em expressões numéricas. |
| aba | 2048 | Uso inadequado de um caractere de tabulação . Uso de um caractere de tabulação em que um número era esperado ou uso de caractere de tabulação em um argumento de macro não citado. |
Também existem nomes que podem ser usados para se referir a grupos de avisos:
| tudo | Todos os avisos, exceto di , mac e reg . Pretende-se que isso cubra todos os avisos que são úteis nos pacotes macro tradicionais. |
| W | Todos os avisos. |
Meio Ambiente
O troff utiliza as seguintes variáveis de ambiente:
| GROFF_TMAC_PATH | Uma lista separada por dois pontos de diretórios nos quais procurar arquivos de macro. O troff examinará os diretórios fornecidos na opção -M antes deles e nos diretórios padrão (diretório atual se estiver no modo não seguro, diretório inicial, / usr / lib / groff / site-tmac , / usr / share / groff / site-tmac , /usr/share/groff/1.22.2/tmac ) após estes. |
| GROFF_TYPESETTER | Aparelho padrao. |
| GROFF_FONT_PATH | Uma lista separada por dois pontos de diretórios nos quais procurar o diretório do nome do desenvolvedor . O troff examinará os diretórios fornecidos na opção -F antes deles e nos diretórios padrão ( / usr / share / groff / site-font , /usr/share/groff/1.22.2/font , / usr / lib / font ) após estes. |
arquivos
| /usr/share/groff/1.22.2/tmac/troffrc | Arquivo de inicialização (chamado antes de qualquer outro pacote de macros). |
| /usr/share/groff/1.22.2/tmac/troffrc-end | Arquivo de inicialização (chamado após qualquer outro pacote de macros). |
| /usr/share/groff/1.22.2/tmac/name.tmac , /usr/share/groff/1.22.2/tmac/tmac.name | Arquivos de macro |
| /usr/share/groff/1.22.2/font/devname/DESC | Arquivo de descrição do dispositivo para o nome do dispositivo. |
| /usr/share/groff/1.22.2/font/dev name / F | Arquivo de fonte para a fonte F do nome do dispositivo . |
Observe que troffrc e troffrc-end não são pesquisados no diretório atual nem no diretório inicial por padrão por razões de segurança (mesmo que a opção -U seja fornecida). Use a opção de linha de comandos -M ou a variável de ambiente GROFF_TMAC_PATH para incluir esses diretórios no caminho de pesquisa, se necessário.
Exemplos
troff myfile
Arquivo de processo myfile .
Comandos relacionados
checknr – Verifique sehá erros nos arquivos nroff e troff .
col – Filtra as alimentações reversas da linha.
dpost – Traduza arquivos criados por troff para PostScript no Solaris.
eqn – Processador de linguagem para descrever equações.
lp – Imprima um arquivo no sistema operacional System V.
man – Exibe a página de manual de um determinado comando.
nroff – Formata documentos para exibição no terminal ou impressora de linha.
tbl – Pré-processador que formata tabelas para nroff ou troff .