☰

¿Vincular a secciones de la página de manual?

tag-icon • tag-icon documentation html manpage
¿Vincular a secciones de la página de manual?

¿Páginas de manual en línea en HTML con anclajes de sección?

Sería bueno tener una versión en línea de las páginas de manual de Ubuntu con enlaces directos a las subsecciones. Eso permitiría señalar a alguien la documentación relevante en muchos casos, por ejemplo, en las respuestas de varios sitios de StackExchange.

Describiré cómo podría ser una solución completa y de qué manera sería útil. No creo que haya una solución completa disponible en alguna parte, por lo que la pregunta es

¿Qué soluciones parciales existen hoy?

Por ejemplo, buscar formas sistemáticas de alguna manera en las páginas de manual, en lugar de vincularlas, sería una solución parcial.


Las páginas man enpáginas de manual.ubuntu.comresuelven la mayor parte del problema, pero no tienen anclajes en los títulos o secciones.

Eso significa que si quiero señalar la sección "Expansión de parámetros" en man bashen línea, tengo que usar

Consulte "Expansión de parámetros" enman bash
[...y utilice su navegador para buscar "Expansión de parámetros"]

Esto abre la página de manual de bash en la parte superior, como una página web larga.

En el caparazón, puedo decir

Verman bash | less "+/Parameter Expansion"

que salta al lugar correcto al inicio.


Sería muy útil tener anclajes de enlaces con nombres similares a los títulos a los que apuntan. Los anclajes nombrados por algún tipo de número de índice aún serían útiles, pero requieren una búsqueda manual en la página web real para usarlos.

Como no es difícil a nivel HTML agregar anclajes a los encabezados, estoy seguro de que existen páginas de manual;
¿Pero hay una colección dePáginas de manual de Ubuntu con anclajes¿En línea en alguna parte, o al menos en un buen subconjunto?

Código de ejemplo

El encabezado de la sección "Expansión de parámetros" de
http://manpages.ubuntu.com/bash
a qué tipo de redirecciones
http://manpages.ubuntu.com/manpages/trusty/en/man1/bash.1.html

       [ ... ]
       tildes in assignments to <b>PATH</b>, <b>MAILPATH</b>,  and  <b>CDPATH</b>,  and  the  shell
       assigns the expanded value.

   <b>Parameter</b> <b>Expansion</b>
       The `<b>$</b>' character introduces parameter expansion, command substitution,
       or arithmetic expansion.  The parameter name or symbol to  be  expanded
       [ ... ]

Para poder enlazar directamente a esta sección, necesitamos algo como:

       [ ... ]
       tildes in assignments to <b>PATH</b>, <b>MAILPATH</b>,  and  <b>CDPATH</b>,  and  the  shell
       assigns the expanded value.

   <a href="#ParameterExpansion"><b>Parameter</b> <b>Expansion</b></a>
       The `<b>$</b>' character introduces parameter expansion, command substitution,
       or arithmetic expansion.  The parameter name or symbol to  be  expanded
       [ ... ]


Esto agrega una etiqueta al código HTML y un atributo, el nombre de la sección sin espacios:

<b>Parameter</b> <b>Expansion</b>
<a href="#ParameterExpansion"><b>Parameter</b> <b>Expansion</b></a>

Ahora, podemos vincularnos a la sección como

http://manpages.ubuntu.com/bash#ParameterExpansion
o incluso
manpages.ubuntu.com/bash#ParameterExpansion

que usa una nota al pie y está escrito como
[manpages.ubuntu.com/bash#ParameterExpansion][6]

Uso de otros documentos de referencia.

En muchos casos, existen documentos de referencia alternativos disponibles, además de la página de manual. Estos suelen tener una buena estructura de enlaces que se utiliza para enlazar desde una tabla de contenido a las secciones, justo lo que necesitamos.
Pero estono resuelve el problema general, ya que no existe una forma común de encontrar si existe o dónde existe dicho documento y de hacer uso de la estructura de enlaces.

Para el ejemplo de bash usado anteriormente, elManual de referencia de bashpodría usarse como una solución individual buscada manualmente:

Sección del Manual de referencia de Bash Shell-Parámetro-Expansión
escrito como
[sección Shell-Parameter-Expansion del Manual de referencia de Bash] (http://www.gnu.org/software/bash/manual/bash.html#Shell-Parameter-Expansion)

Implementación propuesta

Proponer implementar realmente esta idea enpáginas de manual.ubuntu.com,
presenté una solicitud de mejora/error estrechamente relacionada en el proyecto asociado "ubuntu-manpage-repository": Launchpad #1355271: use etiquetas HTML a para permitir enlaces externos a subsecciones de páginas man

Respuesta1

Sí, lo hay, eshttp://man.cx/. Su objetivo es tener todas las páginas de manual en un solo sitio, también en varios idiomas. Lamentablemente, las anclas no tienen nombre, sino números: por ejemplohttp://man.cx/printf#heading1Lo llevará al primer encabezado de la printfpágina de manual. Aún así creo que es mejor que sin anclajes ;)

PD. Agregue el sitio a sus motores de búsqueda, luego simplemente escriba man printfen su barra de direcciones y lo llevará a la página correcta, ¡súper increíble!

Respuesta2

Enunix.stackexchange, hay formas descritas parautilizar las páginas de manual fuera de línea como hipertextotambién. La forma más sencilla para mí parece ser w3mman, que forma parte del paquete w3m, por lo que:

sudo apt-get install w3m

Cuando abrió una página de manual, por ejemplo w3mman man, puede usarla TABpara navegar al siguiente enlace. (Otros atajos de teclado típicos del hombre funcionan igual: desplazarse, buscar, salir :-)

Para desactivar la confirmación de salida (como manse comporta):

  • editar~/.w3m/config

    • si no existe:cp /etc/w3m/config ~/.w3m/

  • colocarconfirm_qq 0

Para reemplazar lo normalhombredominio:

  • editar~/.bashrc

    • agregaralias man='w3mman'

  • source ~/.bashrc

Ahora man <some command>usaré w3mman en lugar del man normal :) Me gusta así. ¡Gracias por preguntar! :)

Respuesta3

8 años después,
vincular páginas de manual con anclajes de sección todavía no es fácil hoy en día.

La página de manual de archlinux parece ser la única que conozco

hombre archlinux

tiene algunas anclas, pero no suficientes

un enlace de demostración: https://man.archlinux.org/man/bash.1.en#extglob

hombre ñu

tiene algunas anclas

enlace de demostración: https://www.gnu.org/software/bash/manual/bash.html#Indexes
https://www.gnu.org/software/bash/manual/bash.html#Pattern-Matching

información relacionada