Início / unix / Perguntas / 698037
Accepted
U. Windl
Asked: 2022-04-06 01:09:02 +0800 CST

Existe algum quase-padrão para adicionar "sub-subseções" em uma página de manual do UNIX?

  • 772

Eu me pergunto: Escrevendo uma página de manual do UNIX usando o manpacote de macros que existe .SH(título da seção) e .SS(subseção). Mas e se eu quiser ter "sub-subseções"?

Existe algum tipo de padrão para tal? Acho que vi algumas páginas mexendo no tamanho da fonte ( troffpelo menos) em .SS, mas gostaria de saber se realmente existe algum (quase) padrão para isso.

man

2 respostas

  1. Best Answer

    Acredito que a resposta curta seja "não" - não há padrão para subsubseções nas páginas de manual.

    A questão surgiu em setembro passado na lista de linux-mandiscussão , onde um grande volume de manmaterial é curado, e ninguém lá tinha conhecimento de qualquer idioma aceito para fazer isso.

    O ponto que eu enfatizaria é este: "se você precisar de subsubseções em uma página de manual , [então] o nível de discussão para a página em geral é muito grosseiro." Não há lei contra a divisão de páginas de manual em vários documentos. groff e Perl fazem isso.

    Até mesmo a página de manual do pacote de macro originalman (1979) saiu pela porta sem que a SSmacro de subseção fosse documentada.

    Para mim, essa supervisão (deliberada?) parece consistente com a noção original de páginas de manual como documentos "concisos".

    Se você tivesse que fazer isso, eu não escreveria minha própria macro ou abusaria TPcomo discutido no linux-mantópico. Eu provavelmente usaria apenas um "cabeçalho run-in". Em outras palavras, comece um parágrafo com um título em itálico ou negrito.

    .P
.B Error handling.
The Z language does not support an exception mechanism.
Therefore you have to check return values at every point blah blah blah
    • 2

  2. O formato de documentação POD do Perl pode ser traduzido para vários formatos, também para páginas de manual usando pod2man. Isto é o que o módulo do Perl Pod::Manfaz (não alegando que é algum tipo de padrão):

    • =head1é traduzido para .SH, usando.IX Header "...."
    • =head2é traduzido para .SS, usando.IX Subsection "...."
    • =head3é traduzido para fonte itálica, usando.IX Subsection "...."
    • =head4é traduzido para texto simples, usando.IX Subsection "...."

    O texto do título para =head3e =head4é cercado por .PPs assim:

    .PP
title text
.IX Subsection "title text"
.PP
    • 0

relate perguntas