Listas aninhadas na página man

6

Eu tenho um parâmetro de linha de comando que leva um número de flags depois, o que eu gostaria de ter como uma lista dentro da lista de parâmetros na página man.

Atualmente, estou simplesmente criando linhas de Flag - Description ( página de manual ), mas isso não é ideal pelos seguintes motivos :

  • não recua linhas quebradas. Eu posso manualmente recuá-los, mas então eu tenho que assumir um conjunto de largura do console, o que eu não quero fazer
  • Preciso contar com novas linhas duplas para ir para a próxima linha, prefiro ter algo como .TP .
por Mat 05.05.2012 / 11:28

1 resposta

8
  • Inicie a lista com .RS , termine com .RE .
  • Inicie os itens da lista com .IP seguido de termo. Coloque o termo entre aspas duplas, se contiver várias palavras.
  • Coloque o texto da descrição na próxima linha após o início do item da lista.
  • É aninhado, portanto, a descrição pode conter outras listas.
  • Use \fB .. \fP para colocar em negrito o termo em vez de .B . (Mesmo para sublinhar - use \fI .. \fP em vez de .I .)
.RS
.IP \fBA\fP
\- Flag 1
.IP \fBB\fP
\- Flag 2
.IP \fBC\fP
\- A slightly longer flag description that could take up more than the width
of the average console. In fact you'd need a very wide console to read all
this.
.RE

Para aumentar sua produtividade, sugiro escrever suas páginas de manual em um formato mais amigável e convertê-las. Algumas ferramentas adequadas são enumeradas em Posso criar uma página man? para um script? .

    
por 05.05.2012 / 15:20

Tags