tldr

O que são páginas tldr?

O projeto tldr-pages é uma coleção de páginas de ajuda mantidas pela comunidade para ferramentas de linha de comando, que pretende ser um complemento mais simples e acessível às páginas de manual tradicionais.

Talvez você seja novo no mundo da linha de comando. Talvez você esteja um pouco enferrujado ou nem sempre consiga se lembrar dos argumentos de comandos como lsof ou tar ?

Certamente não ajuda que, no passado, a primeira opção explicada em man tar fosse:

$ man tar
...
-b blocksize
   Specify the block size, in 512-byte records, for tape drive I/O.
   As a rule, this argument is only needed when reading from or writing to tape drives,
   and usually not even then as the default block size of 20 records (10240 bytes) is very common.
...

Há espaço para páginas de ajuda mais simples, focadas em exemplos práticos. Que tal:

Este repositório é exatamente isso: uma coleção cada vez maior de exemplos para as ferramentas de linha de comando mais comuns do UNIX, Linux, macOS, FreeBSD, NetBSD, OpenBSD, SunOS, Android e Windows.

Como faço para usá-lo?

Dica

Para navegar sem instalar cliente em seu computador, consulte o cliente web em https://tldr.inbrowser.app (com suporte offline usando PWA).

Uma maneira popular e conveniente de acessar essas páginas em seu computador é instalar o cliente Node.js oficial:

npm install -g tldr

Alternativamente, você também pode usar o cliente Python oficial, que pode ser instalado via pip3 (ou outros gerenciadores de pacotes):

pip3 install tldr

Usuários de Linux e Mac também podem instalar o Rust Client oficial usando Homebrew (ou outros gerenciadores de pacotes em outros sistemas operacionais):

brew install tlrc

Então você terá acesso direto à ajuda simplificada e fácil de ler para comandos, como tar , acessível digitando tldr tar em vez do man tar padrão.

Se você não quiser instalar nenhum software, verifique a versão em PDF.

Observação

PDFs para traduções estão disponíveis para a maioria dos idiomas. Você pode encontrá-los nos ativos de lançamento da versão mais recente.

Existem também vários outros clientes disponibilizados pela comunidade, tanto para linha de comando como para outras plataformas. Para uma lista abrangente de clientes, acesse nosso Wiki.

Como posso contribuir para páginas tldr?

Todas as contribuições são bem-vindas!

Algumas maneiras de contribuir incluem:

• Adicionando seu comando favorito que não está coberto.
• Adicionar exemplos ou melhorar o conteúdo de uma página existente.
• Adicionando páginas solicitadas de nossos problemas com o rótulo de ajuda desejada.
• Traduzindo páginas para diferentes idiomas.

Todas as páginas tldr são escritas em Markdown para que possam ser editadas facilmente e as alterações possam ser enviadas em solicitações pull aqui usando Git na linha de comando ou usando a interface da web do GitHub.

Nós nos esforçamos para manter uma comunidade acolhedora e colaborativa. Se for a primeira vez que você contribui, dê uma olhada nas diretrizes de contribuição e vá em frente!

Se quiser contribuir com traduções, você pode visitar https://lukwebsforge.github.io/tldri18n/ para ver o progresso geral de todas as traduções e quais traduções estão faltando ou desatualizadas.

Você também pode se juntar a nós na sala de bate-papo da matriz!

Projetos semelhantes

• As páginas de interface de linha de comando permitem escrever páginas de ajuda padronizadas para CLI, diretórios e configurações.

• Cheat permite criar e visualizar cheatsheets interativos na linha de comando. Ele foi projetado para ajudar a lembrar aos administradores de sistemas Unix as opções de comandos que eles usam com frequência, mas não com frequência suficiente para serem lembrados.

• cheat.sh Agrega folhas de dicas de várias fontes (incluindo páginas tldr) em uma interface unificada.

• devhints As cheatsheets de Rico não se concentram apenas na linha de comando e incluem uma infinidade de outras cheatsheets relacionadas à programação.

• por exemplo, fornece exemplos detalhados com explicações na linha de comando. Os exemplos vêm do repositório, mas eg suporta a exibição de exemplos e comandos personalizados junto com os padrões.

• kb é um gerenciador de base de conhecimento de linha de comando minimalista. kb pode ser usado para organizar suas notas e cheatsheets de forma minimalista e limpa. Ele também oferece suporte a arquivos não textuais.

• navi é uma ferramenta interativa de cheatsheet, que permite navegar por exemplos específicos ou completar comandos instantaneamente.

• bropages (obsoleto) são um complemento altamente legível às páginas de manual. Ele mostra exemplos concisos e de casos comuns para comandos Unix. Os exemplos são enviados pela base de usuários e podem ser votados a favor ou contra; as melhores entradas são as que as pessoas veem primeiro quando procuram um comando.

O que significa "tldr"?

TL;DR significa "Muito longo; não li". Originou-se como uma gíria da Internet, onde é usado para indicar que um texto longo (ou partes dele) foi ignorado por ser muito longo. Leia mais no artigo do How-To Geek.