HACK # 90 。 442 ー 9 章 BSD を完全に理解 and それぞれのフォーマットシーケンスの正確な意味に関心がある人は、 man 7gro 幵と実行し てマニュアルページを読んでほしい。関心を持つほどの時間がない人は、必要なセクション を見つけて自分のマニュアルページに追加すればよい。作成したファイルを保存し、独自の マニュアルページを man に渡して、うまく表示できるかどうかを確かめてほしい。 マニュアルページを印刷 マニュアルページを印刷しておくと便利なことが多い。マニュアルページをそのままプリ ンタに送ったことのある人は、期待どおりの結果にならなかった経験があるだろう。そうす る代わりに、 gro 幵を使用して、マニュアルページを印刷に適した形式に変換することができ る。一般には PostScript が最適だが、幸い gro 幵には PostScript への変換機能がある。 最初に、マニュアルページのソースの場所を正確に知ることが望ましい。こでも ls を例 に取り上げる。 % man -w 15 /usr/share/man/catl/ls. 1. gz (source: /usr/share/man/manl/ls. 1. gz) 今、関心があるのは ( at という単語が入っている方ではなく、ソースの場所だ。 ソースの場所がわかったら圧縮ファイルを zcat で展開し、その結果をパイプで gro 幵に送っ て、 gro 幵の出力を PostScript ファイルにリダイレクトする。 # zcat /usr/share/man/manl/ls. 1 ・ gz ー g て 0 幵〉 15. ps # file 15. ps ls. ps : PostScript document text conforming at level 3.0 特に何も指定しなければ、 gro 幵はマニュアルページを PostScript に変換したいのだと判断 するので、スイッチを付ける必要はない。 高度なハッキング ローカルの web サイトでマニュアルページを公開したければ、 gro 幵で HTML に変換すれ ばよい。詳しくは man lgro 幵を実行してマニュアルページを見てほしい。 PDF に変換することを望むなら、 ports またはパッケージのコレクションから GNU GhostScript をインストールすればよい。詳しい説明は、 man 1 gs を実行してマニュアルペー ジを読んでほしい。
HACK # 90 440 ー 9 章 BSD を完全に理解 intro(6) intro(7) intro(8) intro(9) - introduction t0 games - miscellaneous information pages - introduction tO system maintenance and operation commands - introduction t0 system kernel interfaces 特定のセクションのマニュアルページを読むには、 man コマンドとページの間にセクション 番号を指定して man 7 f00 などと実行すればよい。 マニュアルページを作成 表 9-1 に示す 3 つの gro 幵コマンドを知っているだけで、正しい形式のマー を手早く作り上げることができる。 表 9-1 groff のコマンド ーユアルペー ン コマンド . TH . SH NAME 用途 コメント タイトル 唯一の必要なセクション この程度で十分だということを納得するには、数分の時間をとって以下のマニュアルペー ジの例を入力してみればよい。入力し終えたら (root ユーザになって )/usr/local/man/manl/ boss. 1 に保存し、 man boss を実行してほしい。そして、フォーマットのシーケンスを、画面 上に現れた結果と比較するとよい。 . \ " boss のマ二ュアルページ。 . \ " 間違いや不足があれは、 admin@mycompany.com に連絡してほしい。 . TH man 1 " 04 January 2004 " " 1.0 " "boss man page' . SH NAME boss \ - boss のマニュアルページ . SH SYNOPSIS bOSS . SH DESCRIPTION boss ( 上司 ) とは、ドーナッと、たまに午後の休暇のゴルフで 癒すことができる頑固な生きものである。 . SH OPTIONS boss には、選べるオプションが全くない。 . SH SEE ALSO doughnut(l), golf ( 8 ) . SH BUGS 現在のところ既知のバグはない。
複数の環境を保守 .. フラグ .. フロッピーディスク . DOS フォーマット . 修復用フロッピー フォーマット . マウントを一般ユーザに許可 .. プロミスキャスモード . プロンプト . ヘッドレスシステム . ログをリモートに記録 . アクセスできなくなった場合 .. ポート 25 .. ン ま行 探す… 印刷 . マニュアルペー マスク . マウントボイント マウント マウス .. 無線ネットワーク 見栄えをよくする . 載っていない情報を探す .. 独自のマニュアルページを作成 . テキストを検索 .. メールサーバの最適化 .. 無線 NIC .. PF を使って保護 .. 488 ユーザ リモートからコンソールメッセージを見る 共有リソースを ~ .. 79 , 167 索引 … 271 .. 354 ... 78 .. 358 .. 84 .. 83 .. 211 .. 123 .. 125 .. 127-130 … 345 ... 206 .. 321 .. 441 ... 437 .. 439 .. 446 .. 443 .. 442 ... 349 .. 167 .. 19 … 236 文字列の検索 .. ~ との対話をスクリプトで処理 .. 設定ファイル . や行 ら行 ~ の動作を調べる .. Web サーバのログを統合 . ログ ローダをパスワードで保護 . レスポンス . 類語辞典 . リモート管理 . リビジョン管理 . リソース情報を表示 .. ライプロック . ライプファイルシステム . ログサーバの設定 .. プロンプトを変更 .. 制限 .. ログイン ログアウトを強制 .. 自動ログアウト . ログアウト ライプで参照 . .. 59 .. 32 … 371 … 457 .. 344 … 454 .. 452 … 249 … 461 .. 157 .. 122 ... 365 .. 370 ... 26 .. 27 .. 159 .. 132 .. 1 的 .. 128
独自のマ二ュアルページを作成 ー 4 引 HACK # 90 . SH AUTHOR Dru Lavigne (d1avigne6@sympatico.ca) に zmore に送る ( gzip 形式のマニュアルページを mo て e で直に読むことはできないので注意して 望ましい形式のものを見つければよい。そして、そのマニュアルページを man で開く代わり 自分のマニュアルページを見栄えのよい形式にしたければ、既存のマニュアルページから マニュアルページの見栄えをよくする ぞれのセクションにはどんな説明を書けばよいかがわかってくるだろう。 ENVIRONMENT( 環境変数 ) 、 SEEALSO( 関連項目 ) 、 HISTORY( 履歴 ) 、 BUGS( バグ ) がある。また、それ DESCRIPTION( 説明 ) 、 OPTIONS( オプション ) 、 EXAMPLES( 例 ) 、 DIAGNOSTICS( 診断メッセージ ) 、 他のマニュアルページを読んでみると、よく目にするセクションとして SYNOPSIS ( 書式 ) 、 は好きなだけいくつでも作成することができる。 た状態で現れる。 . SHN E ( 名前 ) は必須だということを覚えておいてほしい。 . SH セクション 最上部と最下部に現れる。セクション (. SH ) 行の情報は太字で現れ、それ以降の行は字下げし してほしい。これらの行はコメントだからだ。タイトル (. (H) 行の情報はマニュアルページの フォーマット済みのマニュアルページには . \ " で始まる行が全く入っていないことに注意 思い描けるだろう。 ページを覗いてみるとよい。そうすれば自分のマニュアルページをどのように見せたいかが に見えるだろう。実際に自分でマニュアルページを作成する前に、いくつかのマニュアル 上記のマニュアルページの例を眺めていると、あらゆるマニュアルページに似ているよう gzip /usr/local/man/manl/boss. 1 を実行してマニュアルページを圧縮してもよい。 % zmore /usr/share/man/manl/ls. 1. gz よい。例として ls が思い浮かぶ。そこで ls のマニュアルページを読んでみる。 例えばスイッチを書きたい場合、スイッチが載っているマニュアルページから拝借すれば ほしい ) 。 List a11 entries except for . lt F 1 A . BL -tag -width indent 明のフォーマットは以下のとおりだ。 スイッチの説明を字下げし、 " を白抜き文字で表示している。このスイッチと説 ションにスイッチが載っており、最初のスイッチは - A だ。このスイッチ自体を太字で表示し、 そして man ls の出力と比較してみる。このマニュアルページでは DES 〔 RIPTION ( 説明 ) のセク
マニュアルページを最大限ー 参照 ・ man manpath こ活用 ー 443 HAC K # 91 ・ man 7 gro 幵 (gro 幵フォーマットのコマンド。「 RequestShort Reference 」セクション を参照 ) ・ man 7 mdoc ( マニュアルページ作成用のテンプレートが載っている小さな手引き ) マニュアルページを最大限に活用 独自のマニュアルページの作成方法がわかったら、次に知りたいのはそれを最大限に活用する 方法だ Un ⅸシステムでは大半の文書がマニュアルページなので、それを最大限に活用する方法を 知っておく価値がある。システムにすべてのマニュアルページがインストールしてあるかど うかを、どうやって確認すればよいのだろうか。マニュアルページをすべて読むことなく、ど うやって必要な情報を突き止めればよいのだろうか。確かに、人生において少なくとも一度 は t ( sh のマニュアルページをすべて読み通すのは貴重な体験だが、特定のシェル変数だけに 関心があるときにすべてを読み通したくはないだろう。 インストールしたマニュアルページを見つける H A C K なにも設定をせすに whatis([Hack # 13D を実行しても、独自のマニュアルページやべンダ製 のアプリケーションのマニュアルページを見つけることはできない。これは不便なだけでな く、システムにインストールしたアプリケーションをユーザが最大限に活用するのを妨げる ことにもなる。 「 [Hack # 90 ] 独自のマニュアルページを作成」で紹介した /etc/manpath.config を思い出し % grep MAP /etc/manpath. config てほしい。 # MAN PATH MAP MAN PATH MAP MAN PATH MAP MAN PATH MAP MAN PATH MAP path element /bin /usr/bin /usr/local/bin /usr/X11R6/bin manpath element /usr/share/man /usr/share/man /usr/local/man /usr/X11R6/man whatis データベースを作成するコマンドは makewhatis だ。 makewhatis はデフォルトでは /usr/share/man だけを読み、 /usr/local/man と /usr/X11R6/man のマニュアルページを無視する。 そんなところにマニュアルページがあることは知らないからだ。 makewhatis の知らないマニュアルページを扱うには、 makewhatis に追加のディレクトリを渡
HACK # 90 独自のマ二ュアルページを作成 独自のマニュアルページを作成 H A C K ー 439 ユーザがどんな問題を解決する場合でも、 Unix の管理者として一言ですむ賢明なアドバイスは 「マニュアルを読め」と言うことだ マニュアルページがないとユーザが知らせてきたら、管理者はどうすればよいだろうか。 そのコマンドは独自に作成したアプリケーションやスクリプトかもしれない。あるいは、ど こかのべンダ製のプログラムで、マニュアルページが付いていなかったのかもしれない。そ んなときには、足りないマニュアルを自分で作成すればよい。 マニュアルページの作成はさほど難しいことではない。結局、マニュアルページは単なる テキストファイルにすぎない。もっと詳しく言うと、 g 幵マクロを散りばめたテキストファ イルを gzip 形式で圧縮したものだ ( きっと gro 幵という名前は、マニュアルページの解読を試 みたときに出る息の詰まるような声からきているのだろう ) 。 man コマンドが手品をするとき、 最初にマニュアルページを探す。そのためには、 manpath で参照できるディレクトリにマニュ アルページが存在しなければならない。 あたりまえのことではあるが、 manpath の設定ファイル /etc/manpath. config には以下のパス マニュアルページの基礎知識 % grep MAP /etc/manpath. config が入っている。 # MAN PATH MA P MAN PATH MAP MANPATH MAP MAN PATH MAP MAN PATH MAP path element /bin /usr/bin /usr/local/bin /usr/X11R6/bin manpath element /usr/share/man /usr/share/man /usr/local/man /usr/X11R6/man 基本的に、システムに付属のプログラムのマニュアルページは / usr / share / man に、べンダ 製アプリケーションのマニュアルページは /usr/local/man に、 X アプリケーションのマニュ アルページは / usr / X11R6 / man にある。これらのディレクトリの中を ls で覗いてみれば、 manl ~ man9 までのディレクトリ名が見つかる。マニュアルページの各セクションの意味を覚えて いない人は、次のようにしてみるとよい。 % whatis intro intro(l) intro(2) intro(3) intro(4) intro(5) - introduction t0 general commands ( t001S and utilities) - introduction tO system calls and error numbers - introduction to the C libraries - introduction t0 devices and device drivers - introduction to file formats
マニュアルページを最大限 ( 表 9-2 less のキー操作 Enter スペースパー ール ール 1 ページ下にスクロ 1 行だけ上にスクロ 1 行だけ下にスクロール 動作 マニュアルページの先頭に移動 1 ページ上に ( 前に ) スクロール 終了 ( マニュアルページ全体を読み通す必要はない ) less をカスタマイズ こ活用 ー 445 HAC K # 91 less が出力をどのようにフォーマットするかを試してみることが重要だ。例えばマニュア ルページを開くと、画面の最下部にプロンプトが現れてマニュアルページのうち何バイトを 読んだかを示す。そこで - m と入力すると、 1 つのコロン ( : ) だけの短いプロンプトに切り替わ る。 -M と入力すると長いプロンプトになり、現在見ている行の範囲を表示する。 いま何行目にいるかを知りたければ - N を試せばよい。独自のプロンプト文字列を作りたけ れば - P の説明を読んでほしい。 スクロールする行数 ( ウインドウサイズとも呼ぶ ) を変更することもできる。以下の例はウィ ンドウサイズを 10 行に変更している。 scroll window size : 10 S ( て 011 window size is 10 lines ([RETURN] を押す ) このように変更した後で [ スペース ] キーを押すと、画面全体でなく 10 行だけ下にスク ロールする。 ヘルプに載っている数十ものオプションを試しているうちに、現在のマニュアルページか ら抜け出すとそれまでのオプションが無効になることに気づくだろう。好みのオプションが 見つかったら ~ /. cshrc ファイルに追加して、いつも使用するように設定すればよい。 は -M ( 長いプロンプト ) と 10 行のウインドウサイズを設定してみる。 setenv LESS Mz10 このように、望みのオプションからスイッチ文字 ( - ) を取り除き、それらをつなげた文字列 を指定する。また、 setenv PAGER more という行を setenvPAGER less と変更する。そうしてお けば、ユーザの選択を尊重するアプリケーションは more でなく less を使用するようになる。 変更をテストするときには、設定ファイルをシェルに読み込ませた後でマニュアルページを
HACK # 91 444 ー 9 章 せばよい。 BSD を完全に理解 # makewhatis /usr/local/man /usr/X11R6/man スーパーユーザはいつでも ( 例えば新しいソフトウェアをインストールした後で ) このコマンドを実行することができる。忘れっぽい管理者、無精な管理者は、こ のコマンドを定期的な on ジョブとして登録しておくとよい。 こうすればユーザはシステム上のすべてのマニュアルページを知ることができる。 マニュアルページを見るときの秘訣 知りたいことを探し出すために、それと関係のない文書を大量に読まされることほど嫌な ことはない。必要な情報に的を絞って探していくほうが望ましい。マニュアルページを読む とき、 man コマンドはテキストをデフォルトのページ表示ツールに送る。それは情報をすばや く見つけ出せるツールだ。 FreeBSD4.1 では、ページ単位で表示するコマンドが more から less に置き換わった。 less には表示を操作するための便利なコマンドが豊富に用意されており、しかも操作方法をカス タマイズすることができる。言葉の意味とは逆に、 more よりも less のほうが多くの機能を備 えている。 あなたの . cshrc ファイルや man man では、デフォルトのページ表示ツールが more になっているかもしれないが、 less よりも more のほうが実際に機能が少ないこと を覚えておいてほしい。 less にはヘルプシステムが備わっており、操作方法の簡潔な一覧を見ることができる。 man コマンドを実行してマニュアルページを見ているときに ( または less でファイルを見ている ときに ) ヘルプ画面を表示するには、 h とだけ入力すればよい。 そのヘルプの内容をここに掲載することはやめておくが、表示を操作するためのキーをい くっか表 9-2 に紹介する。
tcsh シェルの便利な設定ファイルオプション スーパーユーザを含み、システムのすべてのユーザには、ホームディレクトリに ファイルがある。筆者のプロンプトの設定は次のようになっている。 druC: grep prompt ~ /. ( sh て ( if ($?prompt) then set prompt = "%B%n@%N%b : 7 . CShrc HACK # 2 これは tcsh のデフォルトのプロンプトではなく、筆者がカスタマイズしたお気に入りのプ ロンプトで、ここ数年にわたって使用している。プロンプトの書式で使用できる形式の一覧 があれば、その書式を理解するのは簡単だ。それは、 ( shr ( のマニュアルページの奥に入って いるので、すばやく見つけるには次のように実行すればよい。 dru@N: man ( Sh て ( /prompt may include こでは、 / を使用して、マニュアルページの検索ユーティリティを呼び出した。 "prompt may include" という文字列を検索すれば、適切なセクションを探し出して、古びた記憶を直 観的に呼び覚ますには十分だ。 マニュアルページに載っている書式と、筆者のプロンプト文字列とを見比べてほしい。筆 者のプロンプトの設定は次のようになっている。 表 1 -1 プロンプトの設定例 set prompt = "%B%n@%N%b: 少々ごちやごちゃしているが、表 1 -1 でオプションを分析してみる。 文字 %b 説明 現在の作業ディレクトリを表示 ( " / us ⅳ home / ユーザ名 " が " ~ " に置き換わるので、 % / 筆者の場合、プロンプトを見やすくするために、この文字を区切り文字として使用 プロンプトにログイン名を表示 太字に切り替え プロンプト文字列を開始 の場合よりもプロンプトが短くなる ) 太字を解除 筆者の場合、プロンプトとカーソルを区切るために プロンプト文字列を終了 この文字を区切り文字として使用
どうやって情報を探せばよいのかー 437 このコマンドは、 /usr/share/doc の HTML ファイルにすべての変更を統合する。日々の cvsup の実行にこのステップを追加すれば、オフラインの情報を常に最新版にしておくことがで きる。 マニュアルページに載っていない情報を探す これまでに、マニュアルページを読んでも特定のスイッチの動作がわからなかったことは ないだろうか。構文を理解できたつもりでも、実際に試してみると構文工ラーのメッセージ が出ることがある。さらに腹立たしいことに、インターネット上で具体的な例を探し回って も、同じマニュアルページへのリンクだけを何度も目にするかもしれない。 筆者がこんな状況に陥ったとき、プログラムのソースコードが答になるかもしれないと考 えた。あなたは次のように思うかもしれない。「私はプログラマではないので、自分の人生が ソースコードに左右されるとしても、ソースコードを読むことはできない。」そんな人も次の Hack に飛ばずに読み進んでほしい。コメントなら読めるだろうし、 FreeBSD の主要なソー スコードには十分なコメントが記述されている。 こで 1 つ例を示す。 mac 四 rtacl のマニュアルページを読むと、 MIB の構文を定めたルー ルの記述があった。 idtype : id : protocol : port [ , idtype : id : proto ( 01 : port,... ] しかし、このルールの具体的な例は載っていなかった。ルールの作成に成功するまでこの MAC ポリシーは何も実行しないので、実際的なルールの具体例を探した。ところがこのモ ジュールはかなり新しかったため、インターネット上を探しても解説や記事は見つからな かった。そこで、メーリングリストに質問を出す前にソースコードを覗いてみた。 C ソースファイルの場所を見つけるには locate コマンドを使用する。このコマンドに探し たい名前にェを付けて渡せばよい。 mac_portacl の場合は次のように実行する。 % locate mac_portacl. ( /usr/src/sys/security/mac portacl/mac portacl. c locate コマンドで C ソースファイルの場所を探すには、 src をインストールしておかなけ ればならない。また、見てのとおり、 C 言語で書かれたソースコードしか見つけることがで きない。幸い FreeBSD の主要なコードはほとんど C 言語で書かれている。 /sys/sysinstall を 実行して、 src ディストリビューションをすべてインストールすることができる。ディスク容 量が問題になる場合や、自分がログインするシステムにソースをインストールすることが好 ましくない場合には、 http://minnie.tuhs.org/FreeBSD-srctree/FreeBSD.html からソースコード をオンラインで見ることができる。 HAC K # 89