/usr/share/man/man1 のマニュアルページからすべてのコマンド概要を正しく抽出するにはどうすればよいですか?

Question 1

~~ただ走るだけではだめだman foo.gz~~あなたみたいですねできる実行しますman foo.1.gzが、を使用する方-lがきれいです。出典man man:

   -l, --local-file
          Activate `local' mode.  Format and display  local  manual  files
          instead  of  searching  through  the system's manual collection.
          Each manual page argument will be interpreted as an nroff source
          file in the correct format.  No cat file is produced.  If '-' is
          listed as one of the arguments, input will be taken from  stdin.
          When  this  option  is  not used, and man fails to find the page
          required, before displaying the error message,  it  attempts  to
          act as if this option was supplied, using the name as a filename
          and looking for an exact match.

したがって、スクリプトは次のようになります。

#!/usr/bin/env bash
## synopses - extract all synopses in /usr/share/man/man1

## No need to cd into the directory, you can just use globs     
for i in /usr/share/man/man1/ajc*.gz; do
    ## This will print the name of the command.      
    basename "${i//.1.gz}"
    man -l "$i"  | 
       awk '/^SYNOPSIS/{a=1; getline}
            (/^[a-zA-z0-9_]/ && a==1){a=0} 
            (a==1 && /./){print}' | tr -s [:space:]

done

私が示すコマンドawkは、あなたのアプローチよりもうまく機能し (たとえば、テストしてくださいman ajc)、複数行の概要でも機能するようになりました。表示されるエラーのほとんどは無関係ですが、他のエラーはファイル名の処理方法によるものです。この方法の方がうまくいくかどうか教えてください。

Answer

~~ただ走るだけではだめだman foo.gz~~あなたみたいですねできる実行しますman foo.1.gzが、を使用する方-lがきれいです。出典man man:

   -l, --local-file
          Activate `local' mode.  Format and display  local  manual  files
          instead  of  searching  through  the system's manual collection.
          Each manual page argument will be interpreted as an nroff source
          file in the correct format.  No cat file is produced.  If '-' is
          listed as one of the arguments, input will be taken from  stdin.
          When  this  option  is  not used, and man fails to find the page
          required, before displaying the error message,  it  attempts  to
          act as if this option was supplied, using the name as a filename
          and looking for an exact match.

したがって、スクリプトは次のようになります。

#!/usr/bin/env bash
## synopses - extract all synopses in /usr/share/man/man1

## No need to cd into the directory, you can just use globs     
for i in /usr/share/man/man1/ajc*.gz; do
    ## This will print the name of the command.      
    basename "${i//.1.gz}"
    man -l "$i"  | 
       awk '/^SYNOPSIS/{a=1; getline}
            (/^[a-zA-z0-9_]/ && a==1){a=0} 
            (a==1 && /./){print}' | tr -s [:space:]

done

私が示すコマンドawkは、あなたのアプローチよりもうまく機能し (たとえば、テストしてくださいman ajc)、複数行の概要でも機能するようになりました。表示されるエラーのほとんどは無関係ですが、他のエラーはファイル名の処理方法によるものです。この方法の方がうまくいくかどうか教えてください。

Question 2

発生したエラーについては、すべてここで対処します。

man man

MANWIDTH-$MANWIDTHが設定されている場合、その値はマニュアルページをフォーマットする行の長さとして使用されます。設定されていない場合、マニュアルページは現在の端末に適した行の長さでフォーマットされます (使用可能な場合は ioctl(2) を使用し、の値を使用し$COLUMNS、どちらも使用できない場合は 80 文字に戻ります)。cat ページは、デフォルトのフォーマットが使用できる場合、つまり端末の行の長さが 66 から 80 文字の間である場合にのみ保存されます。

MAN_KEEP_FORMATTING- 通常、出力が端末 (ファイルやパイプなど) に送信されていない場合、特別なツールを使わずに結果を読みやすくするために、書式設定文字は破棄されます。ただし、が$MAN_KEEP_FORMATTING空でない値に設定されている場合、これらの書式設定文字は保持されます。これは、書式設定文字を解釈できる man のラッパーに役立つ場合があります。

MAN_KEEP_STDERR- 通常、出力が端末（通常はページャ）に向けられている場合、マニュアルページのフォーマットされたバージョンを作成するために使用されるコマンドからのエラー出力は、ページャの表示を妨げないように破棄されます。などのプログラムは、groff配置の不備などの印刷上の問題に関する比較的軽微なエラーメッセージを生成することが多く、マニュアルページと一緒に表示されると見苦しく、一般的に混乱を招きます。ただし、一部のユーザーはエラーメッセージを見たいと考えているため、が$MAN_KEEP_STDERR空でない値に設定されている場合、エラー出力は通常どおり表示されます。

さて、もう一つのことについてはどうするか。

これがあなたの望みを実現すると思います:

for f in /usr/share/man/man1/*gz ; do
    man -P "sed -ne '1,/^[Nn]/d;/^ /{H;b}
    /^[Ss]..[Yy]..[Nn]/{g;:n
    N;/\n\(\n\)[^ ].*/!bn;s//\1/
    s/.\x08//g;s/\(\n\)  */\1/g;
    w /dev/stderr' -ne '};/./q'" -l "$f"
done 2>~/file

を指定し、次の行のみを出力しますsed。PAGER名前そしてそれに続く概要以外の文字で始まる行に出会うまで<space>、何もない最初の行が<space>thatで始まっていない場合は名前begin と一致しません[Ss][Yy][Nn]。いずれの場合も、次の2行目でファイルの読み取りを完全に中止します。名前で始まっていない<space>。出力から先頭のアックスラッシュ<spaces>とすべてのアックスラッシュをクリアします。\b

for先ほどループで実行したところ、manわずか 1 分でライブラリ全体がループされました。

man出力をターミナルに書き込むか、パイプ/ファイルに書き込むかに基づいて調整します。そのため、そのように指示すると、PAGER が完全に無視されます。これは予想外でした。しかし、私はそれを騙して、sed のwrite 関数を使用して >&2 に書き出し、それをリダイレクトしたので、何もわかりませんでした。

ただし、@terdon の方法のほうが良いかもしれません。sedファイルごとにを取得できるので、簡単にカスタマイズできます。また、端末の幅に合わせようとしないのでフォーマットが少し良くなりますが、どうやらにmanは \backslashes が書き込まれないようです|pipe。

Answer