Чтение и поиск длинных страниц руководства

Я , наконец , надоело , когда хотят , чтобы прочитать о баш «ы readи это -sвариант с man bash. В конце концов я нашел правильное место (около строки 4500), но, как обычно, это было неприятно, так как оба /readи даже /\s-s\sпоиски имеют слишком много совпадений.

Итак, вопрос: как я могу эффективно читать длинные страницы руководства или получать ту же информацию другими способами на местном уровне ? Как конкретный пример, как добраться до соответствующей документации после просмотра read -s pwdв сценарии оболочки? Хорошим ответом может быть фрагмент сценария оболочки или подсказка о каком-либо инструменте и о том, как он используется, или что-то еще полностью, при условии, что он помогает найти правильное место для чтения.

Примечание: я не отмечаю тегом bash, потому что хочу, чтобы вопрос касался чтения справочной страницы в целом, хотя это, вероятно, наиболее часто встречающаяся огромная справочная страница.

Чтобы быстро получить помощь по встроенной функции Bash, используйте help:

help read

это то, что вы хотите.

Для форматирования, подобного man-странице, используйте

help -m read

или даже лучше,

help -m read | less

Если вы все еще настаиваете на поиске этого на странице руководства, я нахожу, что быстро приводит меня к объяснению команды:

/^\s*read [[]

Это работает, потому что, когда команда сначала объясняется, ее имя слегка отступает от начала строки. В конкретном случае readэто займет немного времени, прежде чем вы перейдете к фактическомуread документации, потому что (по понятным причинам) слово «чтение» многократно повторяется на всей странице руководства. [[] Означает совпадение с [, которое обычно предшествует необязательным параметрам. (Я обычно опускаю / ^ \ s * и просто делаю / <встроенную команду> [[])

Еще одна альтернатива

Если вы не возражаете против изменения формата, вы можете преобразовать свою справочную страницу в файл DVI или PDF:

man -T dvi bash >bash.dvi

или

man -T ps bash | ps2pdf - bash.pdf # Requires the Ghostscript suite for ps2pdf

Конечно, имея документ DVI или PDF, вы можете легко выполнить текстовый поиск.

Подход 1

man bashтогда /read \[тогда/-s

Подход 2

Вы можете попробовать инструмент с открытым исходным кодом для объяснения аргументов командной строки, называемый объясненный shell .

Это может быть использовано локально. Прочитайте документацию на https://github.com/idank/explainshell

Предостережения: обычно работает, но только с командами, найденными в репозитории man Ubuntu

В вашем случае он не может распознать -sпереключатель read -s pwd.

Подход 3

Я нашел другой инструмент, который кажется многообещающим, но он не работает в моей системе.

объяснение: краткая документация для команд Unix

В этом случае я обычно просто запускаю manпоиск SHELL BUILTIN COMMANDSзаголовка, затем поиск встроенного, т.е.

man bash
/^SHELL BUILTIN
/  read 

Тем не менее, в Bash вы можете сделать

help read

или, в зависимости от системы, любой из

man 1 read
man bash-builtins

В общем, для этого у меня есть скрипт he("краткая справка"). Вы бы запустили это так:

he bash read

Не существует общего способа поиска информации на странице руководства, равно как нет общего способа поиска информации в книге. Это зависит от того, что вы ищете.

Когда вы ищете информацию о встроенной оболочке, вы можете искать встроенную строку в начале строки, сохраняя отступы, а затем пробел: поиск ^ *read␣(например, тип /^ *read␣ Enter) ( ␣это пробел). Это работает с dash, pdksh, mksh и bash. Справочная страница Zsh разделена, поэтому вам нужно прочитать zshbuiltinsсправочную страницу. Ksh93 содержит специальные символы перед именами некоторых встроенных функций, которые нужно искать ^ *†*␣в UTF-8 или ^ *-*␣в ASCII. Есть несколько ложных срабатываний, но это быстро приведет вас к правильной линии. Поиск ^ *read($| [-[])уменьшает количество ложных срабатываний.

Вы можете ускорить поиск, сообщив своему пейджеру, куда вы хотите перейти. Например, PAGER='less "+/^ *read \["' man bashоткрывается страница руководства bash с описанием readвстроенной функции. Вы можете сделать это функцией:

man-builtin () {
  PAGER="less '+/^ *$1(\$|\\[|-)'" man ${SHELL##*/}
}

Чтобы перейти непосредственно к разделу «Команды SHELL BUILTINS» на справочной странице bash, я определил в своем $HOME/.bash_aliasesфайле следующий псевдоним .

alias man-builtin="man -P 'less -p ^SHELL\ BUILTIN\ COMMANDS' bash"

Просто чтобы предложить другую альтернативу, если вы предпочитаете использовать веб-браузер, который позволяет вам легко осуществлять поиск по текущей странице, вы можете использовать что-то вроде man.cgi используемое на freeBSD.org, которое также позволяет вам просматривать страницы man из разных систем, чтобы увидеть, как они отличаются. Я видел подобное на других сайтах, так что ожидайте, что есть другие варианты вокруг.

Ссылка справки под apropos предлагает некоторую информацию, чтобы получить копию сценария для размещения на вашем собственном сервере со ссылками для загрузки коллекций страниц справочника.

Я нашел способ создать функцию bash для этой цели. Этот фрагмент может быть, например, вставлен в конце ~/.bashrc:

manfind() {
  # required args
  test "$1" -a "$2" || return 1                  

  # create temp file and get its name
  local tmp=$(mktemp /tmp/manfindXXXXXX) || return 1
  ( # subshell for trap
    trap "rm $tmp" EXIT

    # grep all matching lines with line numbers and pipe them to dialog
    if man "$1" |                   # get the whole man page
      grep -n "^\s*$2" |            # grep for the search string, with line nums
      sed 's/:/\n/' |               # replace line num separator with newline for dialog
      cut -c-70  |                  # cut long lines to nice length
      xargs -d'\n' -n 999999 \
        dialog --output-fd 3 --menu "Select line to go to" 0 0 0 3>$tmp -- 1 '(start of man page)'
    then
      # selected line number is now in $tmp, get man page and
      # use vim in read only mode to view it at right line
      man "$1" | vim -R +"$(< $tmp)" -
    else
      # cancel selected from dialog
      exit 1
    fi
  )
}

Комментарии немного объясняют, что он делает. В частности, строка поиска по умолчанию выполняет поиск заданного слова в начале строки, пропуская начальный пробел. Примеры:

# find every line which starts with 'read' followed by space
manfind bash 'read '
# research bash subshells
manfind bash '.*subshell'

Примечание: этот скрипт не имеет понятия о разделах man-страниц ... Я посмотрю, если я подправлю это позже, но установка MANSECTпеременной среды man помогает.

Собирая кусочки из другой дискуссии здесь вот быстрая функция , которую вы можете оставить в вашем , .bashrcчто приведет вас прямо к встроенному (если она существует). В противном случае он открывается manкак обычно:

man() {
    case "$(/bin/bash -c 'type -t '"$1")" in 
        builtin)
            LESS=+?"^       $1 " command -p man bash
            ;;
        *)
            command -p man $@
            ;;
    esac
}

Вы можете использовать любой дистрибутив Linux, info bashесли хотите иметь отдельные параграфы по типу действий, в которых информация идентична страницам руководства.