Um, crea y mantén tus propias páginas man de tu Ubuntu

En el siguiente artículo vamos a echar un vistazo a Um. A día de hoy nadie puede poner en duda la utilidad de las páginas Man y de sus alternativas. Esas alternativas se utilizan principalmente para poder disponer de ejemplos personalizados, y así no tener que pasar por las páginas man completas. Si buscas una forma rápida de comunicar o aprender un comando de Gnu/Linux de forma fácil, vale la pena probar estas alternativas. Um nos va a permitir crear nuestras propias páginas de ayuda para un comando. Esta es una utilidad de terminal, que resulta muy útil para crear y mantener fácilmente nuestras propias páginas Man que contienen solo lo que a nosotros nos interese.

Al crear tus propias páginas de ayuda, se pueden evitar muchos “detalles” de una página man e incluir en ella solo lo que es necesario tener en cuenta para el caso que nos interese. Si alguna vez quisiste crear tu propio conjunto de páginas de tipo Man, Um definitivamente te resultará útil.

Instalar Um en Ubuntu 18.04

Um está disponible para Gnu/Linux y Mac OS. En el momento en el que escribo esto, solo se puede instalar utilizando el administrador de paquetes de Linuxbrew en sistemas Gnu/Linux. Consulta el siguiente artículo si aún no has instalado Linuxbrew en tu Ubuntu, ya que es necesario para realizar lo siguiente.

Una vez instalado Linuxbrew, ejecuta el siguiente comando en una terminal (Ctrl+Alt+T) para instalar Um:

brew install sinclairtarget/wst/um

Si todo va bien, la terminal nos indicará que la instalación ha terminado de manera satisfactoria.

Antes de usarlo para hacer tus páginas Man, debes habilitar la finalización de bash para Um. Para hacerlo, abre tu archivo ~/.bash_profile:

vi ~/.bash_profile

Y, agrega en el archivo las siguientes líneas:

if [ -f $(brew --prefix)/etc/bash_completion.d/um-completion.sh ]; then
. $(brew --prefix)/etc/bash_completion.d/um-completion.sh
fi

Guarda y cierra el archivo. Ahora ejecuta el siguiente comando para actualizar los cambios:

source ~/.bash_profile

Todo listo. Ahora ya podemos crear nuestra primera página Man.

Configurar Um

Para ver la configuración actual, ejecuta:

um config

En este archivo, vamos a poder editar y cambiar los valores de las opciones como son el tema por defecto, directorio de páginas y páginas, como mejor nos interese. Digamos, por ejemplo que si quieres guardar las páginas Um creadas en tu carpeta de Dropbox, simplemente cambia el valor de la directiva de directorio de páginas y envíalas a la carpeta de Dropbox en el archivo ~/.um/umconfig escribiendo dentro de el.

pages_directory = /home/tu-usuario/Dropbox/um

Este archivo, si no está creado, será necesario crearlo para almacenar la configuración.

Crea y mantén tus propias páginas Man

Digamos que si te interesa crear tu propia página Man para el comando ‘apt’, ejecuta en la terminal (Ctrl+Alt+T):

um edit apt

El comando anterior abrirá una plantilla en tu editor predeterminado:

Mi editor predeterminado es Vi. Ahora, ya podemos comenzar a agregar todo lo que necesites recordar sobre el comando ‘apt’ en esta plantilla.

Como se ve en la captura anterior, he agregado una sinopsis, descripción y algunas opciones del comando apt, a modo de ejemplo. Vas a poder agregar tantas secciones como quieras en estas páginas. Asegúrate que le has puesto títulos apropiados y fáciles de entender para cada sección. Una vez hecho esto, guarda y sal del archivo. Si usas el editor Vi, pulsa la tecla ESC y escribe :wq.

Ahora ya puedes ver tu página Man recién creada usando el comando:

um apt

Como se puede ver, la página de manual de apt se ve igual que las páginas man oficiales. Si quieres editar y / o agregar más detalles en una página Man, ejecuta otra vez el mismo comando y agrega los detalles que quieras.

um edit apt

Para ver la lista de páginas Man creadas recientemente usando Um, ejecuta en la terminal (Ctrl+Alt+T):

um list

En caso de que no ya no necesites una página en particular, simplemente elimínala como se muestra a continuación:

um rm dpkg

Para ver la sección de ayuda y todas las opciones generales disponibles, lanza el comando:

um --help

Todas las páginas Man se guardarán en un directorio llamado ~/.um en tu directorio de inicio. Quien quiera puede saber más acerca de esta aplicación en el repositorio que el proyecto tiene en GitHub.


Categorías

Ubuntu

Aficionado a la programación y al software. Dispuesto a aprender de todo para después contarlo.

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

*

*

  1. Responsable de los datos: Miguel Ángel Gatón
  2. Finalidad de los datos: Controlar el SPAM, gestión de comentarios.
  3. Legitimación: Tu consentimiento
  4. Comunicación de los datos: No se comunicarán los datos a terceros salvo por obligación legal.
  5. Almacenamiento de los datos: Base de datos alojada en Occentus Networks (UE)
  6. Derechos: En cualquier momento puedes limitar, recuperar y borrar tu información.