man

Exibe a página de referência on-line

Aplicabilidade

Produto Tipo de Comando
MultiSite

Subcomando de multitool

Subcomando de multiutil

Plataforma
UNIX®
Windows®

Sinopse

  • Exiba uma página de referência (UNIX):
    man [ –g/raphical ] [ command_name ]

Descrição

Esse comando exibe uma página de referência. A documentação exibida depende do contexto do comando. Esse comando não requer uma licença do produto.

Exibindo Páginas de Referência

O comando man exibe uma página de referência on-line especificada nos formatos HTML ou ASCII (apenas UNIX). Para subcomandos do multiutil, você pode utilizar qualquer alias ou abreviação de comando válido. Por exemplo:

cmd-context man lsreplica

Nome completo do comando

cmd-context man lsrep

Abreviação

cmd-context man lsrp

Alias

UNIX: Utilizando o MANPATH

As páginas de referência são armazenadas em subdiretórios do cquest–home–dir/doc/man. O subcomando man modifica o ambiente para incluir uma variável MANPATH configurada nesse diretório. Em seguida, executa o comando UNIX man(1) em um subprocesso. Portanto, o shell a partir do qual o cleartool é chamado não precisa ter o MANPATH configurado.

Entretanto, se você desejar utilizar o UNIX man diretamente, sem passar pelo multitool, inclua cquest–home–dir/doc/man em seu MANPATH. Por exemplo:

setenv MANPATH /usr/catman:/usr/man:/opt/rational/clearquest/doc/man

Com o UNIX man, você deve corresponder o nome do arquivo de páginas de referência. Os nomes de arquivos de subcomandos do multiutil possuem prefixos mu_.

% man mu+describe

Correto

% man describe

Incorreto (subcomando cleartool)

UNIX: Alterando o Navegador HTML Padrão

Para alterar o navegador HTML padrão, utilize as variáveis de ambiente CCASE_WEBSCRIPT, CCASE_NETSCAPE e CCASE_NETSCAPE_OPT. Para obter informações adicionais, consulte xcleardiff.

Restrições

Nenhum.

Opções e Argumentos

Formato de Exibição da Página de Referência

Padrão
ASCII (UNIX); HTML (Windows).
–g/raphical
Inicia um navegador de HTML para exibir a página de referência.

Especificando a Página de Referência

Padrão
A página de referência de visão geral do produto.
command_name
O nome (ou abreviação ou alias) de um subcomando de multiutil; ou o nome de qualquer outra página de referência do produto.

Exemplos

  • Exiba a página de referência para o comando mkreplica.

    cmd-context man mkreplica

  • Exiba a página de referência para o comando describe como HTML em um sistema UNIX.

    cmd-context man –graphical describe


Feedback