TLDR: las páginas del manual simplificadas en Linux

Too long didnt read (tl;dr). Esa expresión que se utiliza como respuesta a comentarios excesivamente largos o como resumen tras una compleja disertación, ha encontrado su equivalente en la documentación de software.

TLDR se distribuye bajo licencia libre MIT. Es un esfuerzo comunitario al que cualquiera puede contribuir y que no pretende sustituir al comando man, sino más bien complementarlo.

Una versión ligera del manual con una descripción sencilla de cada programa, que nos muestra las variantes de uso más habituales. Colecciones de ejemplos que incluyen comandos para sistemas UNIX, Linux, macOS, SunOS y Windows, en su sintaxis más habitual.

Instalación de TLDR

El programa está creado en JavaScript, por lo se puede instalar en cualquier distribución GNU/Linux, mediante su gestor de paquetes npm (incluido junto a nodejs en los repositorios de todas las distros):

npm install -g tldr

Además existen clientes construidos en otros lenguajes de programación (C++, Crystal, Dart, Elixir, Go, PHP, Perl, Python, R, Buby, Rust…), para sistemas operativos móviles (iOS, Android), clientes web (electron), Bash, o empaquetado Snap. Incluso para Emacs.

Los usuarios de Arch Linux o alguna de sus derivadas nos lo encontramos en AUR. Tirando de helper y optando por la versión javascript de TLDR sería algo así:

pacaur -S nodejs-tldr

Uso de TLDR

Una vez instalado, la ejecución no tiene ningún misterio. Es TLDR seguido del comando o programa en cuestión.

  • Tomemos a SSH como ejemplo:
tldr ssh
  • O bien busquemos una entrada cualquiera:
tldr -r
  • O ejemplo al azar:
tldr -e
  • Para listar el conjunto de páginas disponibles con documentación, ejecutamos:
tldr -a
  • Si queremos actualizar la caché local de TLDR:
tldr -u
  • TLDR además ofrece 3 diferentes esquemas de colores (simple, base16, ocean) que se pueden evocar con el parámetro -t seguido del nombre del mismo. A mi me gusta el ocean:
tldr -t ocean ssh

A todo esto y haciendo un remember, si queréis darle color a las páginas de manual en Linux, basta con añadir un puñado de líneas al archivo de configuración .bashrc.

  • Volviendo a TLDR, una cosa que me gusta mucho, es que tenemos acceso a documentación de programas que no están instalados en nuestro sistema. En mi caso, ahora que estoy en Antergos, puedo escribir:
tldr zypper

y recordar como trabaja el gestor de paquetes de openSUSE, sin necesidad de tenerlo instalado (aunque podría, porque también anda por AUR). Lo mismo sucede con cualquier otra herramienta o programa de software, incluida en la base de datos de TLDR.

tl;dr: En definitiva TLDR es una herramienta bastante útil, que complementa tanto la ayuda del programa como las más densas páginas del manual. Cualquiera puede contribuir a su desarrollo, editando o creando nuevas entradas, con sus respectivos ejemplos de uso.

Vía | Hacker News

4 thoughts on “TLDR: las páginas del manual simplificadas en Linux”

  1. Thalskarth says:

    tl;dr 😛

  2. AVE AVROPA says:

    sudo apt install npm

    sudo npm install -g tldr

    ¿?

  3. AVE AVROPA says:

    No entiendo cómo instalarlo en Ubuntu (MATE). Me tira errores.

    1. tannhausser says:

      No tengo Ubuntu a mano para comprobarlo ahora mismo pero creo que te falta nodejs. Sería algo así:

      sudo apt install npm nodejs
      
      sudo npm install -g tldr

      En esta web:

      https://itsfoss.com/tldr-linux-man-pages-simplified/

      el autor, comenta que puede haber un error relativo a la ruta del binario que se puede solucionar creando un soft link:

      ln -s /usr/bin/nodejs /usr/bin/node

Responder a Thalskarth Cancelar respuesta