TLDR: páginas man fáciles de entender para comandos de Linux

Una de las formas más utilizadas y confiables de obtener ayuda en sistemas tipo Unix es a través de páginas de manual, que son la documentación estándar para cada sistema tipo Unix y corresponden a manuales en línea para programas, funciones , bibliotecas, llamadas al sistema, estándares y convenciones formales, formatos de archivo, etc.

Sin embargo, las páginas de manual adolecen de muchos fallos, uno de los cuales es que son demasiado largas y a algunas personas simplemente no les gusta leer demasiado texto en la pantalla.

El TLDR (que significa "Demasiado largo; No leí") es un proyecto impulsado por la comunidad que proporciona documentación concisa y simplificada para varios comandos de Linux.

TLDR tiene como objetivo ofrecer ejemplos rápidos y prácticos de uso de comandos, facilitando a los usuarios la comprensión y el uso de los comandos sin tener que profundizar en manuales extensos o explicaciones extensas.

Normalmente se accede a TLDR a través de la línea de comando utilizando el comando “tldr”, seguido del nombre del comando sobre el que desea obtener información.

tldr ls

TLDR es una jerga de Internet, lo que significa que una publicación, artículo, comentario o cualquier cosa como una página de manual era demasiado larga y quien usó la frase no la leyó por ese motivo. El contenido de las páginas TLDR está disponible abiertamente bajo la permisiva Licencia MIT.

En este breve artículo, mostraremos cómo instalar y utilizar páginas TLDR en Linux.

Cómo instalar páginas TLDR en sistemas Linux

Para acceder cómodamente a las páginas TLDR, debe instalar uno de los clientes compatibles llamado Node.js, que es el cliente original del proyecto tldr-pages.

Para instalar Node.js, puede utilizar el administrador de paquetes específico de su distribución.

sudo apt install nodejs npm         [On Debian, Ubuntu and Mint]
sudo yum install nodejs npm         [On RHEL/CentOS/Fedora and Rocky/AlmaLinux]
sudo emerge -a sys-apps/nodejs npm  [On Gentoo Linux]
sudo apk add nodejs npm             [On Alpine Linux]
sudo pacman -S nodejs npm           [On Arch Linux]
sudo zypper install nodejs npm      [On OpenSUSE]    

Una vez que Node.js y npm estén instalados, puede proceder a instalar TLDR utilizando el comando npm como se muestra. .

sudo npm install -g tldr

TLDR también está disponible como paquete Snap, para instalar y ejecutar.

sudo snap install tldr

Después de instalar el cliente TLDR, puede ver las páginas de manual de cualquier comando, por ejemplo, el comando tar aquí (puede usar cualquier otro comando aquí):

tldr tar

Aquí hay otro ejemplo de cómo acceder a la página de manual resumida para el comando ls.

tldr ls

Para enumerar todos los comandos para la plataforma elegida en el caché, use el indicador -l.

tldr -l 

Para enumerar todos los comandos admitidos en el caché, use el indicador -a.

tldr -a

Puede actualizar o borrar el caché local ejecutando.

tldr -u	#update local cache 
OR
tldr -c 	#clear local cache 

Para buscar páginas usando palabras clave, use las opciones -s, por ejemplo.

tldr -s  "list of all files, sorted by modification date"

Para cambiar el tema de color (simple, base16, océano), use la bandera -t.

tldr -t ocean

También puede mostrar un comando aleatorio, con el indicador -r.

tldr -r   

Puede ver una lista completa de opciones admitidas ejecutando.

tldr -h

Puede encontrar una lista de todas las aplicaciones cliente dedicadas y compatibles para diferentes plataformas en la página wiki de clientes TLDR.

¡Eso es todo por ahora! Las páginas TLDR son ejemplos prácticos resumidos de comandos proporcionados por la comunidad. En este breve artículo, mostramos cómo instalar y usar páginas TLDR en Linux.

Utilice el formulario de comentarios para compartir sus opiniones sobre TLDR o compartir con nosotros cualquier programa similar que exista.