構成ファイルのマンページ

構成ファイルのマンページ

コンピュータ上のプログラムの構成ファイルの構文と論理を見つける必要があることがよくあります。これは可能ですが、man mosquitto/etc/mosquitto.conf ファイルのヘルプセクションが必ずしも生成されるわけではありません。

man /etc/mosquitto.confman ./mosquitto.conf私は与えられたファイルを開くのに必要な正確な助けを提供するようなものを探しています。それはただの蚊ではありません。それはただ一つの例です。

どこかにそのようなマッピングがありますか?インターネットを検索せずに特定のプロファイルに関するヘルプを見つけるために使用できるプログラムはありますか?

答え1

マニュアルページはいくつかのセクションに分かれています。

RedHat(Centos / Rocky)ベースのシステムで

       1   Executable programs or shell commands
       2   System calls (functions provided by the kernel)
       3   Library calls (functions within program libraries)
       4   Special files (usually found in /dev)
       5   File formats and conventions eg /etc/passwd
       6   Games
       7   Miscellaneous  (including  macro  packages  and  conventions), e.g.
           man(7), groff(7)
       8   System administration commands (usually only for root)
       9   Kernel routines [Non standard]

したがって、理論的には、マニュアルページはmosquitto.confセクション5になければなりません。実際、man 5 mosquitto.conf詳細は実際に提供されます。

ただし、これにはパッケージが必要です。供給マンページ。アプリケーションがこれを実行できることはよく文書化されています(たとえば、man sshd_configセクション5のマニュアルページを返します)。

ただし、この情報を提供することは、パッケージとアプリケーションに完全に依存します。

すべての構成ファイルに関連するマンページがあるわけではありません。

答え2

TL/DR: 集中型インフォメーションストアはありません。アプリケーション/ツールなどに関する最新の情報源は、その文書にあります。また、マンページ、情報ページ、tldrページ、html文書、文献、インターネットなどがあります。


マニュアルページはソフトウェア文書の一形態に過ぎません。マニュアルページが存在するかどうかを判断する最速の方法は、コマンドを実行することですman foo。コマンドapropos foo出力には関連情報が含まれていますfoo

man7.org所有者Linuxのマニュアルページプロジェクト、マニュアルページのWebストアです。マンページのリストが含まれています。セクション別アルファベット順そしてプロジェクト別。マニュアルページは、端末でjust man foo(例えばman hosts)、never、man /path/fooまたはman ./fooman /etc/hosts)を介して表示できます。 Distrosはオンラインで独自のマニュアルページをホストすることもできます。

すべてがマニュアルページを持っているわけではありません。これに関するマニュアルページはありませんが、.bashrcこれに関する一部の情報はで見つけることができますが、man bash内容に関する具体的な情報は見つかりません。出力ではなくxattrマニュアルページがあります。 Xattrのマニュアルページにもconfファイルへの言及はありません。これに関するいくつかの情報は、次のように表示されます。xattr.confman xattr.confNo manual entry for xattr.confcat /etc/xattr.conf

# Format:
# <pattern> <action>
#
# Actions:
#   permissions - copy when trying to preserve permissions.
#   skip - do not copy.

他のファイルには.bashrcコメント形式の文書も含まれています。

マニュアルページに似たプロジェクトは次のとおりです。GNUについてそして全長DR。マニュアルページには他のマニュアルページへの参照が含まれていますが、静的であるため、次の参照には別のページを開く必要があります。 GNU Infoには内部ハイパーリンクがあります。 TLDRページは、マニュアルページを簡素化したいコミュニティの努力であるチートシートと少し似ています。また、実際のケースも提供します。彼らはman- ieinfo xattrと同様に使用されますtldr xattr

GNOME や KDE などの GUI アプリケーションは上記の項目を使用しません。エンドユーザー文書はHTMLを使用して提供され、GNOMEなどのビューアを含めることができます。泣く

最終的にドキュメントを提供することは完全に開発者の役割です。彼らはそれをどのような形で提供するのか、まったく提供しないのかを自由に選択できます。それらの多くがあります。その結果、特定の情報の品質と可用性が大きく異なり、単一のストレージを作成することは不可能です。今日の情報を見つけるための最も速く最も簡単な方法はインターネットです。

答え3

残念ながら、すべてのプログラムがマニュアルページを同じように構成するわけではありません。あなたの例の最後の「追加項目」セクションを確認してください。類似または実行できる操作を見つけるmosquitto.conf(7)ことmosquittod(8)ができますman 7 mosquitto.confman 8 mosquittod

のファイル形式は/etc/マニュアルカテゴリ5に属する必要があります。通常、ここman 5 mosquitto.conf(またはman 5 sshd_config)のデフォルトのファイル名です/etc/ssh/sshd_config。時にはプログラム名(例:あまりにも)、または別の名前になることがman 5 passwdあります/etc/master.passwd

マニュアルページのインデックスを試しaproposたりクエリしたりできます。whatisここでは、apropos mosquitto.conf

関連情報