Qualquer comando / ferramenta para mostrar exemplo de um comando

1

man geralmente não contém o exemplo de um comando ou muito pouco.

Como scp :

NAME
     scp — secure copy (remote file copy program)

SYNOPSIS
     scp [-12346BCpqrv] [-c cipher] [-F ssh_config] [-i identity_file] [-l limit] [-o ssh_option] [-P port]
         [-S program] [[user@]host1:]file1 ... [[user@]host2:]file2

É difícil entender onde colocar o arquivo de origem e o arquivo de destino, da mesma forma que documentos como este.

É muito claro e fácil entender com um exemplo e uma descrição:

scp -r  user@source_machine:/user/Desktop user@remote_machine:/path/foo

E como zip:

NAME
       zip - package and compress (archive) files

SYNOPSIS
       zip  [-aABcdDeEfFghjklLmoqrRSTuvVwXyz!@$]  [--longoption  ...]  [-b path] [-n suffixes] [-t date] [-tt
       date] [zipfile [file ...]]  [-xi list]

Obrigado por ter exmaple zip -r foo.zip foo

A maneira normal que eu acho é zip A em B, [zipfile [file ...]] talvez dizendo que você pode empacotar zipfile com outros arquivos também (em visão de falantes não nativos). Somente o exemplo pode deixar isso claro.

Então, eu me pergunto se há um comando ou ferramenta pode me mostrar o exemplo de um comando.

    
por Mithril 24.08.2016 / 04:51

2 respostas

5

Muito tempo e encontrei algumas soluções:

tldr

  • precisa: npm
  • url: link
  • comando: tldr tar

PS: tldr suporta muitos clientes (verifique o leia-me no repo acima). Especialmente, o cliente Go pode trabalhar off-line e fornecer todos os binários da plataforma: link

enganar

  • precisa: python
  • url: link
  • comando: cheat tar

por exemplo

  • precisa: python
  • url: link
  • comando: eg tar

    
por Mithril 03.01.2018 / 07:09
2

Infelizmente, não.

A documentação é de responsabilidade dos desenvolvedores, portanto, é responsabilidade deles incluir exemplos em man páginas. Às vezes eles fazem, às vezes eles não. Por exemplo, o comando find tem uma seção EXAMPLES muito bonita e extensa na sua página man.

Ferramentas para fornecer exemplos seriam úteis, mas como existem milhões de comandos / programas para o Ubuntu e Linux em geral, desenvolver essa ferramenta seria um esforço considerável, no nível de Sísifo. A abordagem simples é apenas procurar online por exemplos de uso de qualquer programa que você esteja tentando executar. Livros também são recursos muito úteis. Muitos dos livros sobre Linux, Unix, shell scripts, etc - eles fornecem muitos exemplos e, mais importante, contexto de uso para esses comandos.

Se você acredita que a página de manual para uma ferramenta em particular deve conter exemplos (mais), por favor arquive um relatório de bug com seus mantenedores ou desenvolvedores no Launchpad ou "upstream" ou, melhor ainda, envie um patch que adicione esses exemplos.

    
por Sergiy Kolodyazhnyy 24.08.2016 / 05:20