Como controlar o conteúdo do cabeçalho em macros groff man

Question

Estou usando as macros groff man para produzir documentação de propósito geral (não na verdade man pages) porque elas são fáceis de aprender e usar. Eu gostaria de controlar o cabeçalho da página postscript como texto livre.

O manual do groff diz:

Use the file man.local for local extensions to the man macros or for style changes.

Macro: .PT

Control the content of the headers. Normally, the header prints the command name and section number on either side, and the optional fifth argument to TH in the center.

Como faço isso na prática?

    

Answer 1

O texto é obscuro, mas o conselho é modificar o arquivo man.local em vez de substituir as macros encontradas nesse arquivo.

Um bom lugar para começar é com a documentação: 5.21 Escrevendo macros (O Manual do GNU Troff). Isso mostra como definir macros.

As macros reais a serem estudadas dependem muito da versão. No Debian, eu acho a macro PT no pacote groff-base , em

/usr/share/groff/1.21/tmac/an-old.tmac

como

.\" Redefine these to customize the header & footer
.
.de1 PT
.  tl '\*[an-title](\*[an-section])'\*[an-extra3]'\*[an-title](\*[an-section])'
..

Ele passa as variáveis nomeadas como o primeiro parâmetro para .tl . Para ver o que é .tl (grep é seu amigo) e o que ele faz é necessário algum trabalho (mencionado aqui ):

Are you aware that .tl (title) takes three parts, left, centre, and right?

Por outro lado, a documentação do groff melhorou com o passar dos anos: você pode encontrar o ".tl" no index .

Como regra, você descobrirá que:

• a maioria das macros (que você encontra ao ler esses arquivos) não está documentada
• grep'ing sobre a lista de macros (grep -w ajuda) é a única maneira de encontrar uma macro em particular
• existem versões específicas do dispositivo de algumas macros que substituem as versões genéricas

Answer 2

Se você quiser ter uma idéia sobre como usar macros modificadas que devem imprimir man pages como um livro, você pode querer verificar as macros que são usadas para imprimir os manuais do Solaris:

link

Compare o arquivo "an" com o arquivo de macro "ansun". Este último é usado para imprimir livros.

Note que estes são conjuntos macro para o troff original e não para o clone troff "groff", mas desde que o groff seja compatível, deve funcionar.