
Estoy usando las macros de groff man para producir documentación de propósito general (no en realidad páginas de manual) porque son fáciles de aprender y usar. Sin embargo, me gustaría controlar el encabezado de la página posdata como texto libre.
Elmanual de groffdice:
Utilice el archivo man.local para extensiones locales de las macros man o para cambios de estilo.
Macro:
.PT
Controlar el contenido de las cabeceras. Normalmente, el encabezado imprime el nombre del comando y el número de sección en cada lado, y el quinto argumento opcional de TH en el centro.
¿Cómo hago esto en la práctica?
Respuesta1
La redacción es confusa, pero el consejo es modificar el man.local
archivo en sí en lugar de anular las macros que se encuentran en ese archivo.
Un buen lugar para comenzar es con la documentación:5.21 Escritura de macros(El Manual GNU Troff). Eso muestra cómodefinirmacros.
Las macros reales a estudiar dependen en gran medida de la versión. En Debian, encuentro la PT
macro en el groff-base
paquete, en
/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])'
..
Pasa variables con nombre como primer parámetro a .tl
. Para ver qué .tl
es (grep es tu amigo) y qué hace requiere algo de trabajo (mencionadoaquí):
¿Sabes que
.tl
(título) tiene tres partes, izquierda, centro y derecha?
Por otro lado, la documentación de groff ha mejorado con los años: puedes encontrar ".tl" en elíndice.
Como regla general, encontrará que:
- la mayoría de las macros (que encontrará al leer estos archivos) no están documentadas
- Revisar la lista de macros (grep
-w
ayuda) es la única forma de encontrar una macro en particular. - Hay versiones específicas del dispositivo de algunas macros que anulan las versiones genéricas.
Respuesta2
Si desea tener una idea sobre cómo utilizar las macros modificadas destinadas a imprimir páginas de manual como un libro, puede consultar las macros que se utilizan para imprimir los libros del manual de Solaris:
https://sourceforge.net/p/schillix-on/schillix-on/ci/default/tree/usr/src/cmd/troff/troff.d/tmac.d/
Compare el archivo "an" con el archivo de macro "ansun". Este último se utiliza para imprimir libros.
Tenga en cuenta que estos son conjuntos de macros para el troff original y no para el clon de troff "groff", pero siempre que groff sea compatible, debería funcionar.