LinuxCommands

Estructura y referencia para documentar comandos y servicios en Linux

LinuxCommands nació como una recopilación de apuntes personales para organizar y entender mejor distintos comandos, scripts y servicios en Linux.

Con el tiempo, se fue estructurando para que sea más fácil de navegar y consultar, tanto para mí como para cualquier persona interesada en aprender o consultar comandos y servicios de manera práctica.

---

Objetivos del proyecto

• Proporcionar un formato claro y reutilizable para documentar comandos Linux.
• Facilitar una documentación legible para humanos y mantenible a largo plazo.
• Reducir duplicación, ambigüedad y variaciones innecesarias entre repositorios.
• Servir como referencia práctica para administradores de sistemas, desarrolladores y equipos técnicos.

---

Enfoque

El repositorio no pretende sustituir herramientas existentes como man, sino complementarlas mediante:

• Ficheros commands.md estructurados,
• Convenciones claras de documentación,
• Ejemplos prácticos y homogéneos,
• Una organización pensada para crecer sin perder consistencia.

El formato utilizado está definido formalmente en un documento de origen y se aplica de forma uniforme en todo el repositorio.

---

Formato de documentación

El formato base de los comandos se define en el Documento de Origen.

La versión más actual y aplicada del formato puede encontrarse en document_management/commands.md.

Este fichero actúa como referencia canónica del estándar utilizado en el repositorio.

---

Generar HTML / PDF (manualmente)

Instrucciones rápidas para generar la documentación localmente y comprobar la jerarquía y el índice.

Prerequisitos:

• asciidoctor para HTML.
• asciidoctor-pdf para generar PDF directamente (opcional).

Instalación (si dispone de Ruby/gems):

gem install asciidoctor
gem install asciidoctor-pdf

Generar HTML:

asciidoctor -b html5 document_management/index.adoc -o document_management/index.html

Generar PDF (directo con asciidoctor-pdf):

asciidoctor-pdf document_management/index.adoc -o document_management/LinuxCommands.pdf

---

Estructura del repositorio

La organización del repositorio está pensada para facilitar la navegación y el crecimiento progresivo del contenido:

• document_management
• fundamentals
• networking
• permission_management
• process_tasks
• scripting
• security
• services
• software_management
• storage
• system_data
• user_permissions
• web_server

---

Información adicional

• Información general del repositorio

---

Contribuciones

Las contribuciones son bienvenidas siempre que respeten el formato y la estructura definidos.
El objetivo es mantener una documentación coherente y de alta calidad.