These manpages are repocopyed to man8.i386

PR:           docs/81715
Submitted by: Nobuyuki Koganemaru <n-kogane at syd dot odn dot ne dot jp>
This commit is contained in:
SUZUKI Koichi 2006-03-05 13:03:34 +00:00
parent a290fe08ef
commit 374f001714
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=27265
4 changed files with 3 additions and 473 deletions

View file

@ -10,8 +10,6 @@ MAN8 = IPXrouted.8\
amd.8\
amq.8\
ancontrol.8\
apm.8\
apmd.8\
arp.8\
asf.8\
atacontrol.8\
@ -314,7 +312,6 @@ MAN8 = IPXrouted.8\
zic.8\
zzz.8
MLINKS+=apm.8 apmconf.8
MLINKS+=boot_i386.8 boot.8
MLINKS+=bootpd.8 bootpgw.8
MLINKS+=bsdlabel.8 disklabel.8

View file

@ -1,159 +0,0 @@
.\" LP (Laptop Package)
.\"
.\" Copyright (c) 1994 by Tatsumi Hosokawa <hosokawa@jp.FreeBSD.org>
.\"
.\" This software may be used, modified, copied, and distributed, in
.\" both source and binary form provided that the above copyright and
.\" these terms are retained. Under no circumstances is the author
.\" responsible for the proper functioning of this software, nor does
.\" the author assume any responsibility for damages incurred with its
.\" use.
.\"
.\" %FreeBSD: src/usr.sbin/apm/apm.8,v 1.28 2004/07/02 23:12:39 ru Exp %
.\"
.\" $FreeBSD$
.Dd November 1, 1994
.Dt APM 8 i386
.Os
.Sh 名称
.Nm apm , zzz
.Nd APM BIOS の制御を行い、その情報を表示する
.Sh 書式
.Nm
.Op Fl ablstzZ
.Op Fl d Ar enable
.Op Fl e Ar enable
.Op Fl h Ar enable
.Op Fl r Ar delta
.Pp
.Nm zzz
.Sh 解説
.Nm
ユーティリティは、
Intel / Microsoft APM (Advanced Power Management) BIOS を制御し、
ラップトップ PC 上の APM の現在の状態を表示します。
.Nm zzz
ユーティリティは、APM 制御によって、システムをサスペンドします。
.Pp
以下のオプションが
.Nm
で利用可能です
(
.Nm zzz
には、オプションはありません)。
オプションが与えられなかった場合は、
.Nm
は、現在の APM の状態や情報を冗長モードで表示します。
複数の表示オプションが指定された場合、
ここに示す順番で値を 1 行に 1 つずつ表示します。
.Bl -tag -width indent
.It Fl a
現在の AC 電源の状態を整数値で表示します。
0, 1がそれぞれ
.Dq 外れている (off-line)
状態と
.Dq つながっている (on-line)
状態をあらわします。
.It Fl b
整数値で、現在のバッテリ状態を表示します。
0, 1, 2, 3という値はそれぞれ、
.Dq 良好 (high)
状態、
.Dq 低バッテリ (low)
状態、
.Dq 危険 (critical)
状態、
.Dq 充電 (charging)
状態をあらわします。
.It Fl d Ar enable
通常のサスペンドとディスプレイのサスペンドを別に扱わない/別に扱うを、
ブール値
.Ar enable
で制御します。
この引数は Libretto 30CT や 50CT を含む
多種のラップトップで動作しないようです。
.It Fl e Ar enable
ブール値引数
.Ar enable
に依存して、コンピュータの APM 機能の有効/無効を切り替えます。
.It Fl h Ar enable
ブール値引数
.Ar enable
に依存して、
カーネルコンテキストスイッチルーチン中の HLT 命令の有効/無効を切り替えます。
これらのオプションは、ほとんど全ての APM の実装においては不要ですが、
.Dq Pa Idle CPU
呼び出しが CPU クロックの減速と HLT 命令を同時に実行する場合は、
そのピーク性能の減少からシステムをまもるために
.Fl h Cm false
オプションが必要です。
詳細については、
.Xr apm 4
を参照してください。
.It Fl l
現在のバッテリの残り割合を表示します。
もし、あなたのラップトップがこの機能を提供していない時には、
255 が表示されます。
.It Fl r Ar delta
ラップトップがサポートしている場合、
レジュームウェイクアップタイマを有効にします。
これによりラップトップがサスペンドされるわけではありませんが、
ラップトップがサスペンドされ
サスペンドからのレジュームがサポートされている場合、
.Ar delta
秒後にラップトップがレジュームします
(サスペンドした時刻を起点とするのではなく、
本コマンドを実行した時間を起点とします)。
.It Fl s
APM サポート状態を整数値で表示します。
0, 1 という値はそれぞれ、
.Dq 利用不可 (disabled)
状態
.Dq 利用可能 (enabled)
状態
をあらわします。
.It Fl t
残りのバッテリ時間を予測して、秒単位で表示します。
分からない場合には -1 を表示します。
.It Fl Z
スタンバイモードに移行します。
本モードではフルパワーモード未満、サスペンドモード以上の電力消費となります。
タイマもしくはリングインジケータイベントにより、
この状態からレジュームする機能をサポートするラップトップがあります。
.Nm
の出力により、ラップトップが何をサポートすると主張しているかが分かります。
.It Fl z
システムをサスペンドします。これは、
.Nm zzz
と等価です。
.El
.Sh バグ
いくつかの APM 実装では、
.Nm
が必要とするパラメータが提供されていません。
そのようなシステムに於いては、
.Nm
は、それらを知らないと表示します。
.Pp
いくつかの APM 実装では、電源スイッチを押したことやカバーが
閉められたことなどのイベントを扱うことができません。
そのような実装に於いては、
システムは
.Nm
.Nm zzz
.Ar だけを
つかってサスペンドする
.Ar べき
です。
.Sh
.Xr apmconf 8
.Nm
にマージされ、
.Nm
が全機能を置き換えました。
.Sh 関連項目
.Xr apm 4
.Sh 作者
.An Tatsumi Hosokawa Aq hosokawa@jp.FreeBSD.org

View file

@ -1,310 +0,0 @@
.\" Copyright (c) 1999 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
.\" Copyright (c) 1999 KOIE Hidetaka <koie@suri.co.jp>
.\" Copyright (c) 1999 Yoshihiko SARUMARU <mistral@imasy.or.jp>
.\" Copyright (c) 1999 Norihiro Kumagai <kuma@nk.rim.or.jp>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" @(#)apmd.8 1.1 (FreeBSD) 6/28/99
.\" %FreeBSD: src/usr.sbin/apmd/apmd.8,v 1.19 2004/07/03 18:35:50 ru Exp %
.\"
.\" $FreeBSD$
.\"
.Dd June 28, 1999
.Dt APMD 8 i386
.Os
.Sh 名称
.Nm apmd
.Nd Advanced Power Management 監視デーモン
.Sh 書式
.Nm
.Op Fl d
.Op Fl f file
.Op Fl s
.Op Fl v
.Sh 解説
.Nm
ユーティリティは、指定した Advanced Power Management
.Pq Tn APM
イベントを監視し、
いずれかのイベントが発生した場合、
対応するコマンドシーケンスを実行します。
設定ファイルで指定されたイベントのみが
.Nm
へ通知され、それ以外のイベントは無視されます。
APM BIOS によって発行された
イベントに対して、
.Nm
は設定ファイルで指定されたコマンドシーケンスを実行します。
.Nm
をサスペンド/スタンバイを監視するようにして起動すると、
カーネルはそれらの要求イベントに対する
処理を行いません。
そのためそれらのイベント発生時に
処理をさせたい場合は、適切なコマンドまたは組み込み関数を
明示的に設定ファイルに指定する必要があります。
.Pp
.Nm
ユーティリティは以下の実行時オプションを理解します。
.Bl -tag -width -f_file
.It Fl d
デバッグモードで起動します。
デーモンモードではなくフォアグラウンドで動作します。
.It Fl f Ar file
デフォルトの設定ファイル
.Pa /etc/apmd.conf
の代りに使用する、別の設定ファイル
.Ar file
を指定します。
.It Fl s
電源状態の変更が検出されたが (AC_POWER_STATE)
ラップトップの BIOS がそれを報告しないときに、
.Nm
に POWERSTATECHANGE イベントをシミュレートさせます。
これにより、電源コードを抜いたときに LCD バックライトを暗くする
といったことが可能になります。
.It Fl v
冗長モードで動作します。
.El
.Pp
.Nm
は起動時に設定ファイル
(デフォルトは
.Pa /etc/apmd.conf )
を読み込み、
監視すべきイベントを APM デバイスドライバへ通知します。
終了時には APM デバイスドライバはイベントの監視を自動的に解除します。
.Pp
.Nm
プロセスがシグナル SIGHUP を受信すると、設定ファイルを読み込み直して、
設定の変更内容を APM デバイスドライバに通知します。
.Pp
.Nm
ユーティリティは、デバイスファイル
.Pa /dev/apmctl
を経由して、イベントの受け取りや APM システム制御用の
.Xr ioctl 2
要求を発行します。
このデバイスファイルは排他制御されてオープンされるため、
.Nm
プロセスは同時に 1 つのみ起動可能です。
.Pp
.Nm
が APM イベントを受け取ると、設定ファイルで指定された
イベントに対応するコマンドリストを実行するために
子プロセスを生成し、再び APM イベントの待ち状態になります。
生成された子プロセスは、
指定されたコマンドを 1 つずつ列挙された順番に実行します。
.Pp
.Nm
が SUSPEND/STANDBY 要求に対するコマンドリストを処理している間、
カーネル内の APM デバイスドライバは、APM BIOS に対して
毎秒 1 回以上通知を発行し続けます。
これによって BIOS は、コマンド処理中であり要求が
まだ完結していないことを認識します。
.Pp
.Nm
ユーティリティはファイル
.Pa /var/run/apmd.pid
を作成し、プロセス ID を記録します。これは
.Nm
を kill や、設定ファイルを読み込ませるために使えます。
.Sh 設定ファイル
.Nm
の設定ファイルの構造は非常にシンプルです。
例えば次のようになります。
.Pp
.Bd -literal
apm_event SUSPENDREQ {
exec "sync && sync && sync";
exec "sleep 1";
exec "zzz";
}
.Ed
.Pp
この例では、APM イベント
.Ql SUSPENDREQ
(ディスプレイを閉じた時などに発生します) を
.Nm
が受け取ると、
.Ql sync
コマンドを 3 回実行し、少し待ったあとに
.Nm zzz ( Ns Nm apm Fl z )
を実行してシステムをサスペンドさせます。
.Pp
.Bl -bullet
.It
apm_event キーワード
.Bd -ragged -offset indent
.Ql apm_event
はキーワードであり、イベントごとの設定の開始を指示します。
.Ed
.It
APM イベント
.Bd -ragged -offset indent
複数のイベントに対して同じ処理を実行したい場合は、それらのイベント名を
コンマで区切って指定します。
有効なイベント名は次の通りです。
.Bl -item
.It
-
.Nm
が起動されているとカーネルでの処理を行わなくなるイベント:
.Pp
.Bl -tag -width USERSUSPENDREQ -compact -offset indent
.It STANDBYREQ
.It USERSTANDBYREQ
.It SUSPENDREQ
コマンドリストに sync を含めることをおすすめします
.It USERSUSPENDREQ
コマンドリストに sync を含めることをおすすめします
.It BATTERYLOW
コマンドリストは zzz のみをおすすめします
.El
.It
- カーネルの処理終了後に
.Nm
へ通知されるイベント:
.Pp
.Bl -tag -width USERSUSPENDREQ -compact -offset indent
.It NORMRESUME
.It CRITRESUME
.It STANDBYRESUME
.It POWERSTATECHANGE
.It UPDATETIME
.It CAPABILITIESCHANGE
.El
.Pp
上記以外のイベントは
.Nm
へ通知されません。
.El
.Ed
.It
コマンドライン文法
.Bd -ragged -offset indent
前述の例では、
.Ql exec
から始まる 3 行はイベントに対するコマンドです。
それぞれの行はセミコロンで終了している必要があります。
イベントに対するコマンドリストは
.Ql {
.Ql }
で囲みます。
.Nm
ユーティリティは、ダブルクォーテーションで囲まれたコマンドの実行に
.Xr system 3
と同様に
.Pa /bin/sh
を使用します。
各コマンドはコマンドリストの最後に到達するか 0 以外の
終了コードで終わるまで順番に実行されます。
.Nm
ユーティリティは、失敗したコマンドの終了コードを、
.Xr syslog 3
経由で報告します。
加えて APM BIOS からの要求イベントを取り消します。
.Ed
.It
組み込み関数
.Bd -ragged -offset indent
コマンド行の代りに
.Nm
の組み込み関数を指定できます。組み込み関数はコマンド行と同様に
セミコロンで終了します。次の組み込み関数が現在サポートされています。
.Bl -item
.It
- reject:
.Bd -ragged -offset indent
APM BIOS からの直前の要求を拒否します。
ディスプレイを閉じた時に発生する SUSPEND 要求を拒否して、
代りに STANDBY 状態にしたい場合などに使用します。
.Ed
.El
.Ed
.El
.Sh 使用例
設定ファイルのサンプルには、以下のものが含まれています。
.Bd -literal
apm_event SUSPENDREQ {
exec "/etc/rc.suspend apm suspend";
}
apm_event USERSUSPENDREQ {
exec "sync && sync && sync";
exec "sleep 1";
exec "apm -z";
}
apm_event NORMRESUME {
exec "/etc/rc.resume apm suspend";
}
apm_event STANDBYRESUME {
exec "/etc/rc.resume apm standby";
}
# resume event configuration for serial mouse users by
# reinitializing a moused(8) connected to a serial port.
#
#apm_event NORMRESUME {
# exec "kill -HUP `cat /var/run/moused.pid`";
#}
# suspend request event configuration for ATA HDD users:
# execute standby instead of suspend.
#
#apm_event SUSPENDREQ {
# reject;
# exec "sync && sync && sync";
# exec "sleep 1";
# exec "apm -Z";
#}
.Ed
.Sh 関連ファイル
.Bl -tag -width /etc/apmd.conf -compact
.It Pa /etc/apmd.conf
.It Pa /dev/apmctl
.It Pa /var/run/apmd.pid
.El
.Sh 関連項目
.Xr apm 4 ,
.Xr apm 8
.Sh 作者
.An Mitsuru IWASAKI Aq iwasaki@FreeBSD.org
.An KOIE Hidetaka Aq koie@suri.co.jp
.Pp
また、
.An Warner Losh Aq imp@FreeBSD.org ,
.An Hiroshi Yamashita Aq bluemoon@msj.biglobe.ne.jp ,
.An Yoshihiko SARUMARU Aq mistral@imasy.or.jp ,
.An Norihiro Kumagai Aq kuma@nk.rim.or.jp ,
.An NAKAGAWA Yoshihisa Aq nakagawa@jp.FreeBSD.org ,
.An Nick Hilliard Aq nick@foobar.org
による貢献がありました。
.Sh 歴史
.Nm
ユーティリティは
.Fx 3.3
から登場しました。

View file

@ -3,6 +3,8 @@
MAN= apm.8 \
apmd.8
MANSUBDIR=/i386
MLINKS+=apm.8 apmconf.8
MANSUBDIR=/i386
.include <bsd.prog.mk>