Use o ManPage Simplificada TLDR caso você não seja fã de linha de comando. Ela é muito útil caso você seja novo no terminal, esteja um pouco enferrujado ou não lembra muito os argumentos dos comandos. Ela é uma coleção de páginas de manual simplificadas para orientar o usuário de forma mais eficiente e breve.
O ManPage Simplificada TLDR te ajuda de forma mais eficiente e breve com informação do comando mais práticos e exemplificados sem todas aquelas linhas imensas para explicar o que cada argumento faz.
O que significa TLDR?
TL > Too Long (Muito Tempo)
DR > Didn’t Read (Não Leu)
Com o significado do termo, ele nos mostrar por que gastar tempo demais para ler se é mais eficaz mostrar os argumentos exemplificados para o usuário colocar a mão na massa.
Contribuir com o ManPage Simplificada TLDR
Caso os comandos que usa corriqueiramente não esteja sendo coberto pelo projeto, você pode contribuir com exemplos práticos para esses comandos ou até pensar em outros exemplos para comandos já existentes.
Para isso, é só verificar as diretrizes de contribuição para poder colaborar com o projeto. Veja a governança do projeto e assim ao entrar na comunidade respeitar os princípios do projeto. O ManPage Simplificada TLDR tem sua licença registrada no MIT.
1. Instalação
Para a instalar o TLDR, vai ser usado a distribuição Debian. Logo, os passos a seguir servirão para qualquer outra distribuição Linux.
A cliente mais maduro do TLDR é o node.js, que poderá ser instalado facilmente a partir do NPM (Node Package Manager).
Caso não tenha o node instalado, instale-o aceitando suas dependências.
apt install npm
Agora para instalar o TLDR basta executar.
npm install -g tldr
Saída:
npm WARN npm You should probably upgrade to a newer version of node as we
npm WARN npm can’t make any promises that npm will work with this version.
npm WARN npm Supported releases of Node.js are the latest release of 4, 6, 7, 8, 9.
npm WARN npm You can find the latest version at https://nodejs.org/
/usr/local/bin/tldr -> /usr/local/lib/node_modules/tldr/bin/tldr
+ [email protected]
added 113 packages from 103 contributors in 4.107s/
Pronto! O ManPage Simplificada TLDR já pode ser usado.
2. Utilização
Após ter instalado o ManPage Simplificada TLDR, poderá ser utilizada para ver as páginas do TLDR da seguinte forma:
- tldr <command> – mostre exemplos para este comando
- tldr <command> –os=<platform> – página comando show para a plataforma dada (Linux, OSX, SunOS)
- tldr –search “<query>” – pesquisar todas as páginas para a consulta
- tldr –linux <command> – mostre a página de comando para Linux
- tldr –osx <command> – mostre a página de comando para o OSX
- tldr –sunos <command> – mostre a página de comando para SunOS
- tldr –list – mostrar todas as páginas da plataforma atual
- tldr –list-all – mostrar todas as páginas disponíveis
- tldr –random – mostrar uma página aleatoriamente
- tldr –random-example – mostra um único exemplo aleatório
- tldr –markdown – mostre a página original do formato de remarcação
O cliente armazena em cache uma cópia de todas as páginas localmente, em ~/.tldr. Existem mais comandos para controlar o cache local:
- tldr –update – baixar as últimas páginas e gerar o índice de pesquisa
- tldr –clear-cache – excluir todo o cache local
Como colaborador, você também pode precisar dos seguintes comandos:
- tldr –render <path> – renderizar uma página local para fins de teste
Exemplo 1:
tldr mkdir
Saída:
Creates a directory.
– Create a directory in current directory or given path:
mkdir directory
– Create directories recursively (useful for creating nested dirs):
mkdir -p path/to/directory
Exemplo 2:
tldr uname
Saída:
Print details about the current machine and the operating system running on it.
Note: for additional information about the operating system, try the lsb_release command.
– Print hardware-related information: machine and processor:
uname -mp
– Print software-related information: operating system, release number, and version:
uname -srv
– Print the nodename (hostname) of the system:
uname -n
– Print all available system information (hardware, software, nodename):
uname -a
See also: lsb_release
3. Configuração
Para configurar o tldr cliente, basta adicionar um arquivo .tldrrc em seu diretório /home. Você pode copiar o conteúdo do arquivo config.json do repositório para obter a estrutura básica para começar e modificá-lo para atender às suas necessidades.
Então é isso!
Precisando de suporte? Entre em nosso grupo no Telegram para tirar suas dúvidas que os admins e outros usuários poderão ter ajudar.
Se gostou do tutorial, compartilhe.
Para receber atualizações de nosso blog, siga-nos no Twitter.