Buscando una opción específica en una página de manual

14

A menudo encuentro manun comando solo para aprender sobre una opción específica. La mayoría de las veces puedo buscar la opción bien, a menos que sea algo así ffmpego gccdonde tenga que pasar por unas 40 coincidencias hasta que llegue a la descripción real de la opción ...

A veces puedo tener suerte y buscar la palabra "opciones" para acercarme y luego refinarla desde allí, pero sería bueno si pudiera saltar directamente a la opción en cuestión. Sería genial si hubiera una herramienta que pudiera analizar las opciones y crear una base de datos en la que pudieras hacer búsquedas, pero después de mirar el margen de ganancia de algunas páginas, he determinado que solo sería un esfuerzo de adivinanza debido a la falta de metainformación en el marcado de groff ... En mi mundo ideal , el modo mujer en emacs apoyaría la búsqueda de opciones específicas ... :)

¿Algún consejo para saltar directamente a una opción específica en una página de manual?

mgalgs
fuente

Respuestas:

5

Aquí está mi guión para hacerlo. Se llama él .

$ he cp    
SYNOPSIS
       cp [OPTION]... [-T] SOURCE DEST
       cp [OPTION]... SOURCE... DIRECTORY
       cp [OPTION]... -t DIRECTORY SOURCE...

$ he gcc -dD
       -dD Dump all macro definitions, at the end of preprocessing, in addition to normal output.

$ he rsync -v
        -v, --verbose               increase verbosity

$ he bash getopts
       getopts optstring name [args]
              getopts is used by shell procedures to parse positional parameters.  optstring contains the option characters to be recognized; if a character is  followed  by  a  colon,  the  option  is
              expected  to  have  an  argument, which should be separated from it by white space.  The colon and question mark characters may not be used as option characters.  Each time it is invoked,
              getopts places the next option in the shell variable name, initializing name if it does not exist, and the index of the next argument to be processed into the variable OPTIND.  OPTIND  is
              initialized  to  1 each time the shell or a shell script is invoked.  When an option requires an argument, getopts places that argument into the variable OPTARG.  The shell does not reset
              OPTIND automatically; it must be manually reset between multiple calls to getopts within the same shell invocation if a new set of parameters is to be used.

              When the end of options is encountered, getopts exits with a return value greater than zero.  OPTIND is set to the index of the first non-option argument, and name is set to ?.

              getopts normally parses the positional parameters, but if more arguments are given in args, getopts parses those instead.

              getopts can report errors in two ways.  If the first character of optstring is a colon, silent error reporting is used.  In normal operation diagnostic messages are printed  when  invalid
              options or missing option arguments are encountered.  If the variable OPTERR is set to 0, no error messages will be displayed, even if the first character of optstring is not a colon.

              If  an  invalid  option  is  seen, getopts places ? into name and, if not silent, prints an error message and unsets OPTARG.  If getopts is silent, the option character found is placed in
              OPTARG and no diagnostic message is printed.

              If a required argument is not found, and getopts is not silent, a question mark (?) is placed in name, OPTARG is unset, and a diagnostic message is printed.  If getopts is silent, then  a
              colon (:) is placed in name and OPTARG is set to the option character found.

              getopts returns true if an option, specified or unspecified, is found.  It returns false if the end of options is encountered or an error occurs.

Pero si no tiene acceso a un script como ese, simplemente ejecute less, luego escriba /^ *-option(tenga en cuenta el espacio), por ejemplo, en la gccpágina de manual, escriba /^ *-dDEnterpara encontrar la documentación para la -dDopción.

Esto funciona porque la opción generalmente aparece al comienzo de la línea.

Mikel
fuente
1
¡Imagina a un gran oso barbudo besándote los dedos de los pies por esto!
Sepehr
¡Jaja! ¡Gracias! También tenga en cuenta que cambié el nombre del script a he, como en "ayuda breve". La última versión está en github
Mikel
2

Esta es la función que uso. Lo llamo "mans" por "búsqueda de hombre".

mans ()
{
    local pages string;
    if [[ -n $2 ]]; then
        pages=(${@:2});
        string="$1";
    else
        pages=$1;
    fi;
    man ${2:+--pager="less -p \"$string\" -G"} ${pages[@]}
}

Uso:

$ mans ^OPTIONS grep find xargs
Pausado hasta nuevo aviso.
fuente
¡Dulce! No es exactamente la solución de tipo de tabla de búsqueda "ideal" que esperaba, pero sigue siendo muy útil. Gracias.
mgalgs
1
Como se indica a continuación, la mayoría de las veces lo que está buscando es al comienzo de la línea después de una sangría, por lo que el patrón generalmente se verá mans '^ *<something>' <page>. Vea mi respuesta para más detalles.
Mikel