En el siguiente artículo vamos a echar un vistazo a las páginas de TLDR. Estas siglas significan ‘Too Long; Didn’t Read‘, se originan en Internet, donde se usan para indicar que un texto largo, o parte de el, se ha omitido por ser demasiado largo. La aplicación va a ofrecer en las páginas mostradas ejemplos prácticos de comandos proporcionados por la comunidad. En general vienen simplificando las páginas Man ofreciendo dichos ejemplos, en diferentes sistemas operativos, incluido Gnu/Linux.

Como todos los usuarios de Gnu/Linux sabemos, una de las formas más utilizadas y fiables para obtener ayuda en sistemas similares a Unix es recurrir a las páginas Man. Las páginas de manual son la documentación estándar para cada sistema similar a Unix y corresponden a los manuales en línea para programas, funciones, bibliotecas, llamadas al sistema, estándares y convenciones formales, formatos de archivo, etc.

Uno de los problemas que le encuentran muchos usuarios a las páginas Man, es que muchas de ellas son demasiado largas. A algunos usuarios, simplemente no les gusta leer demasiado texto en la pantalla para buscar la solución a un problema en concreto.

Como ya he escrito líneas más arriba, TLDR son unas siglas utilizadas en internet para decir que una publicación, un artículo, un comentario o una página de manual, es demasiado larga y quién la utilizó no la leyó por ese motivo. Gracias a esta aplicación, encontraremos cada uno de los comandos resumidos mediante ejemplos. El contenido que ofrecen estás páginas está disponible abiertamente bajo la licencia MIT.

A continuación vamos a ver cómo podemos instalar y utilizar las páginas TLDR en Ubuntu. Pero antes de lanzarse a la instalación, se puede probar una demo de estas páginas. También se puede echar un vistazo a la versión en PDF, para ver si esto es lo que buscas.

Cómo instalar páginas TLDR en Ubuntu

Para instalar estas páginas vamos a poder utilizar NodeJS y NPM o su correspondiente paquete snap.

Instalar usando NodeJS y NPM

Para esta instalación vamos a necesitar tener disponible en nuestro sistema operativo Nodejs y NPM.

Para acceder de manera conveniente a las páginas TLDR, es necesario instalar uno de los clientes admitidos, que es el cliente original para el proyecto tldr-pages. Podemos instalarlo desde NPM ejecutando en una terminal (Ctrl+Alt+T):

sudo npm install -g tldr

Instalar usando paquete snap

TLDR también está disponible como paquete Snap. Para instalarlo en una terminal (Ctrl+Alt+T) habrá que ejecutar el siguiente comando:

sudo snap install tldr

Utilizar TLDR

Después de instalar el cliente TLDR, ya se pueden ver las páginas Man de cualquier comando resumidas mediante ejemplos. Por ejemplo, el comando pwd, como se muestra en la siguiente captura. Puedes usar cualquier otro comando:

tldr pwd

Otro ejemplo de página de manual resumida para el comando ls, será el siguiente:

tldr ls

Actualizar o borrar la caché local

Para actualizar la caché local solo hay usar el comando acompañado con la opción -u:

tldr -u

Si lo que quieres es limpiar la caché local, hay que utilizar la opción -c:

tldr -c

Mostrar todos los comandos

Para enumerar todos los comandos en la caché para la plataforma elegida, solo hay que utilizar la opción -l:

tldr -l

Si lo que queremos es ver todos los comandos admitidos en la caché, habrá que añadir la opción -a:

tldr -a

Buscar páginas

Para buscar páginas usando palabras clave, hay que utilizar la opción -s seguida por las palabras, en inglés, que nos interesen:

tldr -s 'list of all files'

Ver un comando aleatorio

También se puede mostrar un comando aleatorio con la opción -r:

tldr -r

Opciones compatibles

Vamos a poder ver una lista completa de opciones compatibles ejecutando:

tldr -h

Se puede encontrar una lista de todas las aplicaciones de cliente compatibles y dedicadas para diferentes plataformas, en la página Wiki de clientes TLDR. Para obtener más información acerca de TLDR, se puede consultar la página web del proyecto. Si te interesa, puedes leer más sobre este tipo de páginas en el artículo de Wikipedia.

El artículo TLDR, páginas Man resumidas mediante ejemplos en Ubuntu ha sido originalmente publicado en Ubunlog.