¿Qué es el formato de archivo MAN?
Los archivos con la extensión .man contienen manuales de usuario de Unix escritos en lenguaje de marcado fuente roff. Se puede acceder a las páginas de manual emitiendo el comando man seguido del nombre de un programa, función o tema. El código fuente utiliza el paquete de macros *man*, un conjunto de directivas con prefijo de punto (.TH, .SH, .B, .TP) que man renderiza bajo demanda a través de groff o mandoc. Al abrir un archivo .man en un editor de texto se muestra este marcado sin procesar en lugar de una página formateada; los archivos .man admiten macros de formato de visualización para controlar negritas, cursivas, sangrías y el diseño de tablas.
.man es un archivo de texto plano y se puede abrir con cualquier editor de texto, pero lo más común es acceder a los manuales de usuario mediante la herramienta del sistema man invocada desde la línea de comandos. Muchos entornos de sistema gráficos ofrecen diversas herramientas para visualizar documentos man. Las páginas de manual pueden dividirse en las siguientes secciones:
- NAME - nombre del programa, herramienta, biblioteca o función, seguido de una breve descripción
- SYNOPSIS - parámetros y opciones para el comando y, opcionalmente, una firma de función en C
- DESCRIPTION - descripción detallada del comando y sus funciones
- EXAMPLES - ejemplos de cómo se puede utilizar el comando
- SEE ALSO - una lista de funciones o comandos relacionados
Los manuales de usuario de Unix/Linux no suelen guardarse como archivos .man en el disco. Normalmente, los manuales se almacenan con un sufijo que indica a qué sección del manual pertenece el archivo (por ejemplo, ls.1 o printf.3) y las páginas instaladas suelen estar comprimidas con gzip como nombre.seccion.gz, descomprimidas de forma transparente por man. Las páginas de manual suelen estar en inglés, aunque algunos manuales están localizados en varias distribuciones.
Los documentos man se dividen en secciones numeradas. El comando man muestra por defecto la primera entrada que coincida de entre 7 secciones (Unix System V) u 8 (Linux/BSD), que son:
- Comandos generales
- Llamadas al sistema
- Funciones de la biblioteca C
- Archivos especiales y controladores de dispositivos
- Formatos de archivo y archivos de configuración
- Juegos y protectores de pantalla
- Miscelánea / páginas de resumen
- Administración del sistema y demonios (solo Linux/BSD)
Para acceder a una sección determinada es necesario ejecutar man numero_seccion nombre; por ejemplo, man 5 passwd. La salida del manual puede redirigirse a una aplicación diferente para facilitar su lectura, por ejemplo a cat o less.
Seguridad y protección
RIESGO: LOWEl código fuente de una página man es texto plano y no se ejecuta al visualizarse. La única precaución teórica es que roff es un lenguaje de macros Turing completo y groff ha tenido históricamente errores de análisis, por lo que renderizar un .man de una fuente totalmente desconocida se hace mejor con el mandoc más seguro y aislado en lugar del groff completo. En un uso normal (leer documentos de paquetes y proyectos), un archivo .man es inofensivo; abrirlo en un editor de texto es completamente seguro. No lo confunda con un perfil obligatorio .man de Windows, que es una colmena del registro, no un documento.
Detalles del formato
en pocas palabras- Perfil de usuario obligatorio de Windows 2000/XP - El archivo .man heredado de Windows es un perfil de usuario móvil de solo lectura (una colmena del registro NTUSER.DAT renombrada), no relacionado con las páginas man de Unix; el significado original de db_name.
- Archivo de memoria/menú de FoxPro / dBASE - Algunas herramientas de bases de datos antiguas de DOS utilizaban .man para datos de menús o notas compiladas; obsoleto.
Programas que abren archivos MAN
Detalles técnicos
especificación profunda| Codificación de archivo | Texto plano ASCII o UTF-8; no requiere contenido binario ni marca de orden de bytes (BOM) |
| Tipo MIME | text/troff (primario); también reconocido como application/x-troff-man o text/plain |
| Lenguaje de marcado | roff/troff utilizando el paquete de macros man (macros an-old); las llamadas a macros con prefijo de punto deben aparecer al principio de una línea |
| Macro de título | .TH (encabezado de título): normalmente la primera línea que no es un comentario; declara el nombre de la página, el número de sección, la fecha y el paquete de origen |
| Secciones estándar | NAME, SYNOPSIS, DESCRIPTION, OPTIONS, EXAMPLES, FILES, ENVIRONMENT, BUGS, SEE ALSO - cada una introducida por una macro .SH |
| Numeración de secciones de páginas man | 7 secciones en Unix tradicional (System V); 8 en Linux y BSD - la sección 8 cubre comandos de administración del sistema |
| Tamaño de archivo típico | 1 KB - 100 KB; la mayoría de las páginas oscilan entre 5 KB y 30 KB |
| Compresión en disco | Las páginas instaladas suelen estar comprimidas con gzip (p. ej., ls.1.gz) y man las descomprime de forma transparente al momento de la lectura |
| Motor de renderizado | groff (GNU troff) en Linux; mandoc en BSD y macOS moderno, que reemplazó a groff como renderizador de man predeterminado |
| Nomenclatura común de archivos | La extensión con el número de sección es el estándar en disco (ls.1, printf.3, passwd.5); la extensión .man se utiliza principalmente para documentación de terceros o paquetes adjuntos |
| Ruta de instalación | /usr/share/man/manN/ en Linux y BSD, donde N es el número de sección; macOS utiliza /usr/share/man/ con la misma disposición de directorios |
| Formatos de salida | Texto de terminal a través de un paginador (less), PostScript, PDF, HTML y texto plano - todos producidos bajo demanda por groff -T |
| Formatos de fuente relacionados | mdoc (conjunto de macros alternativo de BSD), pod2man (de Perl POD a man), constructor de man de Sphinx y ronn (conversor de Markdown a man) |
| Desarrollador / origen | Bell Labs (sistema man original de Unix, 1971); macros man y groff mantenidos por el Proyecto GNU |
| Lanzado | 1971 (Unix Programmer's Manual, V1); man macros standardized through the 1970s-80s |
| Última versión | N/A (roff/man-macro convention; groff is the active implementation) |
| Estándar abierto | Sí · libre de regalías |
| Especificación | man7.org |
Conversiones de MAN
Preguntas y respuestas de la comunidad
preguntado por usuariosAún no hay preguntas; sea el primero en preguntar sobre los archivos MAN.