ユーザーが で関数を検索できるように、bash 関数のドキュメントを追加したいと思いますman
。私の関数と実際のコマンドの間に目に見える違いはないはずです。
man
自分の関数をチェックする関数でオーバーライドすることで、これを実行できることを知っています。別の方法はありますか?
マニュアルページを作成している場合(それ自体がタスクです/usr/local/man
)、システム全体の変数を編集し$MANPATH
て、その場所を含めるようにシステム全体の変数を編集します。その後、manページが利用可能になります。
実際のシェル関数は、個々のページではなく、組み込みコマンドによって文書化されています。それをオーバーライドする必要があります。しかし、私でさえそこに情報を求めません。man
help
/usr/local/man/manX
通常の man ページを生成してorに投げ込むだけ/usr/local/share/man/manX
です - あなたのディストリビューションがすでに提供しているものは何でも。/etc/manpath.config
このディレクトリがすでにそこに記載されていることを確認してください。MANPATH
そうすれば、スタートアップ ファイルを環境変数でいじる必要がなくなります。
各マンページには、これが関数でありコマンドではないこと、および違いが何であるかを説明する明確に見えるセクションも含まれている必要があります。
その後、社交的な部分が始まります。そのドキュメントについて、あらゆる機会に全員に伝えます。everyとは、適切なだけでなく、everyを意味します。:-)