Recherche d'une option spécifique dans une page de manuel


14

Je me retrouve souvent dans manune commande juste pour en savoir plus sur une option spécifique. La plupart du temps, je peux très bien rechercher l'option, à moins que ce soit quelque chose comme ffmpegou gccoù je dois parcourir environ 40 correspondances jusqu'à ce que j'arrive à la description réelle de l'option ...

Parfois, je peux avoir de la chance et rechercher le mot «options» pour me rapprocher, puis l'affiner à partir de là, mais ce serait bien si je pouvais passer de manière fiable directement à l'option en question. Ce serait cool s'il y avait un outil qui pourrait analyser les options et construire une base de données sur laquelle vous pourriez faire des recherches, mais après avoir regardé le balisage groff pour quelques pages, j'ai déterminé que ce ne serait qu'un effort de meilleure estimation en raison du manque de méta-informations dans le balisage groff ... Dans mon monde idéal , le mode femme dans emacs prendrait en charge la recherche d'options spécifiques ... :)

Des conseils pour passer directement à une option spécifique dans une page de manuel?

Réponses:


5

Voici mon script pour le faire. Ça s'appelle lui .

$ 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.

Mais si vous n'avez pas accès à un script comme celui-là, lancez-le less, puis tapez /^ *-option(notez l'espace), par exemple, dans la gccpage de manuel, tapez /^ *-dDEnterpour trouver la documentation de l' -dDoption.

Cela fonctionne car l'option apparaît généralement au début de la ligne.


1
Imaginez un gros ourson barbu vous embrassant les orteils pour ça!
sepehr

Ha ha! Merci! Notez également que j'ai renommé le script he, comme dans "aide courte". La dernière version est sur github
Mikel

2

C'est la fonction que j'utilise. Je l'appelle "mans" pour "recherche d'homme".

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

Usage:

$ mans ^OPTIONS grep find xargs

Sucré! Pas exactement la solution de type de table de recherche "idéale" que j'espérais, mais toujours très utile. Merci.
mgalgs

1
Comme indiqué ci-dessous, la plupart du temps, ce que vous recherchez est au début de la ligne après une indentation, de sorte que le motif ressemblera généralement mans '^ *<something>' <page>. Voir ma réponse pour plus de détails.
Mikel
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.