+++ /dev/null
-Mon Oct 10 18:02:03 JST 2005 JM ML to CVS Gateway
-
- * translation_list: [JM:11941]
- * draft/man8/restore.8: [JM:11941]
-
-Mon Oct 10 18:02:03 JST 2005 JM ML to CVS Gateway
-
- * translation_list: [JM:11940]
-
-Mon Oct 10 18:01:54 JST 2005 JM ML to CVS Gateway
-
- * translation_list: [JM:11939]
- * draft/man8/dump.8: [JM:11939]
-
-Mon Oct 10 18:01:54 JST 2005 JM ML to CVS Gateway
-
- * translation_list: [JM:11938]
-
-Sun Oct 2 07:50:56 JST 2005 Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
-
- * original/*: dump-0.40b40 を import
+++ /dev/null
-.\" Copyright (c) 1980, 1991, 1993
-.\" Regents of the University of California.
-.\" All rights reserved.
-.\"
-.\"
-.\" Japanese Version Copyright (c) 2004 Takashi Nishida
-.\" all rights reserved.
-.\" Translated Sat Sat Sep 24 15:51:25 JST 2005 (ver0.03)
-.\" by Takashi Nishida
-.\"
-.\"
-.\"
-.\" 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.
-.\" 3. Neither the name of the University nor the names of its contributors
-.\" may be used to endorse or promote products derived from this software
-.\" without specific prior written permission.
-.\"
-.\" 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.
-.\"
-.\" $Id: dump.8.in,v 1.57 2004/07/13 08:17:32 stelian Exp $
-.\"
-.\"WORD: end-of-media indication メディア終端検出
-.\"WORD: incremental backup 増分バックアップ
-.\"WORD: end-of-media メディア終端
-.\"WORD: save 保存
-.\"WORD: feature 機能
-.\"WORD: modified Tower of Hanoi algorithm 修正版のハノイの塔アルゴリズム
-.\"
-.TH DUMP 8 "version 0.4b40 of May 2, 2005" BSD "System management commands"
-.\"O .SH NAME
-.SH 名前
-.\"O dump \- ext2/3 filesystem backup
-dump \- ext2/3 ファイルシステムのバックアップ
-.\"O .SH SYNOPSIS
-.SH 書式
-.\"O .B dump
-.\"O [\fB\-\fIlevel#\fR]
-.\"O [\fB\-ackMnqSuv]
-.\"O [\fB\-A \fIfile\fR]
-.\"O [\fB\-B \fIrecords\fR]
-.\"O [\fB\-b \fIblocksize\fR]
-.\"O [\fB\-d \fIdensity\fR]
-.\"O [\fB\-D \fIfile\fR]
-.\"O [\fB\-e \fIinode numbers\fR]
-.\"O [\fB\-E \fIfile\fR]
-.\"O [\fB\-f \fIfile\fR]
-.\"O [\fB\-F \fIscript\fR]
-.\"O [\fB\-h \fIlevel\fR]
-.\"O [\fB\-I \fInr errors\fR]
-.\"O [\fB\-j\fIcompression level\fR]
-.\"O [\fB\-L \fIlabel\fR]
-.\"O [\fB\-Q \fIfile\fR]
-.\"O [\fB\-s \fIfeet\fR]
-.\"O [\fB\-T \fIdate\fR]
-.\"O [\fB\-y\fR]
-.\"O [\fB\-z\fIcompression level\fR]
-.\"O .I files-to-dump
-.\"O .PP
-.\"O .B dump
-.\"O [\fB\-W \fR| \fB\-w\fR]
-.B dump
-[\fB\-\fIlevel#\fR]
-[\fB\-ackMnqSuv]
-[\fB\-A \fIfile\fR]
-[\fB\-B \fIrecords\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-d \fIdensity\fR]
-[\fB\-D \fIfile\fR]
-[\fB\-e \fIinode numbers\fR]
-[\fB\-E \fIfile\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-h \fIlevel\fR]
-[\fB\-I \fInr errors\fR]
-[\fB\-j\fIcompression level\fR]
-[\fB\-L \fIlabel\fR]
-[\fB\-Q \fIfile\fR]
-[\fB\-s \fIfeet\fR]
-[\fB\-T \fIdate\fR]
-[\fB\-y\fR]
-[\fB\-z\fIcompression level\fR]
-.I files-to-dump
-.PP
-.B dump
-[\fB\-W \fR| \fB\-w\fR]
-.\"O .SH DESCRIPTION
-.SH 説明
-.\"O .B Dump
-.\"O examines files on an ext2/3 filesystem and determines which files need to be
-.\"O backed up. These files are copied to the given disk, tape or other storage
-.\"O medium for safe keeping (see the
-.\"O .B \-f
-.\"O option below for doing remote backups). A dump that is larger than the output
-.\"O medium is broken into multiple volumes. On most media the size is determined by
-.\"O writing until an end-of-media indication is returned.
-.B dump
-は ext2/3 ファイルシステム上のファイルを調べて、バックアップする必要のある
-ファイルを決定し、それらのファイルを
-指定されたディスクやテープ、その他の保管用の記憶メディアにコピーする
-(リモートバックアップを行う場合は下記の
-.B \-f
-オプションを参照のこと)。
-出力メディアより大きなダンプは複数のボリュームに分割される。
-多くのメディアでは、サイズの決定はメディア終端検出 (end-of-media indication)
-が返ってくるまで書き込むことで行われる。
-.\"O .PP
-.PP
-.\"O On media that cannot reliably return an end-of-media indication (such as some
-.\"O cartridge tape drives), each volume is of a fixed size; the actual size is
-.\"O determined by specifying cartridge media, or via the tape size, density and/or
-.\"O block count options below. By default, the same output file name is used for
-.\"O each volume after prompting the operator to change media.
-(いくつかのカートリッジテープドライブのように)
-メディア終端検出が返さないことがあるメディアでは、
-それぞれのボリュームは固定サイズとなる。
-実際のサイズの決定は、カートリッジメディアの指定、つまり
-テープのサイズ、密度やブロック数 (下記参照) を通じて行われる。
-デフォルトでは、オペレータにメディア交換を指示した後の各ボリュームでも
-同じ出力ファイル名が使われる。
-.\"O .PP
-.PP
-.\"O .I files-to-dump
-.\"O is either a mountpoint of a filesystem or a list of files and directories to be
-.\"O backed up as a subset of a filesystem. In the former case, either the path to a
-.\"O mounted filesystem or the device of an unmounted filesystem can be used. In the
-.\"O latter case, certain restrictions are placed on the backup:
-.\"O .B \-u
-.\"O is not allowed, the only dump level that is supported is
-.\"O .B 0
-.\"O and all the files and directories must reside on the same filesystem.
-.I ダンプされるファイル
-は、ファイルシステムのマウントポイント、もしくは、
-ファイルシステムの一部としてバックアップされる
-ファイルやディレクトリのリスト、
-のいずれかである。
-前者の場合、ファイルの指定は、
-マウントされているファイルシステムのパスと、
-マウントされていないファイルシステムのデバイスの、
-いずれでも可能である。
-後者の場合、バックアップには若干の制限がある:
-.B \-u
-は使用できず、
-サポートされるダンプレベルは
-.B 0
-だけであり、すべてのファイルとディレクトリは同一ファイルシステム上に
-属していないといけない。
-.\"O .SH OPTIONS
-.\"O The following options are supported by
-.\"O .B dump:
-.SH オプション
-.B dump
-では以下のオプションがサポートされている:
-.\"O .TP
-.\"O- .BI \-0\-9
-.\"O- Dump levels. A level 0, full backup, guarantees the entire file system is
-.\"O- copied (but see also the
-.\"O+ .BI \-level#
-.\"O+ The dump level (any integer). A level 0, full backup, guarantees the
-.\"O+ entire file system is copied (but see also the
-.\"O .B \-h
-.\"O option below). A level number above 0, incremental backup, tells
-.\"O .B dump
-.\"O to
-.\"O copy all files new or modified since the last dump of a lower level. The
-.\"O- default level is 9.
-.\"O+ default level is 9. Historically only levels 0 to 9 were usable in
-.\"O+ dump, this version is able to understand any integer as a dump level.
-.TP
-.BI \-0\-9
-ダンプレベル (dump level)。
-レベル 0 はフルバックアップで、ファイルシステム全体のコピーを保証する
-(但し、以下の
-.B \-h
-オプションを見ること)。
-0 より大きいレベル番号は増分バックアップ (incremental backup) で、
-そのレベルより番号が小さいレベルの最後のダンプ以後の
-新しいファイルと修正されたファイルすべてのコピーを指示する。
-デフォルトのレベルは 9 である。
-.\"O .TP
-.\"O .BI \-a
-.\"O \*(lqauto-size\*(rq. Bypass all tape length calculations, and write until an
-.\"O end-of-media indication is returned. This works best for most modern tape
-.\"O drives, and is the default. Use of this option is particularly recommended when
-.\"O appending to an existing tape, or using a tape drive with hardware compression
-.\"O (where you can never be sure about the compression ratio).
-.TP
-.BI \-a
-\*(lqオートサイズ\*(rq。
-テープ長の計算すべてをスキップし、
-メディア終端検出が返ってくるまで書き込む。
-このオプションは最近のテープドライブの多くでうまく動作し、デフォルトで有効で
-ある。現在使用中のテープへの追記や、ハードウェア圧縮機能を持つテープドライブ
-を利用する際には、このオプションの使用を特に推奨する。
-.\"O .TP
-.\"O .BI \-A " archive_file"
-.\"O Archive a dump table-of-contents in the specified
-.\"O .I archive_file
-.\"O to be used by
-.\"O .BR restore (8)
-.\"O to determine whether a file is in the dump file that is being restored.
-.TP
-.BI \-A " archive_file"
-ダンプの内容一覧を、指定した
-.I archive_file
-に収録する。
-このダンプの内容一覧は、
-.BR restore (8)
-があるファイルが
-リストアしようとするダンプファイルの中にあるかどうかを
-判断するのに利用できる。
-.\"O .TP
-.\"O .BI \-b " blocksize"
-.\"O- The number of kilobytes per dump record. The default blocksize is 10
-.\"O- and the maximal value is 1024.
-.\"O+ The number of kilobytes per dump record. The default blocksize is 10,
-.\"O+ unless the
-.\"O+ .B \-d
-.\"O+ option has been used to specify a tape density of 6250BPI or more,
-.\"O+ in which case the default blocksize is 32. Th maximal value is 1024.
-.\"O Note however that, since the IO system slices all requests into chunks
-.\"O of
-.\"O .B MAXBSIZE
-.\"O (which can be as low as 64kB), you can experience problems with
-.\"O .BR dump (8)
-.\"O and
-.\"O .BR restore (8)
-.\"O when using a higher value, depending on your kernel and/or libC versions.
-.TP
-.BI \-b " blocksize"
-ダンプレコード (dump record) のキロバイト数。
-ブロックサイズ (block size) はデフォルトでは 10 で、最大値は 1024 である。
-注意すべきこととして、
-IO システムではすべての IO 要求は
-.B MAXBSIZE
-の塊 (64kB という小さな大きさのこともある) に分割されるので、
-カーネルや libC のバージョンによっては、
-.BR dump (8)
-や
-.BR restore (8)
-でブロックサイズに大きな値を用いると問題が起こる場合がある。
-.\"O .TP
-.\"O .BI \-B " records"
-.\"O The number of 1 kB blocks per volume. Not normally required, as
-.\"O .B dump
-.\"O can detect end-of-media. When the specified size is reached,
-.\"O .B dump
-.\"O waits for you to change the volume. This option overrides the calculation of
-.\"O tape size based on length and density. If compression is on this limits the
-.\"O- size of the compressed output per volume.
-.\"O+ size of the compressed output per volume. Multiple values may be given
-.\"O+ as a single argument separated by commas. Each value will be used for one
-.\"O+ dump volume in the order listed; if
-.\"O+ .B dump
-.\"O+ creates more volumes than the
-.\"O+ number of values given, the last value will be used for the remaining
-.\"O+ volumes. This is useful for filling up already partially filled media
-.\"O+ (and then continuing with full size volumes on empty media) or mixing media
-.\"O+ of different sizes.
-.TP
-.BI \-B " records"
-ボリュームの 1kB ブロックの数。
-.B dump
-はメディア終端 (end-of-media) が検出できるので、
-通常は必要ではない。
-指定された数値に到達すると、
-.B dump
-はユーザがボリュームを交換するのを待つ。
-このオプションは、テープ長と密度に基づくテープサイズの計算よりも
-優先される。圧縮が有効の場合は、この値による制限は
-ボリュームあたりの圧縮出力のサイズに適用される。
-.\"O .TP
-.\"O .BI \-c
-.\"O Change the defaults for use with a cartridge tape drive, with a density of 8000
-.\"O bpi, and a length of 1700 feet. Specifying a cartridge drive overrides the
-.\"O end-of-media detection.
-.TP
-.BI \-c
-デフォルト設定をカートリッジテープドライブ用、すなわち密度 800 bpi、
-長さ 1700 feet に変更する。
-カートリッジドライブの指定はメディア終端検出よりも優先される。
-.\"O .TP
-.\"O .BI \-d " density"
-.\"O Set tape density to
-.\"O .IR density .
-.\"O The default is 1600BPI. Specifying a tape density overrides the end-of-media
-.\"O detection.
-.TP
-.BI \-d " density"
-テープの密度を
-.IR density
-に設定する。
-デフォルトは 1600BPI。
-テープ密度の指定は
-メディア終端検出よりも優先される。
-.\"O .TP
-.\"O .BI \-D " file"
-.\"O Set the path name of the file storing the information about the previous
-.\"O full and incremental dumps. The default location is
-.\"O .IR /etc/dumpdates .
-.TP
-.BI \-D " file"
-過去のフルダンプと増分ダンプに関する情報を格納するファイルのパス名を設定する。
-デフォルトの場所は
-.IR /etc/dumpdates
-。
-.\"O .TP
-.\"O .BI \-e " inodes"
-.\"O Exclude
-.\"O .I inodes
-.\"O from the dump. The
-.\"O .I inodes
-.\"O parameter is a comma separated list of inode numbers (you can use
-.\"O .BR stat (1)
-.\"O to find the inode number for a file or directory).
-.TP
-.BI \-e " inodes"
-ダンプから
-.I inodes
-を除外する。
-引数
-.I inodes
-はコンマで区切った inode 番号のリストである
-(ファイルやディレクトリの inode 番号を知るには
-.BR stat (1)
-が使える)。
-.\"O .TP
-.\"O .BI \-E " file"
-.\"O Read list of inodes to be excluded from the dump from the text file
-.\"O .IR file .
-.\"O The file
-.\"O .I file
-.\"O should be an ordinary file containing inode numbers separated by newlines.
-.TP
-.BI \-E " file"
-ダンプから除外する inode のリストを
-テキストファイル
-.IR file
-から読む。
-ファイル
-.I file
-は、改行で区切られた inode 番号を含む通常のファイルでなければならない。
-.\"O .TP
-.\"O .BI \-f " file"
-.\"O Write the backup to
-.\"O .IR file ;
-.\"O .I file
-.\"O may be a special device file like
-.\"O .I /dev/st0
-.\"O (a tape drive),
-.\"O .I /dev/rsd1c
-.\"O (a floppy disk drive), an ordinary file, or
-.\"O .I \-
-.\"O (the standard output). Multiple file names may be given as a single argument
-.\"O separated by commas. Each file will be used for one dump volume in the order
-.\"O listed; if the dump requires more volumes than the number of names given,
-.\"O the last file name will used for all remaining volumes after prompting for
-.\"O media changes. If the name of the file is of the form
-.\"O .I host:file
-.\"O or
-.\"O .I user@host:file
-.\"O .B dump
-.\"O- writes to the named file on the remote host using
-.\"O+ writes to the named file on the remote host (which should already
-.\"O+ exist, dump doesn't create a new remote file) using
-.\"O .BR rmt (8).
-.\"O The default path name of the remote
-.\"O .BR rmt (8)
-.\"O program is
-.\"O .IR /etc/rmt ;
-.\"O this can be overridden by the environment variable
-.\"O .BR RMT .
-.TP
-.BI \-f " file"
-バックアップを
-.IR file
-に書きこむ。
-.I file
-としては
-.I /dev/st0
-(テープドライブ) や
-.I /dev/rsd1c
-(フロッピーディスクドライブ) のようなデバイスファイル、
-通常のファイル、
-.I \-
-(標準出力)
-が指定可能である。
-カンマで区切ることで、複数のファイル名を一つの引き数に指定することが
-できる。それぞれのファイルは、リストに指定された順番で、一つのダンプ
-ボリュームとして使われる。指定したファイル名の数よりも多くのボリュームが
-必要な場合、最後のファイル名が残りすべてのボリュームで使用される
-(ボリューム感ではメディア変更のプロンプトが出される)。
-ファイル名が
-.I host:file
-か
-.I user@host:file
-の形式の場合、
-.B dump
-は
-.BR rmt (8)
-を使って
-リモートホスト上のファイルに書き込みを行う。
-リモートの
-.BR rmt (8)
-プラグラムのデフォルトのパス名は
-.IR /etc/rmt
-である。このパスは環境変数
-.BR RMT
-により上書きできる。
-.\"O .TP
-.\"O .BI \-F " script"
-.\"O Run script at the end of each tape (except for the last one).
-.\"O The device name and the current volume number are passed on the
-.\"O command line. The script must return 0 if
-.\"O .B dump
-.\"O should continue without asking the user to change the tape, 1 if
-.\"O .B dump
-.\"O should continue but ask the user to change the tape. Any other exit code will
-.\"O cause
-.\"O .B dump
-.\"O to abort. For security reasons,
-.\"O .B dump
-.\"O reverts back to the real user ID and the real group ID before running the
-.\"O script.
-.TP
-.BI \-F " script"
-各テープの終りでスクリプト script を走らせる (最後の1巻は除外)。
-デバイス名と現在のボリューム番号がコマンドラインに渡される。
-.B dump
-がテープ交換の要求を行わずに処理を続けるには、スクリプトは 0 を
-返さなければならない。
-1 を返すと、
-.B dump
-はテープ交換を要求する。
-他の終了コードの場合、
-.B dump
-は中止 (abort) する。
-セキュリティ上の理由により、
-スクリプトを走らせる前に
-.B dump
-は実ユーザー ID, 実グループ ID に戻る。
-.\"O .TP
-.\"O .BI \-h " level"
-.\"O Honor the user
-.\"O .B nodump
-.\"O flag
-.\"O .B UF_NODUMP
-.\"O only for dumps at or above the given
-.\"O .IR level .
-.\"O The default honor level is 1, so that incremental backups omit such files but
-.\"O full backups retain them.
-.TP
-.BI \-h " level"
-指定した
-.I level
-以上のダンプでのみ
-ユーザの
-.B nodump
-フラグ
-.B UF_NODUMP
-に従う。
-デフォルトの honor level は 1 であり、したがって
-増分バックアップではそのようなファイルは無視されるが、
-フルバックアップでは保存される。
-.\"O .TP
-.\"O .BI \-I " nr errors"
-.\"O By default,
-.\"O .B dump
-.\"O will ignore the first 32 read errors on the file system before asking for
-.\"O operator intervention. You can change this using this flag to any value. This
-.\"O is useful when running
-.\"O .B dump
-.\"O on an active filesystem where read errors simply indicate an inconsistency
-.\"O between the mapping and dumping passes.
-.\"O .IP
-.\"O A value of 0 means that all read errors will be ignored.
-.TP
-.BI \-I " nr errors"
-デフォルトでは、
-.B dump
-はファイルシステムのリードエラーは最初の 32 件は無視されるが、
-その後はユーザに対処を要求する。
-このフラグを使うと、この件数を任意の値に変えることができる。
-稼働状態にあるファイルシステムで
-.B dump
-を走らせる際に、リードエラーとしてマッピングとダンプ処理の間の矛盾を
-示すエラーだけが発生するような場合に、このオプションは便利である。
-.IP
-値が 0 の場合、リードエラーがすべて無視される。
-.\"O .TP
-.\"O .BI \-j "compression level"
-.\"O Compress every block to be written on the tape using bzlib library. This option
-.\"O will work only when dumping to a file or pipe or, when dumping to a tape drive,
-.\"O if the tape drive is capable of writing variable length blocks. You will need
-.\"O at least the 0.4b24 version of
-.\"O .B restore
-.\"O in order to extract compressed tapes. Tapes written using compression will not
-.\"O be compatible with the BSD tape format. The (optional) parameter specifies the
-.\"O compression level bzlib will use. The default compression level is 2. If the
-.\"O optional parameter is specified, there should be no white space between the
-.\"O option letter and the parameter.
-.TP
-.BI \-j "compression level"
-bzlib ライブラリを用いて、テープに書き込まれる各ブロックを圧縮する。
-このオプションが動作するのは、ダンプの書き込み対象が、ファイル、パイプ、
-もしくは可変長ブロックの書き込みができるテープドライブの場合だけである。
-圧縮されたテープを展開するには、
-バージョン 0.4b24 以降の
-.B restore
-が必要である。
-圧縮を用いて書き込まれたテープは BSD テープフォーマットとは互換性がない。
-(省略可能な) パラメータは bzlib が使用する圧縮レベルを指定する。
-デフォルトの圧縮レベルは 2 である。オプションのパラメータを指定する場合は、
-オプション文字とパラメータの間に空白を入れてはならない。
-.\"O .TP
-.\"O .BI \-k
-.\"O Use Kerberos authentication to talk to remote tape servers. (Only available if
-.\"O this option was enabled when
-.\"O .B dump
-.\"O was compiled.)
-.TP
-.BI \-k
-リモートのテープサーバとの通信に Kerberos 認証を使う
-.RB ( dump
-のコンパイル時にこのオプションが有効になっている場合のみ利用可能)。
-.\"O .TP
-.\"O .BI \-L " label"
-.\"O The user-supplied text string
-.\"O .I label
-.\"O is placed into the dump header, where tools like
-.\"O .BR restore (8)
-.\"O and
-.\"O .BR file (8)
-.\"O can access it. Note that this label is limited to be at most
-.\"O .B LBLSIZE
-.\"O (currently 16) characters, which must include the terminating \e0.
-.TP
-.BI \-L " label"
-ユーザー指定のテキスト文字列
-.I label
-をダンプのヘッダーに入れる。
-ダンプのヘッダーは、
-.BR restore (8)
-や
-.BR file (8)
-のようなツールからアクセスできる。
-このラベルの長さは、終端の \e0 も含めて最大で
-.B LBLSIZE
-(一般に 16) 文字である点に注意すること。
-.\"O .TP
-.\"O .BI \-m
-.\"O If this flag is specified,
-.\"O .B dump
-.\"O will optimise the output for inodes having been changed but not modified since
-.\"O the last dump ('changed' and 'modified' have the meaning defined in
-.\"O .BR stat (2)
-.\"O ). For those inodes,
-.\"O .B dump
-.\"O will save only the metadata, instead of saving the entire inode contents.
-.\"O Inodes which are either directories or have been modified since the last dump
-.\"O are saved in a regular way. Uses of this flag must be consistent, meaning that
-.\"O either every dump in an incremental dump set have the flag, or no one has it.
-.\"O .IP
-.\"O Tapes written using such 'metadata only' inodes will not be compatible with the
-.\"O BSD tape format or older versions of
-.\"O .B restore.
-.TP
-.BI \-m
-このフラグが指定されると、
-.B dump
-は最後のダンプ以降に change されたが modify されていない inode の
-出力を最適化する
-('changed' と modified' の意味は
-.BR stat (2)
-で定義されているものである)。
-それらの inode の場合、
-.B dump
-は inode の内容全体を保存する代わりに、メタデータのみを保存する。
-ディレクトリの inode や最後のダンプ以降に modify された inode は
-通常の方法で保存される。
-このフラグを使用するかどうかは首尾一貫していなくてはならない。
-つまり、増分ダンプを含むすべてのダンプにこのフラグを使うか、
-全く使わないかである。
-.IP
-このような「メタデータだけ」の inode を使って書き込まれたテープは
-BSD テープフォーマットや
-古いバージョンの
-.B restore
-とは互換性がない。
-.\"O .TP
-.\"O .BI \-M
-.\"O Enable the multi-volume feature. The name specified with
-.\"O .B f
-.\"O is treated as a prefix and
-.\"O .B dump
-.\"O writes in sequence to
-.\"O .I <prefix>001, <prefix>002
-.\"O etc. This can be useful when dumping to files on an ext2 partition, in order to
-.\"O bypass the 2GB file size limitation.
-.TP
-.BI \-M
-マルチボリューム機能を有効にする。
-.B f
-オプションで指定された名前を接頭辞 (prefix) としてみなされ、
-.B dump
-は
-.I <prefix>001, <prefix>002
-といったファイルに順番に書き出して行く。
-これは、
-ext2 パーティション上のファイルにダンプする際に、
-2GBのファイルサイズ制限を回避するのに便利である。
-.\"O .TP
-.\"O .BI \-n
-.\"O Whenever
-.\"O .B dump
-.\"O requires operator attention, notify all operators in the group
-.\"O .B operator
-.\"O by means similar to a
-.\"O .BR wall (1).
-.TP
-.BI \-n
-オペレータによる対処が必要なときに、グループ
-.B operator
-に属するオペレータ全員に
-.BR wall (1)
-と同様の方法で通知を行う。
-.\"O .TP
-.\"O .BI \-q
-.\"O Make
-.\"O .B dump
-.\"O abort immediately whenever operator attention is required, without prompting in
-.\"O case of write errors, tape changes etc.
-.TP
-.BI \-q
-オペレータによる対処が必要な場合には常に
-.B dump
-が直ちに終了するように指示する。
-ただし、テープ書き込みエラーやテープ交換などでプロンプトを表示する場合は除く。
-.\"O .TP
-.\"O .BI \-Q " file"
-.\"O Enable the Quick File Access support. Tape positions for each inode are stored
-.\"O into the file
-.\"O .I file
-.\"O which is used by
-.\"O .B restore
-.\"O (if called with parameter
-.\"O .B \-Q
-.\"O and the filename) to directly position the tape at the file
-.\"O .B restore
-.\"O is currently working on. This saves hours when restoring single files from
-.\"O large backups, saves the tapes and the drive's head.
-.TP
-.BI \-Q " file"
-Quick File Access を有効にする。
-各 inode のテープ位置をファイル
-.I file
-に記録する。
-このファイルは、
-.RB ( restore
-が
-.B \-Q
-フラグとファイル名のパラメータ付きで呼ばれた場合に)
-.B restore
-が処理しようとしているファイルの位置にテープを
-直接移動するために使用される。
-この機能を使うと、巨大なバックアップから個別のファイルをリストアする際に
-時間が節約できるとともに、テープやドライブのヘッドの消耗も防ぐことができる。
-.\"O .IP
-.\"O It is recommended to set up the st driver to return logical tape positions
-.\"O rather than physical before calling
-.\"O .B dump/restore
-.\"O with parameter
-.\"O .BR \-Q .
-.\"O Since not all tape devices support physical tape positions those tape devices
-.\"O return an error during
-.\"O .B dump/restore
-.\"O when the st driver is set to the default physical setting. Please see the
-.\"O .BR st (4)
-.\"O man page, option
-.\"O .B MTSETDRVBUFFER
-.\"O , or the
-.\"O .BR mt (1)
-.\"O man page, on how to set the driver to return logical tape positions.
-.IP
-.B dump/restore
-を
-.BR \-Q
-パラメータをつけて呼ぶ前に、
-物理的なテープ位置ではなく論理的な位置を返すように
-st トライバを設定することを推奨する。
-すべてのテープデバイスが物理的なテープ位置をサポートしているわけではないので、
-stドライバがデフォルトの物理的テープ位置を使う設定になっている場合には、
-それらのテープデバイスが
-.B dump/restore
-中にエラーを返す場合がある。
-ドライバを論理テープ位置を返すように設定する方法については、
-.BR st (4)
-のマニュアル、オプション
-.BR MTSETDRVBUFFER 、
-.BR mt (1)
-のマニュアルを参照のこと。
-.\"O .IP
-.\"O Before calling
-.\"O .B restore
-.\"O with parameter
-.\"O .BR \-Q ,
-.\"O always make sure the st driver is set to return the same type of tape position
-.\"O used during the call to
-.\"O .BR dump .
-.\"O Otherwise
-.\"O .B restore
-.\"O may be confused.
-.\"O .IP
-.\"O This option can be used when dumping to local tapes (see above) or to local
-.\"O files.
-.IP
-.B restore
-を
-.BR \-Q
-パラメータ付きで呼ぶ前には、必ず
-.BR dump
-を呼んだときに使用したテープ位置の種別と同じものを返すように
-st ドライバを設定しておくこと。
-さもないと、
-.B restore
-は混乱してしまう。
-.IP
-このオプションが利用可能なのは、
-ローカルのテープ (上述) もしくはローカルのファイルに
-ダンプする場合である。
-.\"O .TP
-.\"O .BI \-s " feet"
-.\"O Attempt to calculate the amount of tape needed at a particular density. If this
-.\"O amount is exceeded,
-.\"O .B dump
-.\"O prompts for a new tape. It is recommended to be a bit conservative on this
-.\"O option. The default tape length is 2300 feet. Specifying the tape size
-.\"O overrides end-of-media detection.
-.TP
-.BI \-s " feet"
-特定の密度において必要なテープの量を計算する。
-この量を越えたときには、
-.B dump
-は新しいテープを要求するプロンプトを出す。
-このオプションは少し控え目に設定する方がよい。
-デフォルトのテープ長は 2300 フィートである。
-テープサイズの指定はメディア終端検出より優先される。
-.\"O .TP
-.\"O .BI \-S
-.\"O Size estimate. Determine the amount of space that is needed to perform the dump
-.\"O without actually doing it, and display the estimated number of bytes it will
-.\"O take. This is useful with incremental dumps to determine how many volumes of
-.\"O media will be needed.
-.TP
-.BI \-S
-サイズ推定。
-実際にダンプを実行せずに、ダンプの実行に必要なスペースの量を決定し、
-推定した必要バイト数を表示する。
-これは、増分ダンプで便利で、
-メディアが何ボリューム必要になるかがわかる。
-.\"O .TP
-.\"O .BI \-T " date"
-.\"O Use the specified date as the starting time for the dump instead of the time
-.\"O determined from looking in
-.\"O .I /etc/dumpdates .
-.\"O The format of
-.\"O .I date
-.\"O is the same as that of
-.\"O .BR ctime (3)
-.\"O followed by an rfc822 timezone specification: either a plus or minus sign
-.\"O followed by two digits for the number of hours and two digits for the minutes.
-.\"O For example, -0800 for eight hours west of Greenwich or +0230 for two hours
-.\"O and a half east of Greenwich. This timezone offset takes into account
-.\"O daylight savings time (if applicable to the timezone): UTC offsets
-.\"O when daylight savings time is in effect will be different than offsets
-.\"O when daylight savings time is not in effect. For backward
-.\"O compatibility, if no timezone is specified, a local time is assumed.
-.\"O This option is useful for automated dump scripts that wish to dump over a
-.\"O specific period of time. The
-.\"O .B \-T
-.\"O option is mutually exclusive from the
-.\"O .B \-u
-.\"O option.
-.TP
-.BI \-T " date"
-.I /etc/dumpdates
-から得られる時間のかわりに、指定日時をダンプ起点時間として使う。
-.I date
-の書式は
-.BR ctime (3)
-と同じで、
-rfc822 タイムゾーン指定が続く。
-タイムゾーン指定は、+/- 符号に 2桁の時間 (hour) と 2桁の分 (minute) が
-続く形式で、
-例えば、-800 はグリニッジより 8時間西で、+0230 は 2時間半東を表す。
-(夏時間があるタイムゾーンの場合には) このタイムゾーンオフセットは
-夏時間の分も考慮に入れて指定する:
-夏時間が有効なときの UTC オフセットは
-夏時間でないときのオフセットとは異なる。
-過去との互換性のため、
-タイムゾーンが指定されない場合は、ローカル時間であると仮定される。
-このオプションは、期間を指定して自動的でダンプを行うスクリプトで便利である。
-.B \-T
-オプションと
-.B \-u
-オプションは同時に使用できない。
-.\"O .TP
-.\"O .BI \-u
-.\"O Update the file
-.\"O .I /etc/dumpdates
-.\"O after a successful dump. The format of
-.\"O .I /etc/dumpdates
-.\"O is readable by people, consisting of one free format record per line:
-.\"O filesystem name, increment level and
-.\"O .BR ctime (3)
-.\"O format dump date followed by a rfc822 timezone specification (see the
-.\"O .B \-u
-.\"O option for details). If no timezone offset is specified, times are interpreted
-.\"O as local. Whenever the file is written, all dates in the file are converted
-.\"O to the local time zone, without changing the UTC times. There
-.\"O may be only one entry per filesystem at each level. The file
-.\"O .I /etc/dumpdates
-.\"O may be edited to change any of the fields, if necessary.
-.TP
-.BI \-u
-ダンプが成功した後に
-.I /etc/dumpdates
-ファイルを更新する。
-.I /etc/dumpdates
-のフォーマットは人間が読める形式で、フリーフォーマットで以下の行から成る:
-ファイルシステム名、増分レベル、
-.BR ctime (3)
-フォーマットのダンプ日時、rfc822のタイムゾーン識別子
-.\"訳注: タイムゾーンの説明は -T オプションに記載されているので
-.\" 日本語訳では -T とする (原文は -u となっている)
-(詳細は
-.B \-T
-オプションの項を参照)。
-タイムゾーンオフセットが指定されないと、ローカル時間と解釈される。
-このファイルに書き込みを行う度に、
-ファイル内のすべての日時はローカルのタイムゾーンに変換される。
-但し、UTC 時間は変更されない。各ダンプレベルについてファイルシステム毎に
-一つのエントリだけが作られる。
-必要であれば、
-もし必要ならば、
-.I /etc/dumpdates
-ファイルを編集して、任意のフィールドを変更することもできる。
-.\"O .TP
-.\"O .BI \-v
-.\"O The
-.\"O .B \-v
-.\"O (verbose) makes
-.\"O .B dump
-.\"O to print extra information which could be helpful in debug sessions.
-.TP
-.BI \-v
-.B \-v
-(verbose) オプションは
-.B dump
-にデバッグに有益な追加の情報を表示させる。
-.\"O .TP
-.\"O .BI \-W
-.\"O .B Dump
-.\"O tells the operator what file systems need to be dumped. This information is
-.\"O gleaned from the files
-.\"O .I /etc/dumpdates
-.\"O and
-.\"O .IR /etc/fstab .
-.\"O The
-.\"O .B \-W
-.\"O option causes
-.\"O .B dump
-.\"O to print out, for all file systems in
-.\"O .I /etc/dumpdates ,
-.\"O and regognized file systems in
-.\"O .I /etc/mtab
-.\"O and
-.\"O .IR /etc/fstab .
-.\"O the most recent dump date and level, and highlights those that should be
-.\"O dumped. If the
-.\"O .B \-W
-.\"O option is set, all other options are ignored, and
-.\"O .B dump
-.\"O exits immediately.
-.TP
-.BI \-W
-.B dump
-はどのファイルシステムがダンプする必要があるかをオペレータに通知する。
-この情報は
-.I /etc/dumpdates
-と
-.I /etc/fstab
-ファイルから収集される。
-.B \-W
-オプションでは、
-.I /etc/dumpdates
-内のすべてのファイルシステムと、
-.I /etc/mtab
-と
-.IR /etc/fstab
-のうちダンプ対象と認識されたファイルシステムについて、
-最後のダンプ日時・レベルと、強調表示でダンプすべきかどうかが
-表示される。
-.B \-W
-が設定されると、すべてのオプションが無視され、
-.B dump
-はすぐに終了する。
-.\"O .TP
-.\"O .BI \-w
-.\"O Is like
-.\"O .BR \-W ,
-.\"O but prints only recognized filesystems in
-.\"O .I /etc/mtab
-.\"O and
-.\"O .I /etc/fstab
-.\"O which need to be dumped.
-.TP
-.BI \-w
-は
-.BR \-W
-に似ているが、
-.I /etc/mtab
-と
-.I /etc/fstab
-のうちダンプが必要とされたファイルシステムのみを出力する。
-.\"O .TP
-.\"O .BI \-y
-.\"O Compress every block to be written to the tape using the lzo library.
-.\"O This doesn't compress as well as the zlib library but it's much faster.
-.\"O This option will work only when dumping to a file or pipe or, when dumping to
-.\"O a tape drive, if the tape drive is capable of writing variable length blocks.
-.\"O You will need at least the 0.4b34 version of
-.\"O .B restore
-.\"O in order to extract compressed tapes. Tapes written using compression will not
-.\"O be compatible with the BSD tape format.
-.TP
-.BI \-y
-lzo ライブラリを用いて、テープに書き込まれる各ブロックを圧縮する。
-これは zlib と比べて圧縮率はよくないが高速である。
-このオプションが動作するのは、ダンプの書き込み対象が、ファイル、パイプ、
-もしくは可変長ブロックの書き込みができるテープドライブの場合だけである。
-圧縮されたテープを展開するには、
-バージョン 0.4b34 以降の
-.B restore
-が必要である。
-圧縮を用いて書き込まれたテープは BSD テープフォーマットとは互換性がない。
-.\"O .TP
-.\"O .BI \-z "compression level"
-.\"O Compress every block to be written on the tape using zlib library. This option
-.\"O will work only when dumping to a file or pipe or, when dumping to a tape drive,
-.\"O if the tape drive is capable of writing variable length blocks. You will need
-.\"O at least the 0.4b22 version of
-.\"O .B restore
-.\"O in order to extract compressed tapes. Tapes written using compression will not
-.\"O be compatible with the BSD tape format. The (optional) parameter specifies the
-.\"O compression level zlib will use. The default compression level is 2. If the
-.\"O optional parameter is specified, there should be no white space between the
-.\"O option letter and the parameter.
-.TP
-.BI \-z "compression level"
-zlib ライブラリを用いて、テープに書き込まれる各ブロックを圧縮する。
-このオプションが動作するのは、ダンプの書き込み対象が、ファイル、パイプ、
-もしくは可変長ブロックの書き込みができるテープドライブの場合だけである。
-圧縮されたテープを展開するには、
-バージョン 0.4b22 以降の
-.B restore
-が必要である。
-圧縮を用いて書き込まれたテープは BSD テープフォーマットとは互換性がない。
-(省略可能な) パラメータは zlib が使用する圧縮レベルを指定する。
-デフォルトの圧縮レベルは 2 である。オプションのパラメータを指定する場合は、
-オプション文字とパラメータの間に空白を入れてはならない。
-.\"O .PP
-.\"O .B Dump
-.\"O requires operator intervention on these conditions: end of tape, end of dump,
-.\"O tape write error, tape open error or disk read error (if there is more than a
-.\"O threshold of nr errors). In addition to alerting all operators implied by the
-.\"O .B \-n
-.\"O key,
-.\"O .B dump
-.\"O interacts with the operator on dump's control terminal at times when
-.\"O .B dump
-.\"O can no longer proceed, or if something is grossly wrong. All questions
-.\"O .B dump
-.\"O poses
-.\"O .I must
-.\"O be answered by typing \*(lqyes\*(rq or \*(lqno\*(rq, appropriately.
-.PP
-.B dump
-は以下の場合にオペレータの介在が必要となる:
-テープの末尾、ダンプの終了、テープの書き込みエラー、テープのオープンエラー
-ディスクの読み出しエラー (nr error の閾値を超えた場合)。
-.B \-n
-フラグで通知が行われるオペレータ全員への警告に加えて、
-.B dump
-がこれ以上続行できなくなった場合や何かひどく悪い状況の場合には、
-.B dump
-は制御端末経由でオペレータとやりとりする。
-.B dump
-が提示するすべての質問に
-\*(lqyes\*(rq か \*(lqno\*(rq で適切に答えなければならない。
-.\"O .PP
-.\"O Since making a dump involves a lot of time and effort for full dumps,
-.\"O .B dump
-.\"O checkpoints itself at the start of each tape volume. If writing that volume
-.\"O fails for some reason,
-.\"O .B dump
-.\"O will, with operator permission, restart itself from the checkpoint after the
-.\"O old tape has been rewound and removed, and a new tape has been mounted.
-.PP
-フルダンプの場合、ダンプを作成するのは多大な時間と労力を必要とするので、
-各テープボリュームの開始に
-.B dump
-はチェックポイントを置く。
-もし何らかの理由でボリュームの書き込みに失敗したら、
-オペレータの許可のもとで、
-.B dump
-は古いテープを巻戻して除去し、新しいテープをマウントしてから、
-チェックポイントから再スタートする。
-.\"O .PP
-.\"O .B Dump
-.\"O tells the operator what is going on at periodic intervals, including usually
-.\"O low estimates of the number of blocks to write, the number of tapes it will
-.\"O take, the time to completion, and the time to the tape change. The output is
-.\"O verbose, so that others know that the terminal controlling
-.\"O .B dump
-.\"O is busy, and will be for some time.
-.PP
-.B dump
-はオペレータに
-進行状況を
-周期的に知らせる。
-通常、書き込みブロック数、必要なテープ数、完了までの時間、テープ交換までの時間の
-低めの見積りが表示される。出力は冗長であるので、
-.B dump
-に使っている端末がビジーで、しばらくかかることが他の人にもわかる。
-.\"O .PP
-.\"O In the event of a catastrophic disk event, the time required to restore all the
-.\"O necessary backup tapes or files to disk can be kept to a minimum by staggering
-.\"O the incremental dumps. An efficient method of staggering incremental dumps to
-.\"O minimize the number of tapes follows:
-.PP
-増分ダンプを交互配置することによって、
-ディスクが壊れた際に、必要なすべてのバックアップテープやバックアップファイル
-をディスクに復旧するのに要する時間を最小にできる。
-テープ数を最小にする増分ダンプの交互配置の効率的な方法を以下に示す:
-.\"O .IP \(em
-.\"O Always start with a level 0 backup, for example:
-.\"O .RS 14
-.\"O .B /sbin/dump -0u -f /dev/st0 /usr/src
-.\"O .RE
-.\"O .IP
-.\"O This should be done at set intervals, say once a month or once every two months,
-.\"O and on a set of fresh tapes that is saved forever.
-.IP \(em
-常にレベル 0 のバックアップから開始する、例えば、
-.RS 14
-.B /sbin/dump -0u -f /dev/st0 /usr/src
-.RE
-.IP
-これは間隔を開けて行うべきで、一般には 1ヵ月か 2ヵ月に 1度と言われている。
-バックアップは新品のテープに行い、ずっと保管する。
-.\"O .IP \(em
-.\"O After a level 0, dumps of active file systems are taken on a daily basis, using
-.\"O a modified Tower of Hanoi algorithm, with this sequence of dump levels:
-.\"O .RS 14
-.\"O .B 3 2 5 4 7 6 9 8 9 9 ...
-.\"O .RE
-.\"O .IP
-.\"O For the daily dumps, it should be possible to use a fixed number of tapes for
-.\"O each day, used on a weekly basis. Each week, a level 1 dump is taken, and the
-.\"O daily Hanoi sequence repeats beginning with 3. For weekly dumps, another fixed
-.\"O set of tapes per dumped file system is used, also on a cyclical basis.
-.IP \(em
-レベル 0 のバックアップの後は、稼働ファイルシステムのダンプを毎日行う。
-修正版のハノイの塔アルゴリズムを使い、ダンプレベルを以下のシーケンス
-にしたがって設定する:
-.RS 14
-.B 3 2 5 4 7 6 9 8 9 9 ...
-.RE
-.IP
-毎日のダンプには、一週間の各曜日単位に一定数のテープ一式を用意しておけばよい。
-毎週、レベル 1 のダンプを取り、3 から始まる毎日のハノイ・シーケンスを
-繰り返す。各週のダンプでは、毎日のバックアップとは別のテープ一式を
-ファイルシステム単位に用意して、循環させて使用する。
-.\"O .PP
-.\"O After several months or so, the daily and weekly tapes should get rotated out
-.\"O of the dump cycle and fresh tapes brought in.
-.PP
-数ヵ月かそれくらい経過したら、各曜日と各週のテープは
-ダンプサイクルから外し、新品のテープに入れ替える。
-.\"O .PP
-.\"O (The 4.3BSD option syntax is implemented for backward compatibility but is not
-.\"O documented here.)
-.PP
-(過去との互換性のために 4.3BSD 形式のオプションが実装されているが、
-ここには書かれていない)
-.\"O .SH ENVIRONMENT
-.SH 環境変数
-.\"O .TP
-.\"O .B TAPE
-.\"O If no
-.\"O .B \-f
-.\"O option was specified,
-.\"O .B dump
-.\"O will use the device specified via
-.\"O .B TAPE
-.\"O as the dump device.
-.\"O .B TAPE
-.\"O may be of the form
-.\"O .IR tapename ,
-.\"O .IR host:tapename ,
-.\"O or
-.\"O .IR user@host:tapename .
-.TP
-.B TAPE
-.B \-f
-オプションを指定しない場合、
-.B dump
-は
-.B TAPE
-にて指定したデバイスを
-ダンプデバイスとして使う。
-.B TAPE
-は
-.IR tapename ,
-.IR host:tapename ,
-.I user@host:tapename
-のいずれかの形式で指定する。
-.\"O .TP
-.\"O .B RMT
-.\"O The environment variable
-.\"O .B RMT
-.\"O will be used to determine the pathname of the remote
-.\"O .BR rmt (8)
-.\"O program.
-.TP
-.B RMT
-環境変数
-.B RMT
-は
-リモートの
-.BR rmt (8)
-プログラムのパス名を指定するのに使われる。
-.\"O .TP
-.\"O .B RSH
-.\"O .B Dump
-.\"O uses the contents of this variable to determine the name of the remote shell
-.\"O command to use when doing remote backups (rsh, ssh etc.). If this variable is
-.\"O not set,
-.\"O .BR rcmd (3)
-.\"O will be used, but only root will be able to do remote backups.
-.TP
-.B RSH
-.B dump
-はこの変数の内容を使って、
-リモートバックアップを行うときに使う
-リモートシェルコマンドの名前 (rsh, ssh など) を決定する。
-この変数が設定されていない場合、
-.BR rcmd (3)
-を使うが、root だけがリモートバックアップを実行できる。
-.\"O .SH FILES
-.SH ファイル
-.\"O .TP
-.\"O .I /dev/st0
-.\"O default tape unit to dump to
-.TP
-.I /dev/st0
-ダンプするデフォルトのテープユニット
-.\"O .TP
-.\"O .I /etc/dumpdates
-.\"O dump date records
-.TP
-.I /etc/dumpdates
-ダンプ日時の記録
-.\"O .TP
-.\"O .I /etc/fstab
-.\"O dump table: file systems and frequency
-.TP
-.I /etc/fstab
-ダンプ表: ファイルシステムと頻度
-.\"O .TP
-.\"O .I /etc/mtab
-.\"O dump table: mounted file systems
-.TP
-.I /etc/mtab
-ダンプ表: マウントされているファイルシステム
-.\"O .TP
-.\"O .I /etc/group
-.\"O to find group
-.\"O .I operator
-.TP
-.I /etc/group
-グループ
-.I operator
-を探すのに使われる。
-.\"O .SH SEE ALSO
-.\"O .BR fstab (5),
-.\"O .BR restore (8),
-.\"O .BR rmt (8)
-.SH 関連項目
-.BR fstab (5),
-.BR restore (8),
-.BR rmt (8)
-.\"O .SH DIAGNOSTICS
-.\"O Many, and verbose.
-.SH 所見(DIAGNOSTICS)
-多数、冗長。
-.\"O .SH COMPATIBILITY
-.\"O The format of the
-.\"O .I /etc/dumpdates
-.\"O file has changed in release 0.4b34, however, the file will be read
-.\"O correctly with either pre-0.4b34 or 0.4b34 and later versions of
-.\"O .B dump
-.\"O provided that the machine on which
-.\"O .B dump
-.\"O is run did not change timezones (which should be a fairly rare occurence).
-.SH 移植性
-.I /etc/dumpdates
-ファイルのフォーマットは
-リリース 0.4b34 で変更されたが、
-タイムゾーンを変更しないマシン (それはかなり稀だが)では
-.B dump
-の 0.4b34 より前もしくは 0.4b34 以後のどちらのバージョンでも
-正しく読めるはずである。
-.\"O .SH EXIT STATUS
-.\"O .B Dump
-.\"O exits with zero status on success. Startup errors are indicated with an exit
-.\"O code of 1; abnormal termination is indicated with an exit code of 3.
-.SH 返り値
-.B dump
-は成功すると 0 で終了する。
-開始時のエラーの場合は終了コード 1 が返され、
-異常な終了があった場合は終了コード 3 が返される。
-.\"O .SH BUGS
-.SH バグ
-.\"O It might be considered a bug that this version of dump can only handle ext2/3
-.\"O filesystems. Specifically, it does not work with FAT filesystems.
-このバージョンの dump が ext2/3 ファイルシテスムしか取り扱えないのは、
-バグとみなされるかもしれない。特に、FAT ファイルシステムでは動作しない。
-.\"O .PP
-.\"O Fewer than 32 read errors (change this with
-.\"O .BR \-I )
-.\"O on the filesystem are ignored. If noticing read errors is important, the output
-.\"O from dump can be parsed to look for lines that contain the text 'read error'.
-.PP
-ファイルシステムの
-32回未満のリードエラー
-.RB ( \-I
-で変更できる) は無視される。
-リードエラーの通知が重要なら、ダンプの出力を解析して、
-'read error' という文字列を含む行を探せばよい。
-.\"O .PP
-.\"O When a read error occurs,
-.\"O .B dump
-.\"O prints out the corresponding physical disk block and sector number and the
-.\"O ext2/3 logical block number. It doesn't print out the corresponing file name or
-.\"O even the inode number. The user has to use
-.\"O .BR debugfs (8),
-.\"O commands
-.\"O .B ncheck
-.\"O and
-.\"O .B icheck
-.\"O to translate the
-.\"O .B ext2blk
-.\"O number printed out by
-.\"O .B dump
-.\"O into an inode number, then into a file name.
-.PP
-リードエラーが起きたとき、
-.B dump
-は対応する物理ディスクブロック、セクタ番号、ext2/3 論理ブロック番号を表示する。
-対応するファイル名や、そして inode番号さえも表示されない。
-.B dump
-が表示した
-.B ext2blk
-番号を inode 番号に、さらにファイル名に変換するには、
-ユーザーは
-.BR debugfs (8)
-を使用し、
-コマンド
-.B ncheck
-や
-.B icheck
-を実行する必要がある。
-.\"O .PP
-.\"O Each reel requires a new process, so parent processes for reels already written
-.\"O just hang around until the entire tape is written.
-.PP
-各リール (ボリューム) ごとに新しいプロセスが必要であるため、
-テープ全体の書き込みが終わるまでは、
-すでに書き込まれたリールの親プロセスはただ単に停止する。
-.\"O .PP
-.\"O The estimated number of tapes is not correct if compression is on.
-.PP
-圧縮が有効の場合、推定されるテープの数が正しくない。
-.\"O .PP
-.\"O It would be nice if
-.\"O .B dump
-.\"O knew about the dump sequence, kept track of the tapes scribbled on, told the
-.\"O operator which tape to mount when, and provided more assistance for the
-.\"O operator running
-.\"O .BR restore .
-.PP
-できればいいのにと思うことは、
-.B dump
-がダンプシーケンスについて知っていて、
-書き出されたテープを追跡し、
-オペレータにいつどのテープをマウントするか知らせて、
-.BR restore
-を実行するオペレータにもっと手助けをできればよいのに
-ということである。
-.\"O .PP
-.\"O .B Dump
-.\"O cannot do remote backups without being run as root, due to its security history.
-.\"O Presently, it works if you set it setuid (like it used to be), but this might
-.\"O constitute a security risk. Note that you can set
-.\"O .B RSH
-.\"O to use a remote shell program instead.
-.PP
-過去のセキュリティの経緯のため、
-.B dump
-は
-root として実行された場合を除いてリモートバックアップはできない。
-現在は、(以前そうであったように) setuid ビットをセットすることで
-root 以外でも動作するようになるが、セキュリティ上のリスクが発生する
-可能性がある。代わりに、
-.B RSH
-を設定してリモートのシェルプログラムを使うことができる点も
-覚えておいてほしい。
-.\"O .SH AUTHOR
-.\"O The
-.\"O .B dump/restore
-.\"O backup suite was ported to Linux's Second Extended File System by Remy Card
-.\"O <card@Linux.EU.Org>. He maintained the initial versions of
-.\"O .B dump
-.\"O (up and including 0.4b4, released in january 1997).
-.\"O .PP
-.\"O Starting with 0.4b5, the new maintainer is Stelian Pop <stelian@popies.net>.
-.SH 著者
-.B dump/restore
-バックアップソフトは
-Remy Card <card@Linux.EU.Org>
-によりって Linux の ext2 ファイルシステムに移植された。
-彼は
-.B dump
-の初期バージョンを開発した。
-(1997年1月にリリースされた 0.4b4 まで)
-.PP
-0.4b5 からは、Stelian Pop <stelian@popies.net> が
-新しく開発者となった。
-.\"O .SH AVAILABILITY
-.\"O The
-.\"O .B dump/restore
-.\"O backup suite is available from <http://dump.sourceforge.net>
-.SH 入手
-.B dump/restore
-バックアップソフトは <http://dump.sourceforge.net> から入手できる。
-.\"O .SH HISTORY
-.\"O A
-.\"O .B dump
-.\"O command appeared in
-.\"O .B Version 6 AT&T UNIX.
-.SH 歴史
-.B dump
-コマンドは
-.B Version 6 AT&T UNIX
-で登場した。
+++ /dev/null
-.\" Copyright (c) 1985, 1991, 1993
-.\" The Regents of the University of California. All rights reserved.
-.\"
-.\" Japanese Version Copyright (c) 2005 Takashi Nishida
-.\" all rights reserved.
-.\" Translated Sat Sat Sep 24 15:51:25 JST 2005 (ver0.03)
-.\" by Takashi Nishida
-.\"
-.\"
-.\" 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.
-.\" 3. Neither the name of the University nor the names of its contributors
-.\" may be used to endorse or promote products derived from this software
-.\" without specific prior written permission.
-.\"
-.\" 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.
-.\"
-.\" $Id: restore.8.in,v 1.30 2003/03/30 15:40:39 stelian Exp $
-.\"
-.TH RESTORE 8 "version 0.4b34 of April 18, 2003" BSD "System management commands"
-.\"O.SH NAME
-.SH 名前
-restore \- dumpで作ったバックアップからファイルもしくはファイルシステムを修復する。
-.SH 書式
-.B restore \-C
-[\fB\-cdklMvVy\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-D \fIfilesystem\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-L \fIlimit\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-.PP
-.B restore \-i
-[\fB\-acdhklmMNouvVy\fR]
-[\fB\-A \fIfile\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-Q \fIfile\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-.PP
-.B restore \-P
-.I file
-[\fB\-acdhklmMNuvVy\fR]
-[\fB\-A \fIfile\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-[\fB\-X \fIfilelist\fR]
-[ \fIfile ... \fR]
-.PP
-.B restore \-R
-[\fB\-cdklMNuvVy\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-.PP
-.B restore \-r
-[\fB\-cdklMNuvVy\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-.PP
-.B restore \-t
-[\fB\-cdhklMNuvVy\fR]
-[\fB\-A \fIfile\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-Q \fIfile\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-[\fB\-X \fIfilelist\fR]
-[ \fIfile ... \fR]
-.PP
-.B restore \-x
-[\fB\-adchklmMNouvVy\fR]
-[\fB\-A \fIfile\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-Q \fIfile\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-[\fB\-X \fIfilelist\fR]
-[ \fIfile ... \fR]
-.PP
-.\"O (The 4.3BSD option syntax is implemented for backward compatibility but is not
-.\"O documented here.)
-(過去との互換性のために4.3BSDのオプション文法が実装されているが、
-ここでは文書化されない)
-.\"O .SH DESCRIPTION
-.SH 説明
-.\"O The
-.\"O .B restore
-.\"O command performs the inverse function of
-.\"O .BR dump (8).
-.B restore
-コマンドは
-.BR dump (8)
-の逆の機能を実行する。
-.\"O A full backup of a file system may be restored and subsequent incremental
-.\"O backups layered on top of it. Single files and directory subtrees may be
-.\"O restored from full or partial backups.
-ファイルシステムのフルバックアップが復元され、
-続く増分バックアップ(incremental backups)がその上に積み重ねられる。
-個々のファイルやディレクトリサブツリーがフルバックアップもしくは部分バックアップから復元できる。
-.\"O .B Restore
-.\"O works across a network; to do this see the
-.\"O .B \-f
-.\"O flag described below. Other arguments to the command are file or directory
-.\"O names specifying the files that are to be restored. Unless the
-.\"O .B \-h
-.\"O flag is specified (see below), the appearance of a directory name refers to
-.\"O the files and (recursively) subdirectories of that directory.
-.B Restore
-はネットワークを越えて動作する;
-これをするためには
-以下に記述する
-.B \-f
-フラグを見ること。
-コマンドへの他の引数はファイルもしくはディレクトリで、
-復元するファイルを明示する。
-.B \-h
-フラグ(下記)が明示されない限り、
-ディレクトリ名を示すと
-そのディレクトリのファイルやサブディレクトリ(再帰的に)を参照する。
-.PP
-.\"O .PP
-.\"O Exactly one of the following flags is required:
-.\"O .TP
-以下のフラグのうち必ず一つが必要である:
-.TP
-.\"O .B \-C
-.\"O This mode allows comparison of files from a dump.
-.\"O .B Restore
-.\"O reads the backup and compares its contents with files present on the disk. It
-.\"O first changes its working directory to the root of the filesystem that was
-.\"O dumped and compares the tape with the files in its new current directory. See
-.\"O also the
-.B \-C
-このモードではダンプとファイルの比較をする。
-.B restore
-はバックアップを読んでその内容をディスク上にあるファイルと比較する。
-まず、ワーキングディレクトリをダンプしたファイルシステムのルートに変更し、
-テープと新しいカレントディレクトリのファイルと比較する。
-後述の
-.\"O .B \-L
-フラグも参照せよ。
-.\"O .TP
-.\"O .B \-i
-.\"O This mode allows interactive restoration of files from a dump. After reading in
-.\"O the directory information from the dump,
-.\"O .B restore
-.\"O provides a shell like interface that allows the user to move around the
-.\"O directory tree selecting files to be extracted. The available commands are
-.\"O given below; for those commands that require an argument, the default is the
-.\"O current directory.
-.\"O .RS
-.TP
-.B \-i
-このモードはダンプからのファイルの対話的な復旧ができる。
-ダンプからディレクトリ情報を読んだ後、
-.B restore
-はシェルのようなインターフェースを提供し、
-ユーザーはディレクトリツリーを動きまわることができ、展開すべきファイルを選ぶ。
-利用できるコマンドは以下に示す;
-引数を必要とするコマンドでは、
-デフォルトはカレントディレクトリである。
-.RS
-.\"O .TP
-.\"O .B add \fR[\fIarg\fR]
-.\"O The current directory or specified argument is added to the list of files to be
-.\"O extracted. If a directory is specified, then it and all its descendents are
-.\"O added to the extraction list (unless the
-.\"O .B \-h
-.\"O flag is specified on the command line). Files that are on the extraction list
-.\"O are prepended with a \*(lq*\*(rq when they are listed by
-.\"O .BR ls .
-.\"O .TP
-.\"O .BI cd " arg"
-.\"O Change the current working directory to the specified argument.
-.TP
-.B add \fR[\fIarg\fR]
-カレントディレクトリもしくは指定の引数を展開するファイルのリストに加える。
-もし、ディレクトリが指定された場合は、それ以下を展開リストに加える。
-(コマンドラインで
-.B \-h
-フラグが無い限り)。
-.BR ls
-でリストすると、
-展開リストにあるファイルは
-\*(lq*\*(rqが前に付け加えられる。
-.TP
-.BI cd " arg"
-カレントワーキングディレクトリを指定された引数に変更する。
-.\"O .TP
-.\"O .B delete \fR[\fIarg\fR]
-.\"O The current directory or specified argument is deleted from the list of files
-.\"O to be extracted. If a directory is specified, then it and all its descendents
-.\"O are deleted from the extraction list (unless the
-.\"O .B \-h
-.\"O flag is specified on the command line). The most expedient way to extract most
-.\"O of the files from a directory is to add the directory to the extraction list
-.\"O and then delete those files that are not needed.
-.TP
-.B delete \fR[\fIarg\fR]
-カレントディレクトリもしくは指定の引数を
-展開するファイルのリストから削除する。
-もし、ディレクトリが指定されたら、それ以下が
-展開リストから削除される。
-(コマンドラインで
-.B \-h
-フラグが指定されていない限り)。
-ディレクトリから多くのファイルを展開する
-もっとも好都合な方法は、
-ディレクトリを展開リストに加えて、そして、必要でないファイルを削除することである。
-.\"O .TP
-.\"O .B extract
-.\"O All files on the extraction list are extracted from the dump.
-.\"O .B Restore
-.\"O will ask which volume the user wishes to mount. The fastest way to extract a f
-.\"O ew files is to start with the last volume and work towards the first volume.
-.TP
-.B extract
-展開リストの全てのファイルをダンプから展開する。
-.B restore
-はユーザーがマウントしたいボリュームを聞いて来る。
-わずかなファイルを最も速く展開する方法は、
-最後のボリュームからはじめて、最初のボリュームに戻って行くことである。
-.\"O .TP
-.\"O .B help
-.\"O List a summary of the available commands.
-.TP
-.B help
-利用可能なコマンドのまとめを列挙する。
-.\"O .TP
-.\"O .B ls \fR[\fIarg\fR]
-.\"O List the current or specified directory. Entries that are directories are
-.\"O appended with a \*(lq/\*(rq. Entries that have been marked for extraction are
-.\"O prepended with a \*(lq*\*(rq. If the verbose flag is set, the inode number of
-.\"O each entry is also listed.
-.TP
-.B ls \fR[\fIarg\fR]
-カレントもしくは指定したディレクトリを表示する。
-ディレクトリのエントリは
-\*(lq/\*(rq
-が付加される。
-展開のためにマークをつけたエントリは
-前に\*(lq*\*(rqが着いている。
-もし、verbose フラグをつけた場合は、
-各エントリのinode番号もリストする。
-.\"O .TP
-.\"O .B pwd
-.\"O Print the full pathname of the current working directory.
-.TP
-.B pwd
-カレントワーキングディレクトリのフルパス名を表示する。
-.\"O .TP
-.\"O .B quit
-.\"O .B Restore
-.\"O immediately exits, even if the extraction list is not empty.
-.TP
-.B quit
-展開リストが空でなくても、
-.B restore
-は直ちに終了する。
-.\"O .TP
-.\"O .B setmodes
-.\"O All directories that have been added to the extraction list have their owner,
-.\"O modes, and times set; nothing is extracted from the dump. This is useful for
-.\"O cleaning up after a
-.\"O .B restore
-.\"O has been prematurely aborted.
-.TP
-.B setmodes
-展開リストに加えられている全てのディレクトリにオーナー、モード、そして時間をセットするだけで、
-ダンプからは展開しない。
-これは、
-.B restore
-を打ち切った後で、後かたづけするのに便利である。
-.\"O .TP
-.\"O .B verbose
-.\"O The sense of the
-.\"O .B \-v
-.\"O flag is toggled. When set, the verbose flag causes the
-.\"O .B ls
-.\"O command to list the inode numbers of all entries. It also causes
-.\"O .B restore
-.\"O to print out information about each file as it is extracted.
-.TP
-.B verbose
-.B \-v
-フラグの状態を入切する。
-セットされると、
-verboseフラグは
-.B ls
-コマンドで、
-全てのエントリにinode番号を記載するようにする。
-また、
-.B restore
-は
-各ファイルが展開されるか
-情報を表示する。
-.\"O .RE
-.RE
-.\"O .TP
-.\"O .BI \-P " file"
-.\"O .B Restore
-.\"O creates a new Quick File Access file
-.\"O .I file
-.\"O from an existing dump file without restoring its contents.
-.TP
-.BI \-P " file"
-今あるダンプファイルから
-内容をリストアすること無しに
-新しいQuick File Access ファイル
-.I file
-を生成する。
-.\"O .TP
-.\"O .B \-R
-.\"O .B Restore
-.\"O requests a particular tape of a multi-volume set on which to restart a full
-.\"O restore (see the
-.\"O .B \-r
-.\"O flag below). This is useful if the restore has been interrupted.
-.TP
-.B \-R
-フルリストア(
-(下記の
-.B \-r
-フラグを見よ)
-を再開する場合に、
-.B restore
-はマルチボリューム一式のうちの一部のテープを要求する。
-restoreを中断した場合にこれは便利である。
-.\"O .TP
-.\"O .B \-r
-.\"O Restore (rebuild) a file system. The target file system should be made pristine
-.\"O with
-.\"O .BR mke2fs (8),
-.\"O mounted, and the user
-.\"O .BR cd 'd
-.\"O into the pristine file system before starting the restoration of the initial
-.\"O level 0 backup. If the level 0 restores successfully, the
-.\"O .B \-r
-.\"O flag may be used to restore any necessary incremental backups on top of the
-.\"O level 0. The
-.\"O .B \-r
-.\"O flag precludes an interactive file extraction and can be detrimental to one's
-.\"O health (not to mention the disk) if not used carefully. An example:
-.\"O .IP
-.TP
-.B \-r
-ファイルシステムをリストア(再構築)する。
-level 0バックアップの復旧を最初にはじめる前に、
-ターゲットファイルシステムを
-.BR mke2fs (8)
-で初期化、マウントし、初期化したファイルシステムに
-.BR cd
-で移動していなくてはならない。
-もし、level 0 がうまくリストアできたら、
-level 0 を頂点とした
-任意の増分バックアップが
-.B \-r
-フラグを使ってリストアできる。
-不注意に利用すると、
-.B \-r
-フラグでは対話的なファイル展開をしないので
-うっかりリストアをしてしまうと差障りがあるだろう。
-(ディスクだけではなく)
-例えば:
-.IP
-.\"O .RS 14
-.\"O .B mke2fs /dev/sda1
-.\"O .TP
-.\"O .B mount /dev/sda1 /mnt
-.\"O .TP
-.\"O .B cd /mnt
-.\"O .TP
-.\"O .B restore rf /dev/st0
-.\"O .RE
-.RS 14
-.B mke2fs /dev/sda1
-.TP
-.B mount /dev/sda1 /mnt
-.TP
-.B cd /mnt
-.TP
-.B restore rf /dev/st0
-.RE
-.\"O .IP
-.\"O Note that
-.\"O .B restore
-.\"O leaves a file
-.\"O .I restoresymtable
-.\"O in the root directory to pass information between incremental restore passes.
-.\"O This file should be removed when the last incremental has been restored.
-.\"O .IP
-.\"O .BR Restore ,
-.\"O in conjunction with
-.\"O .BR mke2fs (8)
-.\"O and
-.\"O .BR dump (8),
-.\"O may be used to modify file system parameters such as size or block size.
-.IP
-.B restore
-は増分リストア各パスの間の情報を渡すために
-ファイル
-.I restoresymtable
-をルートディレクトリに置くことに注意せよ。
-最後の増分がリストアできたら
-このファイルは取り除くべきである。
-.IP
-.BR mke2fs (8)
-および
-.BR dump (8)
-と組み合わせて
-.BR restore
-は
-サイズやブロックサイズのような
-ファイルシステムパラメータを変更するのに
-用いることができる。
-.\"O .TP
-.\"O .B \-t
-.\"O The names of the specified files are listed if they occur on the backup. If no
-.\"O file argument is given, the root directory is listed, which results in the
-.\"O entire content of the backup being listed, unless the
-.\"O .B \-h
-.\"O flag has been specified. Note that the
-.\"O .B \-t
-.\"O flag replaces the function of the old
-.\"O .BR dumpdir (8)
-.\"O program. See also the
-.\"O .B \-X
-.\"O option below.
-.TP
-.B \-t
-指定ファイルがバックアップにあるならその名前を表示する。
-もし、ファイル引数を与えなかった場合は、ルートディレクトリが表示され、
-.B \-h
-フラグを指定しない限り、
-バックアップの全内容が表示される結果になる。
-.B \-t
-フラグは
-古い
-.BR dumpdir (8)
-プログラムの機能を置き換えるものであることに
-注意されたい。
-以下の
-.B \-X
-オプションも見よ。
-.\"O .TP
-.\"O .B \-x
-.\"O The named files are read from the given media. If a named file matches a
-.\"O directory whose contents are on the backup and the
-.\"O .B \-h
-.\"O flag is not specified, the directory is recursively extracted. The owner,
-.\"O modification time, and mode are restored (if possible). If no file argument is
-.\"O given, the root directory is extracted, which results in the entire content of
-.\"O the backup being extracted, unless the
-.\"O .B \-h
-.\"O flag has been specified. See also the
-.\"O .B \-X
-.\"O option below.
-.\"O .SH OPTIONS
-.\"O The following additional options may be specified:
-.TP
-.B \-x
-与えられたメディアから指定ファイルを読む。
-もし、
-指定ファイルがディレクトリで
-バックアップ上にはその中身があって
-.B \-h
-フラグが指定されていない場合、
-ディレクトリは再帰的に展開される。
-オーナー、修正時間、そしてモードがリストアされる(可能ならば)。
-もし、ファイル引数がなにも与えられない場合、
-ルートディレクトリが展開され、
-.B \-h
-フラグが指定されない限り、
-バックアップのすべての内容が展開される結果になる。
-また、以下の
-.B \-X
-オプションも見ること。
-
-.SH オプション
-以下の追加オプションが指定できる:
-.\"O .TP
-.\"O .B \-a
-.\"O In
-.\"O .B \-i
-.\"O or
-.\"O .B \-x
-.\"O mode,
-.\"O .B restore
-.\"O does ask the user for the volume number on which the files to be extracted are
-.\"O supposed to be (in order to minimise the time by reading only the interesting
-.\"O volumes). The
-.\"O .B \-a
-.\"O option disables this behaviour and reads all the volumes starting with 1. This
-.\"O option is useful when the operator does not know on which volume the files to
-.\"O be extracted are and/or when he prefers the longer unattended mode rather than
-.\"O the shorter interactive mode.
-.TP
-.B \-a
-.B \-i
-もしくは
-.B \-x
-モードでは、
-.B restore
-は展開したいファイルがはいっているボリューム番号を
-ユーザーに要求する。
-(時間を最小限にするため必要なボリュームだけ読みこむ)
-.B \-a
-オプションはこの機能を無効にし、1からはじまる全てのボリュームを読む。
-展開したにファイルがどのボリュームにあるかオペレータが知らない場合、
-短時間い対話式モードよりもむしろ長くても無人モードの方が好ましい場合、
-このオプションが役立つ。
-.TP
-.BI \-A " archive_file"
-メディアの代わりに
-.I archive_file
-から内容一覧を読み込む。
-このオプションは
-.BR \-t ,
-.BR \-i ,
-もしくは
-.B \-x
-オプションと組み合わせて使え、
-メディアをマウントすることなしにメディア上にファイルが存在するかどうか
-調べることを可能にする。
-.\"O .TP
-.\"O .BI \-A " archive_file"
-.\"O Read the table of contents from
-.\"O .I archive_file
-.\"O instead of the media. This option can be used in combination with the
-.\"O .BR \-t ,
-.\"O .BR \-i ,
-.\"O or
-.\"O .B \-x
-.\"O options, making it possible to check whether files are on the media without
-.\"O having to mount the media.
-.TP
-.BI \-b " blocksize"
-ダンプレコードあたりのkilobytes数。
-もし、
-.B \-b
-オプションを指定しない場合、
-.B restore
-はメディアブロックサイズを動的に決定しようとする。
-.\"O .TP
-.\"O .BI \-b " blocksize"
-.\"O The number of kilobytes per dump record. If the
-.\"O .B \-b
-.\"O option is not specified,
-.\"O .B restore
-.\"O tries to determine the media block size dynamically.
-.\"O .TP
-.\"O .B \-c
-.\"O Normally,
-.\"O .B restore
-.\"O will try to determine dynamically whether the dump was made from an old
-.\"O (pre-4.4) or new format file system. The
-.\"O .B \-c
-.\"O flag disables this check, and only allows reading a dump in the old format.
-.TP
-.B \-c
-通常、
-.B restore
-は起動時にダンプが古いファイル形式(pre-4.4)か新しいファイル形式
-のどちらで生成されたかを判断しようとする。
-.B \-c
-はこの検査を無効にし、ダンプを旧フォーマットで読むことだけを許可する。
-.\"O .TP
-.\"O .B \-d
-.\"O The
-.\"O .B \-d
-.\"O (debug) flag causes
-.\"O .B restore
-.\"O to print debug information.
-.TP
-.B \-d
-.B \-d
-(デバッグ)フラグは
-.B restore
-がデバッグ情報を表示するようにする。
-.\"O .TP
-.\"O .BI \-D " filesystem"
-.\"O The
-.\"O .B \-D
-.\"O flag allows the user to specify the filesystem name when using
-.\"O .B restore
-.\"O with the
-.\"O .B \-C
-.\"O option to check the backup.
-.TP
-.BI \-D " filesystem"
-.B restore
-を
-.B \-C
-オプションで使って
-バックアップを検査する際に
-ユーザーは
-.B \-D
-フラグでファイルシステム名を指定することができる。
-.\"O .TP
-.\"O .BI \-f " file"
-.\"O Read the backup from
-.\"O .IR file ;
-.\"O .I file
-.\"O may be a special device file like
-.\"O .I /dev/st0
-.\"O (a tape drive),
-.\"O .I /dev/sda1
-.\"O (a disk drive), an ordinary file, or
-.\"O .I \-
-.\"O (the standard input). If the name of the file is of the form
-.\"O .I host:file
-.\"O or
-.\"O .IR user@host:file ,
-.\"O .B restore
-.\"O reads from the named file on the remote host using
-.\"O .BR rmt (8).
-.TP
-.BI \-f " file"
-バックアップを
-.IR file
-から読む ;
-.I file
-は
-.I /dev/st0
-(テープドライブ),
-.I /dev/sda1
-(ディスクドライブ)
-のようなデバイスファイル、
-通常のファイル,
-もしくは
-.I \-
-(標準入力)
-である。
-もし、ファイル名が
-.I host:file
-もしくは
-.IR user@host:file
-の形式であるなら、
-.B restore
-は
-.BR rmt (8)
-を使ってリモートホスト上の指定ファイルから読み込む。
-.\"O .TP
-.\"O .BI \-F " script"
-.\"O Run script at the beginning of each tape. The device name and the current
-.\"O volume number are passed on the command line. The script must return 0 if
-.\"O .B restore
-.\"O should continue without asking the user to change the tape, 1 if
-.\"O .B restore
-.\"O should continue but ask the user to change the tape. Any other exit code will
-.\"O cause
-.\"O .B restore
-.\"O to abort. For security reasons,
-.\"O .B restore
-.\"O reverts back to the real user ID and the real group ID before running the
-.\"O script.
-.TP
-.BI \-F " script"
-各テープのはじめでスクリプト(script)を走らせる。
-デバイス名と現在のボリューム番号がコマンドライン引数で渡される。
-もし、
-.B restore
-がテープを交換するようにユーザーに要求せずに続けたいなら、
-スクリプトは必ず0を返す必要があり、
-続けるけれどもユーザーにテープを交換するように要求するのなら1を返す。
-他の終了コードでは
-.B restore
-を中止させる。
-セキュリティ上の理由で、
-スクリプトを走らせる前に
-.B restore
-は本来(real)のユーザーIDとグループIDに戻る。
-.\"O .TP
-.\"O .B \-h
-.\"O Extract the actual directory, rather than the files that it references. This
-.\"O prevents hierarchical restoration of complete subtrees from the dump.
-.TP
-.B \-h
-ディレクトリを抽出し、
-その中のファイルは抽出しない。
-これで、
-ダンプからサブツリー全体の階層的なリストアを抑制する。
-.\"O .TP
-.\"O .B \-k
-.\"O Use Kerberos authentication when contacting the remote tape server. (Only
-.\"O available if this options was enabled when
-.\"O .B restore
-.\"O was compiled.)
-.TP
-.B \-k
-リモートテープサーバーと通信する時にKerbelos認証を使う。
-(
-.B restore
-をコンパイルするときに
-このオプションが有効にされている場合のみ利用可能
-)
-.\"O .TP
-.\"O .B \-l
-.\"O When doing remote restores, assume the remote file is a regular file (instead
-.\"O of a tape device). If you're restoring a remote compressed file, you will need
-.\"O to specify this option or
-.\"O .B restore
-.\"O will fail to access it correctly.
-.TP
-.B \-l
-リモートリストアをするときに、
-リモートファイルは
-(テープデバイスではなく)
-通常のファイルであると仮定する。
-もし、リモートの圧縮ファイルをリストアする場合は
-このオプションを指定する必要があり、
-そうしないと
-.B restore
-は正しくアクセスできない。
-.\"O .TP
-.\"O .BI \-L " limit"
-.\"O The
-.\"O .B \-L
-.\"O flag allows the user to specify a maximal number of miscompares when using
-.\"O .B restore
-.\"O with the
-.\"O .B \-C
-.\"O option to check the backup. If this limit is reached,
-.\"O .B restore
-.\"O will abort with an error message. A value of 0 (the default value) disables
-.\"O the check.
-.TP
-.BI \-L " limit"
-バックアップを検査するのに
-.B restore
-を
-.B \-C
-オプションで
-使うとき、
-.B \-L
-フラグで不一致の上限回数を指定できる。
-もし、この制限に達っすると、
-.B restore
-はエラーメッセージとともに中断する。
-0の値(デフォルト値)は検査を無効にする。
-.\"O .TP
-.\"O .B \-m
-.\"O Extract by inode numbers rather than by file name. This is useful if only a few
-.\"O files are being extracted, and one wants to avoid regenerating the complete
-.\"O pathname to the file.
-.TP
-.B \-m
-は
-ファイル名ではなくinode番号によって展開する。
-これは、
-展開すべきファイルはわずかばかりで、
-ファイルの完全なパス名を生成するのを避けたいときに、
-便利である。
-.\"O .TP
-.\"O .B \-M
-.\"O Enables the multi-volume feature (for reading dumps made using the
-.\"O .B \-M
-.\"O option of dump). The name specified with
-.\"O .B \-f
-.\"O is treated as a prefix and
-.\"O .B restore
-.\"O tries to read in sequence from
-.\"O .I <prefix>001, <prefix>002
-.\"O etc.
-.TP
-.B \-M
-はマルチボリューム機能を有効にする。
-(dumpの
-.B \-M
-オプションを使って作ったダンプを読むために)
-.B \-f
-で指定された名前
-はprefixとして扱われ、
-.B restore
-は
-.I <prefix>001, <prefix>002
-他の順で読みこもうとする。
-.\"O .TP
-.\"O .B \-N
-.\"O The
-.\"O .B \-N
-.\"O flag causes
-.\"O .B restore
-.\"O to perform a full execution as requested by one of
-.\"O .BR \-i ,
-.\"O .BR \-R ,
-.\"O .BR \-r ,
-.\"O .B t
-.\"O or
-.\"O .B x
-.\"O command without actually writing any file on disk.
-.TP
-.B \-N
-.B \-N
-フラグは
-.BR \-i ,
-.BR \-R ,
-.BR \-r ,
-.B t
-もしくは
-.B x
-コマンドのどれかで要請された全作業を、
-ディスクにファイルを実際に書き込まずに、
-.B restore
-が実施するようにする。
-.\"O .TP
-.\"O .B \-o
-.\"O The
-.\"O .B \-o
-.\"O flag causes
-.\"O .B restore
-.\"O to automatically restore the current directory permissions without asking the
-.\"O operator whether to do so in one of
-.\"O .B \-i
-.\"O or
-.\"O .B \-x
-.\"O modes.
-.TP
-.B \-o
-.B \-i
-もしくは
-.B \-x
-モードでオペレータに問い合わせること無く
-.B restore
-が現ディレクトリのパーミッションを
-自動的に復元するようにする。
-.\"O .TP
-.\"O .BI \-Q " file"
-.\"O Use the file
-.\"O .I file
-.\"O in order to read tape position as stored using the dump Quick File Access mode,
-.\"O in one of
-.\"O .BR \-i ,
-.\"O .B \-x
-.\"O or
-.\"O .B \-t
-.\"O mode.
-.TP
-.BI \-Q " file"
-は、
-.BR \-i ,
-.B \-x
-もしくは
-.B \-t
-モードにおいて、
-ファイル
-.I file
-をdumpの Quick File Accessモードを使って格納されているものとして
-テープ位置を読みこむのに使う。
-.\"O .IP
-.\"O It is recommended to set up the st driver to return logical tape positions
-.\"O rather than physical before calling
-.\"O .B dump/restore
-.\"O with parameter
-.\"O .BR \-Q .
-.\"O Since not all tape devices support physical tape positions those tape devices
-.\"O return an error during
-.\"O .B dump/restore
-.\"O when the st driver is set to the default physical setting. Please see the
-.\"O .BR st (4)
-.\"O man page, option
-.\"O .B MTSETDRVBUFFER
-.\"O , or the
-.\"O .BR mt(1)
-.\"O man page, on how to set the driver to return logical tape positions.
-.IP
-パラメータ
-.BR \-Q .
-で
-.B dump/restore
-を呼ぶ前に、
-物理ではなく論理テープ位置を返すように
-stドライバをセットアップしておくことを推奨する。
-すべてのテープデバイスが
-物理テープ位置をサポートしているわけではないので、
-stドライバがデフォルトの物理位置の設定にセットされる時、
-それらのテープデバイスは
-.B dump/restore
-の時にエラーを返す。
-どのようにドライバを論理テープ位置を返すように設定するかについては、
-.BR st (4)
-man page
-オプション
-.B MTSETDRVBUFFER
-, もしくは
-.BR mt(1)
-man page
-を見るように。
-.\"O .IP
-.\"O Before calling
-.\"O .B restore
-.\"O with parameter
-.\"O .BR \-Q ,
-.\"O always make sure the st driver is set to return the same type of tape position
-.\"O used during the call to
-.\"O .BR dump .
-.\"O Otherwise
-.\"O .B restore
-.\"O may be confused.
-.IP
-.B restore
-をパラメータ
-.BR \-Q
-で呼ぶ前に、
-.BR dump
-を呼んだときに使ったものと
-同じ形式のテープ位置を返すように
-stドライバが
-設定されていることをいつも確かめるように。
-そうでなければ、
-.B restore
-は混乱するであろう。
-.\"O .IP
-.\"O This option can be used when restoring from local or remote tapes (see above)
-.\"O or from local or remote files.
-.IP
-このオプションは
-ローカルもしくはリモートテープ(上記を見ること)
-もしくはローカル、リモートファイルから復元するときに、
-使うことができる。
-.\"O .TP
-.\"O .BI \-s " fileno"
-.\"O Read from the specified
-.\"O .I fileno
-.\"O on a multi-file tape. File numbering starts at 1.
-.TP
-.BI \-s " fileno"
-マルチファイルテープの
-指定された
-.I fileno
-から読む。
-ファイル番号は1から開始する。
-.\"O .TP
-.\"O .BI \-T " directory"
-.\"O The
-.\"O .B \-T
-.\"O flag allows the user to specify a directory to use for the storage of temporary
-.\"O files. The default value is
-.\"O .IR /tmp .
-.\"O This flag is most useful when restoring files after having booted from a
-.\"O floppy. There might be little or no space on the floppy filesystem, but another
-.\"O source of space might exist.
-.TP
-.BI \-T " directory"
-.B \-T
-フラグで
-テンポラリファイルを格納するのに使う
-ディレクトリが指定できる。
-デフォルト値は
-.IR /tmp
-である。
-このフラグは
-フロッピーからブートした後でrestoreする時に
-もっとも便利である。
-フロッピーのファイルシステムでは
-空きがないか、わずかなのに
-他の資源には空きがあるであろうから。
-.\"O .TP
-.\"O .B \-u
-.\"O When creating certain types of files,
-.\"O .B restore
-.\"O may generate a warning diagnostic if they already exist in the target
-.\"O directory. To prevent this, the
-.\"O .B \-u
-.\"O (unlink) flag causes
-.\"O .B restore
-.\"O to remove old entries before attempting to create new ones.
-.TP
-.B \-u
-ある種のファイルを生成するとき、
-それらがターゲットディレクトリにすでに存在するなら
-.B restore
-は警告診断を発生させる。
-これを防止するため、
-.B \-u
-(unlink)
-フラグで
-.B restore
-が新しいエントリを生成しようとする前に
-古いエントリを削除する。
-.\"O .TP
-.\"O .B \-v
-.\"O Normally
-.\"O .B restore
-.\"O does its work silently. The
-.\"O .B \-v
-.\"O (verbose) flag causes it to type the name of each file it treats preceded by
-.\"O its file type.
-.TP
-.B \-v
-通常、
-.B restore
-は静かに稼働する。
-.B \-v
-(verbose) フラグは
-ファイルを取り扱う前に
-それぞれのファイルのタイプに続いて名前を表示する。
-.\"O .TP
-.\"O .B \-V
-.\"O Enables reading multi-volume non-tape mediums like CDROMs.
-.TP
-.B \-V
-は
-CDROMのような非テープメディアの
-マルチボリュームを読みだすことを有効にする。
-.\"O .TP
-.\"O .BI \-X " filelist"
-.\"O Read list of files to be listed or extracted from the text file
-.\"O .I filelist
-.\"O in addition to those specified on the command line. This can be used in
-.\"O conjunction with the
-.\"O .B \-t
-.\"O or
-.\"O .B \-x
-.\"O commands. The file
-.\"O .I filelist
-.\"O should contain file names separated by newlines.
-.\"O .I filelist
-.\"O may be an ordinary file or
-.\"O .I -
-.\"O (the standard input).
-.TP
-.BI \-X " filelist"
-は
-テキストファイル
-.I filelist
-から
-一覧もしくは展開されるべきファイルのリスト
-を読んで、
-コマンドラインで指定されたリストに加える。
-これは
-.B \-t
-もしくは
-.B \-x
-コマンドとともに
-使うことができる。
-ファイル
-.I filelist
-は改行で区切られたファイル名を含まなくてはならない。
-.I filelist
-は通常のファイルか
-.I -
-(標準入力)
-である。
-.\"O .TP
-.\"O .B \-y
-.\"O Do not ask the user whether to abort the restore in the event of an error.
-.\"O Always try to skip over the bad block(s) and continue.
-.TP
-.B \-y
-は
-エラーの場合においても
-restoreを中断するかどうか
-ユーザーに問わない。
-なるたけ、バッドブロックを飛ばして継続することを試みる。
-.\"O .SH DIAGNOSTICS
-.\"O Complains if it gets a read error. If
-.\"O .B y
-.\"O has been specified, or the user responds
-.\"O .BR y ,
-.\"O .B restore
-.\"O will attempt to continue the restore.
-.SH 診断(DIAGNOSTICS)
-リードエラーが起きたら診断が表示される。
-もし、
-.B y
-が指定されていたり、
-もしくはユーザーが
-.BR y
-と返答すると、
-.B restore
-はリストアを継続しようと試みる。
-.\"O .PP
-.\"O If a backup was made using more than one tape volume,
-.\"O .B restore
-.\"O will notify the user when it is time to mount the next volume. If the
-.\"O .B \-x
-.\"O or
-.\"O .B \-i
-.\"O flag has been specified,
-.\"O .B restore
-.\"O will also ask which volume the user wishes to mount. The fastest way to extract
-.\"O a few files is to start with the last volume, and work towards the first volume.
-.PP
-もし、バックアップが1テープより多くのボリュームを使って作られた場合は、
-次のボリュームをマウントする時がきたら
-.B restore
-はユーザーに通知する。
-もし、
-.B \-x
-もしくは
-.B \-i
-フラグが指定されたら、
-.B restore
-は
-ユーザーがマウントしたいボリュームも問い合わせて来る。
-わずかなファイルを展開するもっとも手早い方法は
-最終ボリュームから始めて、
-最初のボリュームに向かって作業を進めていくことである。
-.\"O .PP
-.\"O There are numerous consistency checks that can be listed by
-.\"O .BR restore .
-.\"O Most checks are self-explanatory or can \*(lqnever happen\*(rq. Common errors
-.\"O are given below:
-.PP
-.BR restore .
-には多数の一貫性検査がある。
-ほとんどのチェックは自明なものや
-\*(lq 決して起こりえない \*(rq
-ものである。
-よくあるエラーを以下に挙げる:
-.\"O .TP
-.\"O .I Converting to new file system format
-.\"O A dump tape created from the old file system has been loaded. It is
-.\"O automatically converted to the new file system format.
-.TP
-.I Converting to new file system format
-古いファイルシテスムで生成されたダンプテープがロードされている。
-新しいファイルシステム形式に自動的に変換される。
-.\"O .TP
-.\"O .I <filename>: not found on tape
-.\"O The specified file name was listed in the tape directory, but was not found on
-.\"O the tape. This is caused by tape read errors while looking for the file, and
-.\"O from using a dump tape created on an active file system.
-.TP
-.I <filename>: not found on tape
-指定されたファイル名はテープディレクトリには記載されているが、
-テープ上に見付からなかった。
-これが起こるのはファイルを探しているときのテープリードエラーや
-稼働中のファイルシステムで生成したダンプを使うことによる。
-.\"O .TP
-.\"O .I expected next file <inumber>, got <inumber>
-.\"O A file that was not listed in the directory showed up. This can occur when
-.\"O using a dump created on an active file system.
-.TP
-.I expected next file <inumber>, got <inumber>
-ディレクトリにはないファイルが出現した。
-これは稼働中のファイルシステムで生成したダンプを使ったときに起こりうる。
-.\"O .TP
-.\"O .I Incremental dump too low
-.\"O When doing an incremental restore, a dump that was written before the previous
-.\"O incremental dump, or that has too low an incremental level has been loaded.
-.TP
-.I Incremental dump too low
-増分リストアをしているとき、
-直前の増分ダンプ以前に書かれたダンプか、
-増分レベルの低すぎるダンプがロードされている。
-.\"O .TP
-.\"O .I Incremental dump too high
-.\"O When doing an incremental restore, a dump that does not begin its coverage
-.\"O where the previous incremental dump left off, or that has too high an
-.\"O incremental level has been loaded.
-.TP
-.I Incremental dump too high
-増分リストアをしているときに、
-直前の増分ダンプを終えた後でその適合範囲から始まらないダンプ、
-もしくは増分レベルの高すぎるダンプがロードされている。
-.\"O .TP
-.\"O .I Tape read error while restoring <filename>
-.TP
-.I Tape read error while restoring <filename>
-.\"O .TP
-.\"O .I Tape read error while skipping over inode <inumber>
-.TP
-.I Tape read error while skipping over inode <inumber>
-.\"O .TP
-.\"O .I Tape read error while trying to resynchronize
-.\"O A tape (or other media) read error has occurred. If a file name is specified,
-.\"O its contents are probably partially wrong. If an inode is being skipped or the
-.\"O tape is trying to resynchronize, no extracted files have been corrupted, though
-.\"O files may not be found on the tape.
-.TP
-.I Tape read error while trying to resynchronize
-テープ(もしくは他のメディア)リードエラーが起こった。
-ファイル名が指定されていて、
-その内容の一部が悪いかも知れない。
-inodeがスキップされているとか
-テープが再同期を試みるなら、
-抽出されたファイルは破損していないものの、
-テープ上のファイルは見付けられないかもしれない。
-.\"O .TP
-.\"O .I resync restore, skipped <num> blocks
-.\"O After a dump read error,
-.\"O .B restore
-.\"O may have to resynchronize itself. This message lists the number of blocks that
-.\"O were skipped over.
-.TP
-.I resync restore, skipped <num> blocks
-ダンプリードエラーの後、
-.B restore
-は正常に再同期しなくてはならない。
-このメッセージは
-飛ばしたブロックの数を記載している。
-.\"O .SH EXIT STATUS
-.\"O .B Restore
-.\"O exits with zero status on success. Tape errors are indicated with an exit code
-.\"O of 1.
-.SH 返り値(EXIT STATUS)
-.B Restore
-は成功すると 0 で終了する。
-1 のexit code はテープエラーを示している。
-.\"O .PP
-.\"O When doing a comparison of files from a dump, an exit code of 2 indicates that
-.\"O some files were modified or deleted since the dump was made.
-.PP
-ダンプからのファイルを比較を行ったときに、
-exit code 2 は、
-ダンプが生成されてから
-いくらかのファイルが更新されるか削除された
-ことを示す。
-.\"O .SH ENVIRONMENT
-.\"O If the following environment variable exists it will be utilized by
-.\"O .BR restore :
-.SH 環境変数
-もし、以下の環境変数が存在するなら
-.BR restore
-で利用される。:
-.\"O .TP
-.\"O .B TAPE
-.\"O If no
-.\"O .B \-f
-.\"O option was specified,
-.\"O .B restore
-.\"O will use the device specified via
-.\"O .B TAPE
-.\"O as the dump device.
-.\"O .B TAPE
-.\"O may be of the form
-.\"O .IR tapename ,
-.\"O .I host:tapename
-.\"O or
-.\"O .IR user@host:tapename .
-.TP
-.B TAPE
-もし、
-.B \-f
-オプションが指定されていない場合、
-.B restore
-は
-ダンプデバイスとして
-.B TAPE
-で指定されるデバイスを使う。
-.B TAPE
-は
-.IR tapename ,
-.I host:tapename
-もしくは
-.IR user@host:tapename
-の形式である。
-.\"O .TP
-.\"O .B TMPDIR
-.\"O The directory given in
-.\"O .B TMPDIR
-.\"O will be used instead of
-.\"O .I /tmp
-.\"O to store temporary files.
-.TP
-.B TMPDIR
-.B TMPDIR
-で与えられたディレクトリは
-.I /tmp
-の代わりに一時ファイルを格納するのに使う。
-.\"O .TP
-.\"O .B RMT
-.\"O The environment variable
-.\"O .B RMT
-.\"O will be used to determine the pathname of the remote
-.\"O .BR rmt (8)
-.\"O program.
-.TP
-.B RMT
-環境変数
-.B RMT
-はリモートプログラム
-.BR rmt (8)
-のパス名を決めるのに使われる。
-.\"O .TP
-.\"O .B RSH
-.\"O .B Restore
-.\"O uses the contents of this variable to determine the name of the remote shell
-.\"O command to use when doing a network restore (rsh, ssh etc.). If this variable
-.\"O is not set,
-.\"O .BR rcmd (3)
-.\"O will be used, but only root will be able to do a network restore.
-.TP
-.B RSH
-.B restore
-はこの環境変数の内容を
-ネットワークリストアするときに
-リモートシェルコマンドの名前を決めるのに
-つかう。
-(rsh, ssh 他)
-もし、この変数が設定されていない場合は
-.BR rcmd (3)
-が使われるが、
-rootのみがネットワークリストアできる。
-.\"O .SH FILES
-.SH ファイル
-.\"O .TP
-.\"O .I /dev/st0
-.\"O the default tape drive
-.TP
-.I /dev/st0
-デフォルトのテープドライブ
-.\"O .TP
-.\"O .I /tmp/rstdir*
-.\"O file containing directories on the tape
-.TP
-.I /tmp/rstdir*
-テープ上のディレクトリを含むファイル
-.\"O .TP
-.\"O .I /tmp/rstmode*
-.\"O owner, mode, and time stamps for directories
-.TP
-.I /tmp/rstmode*
-ディレクトリのオーナー、モード、タイムスタンプ
-.\"O .TP
-.\"O .I ./restoresymtable
-.\"O information passed between incremental restores
-.TP
-.I ./restoresymtable
-増分リストアの間で渡される情報
-.\"O .SH SEE ALSO
-.\"O .BR dump (8),
-.\"O .BR mount (8),
-.\"O .BR mke2fs (8),
-.\"O .BR rmt (8)
-.SH 関連項目
-.BR dump (8),
-.BR mount (8),
-.BR mke2fs (8),
-.BR rmt (8)
-.\"O .SH BUGS
-.\"O .B Restore
-.\"O can get confused when doing incremental restores from dumps that were made on
-.\"O active file systems.
-.SH バグ
-稼働中のファイルシステムで作られたダンプから増分リストアをするとき、
-.B restore
-は誤動作しうる。
-.\"O .PP
-.\"O A level 0 dump must be done after a full restore. Because
-.\"O .B restore
-.\"O runs in user code, it has no control over inode allocation; thus a full dump
-.\"O must be done to get a new set of directories reflecting the new inode
-.\"O numbering, even though the content of the files is unchanged.
-.PP
-フルリストアの後、必ずレベル0ダンプを行うべきである。
-なぜなら、
-.B restore
-はユーザーコードで走るので、
-inodeの割り当てまで管理しない;
-なので、たとえファイルの内容を変えていなくとも、
-新しいinode番号を反映する
-新しいディレクトリ一式を得るためにフルダンプしなくてはならない。
-.\"O .PP
-.\"O The temporary files
-.\"O .I /tmp/rstdir*
-.\"O and
-.\"O .I /tmp/rstmode*
-.\"O are generated with a unique name based on the date of the dump and the process
-.\"O ID (see
-.\"O .BR mktemp (3) ),
-.\"O except when
-.\"O .B \-r
-.\"O or
-.\"O .B \-R
-.\"O is used. Because
-.\"O .B \-R
-.\"O allows you to restart a
-.\"O .B \-r
-.\"O operation that may have been interrupted, the temporary files should be the
-.\"O same across different processes. In all other cases, the files are unique
-.\"O because it is possible to have two different dumps started at the same time,
-.\"O and separate operations shouldn't conflict with each other.
-.PP
-テンポラリファイル
-.I /tmp/rstdir*
-および
-.I /tmp/rstmode*
-はダンプの日時とプロセスIDに基づいたユニークな名前
-(
-.BR mktemp (3)
-をみること)で生成される、
-.B \-r
-もしくは
-.B \-R
-を使うときを除いて。
-.B \-R
-は
-中断された
-.B \-r
-の作業を再開することができるので、
-テンポラリファイルは
-異なるプロセスにまたがって同じになるべきである。
-他の場合ではすべて、
-ファイルはユニークで、
-それは
-2つの異なるダンプを同時に開始し
-それぞれ別の処理どおしが衝突を起こさないためである。
-.\"O .PP
-.\"O To do a network restore, you have to run
-.\"O .B restore
-.\"O as root or use a remote shell replacement (see
-.\"O .B RSH
-.\"O variable). This is due to the previous security history of
-.\"O .B dump
-.\"O and
-.\"O .BR restore .
-.\"O (
-.\"O .B restore
-.\"O is written to be setuid root, but we are not certain all bugs are gone from the
-.\"O code - run setuid at your own risk.)
-.PP
-ネットワークリストアをするためには、
-.B restore
-はrootにて走らせるか、
-リモートシェルの置き換え
-をしなければならない
-(
-.B RSH
-変数をみること)。
-これは、
-.B dump
-と
-.BR restore
-の
-これまでのセキュリティの変遷のためである。
-(
-.B restore
-はrootにsetuidするように書かれているが、
-コードから全てのバグを取り除いた確証はない。
-自己責任にて setuid を走らせること。
-)
-.\"O .PP
-.\"O At the end of restores in
-.\"O .B \-i
-.\"O or
-.\"O .B \-x
-.\"O modes (unless
-.\"O .B \-o
-.\"O option is in use),
-.\"O .B restore
-.\"O will ask the operator whether to set the permissions on the current
-.\"O directory. If the operator confirms this action, the permissions
-.\"O on the directory from where
-.\"O .B restore
-.\"O was launched will be replaced by the permissions on the dumped root
-.\"O inode. Although this behaviour is not really a bug, it has proven itself
-.\"O to be confusing for many users, so it is recommended to answer 'no',
-.\"O unless you're performing a full restore and you do want to restore the
-.\"O permissions on '/'.
-.PP
-.B \-i
-もしくは
-.B \-x
-モードで
-リストアの最後で
-(
-.B \-o
-オプションが使われていなければ)、
-.B restore
-は
-カレントディレクトリのパーミッションをセットするかどうか聞いて来る。
-もしこの実行を認めると、
-.B restore
-を発行したディレクトリのパーミッションが
-ダンプ元のinodeのパーミッションで
-置き換えられる。
-この挙動は本当のバグでないにもかかわらず、
-多くのユーザを当惑させることが分かっていて、
-なのでnoと答えることを推奨している、
-フルリストアをする場合や、'/' のパーミッションを復元しようとしている場合でなければ。
-.\"O .SH AUTHOR
-.\"O The
-.\"O .B dump/restore
-.\"O backup suite was ported to Linux's Second Extended File System by Remy Card
-.\"O <card@Linux.EU.Org>. He maintained the initial versions of
-.\"O .B dump
-.\"O (up and including 0.4b4, released in january 1997).
-.\"O .PP
-.\"O Starting with 0.4b5, the new maintainer is Stelian Pop <stelian@popies.net>.
-.SH 著者
-.B dump/restore
-バックアップsuiteは
-Remy Card <card@Linux.EU.Org>
-によって
-Linuxのext2ファイルシステム(Second Extended File System)
-に移植された。
-彼は
-.B dump
-の初期バージョンを保守した
-(1997年1月にリリースされた0.4b4を含む以後)。
-.PP
-0.4b5からは、
-新しいメンテナは
-Stelian Pop <stelian@popies.net>
-である。
-.\"O .SH AVAILABILITY
-.\"O The
-.\"O .B dump/restore
-.\"O backup suite is available from <http://dump.sourceforge.net>
-.SH 入手
-.B dump/restore
-バックアップsuiteは
-<http://dump.sourceforge.net>
-から入手できる。
-.\"O .SH HISTORY
-.\"O The
-.\"O .B restore
-.\"O command appeared in 4.2BSD.
-.SH 履歴
-.B restore
-コマンドは
-4.2BSD
-で登場した。
+++ /dev/null
-Begin3
-Title: dump and restore for Ext2fs
-Version: 0.4b40
-Entered-date: 01MAY05
-Description: Port of the 4.4BSD dump and restore backup suite
-Keywords: backup, filesystem, Ext2fs
-Author: University of California, Berkeley
-Maintained-by: stelian@popies.net (Stelian Pop)
-Primary-site: http://dump.sourceforge.net/
- 0kB dump-0.4b40.tar.gz
- 0 dump.lsm
-Original-site: ftp.freebsd.org /pub/bsd-sources/4.4BSD-Lite2/sbin
- dump/*
- restore/*
-Platforms: linux 2.0.x, linux 2.2.x, linux 2.4.x, linux 2.6.x
- e2fsprogs 1.14 or better
-Copying-policy: BSD
-End
+++ /dev/null
-.\" Copyright (c) 1980, 1991, 1993
-.\" Regents of the University of California.
-.\" 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.
-.\" 3. Neither the name of the University nor the names of its contributors
-.\" may be used to endorse or promote products derived from this software
-.\" without specific prior written permission.
-.\"
-.\" 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.
-.\"
-.\" $Id: dump.8.in,v 1.57 2004/07/13 08:17:32 stelian Exp $
-.\"
-.TH DUMP 8 "version 0.4b40 of May 2, 2005" BSD "System management commands"
-.SH NAME
-dump \- ext2/3 filesystem backup
-.SH SYNOPSIS
-.B dump
-[\fB\-\fIlevel#\fR]
-[\fB\-ackMnqSuv]
-[\fB\-A \fIfile\fR]
-[\fB\-B \fIrecords\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-d \fIdensity\fR]
-[\fB\-D \fIfile\fR]
-[\fB\-e \fIinode numbers\fR]
-[\fB\-E \fIfile\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-h \fIlevel\fR]
-[\fB\-I \fInr errors\fR]
-[\fB\-j\fIcompression level\fR]
-[\fB\-L \fIlabel\fR]
-[\fB\-Q \fIfile\fR]
-[\fB\-s \fIfeet\fR]
-[\fB\-T \fIdate\fR]
-[\fB\-y\fR]
-[\fB\-z\fIcompression level\fR]
-.I files-to-dump
-.PP
-.B dump
-[\fB\-W \fR| \fB\-w\fR]
-.SH DESCRIPTION
-.B Dump
-examines files on an ext2/3 filesystem and determines which files need to be
-backed up. These files are copied to the given disk, tape or other storage
-medium for safe keeping (see the
-.B \-f
-option below for doing remote backups). A dump that is larger than the output
-medium is broken into multiple volumes. On most media the size is determined by
-writing until an end-of-media indication is returned.
-.PP
-On media that cannot reliably return an end-of-media indication (such as some
-cartridge tape drives), each volume is of a fixed size; the actual size is
-determined by specifying cartridge media, or via the tape size, density and/or
-block count options below. By default, the same output file name is used for
-each volume after prompting the operator to change media.
-.PP
-.I files-to-dump
-is either a mountpoint of a filesystem or a list of files and directories to be
-backed up as a subset of a filesystem. In the former case, either the path to a
-mounted filesystem or the device of an unmounted filesystem can be used. In the
-latter case, certain restrictions are placed on the backup:
-.B \-u
-is not allowed, the only dump level that is supported is
-.B 0
-and all the files and directories must reside on the same filesystem.
-.SH OPTIONS
-The following options are supported by
-.B dump:
-.TP
-.BI \-level#
-The dump level (any integer). A level 0, full backup, guarantees the
-entire file system is copied (but see also the
-.B \-h
-option below). A level number above 0, incremental backup, tells
-.B dump
-to
-copy all files new or modified since the last dump of a lower level. The
-default level is 9. Historically only levels 0 to 9 were usable in
-dump, this version is able to understand any integer as a dump level.
-.TP
-.BI \-a
-\*(lqauto-size\*(rq. Bypass all tape length calculations, and write until an
-end-of-media indication is returned. This works best for most modern tape
-drives, and is the default. Use of this option is particularly recommended when
-appending to an existing tape, or using a tape drive with hardware compression
-(where you can never be sure about the compression ratio).
-.TP
-.BI \-A " archive_file"
-Archive a dump table-of-contents in the specified
-.I archive_file
-to be used by
-.BR restore (8)
-to determine whether a file is in the dump file that is being restored.
-.TP
-.BI \-b " blocksize"
-The number of kilobytes per dump record. The default blocksize is 10,
-unless the
-.B \-d
-option has been used to specify a tape density of 6250BPI or more,
-in which case the default blocksize is 32. Th maximal value is 1024.
-Note however that, since the IO system slices all requests into chunks
-of
-.B MAXBSIZE
-(which can be as low as 64kB), you can experience problems with
-.BR dump (8)
-and
-.BR restore (8)
-when using a higher value, depending on your kernel and/or libC versions.
-.TP
-.BI \-B " records"
-The number of 1 kB blocks per volume. Not normally required, as
-.B dump
-can detect end-of-media. When the specified size is reached,
-.B dump
-waits for you to change the volume. This option overrides the calculation of
-tape size based on length and density. If compression is on this limits the
-size of the compressed output per volume. Multiple values may be given
-as a single argument separated by commas. Each value will be used for one
-dump volume in the order listed; if
-.B dump
-creates more volumes than the
-number of values given, the last value will be used for the remaining
-volumes. This is useful for filling up already partially filled media
-(and then continuing with full size volumes on empty media) or mixing media
-of different sizes.
-.TP
-.BI \-c
-Change the defaults for use with a cartridge tape drive, with a density of 8000
-bpi, and a length of 1700 feet. Specifying a cartridge drive overrides the
-end-of-media detection.
-.TP
-.BI \-d " density"
-Set tape density to
-.IR density .
-The default is 1600BPI. Specifying a tape density overrides the end-of-media
-detection.
-.TP
-.BI \-D " file"
-Set the path name of the file storing the information about the previous
-full and incremental dumps. The default location is
-.IR /usr/local/etc/dumpdates .
-.TP
-.BI \-e " inodes"
-Exclude
-.I inodes
-from the dump. The
-.I inodes
-parameter is a comma separated list of inode numbers (you can use
-.BR stat (1)
-to find the inode number for a file or directory).
-.TP
-.BI \-E " file"
-Read list of inodes to be excluded from the dump from the text file
-.IR file .
-The file
-.I file
-should be an ordinary file containing inode numbers separated by newlines.
-.TP
-.BI \-f " file"
-Write the backup to
-.IR file ;
-.I file
-may be a special device file like
-.I /dev/st0
-(a tape drive),
-.I /dev/rsd1c
-(a floppy disk drive), an ordinary file, or
-.I \-
-(the standard output). Multiple file names may be given as a single argument
-separated by commas. Each file will be used for one dump volume in the order
-listed; if the dump requires more volumes than the number of names given,
-the last file name will used for all remaining volumes after prompting for
-media changes. If the name of the file is of the form
-.I host:file
-or
-.I user@host:file
-.B dump
-writes to the named file on the remote host (which should already
-exist, dump doesn't create a new remote file) using
-.BR rmt (8).
-The default path name of the remote
-.BR rmt (8)
-program is
-.IR /etc/rmt ;
-this can be overridden by the environment variable
-.BR RMT .
-.TP
-.BI \-F " script"
-Run script at the end of each tape (except for the last one).
-The device name and the current volume number are passed on the
-command line. The script must return 0 if
-.B dump
-should continue without asking the user to change the tape, 1 if
-.B dump
-should continue but ask the user to change the tape. Any other exit code will
-cause
-.B dump
-to abort. For security reasons,
-.B dump
-reverts back to the real user ID and the real group ID before running the
-script.
-.TP
-.BI \-h " level"
-Honor the user
-.B nodump
-flag
-.B UF_NODUMP
-only for dumps at or above the given
-.IR level .
-The default honor level is 1, so that incremental backups omit such files but
-full backups retain them.
-.TP
-.BI \-I " nr errors"
-By default,
-.B dump
-will ignore the first 32 read errors on the file system before asking for
-operator intervention. You can change this using this flag to any value. This
-is useful when running
-.B dump
-on an active filesystem where read errors simply indicate an inconsistency
-between the mapping and dumping passes.
-.IP
-A value of 0 means that all read errors will be ignored.
-.TP
-.BI \-j "compression level"
-Compress every block to be written on the tape using bzlib library. This option
-will work only when dumping to a file or pipe or, when dumping to a tape drive,
-if the tape drive is capable of writing variable length blocks. You will need
-at least the 0.4b24 version of
-.B restore
-in order to extract compressed tapes. Tapes written using compression will not
-be compatible with the BSD tape format. The (optional) parameter specifies the
-compression level bzlib will use. The default compression level is 2. If the
-optional parameter is specified, there should be no white space between the
-option letter and the parameter.
-.TP
-.BI \-k
-Use Kerberos authentication to talk to remote tape servers. (Only available if
-this option was enabled when
-.B dump
-was compiled.)
-.TP
-.BI \-L " label"
-The user-supplied text string
-.I label
-is placed into the dump header, where tools like
-.BR restore (8)
-and
-.BR file (8)
-can access it. Note that this label is limited to be at most
-.B LBLSIZE
-(currently 16) characters, which must include the terminating \e0.
-.TP
-.BI \-m
-If this flag is specified,
-.B dump
-will optimise the output for inodes having been changed but not modified since
-the last dump ('changed' and 'modified' have the meaning defined in
-.BR stat (2)
-). For those inodes,
-.B dump
-will save only the metadata, instead of saving the entire inode contents.
-Inodes which are either directories or have been modified since the last dump
-are saved in a regular way. Uses of this flag must be consistent, meaning that
-either every dump in an incremental dump set have the flag, or no one has it.
-.IP
-Tapes written using such 'metadata only' inodes will not be compatible with the
-BSD tape format or older versions of
-.B restore.
-.TP
-.BI \-M
-Enable the multi-volume feature. The name specified with
-.B f
-is treated as a prefix and
-.B dump
-writes in sequence to
-.I <prefix>001, <prefix>002
-etc. This can be useful when dumping to files on an ext2 partition, in order to
-bypass the 2GB file size limitation.
-.TP
-.BI \-n
-Whenever
-.B dump
-requires operator attention, notify all operators in the group
-.B operator
-by means similar to a
-.BR wall (1).
-.TP
-.BI \-q
-Make
-.B dump
-abort immediately whenever operator attention is required, without prompting in
-case of write errors, tape changes etc.
-.TP
-.BI \-Q " file"
-Enable the Quick File Access support. Tape positions for each inode are stored
-into the file
-.I file
-which is used by
-.B restore
-(if called with parameter
-.B \-Q
-and the filename) to directly position the tape at the file
-.B restore
-is currently working on. This saves hours when restoring single files from
-large backups, saves the tapes and the drive's head.
-.IP
-It is recommended to set up the st driver to return logical tape positions
-rather than physical before calling
-.B dump/restore
-with parameter
-.BR \-Q .
-Since not all tape devices support physical tape positions those tape devices
-return an error during
-.B dump/restore
-when the st driver is set to the default physical setting. Please see the
-.BR st (4)
-man page, option
-.B MTSETDRVBUFFER
-, or the
-.BR mt (1)
-man page, on how to set the driver to return logical tape positions.
-.IP
-Before calling
-.B restore
-with parameter
-.BR \-Q ,
-always make sure the st driver is set to return the same type of tape position
-used during the call to
-.BR dump .
-Otherwise
-.B restore
-may be confused.
-.IP
-This option can be used when dumping to local tapes (see above) or to local
-files.
-.TP
-.BI \-s " feet"
-Attempt to calculate the amount of tape needed at a particular density. If this
-amount is exceeded,
-.B dump
-prompts for a new tape. It is recommended to be a bit conservative on this
-option. The default tape length is 2300 feet. Specifying the tape size
-overrides end-of-media detection.
-.TP
-.BI \-S
-Size estimate. Determine the amount of space that is needed to perform the dump
-without actually doing it, and display the estimated number of bytes it will
-take. This is useful with incremental dumps to determine how many volumes of
-media will be needed.
-.TP
-.BI \-T " date"
-Use the specified date as the starting time for the dump instead of the time
-determined from looking in
-.I /usr/local/etc/dumpdates .
-The format of
-.I date
-is the same as that of
-.BR ctime (3)
-followed by an rfc822 timezone specification: either a plus or minus sign
-followed by two digits for the number of hours and two digits for the minutes.
-For example, -0800 for eight hours west of Greenwich or +0230 for two hours
-and a half east of Greenwich. This timezone offset takes into account
-daylight savings time (if applicable to the timezone): UTC offsets
-when daylight savings time is in effect will be different than offsets
-when daylight savings time is not in effect. For backward
-compatibility, if no timezone is specified, a local time is assumed.
-This option is useful for automated dump scripts that wish to dump over a
-specific period of time. The
-.B \-T
-option is mutually exclusive from the
-.B \-u
-option.
-.TP
-.BI \-u
-Update the file
-.I /usr/local/etc/dumpdates
-after a successful dump. The format of
-.I /usr/local/etc/dumpdates
-is readable by people, consisting of one free format record per line:
-filesystem name, increment level and
-.BR ctime (3)
-format dump date followed by a rfc822 timezone specification (see the
-.B \-u
-option for details). If no timezone offset is specified, times are interpreted
-as local. Whenever the file is written, all dates in the file are converted
-to the local time zone, without changing the UTC times. There
-may be only one entry per filesystem at each level. The file
-.I /usr/local/etc/dumpdates
-may be edited to change any of the fields, if necessary.
-.TP
-.BI \-v
-The
-.B \-v
-(verbose) makes
-.B dump
-to print extra information which could be helpful in debug sessions.
-.TP
-.BI \-W
-.B Dump
-tells the operator what file systems need to be dumped. This information is
-gleaned from the files
-.I /usr/local/etc/dumpdates
-and
-.IR /etc/fstab .
-The
-.B \-W
-option causes
-.B dump
-to print out, for all file systems in
-.I /usr/local/etc/dumpdates ,
-and regognized file systems in
-.I /etc/mtab
-and
-.IR /etc/fstab .
-the most recent dump date and level, and highlights those that should be
-dumped. If the
-.B \-W
-option is set, all other options are ignored, and
-.B dump
-exits immediately.
-.TP
-.BI \-w
-Is like
-.BR \-W ,
-but prints only recognized filesystems in
-.I /etc/mtab
-and
-.I /etc/fstab
-which need to be dumped.
-.TP
-.BI \-y
-Compress every block to be written to the tape using the lzo library.
-This doesn't compress as well as the zlib library but it's much faster.
-This option will work only when dumping to a file or pipe or, when dumping to
-a tape drive, if the tape drive is capable of writing variable length blocks.
-You will need at least the 0.4b34 version of
-.B restore
-in order to extract compressed tapes. Tapes written using compression will not
-be compatible with the BSD tape format.
-.TP
-.BI \-z "compression level"
-Compress every block to be written on the tape using zlib library. This option
-will work only when dumping to a file or pipe or, when dumping to a tape drive,
-if the tape drive is capable of writing variable length blocks. You will need
-at least the 0.4b22 version of
-.B restore
-in order to extract compressed tapes. Tapes written using compression will not
-be compatible with the BSD tape format. The (optional) parameter specifies the
-compression level zlib will use. The default compression level is 2. If the
-optional parameter is specified, there should be no white space between the
-option letter and the parameter.
-.PP
-.B Dump
-requires operator intervention on these conditions: end of tape, end of dump,
-tape write error, tape open error or disk read error (if there is more than a
-threshold of nr errors). In addition to alerting all operators implied by the
-.B \-n
-key,
-.B dump
-interacts with the operator on dump's control terminal at times when
-.B dump
-can no longer proceed, or if something is grossly wrong. All questions
-.B dump
-poses
-.I must
-be answered by typing \*(lqyes\*(rq or \*(lqno\*(rq, appropriately.
-.PP
-Since making a dump involves a lot of time and effort for full dumps,
-.B dump
-checkpoints itself at the start of each tape volume. If writing that volume
-fails for some reason,
-.B dump
-will, with operator permission, restart itself from the checkpoint after the
-old tape has been rewound and removed, and a new tape has been mounted.
-.PP
-.B Dump
-tells the operator what is going on at periodic intervals, including usually
-low estimates of the number of blocks to write, the number of tapes it will
-take, the time to completion, and the time to the tape change. The output is
-verbose, so that others know that the terminal controlling
-.B dump
-is busy, and will be for some time.
-.PP
-In the event of a catastrophic disk event, the time required to restore all the
-necessary backup tapes or files to disk can be kept to a minimum by staggering
-the incremental dumps. An efficient method of staggering incremental dumps to
-minimize the number of tapes follows:
-.IP \(em
-Always start with a level 0 backup, for example:
-.RS 14
-.B /sbin/dump -0u -f /dev/st0 /usr/src
-.RE
-.IP
-This should be done at set intervals, say once a month or once every two months,
-and on a set of fresh tapes that is saved forever.
-.IP \(em
-After a level 0, dumps of active file systems are taken on a daily basis, using
-a modified Tower of Hanoi algorithm, with this sequence of dump levels:
-.RS 14
-.B 3 2 5 4 7 6 9 8 9 9 ...
-.RE
-.IP
-For the daily dumps, it should be possible to use a fixed number of tapes for
-each day, used on a weekly basis. Each week, a level 1 dump is taken, and the
-daily Hanoi sequence repeats beginning with 3. For weekly dumps, another fixed
-set of tapes per dumped file system is used, also on a cyclical basis.
-.PP
-After several months or so, the daily and weekly tapes should get rotated out
-of the dump cycle and fresh tapes brought in.
-.PP
-(The 4.3BSD option syntax is implemented for backward compatibility but is not
-documented here.)
-.SH ENVIRONMENT
-.TP
-.B TAPE
-If no
-.B \-f
-option was specified,
-.B dump
-will use the device specified via
-.B TAPE
-as the dump device.
-.B TAPE
-may be of the form
-.IR tapename ,
-.IR host:tapename ,
-or
-.IR user@host:tapename .
-.TP
-.B RMT
-The environment variable
-.B RMT
-will be used to determine the pathname of the remote
-.BR rmt (8)
-program.
-.TP
-.B RSH
-.B Dump
-uses the contents of this variable to determine the name of the remote shell
-command to use when doing remote backups (rsh, ssh etc.). If this variable is
-not set,
-.BR rcmd (3)
-will be used, but only root will be able to do remote backups.
-.SH FILES
-.TP
-.I /dev/st0
-default tape unit to dump to
-.TP
-.I /usr/local/etc/dumpdates
-dump date records
-.TP
-.I /etc/fstab
-dump table: file systems and frequency
-.TP
-.I /etc/mtab
-dump table: mounted file systems
-.TP
-.I /etc/group
-to find group
-.I operator
-.SH SEE ALSO
-.BR fstab (5),
-.BR restore (8),
-.BR rmt (8)
-.SH DIAGNOSTICS
-Many, and verbose.
-.SH COMPATIBILITY
-The format of the
-.I /usr/local/etc/dumpdates
-file has changed in release 0.4b34, however, the file will be read
-correctly with either pre-0.4b34 or 0.4b34 and later versions of
-.B dump
-provided that the machine on which
-.B dump
-is run did not change timezones (which should be a fairly rare occurence).
-.SH EXIT STATUS
-.B Dump
-exits with zero status on success. Startup errors are indicated with an exit
-code of 1; abnormal termination is indicated with an exit code of 3.
-.SH BUGS
-It might be considered a bug that this version of dump can only handle ext2/3
-filesystems. Specifically, it does not work with FAT filesystems.
-.PP
-Fewer than 32 read errors (change this with
-.BR \-I )
-on the filesystem are ignored. If noticing read errors is important, the output
-from dump can be parsed to look for lines that contain the text 'read error'.
-.PP
-When a read error occurs,
-.B dump
-prints out the corresponding physical disk block and sector number and the
-ext2/3 logical block number. It doesn't print out the corresponing file name or
-even the inode number. The user has to use
-.BR debugfs (8),
-commands
-.B ncheck
-and
-.B icheck
-to translate the
-.B ext2blk
-number printed out by
-.B dump
-into an inode number, then into a file name.
-.PP
-Each reel requires a new process, so parent processes for reels already written
-just hang around until the entire tape is written.
-.PP
-The estimated number of tapes is not correct if compression is on.
-.PP
-It would be nice if
-.B dump
-knew about the dump sequence, kept track of the tapes scribbled on, told the
-operator which tape to mount when, and provided more assistance for the
-operator running
-.BR restore .
-.PP
-.B Dump
-cannot do remote backups without being run as root, due to its security history.
-Presently, it works if you set it setuid (like it used to be), but this might
-constitute a security risk. Note that you can set
-.B RSH
-to use a remote shell program instead.
-.SH AUTHOR
-The
-.B dump/restore
-backup suite was ported to Linux's Second Extended File System by Remy Card
-<card@Linux.EU.Org>. He maintained the initial versions of
-.B dump
-(up and including 0.4b4, released in january 1997).
-.PP
-Starting with 0.4b5, the new maintainer is Stelian Pop <stelian@popies.net>.
-.SH AVAILABILITY
-The
-.B dump/restore
-backup suite is available from <http://dump.sourceforge.net>
-.SH HISTORY
-A
-.B dump
-command appeared in
-.B Version 6 AT&T UNIX.
+++ /dev/null
-.so man8/dump.8
+++ /dev/null
-.\" Copyright (c) 1985, 1991, 1993
-.\" The Regents of the University of California. 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.
-.\" 3. Neither the name of the University nor the names of its contributors
-.\" may be used to endorse or promote products derived from this software
-.\" without specific prior written permission.
-.\"
-.\" 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.
-.\"
-.\" $Id: restore.8.in,v 1.32 2004/07/13 08:17:32 stelian Exp $
-.\"
-.TH RESTORE 8 "version 0.4b40 of May 2, 2005" BSD "System management commands"
-.SH NAME
-restore \- restore files or file systems from backups made with dump
-.SH SYNOPSIS
-.B restore \-C
-[\fB\-cdklMvVy\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-D \fIfilesystem\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-L \fIlimit\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-.PP
-.B restore \-i
-[\fB\-acdhklmMNouvVy\fR]
-[\fB\-A \fIfile\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-Q \fIfile\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-.PP
-.B restore \-P
-.I file
-[\fB\-acdhklmMNuvVy\fR]
-[\fB\-A \fIfile\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-[\fB\-X \fIfilelist\fR]
-[ \fIfile ... \fR]
-.PP
-.B restore \-R
-[\fB\-cdklMNuvVy\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-.PP
-.B restore \-r
-[\fB\-cdklMNuvVy\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-.PP
-.B restore \-t
-[\fB\-cdhklMNuvVy\fR]
-[\fB\-A \fIfile\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-Q \fIfile\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-[\fB\-X \fIfilelist\fR]
-[ \fIfile ... \fR]
-.PP
-.B restore \-x
-[\fB\-adchklmMNouvVy\fR]
-[\fB\-A \fIfile\fR]
-[\fB\-b \fIblocksize\fR]
-[\fB\-f \fIfile\fR]
-[\fB\-F \fIscript\fR]
-[\fB\-Q \fIfile\fR]
-[\fB\-s \fIfileno\fR]
-[\fB\-T \fIdirectory\fR]
-[\fB\-X \fIfilelist\fR]
-[ \fIfile ... \fR]
-.SH DESCRIPTION
-The
-.B restore
-command performs the inverse function of
-.BR dump (8).
-A full backup of a file system may be restored and subsequent incremental
-backups layered on top of it. Single files and directory subtrees may be
-restored from full or partial backups.
-.B Restore
-works across a network; to do this see the
-.B \-f
-flag described below. Other arguments to the command are file or directory
-names specifying the files that are to be restored. Unless the
-.B \-h
-flag is specified (see below), the appearance of a directory name refers to
-the files and (recursively) subdirectories of that directory.
-.PP
-Exactly one of the following flags is required:
-.TP
-.B \-C
-This mode allows comparison of files from a dump.
-.B Restore
-reads the backup and compares its contents with files present on the disk. It
-first changes its working directory to the root of the filesystem that was
-dumped and compares the tape with the files in its new current directory. See
-also the
-.B \-L
-flag described below.
-.TP
-.B \-i
-This mode allows interactive restoration of files from a dump. After reading in
-the directory information from the dump,
-.B restore
-provides a shell like interface that allows the user to move around the
-directory tree selecting files to be extracted. The available commands are
-given below; for those commands that require an argument, the default is the
-current directory.
-.RS
-.TP
-.B add \fR[\fIarg\fR]
-The current directory or specified argument is added to the list of files to be
-extracted. If a directory is specified, then it and all its descendents are
-added to the extraction list (unless the
-.B \-h
-flag is specified on the command line). Files that are on the extraction list
-are prepended with a \*(lq*\*(rq when they are listed by
-.BR ls .
-.TP
-.BI cd " arg"
-Change the current working directory to the specified argument.
-.TP
-.B delete \fR[\fIarg\fR]
-The current directory or specified argument is deleted from the list of files
-to be extracted. If a directory is specified, then it and all its descendents
-are deleted from the extraction list (unless the
-.B \-h
-flag is specified on the command line). The most expedient way to extract most
-of the files from a directory is to add the directory to the extraction list
-and then delete those files that are not needed.
-.TP
-.B extract
-All files on the extraction list are extracted from the dump.
-.B Restore
-will ask which volume the user wishes to mount. The fastest way to extract a f
-ew files is to start with the last volume and work towards the first volume.
-.TP
-.B help
-List a summary of the available commands.
-.TP
-.B ls \fR[\fIarg\fR]
-List the current or specified directory. Entries that are directories are
-appended with a \*(lq/\*(rq. Entries that have been marked for extraction are
-prepended with a \*(lq*\*(rq. If the verbose flag is set, the inode number of
-each entry is also listed.
-.TP
-.B pwd
-Print the full pathname of the current working directory.
-.TP
-.B quit
-.B Restore
-immediately exits, even if the extraction list is not empty.
-.TP
-.B setmodes
-All directories that have been added to the extraction list have their owner,
-modes, and times set; nothing is extracted from the dump. This is useful for
-cleaning up after a
-.B restore
-has been prematurely aborted.
-.TP
-.B verbose
-The sense of the
-.B \-v
-flag is toggled. When set, the verbose flag causes the
-.B ls
-command to list the inode numbers of all entries. It also causes
-.B restore
-to print out information about each file as it is extracted.
-.RE
-.TP
-.BI \-P " file"
-.B Restore
-creates a new Quick File Access file
-.I file
-from an existing dump file without restoring its contents.
-.TP
-.B \-R
-.B Restore
-requests a particular tape of a multi-volume set on which to restart a full
-restore (see the
-.B \-r
-flag below). This is useful if the restore has been interrupted.
-.TP
-.B \-r
-Restore (rebuild) a file system. The target file system should be made pristine
-with
-.BR mke2fs (8),
-mounted, and the user
-.BR cd 'd
-into the pristine file system before starting the restoration of the initial
-level 0 backup. If the level 0 restores successfully, the
-.B \-r
-flag may be used to restore any necessary incremental backups on top of the
-level 0. The
-.B \-r
-flag precludes an interactive file extraction and can be detrimental to one's
-health (not to mention the disk) if not used carefully. An example:
-.IP
-.RS 14
-.B mke2fs /dev/sda1
-.TP
-.B mount /dev/sda1 /mnt
-.TP
-.B cd /mnt
-.TP
-.B restore rf /dev/st0
-.RE
-.IP
-Note that
-.B restore
-leaves a file
-.I restoresymtable
-in the root directory to pass information between incremental restore passes.
-This file should be removed when the last incremental has been restored.
-.IP
-.BR Restore ,
-in conjunction with
-.BR mke2fs (8)
-and
-.BR dump (8),
-may be used to modify file system parameters such as size or block size.
-.TP
-.B \-t
-The names of the specified files are listed if they occur on the backup. If no
-file argument is given, the root directory is listed, which results in the
-entire content of the backup being listed, unless the
-.B \-h
-flag has been specified. Note that the
-.B \-t
-flag replaces the function of the old
-.BR dumpdir (8)
-program. See also the
-.B \-X
-option below.
-.TP
-.B \-x
-The named files are read from the given media. If a named file matches a
-directory whose contents are on the backup and the
-.B \-h
-flag is not specified, the directory is recursively extracted. The owner,
-modification time, and mode are restored (if possible). If no file argument is
-given, the root directory is extracted, which results in the entire content of
-the backup being extracted, unless the
-.B \-h
-flag has been specified. See also the
-.B \-X
-option below.
-.SH OPTIONS
-The following additional options may be specified:
-.TP
-.B \-a
-In
-.B \-i
-or
-.B \-x
-mode,
-.B restore
-does ask the user for the volume number on which the files to be extracted are
-supposed to be (in order to minimise the time by reading only the interesting
-volumes). The
-.B \-a
-option disables this behaviour and reads all the volumes starting with 1. This
-option is useful when the operator does not know on which volume the files to
-be extracted are and/or when he prefers the longer unattended mode rather than
-the shorter interactive mode.
-.TP
-.BI \-A " archive_file"
-Read the table of contents from
-.I archive_file
-instead of the media. This option can be used in combination with the
-.BR \-t ,
-.BR \-i ,
-or
-.B \-x
-options, making it possible to check whether files are on the media without
-having to mount the media.
-.TP
-.BI \-b " blocksize"
-The number of kilobytes per dump record. If the
-.B \-b
-option is not specified,
-.B restore
-tries to determine the media block size dynamically.
-.TP
-.B \-c
-Normally,
-.B restore
-will try to determine dynamically whether the dump was made from an old
-(pre-4.4) or new format file system. The
-.B \-c
-flag disables this check, and only allows reading a dump in the old format.
-.TP
-.B \-d
-The
-.B \-d
-(debug) flag causes
-.B restore
-to print debug information.
-.TP
-.BI \-D " filesystem"
-The
-.B \-D
-flag allows the user to specify the filesystem name when using
-.B restore
-with the
-.B \-C
-option to check the backup.
-.TP
-.BI \-f " file"
-Read the backup from
-.IR file ;
-.I file
-may be a special device file like
-.I /dev/st0
-(a tape drive),
-.I /dev/sda1
-(a disk drive), an ordinary file, or
-.I \-
-(the standard input). If the name of the file is of the form
-.I host:file
-or
-.IR user@host:file ,
-.B restore
-reads from the named file on the remote host using
-.BR rmt (8).
-.TP
-.BI \-F " script"
-Run script at the beginning of each tape. The device name and the current
-volume number are passed on the command line. The script must return 0 if
-.B restore
-should continue without asking the user to change the tape, 1 if
-.B restore
-should continue but ask the user to change the tape. Any other exit code will
-cause
-.B restore
-to abort. For security reasons,
-.B restore
-reverts back to the real user ID and the real group ID before running the
-script.
-.TP
-.B \-h
-Extract the actual directory, rather than the files that it references. This
-prevents hierarchical restoration of complete subtrees from the dump.
-.TP
-.B \-k
-Use Kerberos authentication when contacting the remote tape server. (Only
-available if this options was enabled when
-.B restore
-was compiled.)
-.TP
-.B \-l
-When doing remote restores, assume the remote file is a regular file (instead
-of a tape device). If you're restoring a remote compressed file, you will need
-to specify this option or
-.B restore
-will fail to access it correctly.
-.TP
-.BI \-L " limit"
-The
-.B \-L
-flag allows the user to specify a maximal number of miscompares when using
-.B restore
-with the
-.B \-C
-option to check the backup. If this limit is reached,
-.B restore
-will abort with an error message. A value of 0 (the default value) disables
-the check.
-.TP
-.B \-m
-Extract by inode numbers rather than by file name. This is useful if only a few
-files are being extracted, and one wants to avoid regenerating the complete
-pathname to the file.
-.TP
-.B \-M
-Enables the multi-volume feature (for reading dumps made using the
-.B \-M
-option of dump). The name specified with
-.B \-f
-is treated as a prefix and
-.B restore
-tries to read in sequence from
-.I <prefix>001, <prefix>002
-etc.
-.TP
-.B \-N
-The
-.B \-N
-flag causes
-.B restore
-to perform a full execution as requested by one of
-.BR \-i ,
-.BR \-R ,
-.BR \-r ,
-.B t
-or
-.B x
-command without actually writing any file on disk.
-.TP
-.B \-o
-The
-.B \-o
-flag causes
-.B restore
-to automatically restore the current directory permissions without asking the
-operator whether to do so in one of
-.B \-i
-or
-.B \-x
-modes.
-.TP
-.BI \-Q " file"
-Use the file
-.I file
-in order to read tape position as stored using the dump Quick File Access mode,
-in one of
-.BR \-i ,
-.B \-x
-or
-.B \-t
-mode.
-.IP
-It is recommended to set up the st driver to return logical tape positions
-rather than physical before calling
-.B dump/restore
-with parameter
-.BR \-Q .
-Since not all tape devices support physical tape positions those tape devices
-return an error during
-.B dump/restore
-when the st driver is set to the default physical setting. Please see the
-.BR st (4)
-man page, option
-.B MTSETDRVBUFFER
-, or the
-.BR mt(1)
-man page, on how to set the driver to return logical tape positions.
-.IP
-Before calling
-.B restore
-with parameter
-.BR \-Q ,
-always make sure the st driver is set to return the same type of tape position
-used during the call to
-.BR dump .
-Otherwise
-.B restore
-may be confused.
-.IP
-This option can be used when restoring from local or remote tapes (see above)
-or from local or remote files.
-.TP
-.BI \-s " fileno"
-Read from the specified
-.I fileno
-on a multi-file tape. File numbering starts at 1.
-.TP
-.BI \-T " directory"
-The
-.B \-T
-flag allows the user to specify a directory to use for the storage of temporary
-files. The default value is
-.IR /tmp .
-This flag is most useful when restoring files after having booted from a
-floppy. There might be little or no space on the floppy filesystem, but another
-source of space might exist.
-.TP
-.B \-u
-When creating certain types of files,
-.B restore
-may generate a warning diagnostic if they already exist in the target
-directory. To prevent this, the
-.B \-u
-(unlink) flag causes
-.B restore
-to remove old entries before attempting to create new ones.
-.TP
-.B \-v
-Normally
-.B restore
-does its work silently. The
-.B \-v
-(verbose) flag causes it to type the name of each file it treats preceded by
-its file type.
-.TP
-.B \-V
-Enables reading multi-volume non-tape mediums like CDROMs.
-.TP
-.BI \-X " filelist"
-Read list of files to be listed or extracted from the text file
-.I filelist
-in addition to those specified on the command line. This can be used in
-conjunction with the
-.B \-t
-or
-.B \-x
-commands. The file
-.I filelist
-should contain file names separated by newlines.
-.I filelist
-may be an ordinary file or
-.I -
-(the standard input).
-.TP
-.B \-y
-Do not ask the user whether to abort the restore in the event of an error.
-Always try to skip over the bad block(s) and continue.
-.PP
-(The 4.3BSD option syntax is implemented for backward compatibility but is not
-documented here.)
-.SH DIAGNOSTICS
-Complains if it gets a read error. If
-.B y
-has been specified, or the user responds
-.BR y ,
-.B restore
-will attempt to continue the restore.
-.PP
-If a backup was made using more than one tape volume,
-.B restore
-will notify the user when it is time to mount the next volume. If the
-.B \-x
-or
-.B \-i
-flag has been specified,
-.B restore
-will also ask which volume the user wishes to mount. The fastest way to extract
-a few files is to start with the last volume, and work towards the first volume.
-.PP
-There are numerous consistency checks that can be listed by
-.BR restore .
-Most checks are self-explanatory or can \*(lqnever happen\*(rq. Common errors
-are given below:
-.TP
-.I Converting to new file system format
-A dump tape created from the old file system has been loaded. It is
-automatically converted to the new file system format.
-.TP
-.I <filename>: not found on tape
-The specified file name was listed in the tape directory, but was not found on
-the tape. This is caused by tape read errors while looking for the file, and
-from using a dump tape created on an active file system.
-.TP
-.I expected next file <inumber>, got <inumber>
-A file that was not listed in the directory showed up. This can occur when
-using a dump created on an active file system.
-.TP
-.I Incremental dump too low
-When doing an incremental restore, a dump that was written before the previous
-incremental dump, or that has too low an incremental level has been loaded.
-.TP
-.I Incremental dump too high
-When doing an incremental restore, a dump that does not begin its coverage
-where the previous incremental dump left off, or that has too high an
-incremental level has been loaded.
-.TP
-.I Tape read error while restoring <filename>
-.TP
-.I Tape read error while skipping over inode <inumber>
-.TP
-.I Tape read error while trying to resynchronize
-A tape (or other media) read error has occurred. If a file name is specified,
-its contents are probably partially wrong. If an inode is being skipped or the
-tape is trying to resynchronize, no extracted files have been corrupted, though
-files may not be found on the tape.
-.TP
-.I resync restore, skipped <num> blocks
-After a dump read error,
-.B restore
-may have to resynchronize itself. This message lists the number of blocks that
-were skipped over.
-.SH EXIT STATUS
-.B Restore
-exits with zero status on success. Tape errors are indicated with an exit code
-of 1.
-.PP
-When doing a comparison of files from a dump, an exit code of 2 indicates that
-some files were modified or deleted since the dump was made.
-.SH ENVIRONMENT
-If the following environment variable exists it will be utilized by
-.BR restore :
-.TP
-.B TAPE
-If no
-.B \-f
-option was specified,
-.B restore
-will use the device specified via
-.B TAPE
-as the dump device.
-.B TAPE
-may be of the form
-.IR tapename ,
-.I host:tapename
-or
-.IR user@host:tapename .
-.TP
-.B TMPDIR
-The directory given in
-.B TMPDIR
-will be used instead of
-.I /tmp
-to store temporary files.
-.TP
-.B RMT
-The environment variable
-.B RMT
-will be used to determine the pathname of the remote
-.BR rmt (8)
-program.
-.TP
-.B RSH
-.B Restore
-uses the contents of this variable to determine the name of the remote shell
-command to use when doing a network restore (rsh, ssh etc.). If this variable
-is not set,
-.BR rcmd (3)
-will be used, but only root will be able to do a network restore.
-.SH FILES
-.TP
-.I /dev/st0
-the default tape drive
-.TP
-.I /tmp/rstdir*
-file containing directories on the tape
-.TP
-.I /tmp/rstmode*
-owner, mode, and time stamps for directories
-.TP
-.I ./restoresymtable
-information passed between incremental restores
-.SH SEE ALSO
-.BR dump (8),
-.BR mount (8),
-.BR mke2fs (8),
-.BR rmt (8)
-.SH BUGS
-.B Restore
-can get confused when doing incremental restores from dumps that were made on
-active file systems.
-.PP
-A level 0 dump must be done after a full restore. Because
-.B restore
-runs in user code, it has no control over inode allocation; thus a full dump
-must be done to get a new set of directories reflecting the new inode
-numbering, even though the content of the files is unchanged.
-.PP
-The temporary files
-.I /tmp/rstdir*
-and
-.I /tmp/rstmode*
-are generated with a unique name based on the date of the dump and the process
-ID (see
-.BR mktemp (3) ),
-except when
-.B \-r
-or
-.B \-R
-is used. Because
-.B \-R
-allows you to restart a
-.B \-r
-operation that may have been interrupted, the temporary files should be the
-same across different processes. In all other cases, the files are unique
-because it is possible to have two different dumps started at the same time,
-and separate operations shouldn't conflict with each other.
-.PP
-To do a network restore, you have to run
-.B restore
-as root or use a remote shell replacement (see
-.B RSH
-variable). This is due to the previous security history of
-.B dump
-and
-.BR restore .
-(
-.B restore
-is written to be setuid root, but we are not certain all bugs are gone from the
-code - run setuid at your own risk.)
-.PP
-At the end of restores in
-.B \-i
-or
-.B \-x
-modes (unless
-.B \-o
-option is in use),
-.B restore
-will ask the operator whether to set the permissions on the current
-directory. If the operator confirms this action, the permissions
-on the directory from where
-.B restore
-was launched will be replaced by the permissions on the dumped root
-inode. Although this behaviour is not really a bug, it has proven itself
-to be confusing for many users, so it is recommended to answer 'no',
-unless you're performing a full restore and you do want to restore the
-permissions on '/'.
-.PP
-It should be underlined that because it runs in user code,
-.B restore
-, when run with the
-.B \-C
-option, sees the files as the kernel presents them, whereas
-.B dump
-sees all the files on a given filesystem. In particular, this
-can cause some confusion when comparing a dumped filesystem a part
-of which is hidden by a filesystem mounted on top of it.
-.SH AUTHOR
-The
-.B dump/restore
-backup suite was ported to Linux's Second Extended File System by Remy Card
-<card@Linux.EU.Org>. He maintained the initial versions of
-.B dump
-(up and including 0.4b4, released in january 1997).
-.PP
-Starting with 0.4b5, the new maintainer is Stelian Pop <stelian@popies.net>.
-.SH AVAILABILITY
-The
-.B dump/restore
-backup suite is available from <http://dump.sourceforge.net>
-.SH HISTORY
-The
-.B restore
-command appeared in 4.2BSD.
+++ /dev/null
-.\" Copyright (c) 1983, 1991, 1993
-.\" The Regents of the University of California. 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.
-.\" 3. Neither the name of the University nor the names of its contributors
-.\" may be used to endorse or promote products derived from this software
-.\" without specific prior written permission.
-.\"
-.\" 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.
-.\"
-.\" $Id: rmt.8.in,v 1.10 2003/03/30 15:40:40 stelian Exp $
-.\"
-.TH RMT 8 "version 0.4b40 of May 2, 2005" BSD "System management commands"
-.SH NAME
-rmt \- remote magtape protocol module
-.SH SYNOPSIS
-.B rmt
-.SH DESCRIPTION
-.B Rmt
-is a program used by the remote
-.BR dump (8),
-.BR restore (8)
-or
-.BR tar (1)
-programs in manipulating a magnetic tape drive through an interprocess
-communication connection.
-.B Rmt
-is normally started up with an
-.BR rexec (3)
-or
-.BR rcmd (3)
-call.
-.PP
-The
-.B rmt
-program accepts requests specific to the manipulation of magnetic tapes,
-performs the commands, then responds with a status indication. All responses
-are in
-.B ASCII
-and in one of the following two forms.
-.PP
-Successful commands have responses of:
-.RS
-.B A\fInumber\fR\en
-.RE
-.PP
-where
-.I number
-is an
-.B ASCII
-representation of a decimal number.
-.PP
-Unsuccessful commands are responded to with:
-.RS
-.B E\fIerror-number\fR\en\fIerror-message\fR\en
-.RE
-.PP
-where
-.I error-number
-is one of the possible error numbers described in
-.BR intro (2)
-and
-.I error-message
-is the corresponding error string as printed from a call to
-.BR perror (3).
-.PP
-The protocol is comprised of the following commands, which are sent as
-indicated - no spaces are supplied between the command and its arguments, or
-between its arguments, and \en indicates that a newline should be supplied:
-.TP
-.B O\fIdevice\fR\en\fImode\fR\en
-Open the specified
-.I device
-using the indicated
-.IR mode .
-.I Device
-is a full pathname and
-.I mode
-is an
-.B ASCII
-representation of a decimal number suitable for passing to
-.BR open (2).
-If a device had already been opened, it is closed before a new open is
-performed.
-.TP
-.B C\fIdevice\fR\en
-Close the currently open device. The
-.I device
-specified is ignored.
-.TP
-.B L\fIwhence\fR\en\fIoffset\fR\en
-Perform an
-.BR lseek (2)
-operation using the specified parameters. The response value is that returned
-from the
-.B lseek
-call.
-.TP
-.B W\fIcount\fR\en
-Write data onto the open device.
-.B Rmt
-reads
-.I count
-bytes from the connection, aborting if a premature end-of-file is encountered.
-The response value is that returned from the
-.BR write (2)
-call.
-.TP
-.B R\fIcount\fR\en
-Read
-.I count
-bytes of data from the open device. If
-.I count
-exceeds the size of the data buffer (10 kilobytes), it is truncated to the
-data buffer size.
-.B Rmt
-then performs the requested
-.BR read (2)
-and responds with
-.B A\fIcount-read\fR\en
-if the read was successful; otherwise an error in the standard format is
-returned. If the read was successful, the data read is then sent.
-.TP
-.B I\fIoperation\fR\en\fIcount\fR\en
-Perform a
-.B MTIOCOP
-.BR ioctl (2)
-command using the specified parameters. The parameters are interpreted as the
-.B ASCII
-representations of the decimal values to place in the
-.B mt_op
-and
-.B mt_count
-fields of the structure used in the
-.B ioctl
-call. The return value is the
-.I count
-parameter when the operation is successful.
-.IP
-By issuing the
-.B I-1\en0\en
-command, a client will specify that he is using the VERSION 1 protocol.
-.IP
-For a VERSION 0 client, the
-.I operation
-parameter is the platform
-.B mt_op
-value (could be different if the client and the
-.B rmt
-server are on two different platforms). For a VERSION 1 client, the
-.I operation
-parameter is standardized as below:
-.RS
-.TP
-.B 0
-Issue a
-.B MTWEOF
-command (write
-.I count
-end-of-file records).
-.TP
-.B 1
-Issue a
-.B MTFSF
-command (forward space over
-.I count
-file marks).
-.TP
-.B 2
-Issue a
-.B MTBSF
-command (backward space over
-.I count
-file marks).
-.TP
-.B 3
-Issue a
-.B MTFSR
-command (forward space
-.I count
-inter-record gaps).
-.TP
-.B 4
-Issue a
-.B MTBSR
-command (backward space
-.I count
-inter-record gaps).
-.TP
-.B 5
-Issue a
-.B MTREW
-command (rewind).
-.TP
-.B 6
-Issue a
-.B MTOFFL
-command (rewind and put the drive offline).
-.TP
-.B 7
-Issue a
-.B MTNOP
-command (no operation, set status only).
-.RE
-.TP
-.B i\fIoperation\fR\en\fIcount\fR\en
-Perform an extended
-.B MTIOCOP
-.BR ioctl (2)
-command using the specified parameters. The parameters are interpreted as the
-.B ASCII
-representations of the decimal values to place in the
-.B mt_op
-and
-.B mt_count
-fields of the structure used in the
-.B ioctl
-call. The return value is the
-.I count
-parameter when the operation is successful. The possible operations are:
-.RS
-.TP
-.B 0
-Issue a
-.B MTCACHE
-command (switch cache on).
-.TP
-.B 1
-Issue a
-.B MTNOCACHE
-command (switch cache off).
-.TP
-.B 2
-Issue a
-.B MTRETEN
-command (retension the tape).
-.TP
-.B 3
-Issue a
-.B MTERASE
-command (erase the entire tape).
-.TP
-.B 4
-Issue a
-.B MTEOM
-command (position to end of media).
-.TP
-.B 5
-Issue a
-.B MTNBSF
-command (backward space count files to BOF).
-.RE
-.TP
-.B S
-Return the status of the open device, as obtained with a
-.B MTIOCGET
-.B ioctl
-call. If the operation was successful, an \*(lqack\*(rq is sent with the size
-of the status buffer, then the status buffer is sent (in binary, which is
-non-portable between different platforms).
-.TP
-.BI s sub-command
-This is a replacement for the previous
-.B S
-command, portable across different platforms. If the open device is a magnetic
-tape, return members of the magnetic tape status structure, as obtained with a
-.B MTIOCGET
-ioctl call. If the open device is not a magnetic tape, an error is returned. If
-the
-.B MTIOCGET
-operation was successful, the numerical value of the structure member is
-returned in decimal. The following sub commands are supported:
-.RS
-.TP
-.B T
-return the content of the structure member
-.B mt_type
-which contains the type of the magnetic tape device.
-.TP
-.B D
-return the content of the structure member
-.B mt_dsreg
-which contains the "drive status register".
-.TP
-.B E
-return the content of the structure member
-.B mt_erreg
-which contains the "error register". This structure member must be retrieved
-first because it is cleared after each
-.B MTIOCGET
-ioctl call.
-.TP
-.B R
-return the content of the structure member
-.B mt_resid
-which contains the residual count of the last I/O.
-.TP
-.B F
-return the content of the structure member
-.B mt_fileno
-which contains the file number of the current tape position.
-.TP
-.B B
-return the content of the structure member
-.B mt_blkno
-which contains the block number of the current tape position.
-.TP
-.B f
-return the content of the structure member
-.B mt_flags
-which contains MTF_ flags from the driver.
-.TP
-.B b
-return the content of the structure member
-.B mt_bf
-which contains the optimum blocking factor.
-.RE
-.PP
-Any other command causes
-.B rmt
-to exit.
-.SH DIAGNOSTICS
-All responses are of the form described above.
-.SH SEE ALSO
-.BR rcmd (3),
-.BR rexec (3),
-.I /usr/include/sys/mtio.h,
-.BR rdump (8),
-.BR rrestore (8)
-.SH BUGS
-People should be discouraged from using this for a remote file access protocol.
-.SH AUTHOR
-The
-.B dump/restore
-backup suit was ported to Linux's Second Extended File System by Remy Card
-<card@Linux.EU.Org>. He maintained the initial versions of
-.B dump
-(up and including 0.4b4, released in january 1997).
-.PP
-Starting with 0.4b5, the new maintainer is Stelian Pop <stelian@popies.net>.
-.SH AVAILABILITY
-The
-.B dump/restore
-backup suit is available from <http://dump.sourceforge.net>
-.SH HISTORY
-The
-.B rmt
-command appeared in 4.2BSD.
+++ /dev/null
-.so man8/restore.8
+++ /dev/null
-●:dump::2005/05/02:dump:8:2005/10/10::tnishida@ms.naist.jp:Takashi Nishida:
-※:dump::2005/05/02:rdump:8:dump:8:
-●:dump::2005/05/02:restore:8:2005/10/10::tnishida@ms.naist.jp:Takashi Nishida:
-×:dump::2005/05/02:rmt:8:::::
-※:dump::2005/05/02:rrestore:8:restore:8:
+++ /dev/null
-Sat Oct 2 19:05:19 1999 NAKANO Takeo <nakano@apm.seikei.ac.jp>
-
- * translation_list: 書式変更.
-
-Thu Sep 16 10:52:02 1999 NAKANO Takeo <nakano@apm.seikei.ac.jp>
-
- * translation_list: typo fix.
-
-Wed Aug 11 21:22:30 1999 NAKANO Takeo <nakano@apm.seikei.ac.jp>
-
- * draft/man1/*.1: moved from e2fsprogs-e2c/
- * translation_list: update info.
+++ /dev/null
-.\" -*- nroff -*-
-.\"WORD: user space ユーザー空間
-.\"WORD: attribute アトリビュート
-.\"WORD: fragment フラグメント
-.\"WORD: suffix サフィックス
-.\"
-.TH E2COMPRESS 1 "April 1997" "E2Compress Utilities"
-
-.\".SH NAME
-.\"e2compress, e2decompress \- compress file in a format readable by the kernel on a Linux second extended file system
-.SH 名前
-e2compress, e2decompress \- Linux 2nd 拡張ファイルシステム上のファイルをカーネルが利用できる形式で圧縮
-
-.\".SH SYNOPSIS
-.\"(N.B. This manual page is not up to date. The results of `e2compress --help' are reasonably
-.\"correct, as is the information in the Texinfo file: *See
-.\"(e2compr)e2compress.)
-.SH 書式
-このマニュアルページは、更新されていない。`e2compress --help'を実行して
-得られる結果が、正しい。それは、Texinfo ファイルの情報のままである。((e2compr)e2compressを見よ。)
-.B e2compress
-[
-.B \-vf
-]
-[
-.B -m
-algorithm_name
-]
-[
-.B -b
-cluster_size
-]
-[
-.B -S
-suffix
-]
-.I files ...
-.PP
-.B e2decompress
-[
-.B \-vf
-]
-[
-.B -S
-suffix
-]
-.I files ...
-
-.\".SH DESCRIPTION
-.\".B e2compress
-.\"compresses the files directly into the format readable by the kernel
-.\"on a second extended file system.
-.SH 説明
-.B e2compress
-は、Linux 2nd 拡張ファイルシステム上のファイルを、カーネルが読める形式に、
-直接圧縮する。
-
-.\"Unlike
-.\".B chattr +c,
-.\".B e2compress
-.\"does the compression jobs in the user space.
-.\"This may have some advantages.
-.B chattr +c,
-を使うのと異なり、
-.B e2compress
-は、圧縮作業をユーザー空間(user space)で行う。
-この方法には、いくらかの利点がありうる。
-
-.\".B e2compress
-.\"opens the file it is working on, and creates a new temporary file
-.\"(whose name is derived from the original file by adding
-.\".B suffix
-.\"(`~z~' by default)) for
-.\"which the automatic compression will be turned off.
-.B e2compress
-は、作業のためにファイルをオープンするとともに、自動圧縮を行わないように
-設定されたテンポラリーファイルを作る。(テンポラリーファイルの名称は、
-元のファイル名に
-.B suffix
-(デフォルトは`~z~')を加えたものである。)
-
-.\"It then reads from the input file, compresses each cluster in memory,
-.\" verifies the compression by decompressing to a work area and comparing
-.\" with the original, and then writes the compressed data to the temporary
-.\"file, using the lseek() system call to create the necessary holes as it goes.
-それから、入力ファイルを読み、メモリ上でクラスタ(cluster)毎に圧縮し、
-ワークエリアに伸張したものと元のデータを比較することにより圧縮データを検査する。
-こののち、テンポラリーファイルに、lseek()システムコールでうまく動作するように
-すき間を作りながら、圧縮データを書きこむ。
-
-.\"When it is done, automatic compression is turned on again for the
-.\"temporary file, and the temporary file is renamed to replace the
-.\" original file.
-以上が終わったら、テンポラリーファイルを自動圧縮が有効な状態にし、
-最後に、テンポラリーファイルを元のファイルを置き換える形でリネームする。
-
-
-.LP
-.\"When
-.\".B e2decompress
-.\"or
-.\".B e2compress -d
-.\"is called to decompress a file,
-ファイルを伸張するには、
-.B e2decompress
-または、
-.B e2compress -d
-を使用する。
-
-.\"we create a temporary file, remove the compression attribute,
-.\" attempt to disable automatic decompression
-.\"on the input file, and do decompression in user space, performing some
-.\"checks on the way.
-テンポラリーファイルを作り、圧縮アトリビュート(attribute)を取り除く。
-次に入力ファイルの自動伸張を無効にするよう試みた後、途中でいくらかのチェックを
-行いながら、ユーザー空間(user space)で伸長を行う。
-
-.LP
-.\"Using
-.\".B e2compress
-.\"instead of
-.\".B chattr +c
-.\"has some advantages.
-.B chattr +c
-の代わりに、
-.B e2compress
-を使うことには利点がある。
-
-.\"The main one is that the resulting file will not be fragmented as it
-.\"would be with
-.\".B chattr
-主な利点の一つは、
-.B chattr
-を使った場合と違って、圧縮の結果としてえられるファイルがフラグメント(fragment)
-を起こさない。
-.\": this comes from the fact that
-.\".B e2compress
-.\"does not free some blocks as the kernel would do.
-.\"Also, the compression is done in the user space.
-: これは、
-カーネルが圧縮を個行った場合と異なり、
-.B e2compress
-はブロックを解放することがない事による。
-.\"Some people may consider it is better.
-この方がより好ましいと考える人もいる。
-
-.\".B e2compress
-.\"is also more safe, since the compressed data is
-.\"immediatly checked for decompression.
-.B e2compress
-は、圧縮の際に正しく伸張できるか確認するので、より安全である。
-
-.LP
-.\"One disadvantage of using
-.\".B e2compress
-.\"is that the original file and the temporay must coexist.
-.\"This may be not possible if the file system is completely full.
-.B e2compress
-を使うことの欠点のひとつは、テンポラリーファイルが元のファイルと
-同時に存在してしまうことである。このために、ファイルシステムが完全に
-一杯であるときに、圧縮できなくなる。
-.\".B chattr +c
-.\"will work even on a completely full file system.
-.B chattr +c
-は、ファイルシステムがたとえ完全に一杯であっても動作する。
-
-.\".SH OPTIONS
-.SH オプション
-
-.TP
-.I -m algorithm_name
-.\"Set the algorithm used for compression.
-.\"Valid algorithms are the same as for the
-.\".B chattr
-.\"utility.
-圧縮に使用するアルゴリズムを設定する。有効なアルゴリズムは、
-.B chattr
-ユーティリティと同じである。
-
-.TP
-.I -S suffix
-.\"Uses the provided suffix to create the temporary file, instead of the
-.\"default suffix (which is `~z~').
-テンポラリーファイルを作成する際に、デフォルトのサフィックス(suffix)
-(`~z~')の代わりに指定のサフィックス(suffix)を使う。
-
-.TP
-.I -b cluster_size
-.\"Set the cluster size (measured in filesystem blocks) for compressed files.
-.\"Valid sizes are the same as for the
-.\".B chattr
-.\"utility.
-圧縮ファイルに使用するクラスタ(cluster)サイズ(ファイルシステムのブロック数で
-数える)を設定する。有効なクラスタ(cluster)サイズは、
-.B chattr
-ユーティリティと同じである。
-
-.TP
-.I -c
-.\"Compress files. This is the default behaviour, unless the program is
-.\"called under the name
-.\".B e2decompress
-ファイルを圧縮する。これは、このプログラムが
-.B e2decompress
-という名前で実行されなかった場合の、デフォルト動作である。
-
-.TP
-.I -d
-.\"Decompress files.
-ファイルを伸張する。
-
-.TP
-.I -f
-.\"Force compression. If this flag is not used,
-.\".B e2compress
-.\"will stop if the input file has more than one link, or if the temporary file
-.\"already exists.
-.\"If this flag is used,
-.\".B e2compress
-.\"will continue.
-.\"No verification will be performed when you use this flag.
-強制圧縮を行う。このオプションが使われないときは、
-.B e2compress
-は、テンポラリーファイルがすでに存在していたり、入力ファイルのリンク数が2以上
-であった場合、処理を中止する。
-このオプションが指定されたときは、
-.B e2compress
-は、そのような場合でも処理を続行する。このオプションを指定すると
-照合は行われない。
-
-.TP
-.I -h
-.\"Display a short help message.
-ヘルプメッセージを表示する。
-
-.TP
-.I -v
-.\"Display some statistics about clusters.
-クラスタ(cluster)に関する統計値を表示する。
-
-.\".SH AUTHOR
-.SH 著者
-.\".B e2compress
-.\"was first written by Antoine de Maricourt <dumesnil@etca.fr>, and has
-.\"been extensively modified by Peter Moulder <reiter@netspace.net.au>.
-.B e2compress
-は、最初に、Antoine de Maricourt <dumesnil@etca.fr> によって作成された。
-のちに、 Peter Moulder <reiter@netspace.net.au> によって拡張的な変更が行われた。
-
-.\".SH BUGS AND LIMITATIONS
-.SH バグと制限
-.\"This program still isn't finished -- but it's now ready enough that the author uses it
-.\"to compress directory trees (find DIRS -type f -print0|xargs -0 e2compress -mgzip9 -b32).
-このプログラムはまだ完成していない。しかし、著者がディレクトリツリーを圧縮
-するために使う
-(find DIRS -type f -print0|xargs -0 e2compress -mgzip9 -b32)
-には十分な状態にある。
-
-.LP
-.\"The precise behaviour of this program in certain circumstances has changed.
-.\"This will continue to occur until it is considered `finished' in some sense.
-ある条件下でのこのプログラムの適切な振る舞いは、変更されている。
-このようなことは、何らかの意味で「完成」と思えるようになるまで、起こりうる。
-.LP
-.\"Any writes to the file while e2compress is in action (that is to say
-.\"after e2compress has read the file but before the file is replaced
-.\"with the compressed version) are lost.
-e2compressが動作している間(言い換えれば、e2compressがファイルを読んだ後、
-圧縮済みの半に置き換えられるまでの間)に行われたファイルへの書き込みは、
-すべて失われる。
-
-.\" (For decompressing, no writes
-.\"are possible because the NOCOMPR flag is set on the input file, which
-.\"prevents any other processes from having the file open.)
-(ちなみに、伸張処理のときは、NOCOMPRフラグが、他のプロセスがファイルを開くのを抑止するため、書き込むことはできない。 )
-.\" In both
-.\"cases (compressing and decompressing) the results of ,any `chmod', `chown' or
-.\"`touch' operation during this period` will be lost.
-圧縮時にも、伸張時にも、この期間に行われた、`chmod'. `chwon', `touch'等の
-オペレーションの結果は失われる。
-
-.\".SH AVAILABILITY
-.\"The latest release of this program is available from the e2compr home page,
-.\"<http://netspace.net.au/~reiter/e2compr/software.html#ancillary>
-.SH 入手方法
-このプログラムの最新リリースは、e2compr home page
-<http://netspace.net.au/~reiter/e2compr/software.html#ancillary>
-から入手できる。
-.\".SH SEE ALSO
-.SH 関連項目
-.BR chattr (1)
-,
-.BR e2ratio (1)
-,
-.BR lsattr (1)
-
-
-
-
-
-
-
-
-
-
-
-
-
+++ /dev/null
-.\" -*- nroff -*-
-.\"WORD: compression ratio 圧縮率
-.\"WORD: compression factor 圧縮比
-.\"WORD: cluster クラスタ
-.\"WORD: entry エントリー
-.\"
-.TH E2RATIO 1 "July 97" "E2Compr Utilities"
-
-.\".SH NAME
-.\"e2ratio \- display the compression ratio on a Linux second
-.\" extended file system
-.SH 名前
-e2ratio \- Linux 2nd拡張ファイルシステム上のファイルの圧縮率の表示
-
-.\".SH SYNOPSIS
-.SH 書式
-.B e2ratio
-[
-.B \-abslf
-]
-[
-files ...
-]
-
-.\".SH DESCRIPTION
-.\".B e2ratio
-.\"is similar to
-.\".B du
-.\"but displays the compression ratio for the given files instead of the
-.\"number of blocks used.
-.SH 説明
-.B e2ratio
-は、
-.B du
-に類似ている。しかし、ファイルが使用しているブロック数ではなく、
-圧縮率を表示する。
-
-.LP
-.\".B e2ratio
-.\"recursively descends into directories.
-.B e2ratio
-は、ディレクトリを再帰的にたどって、表示を行う。
-
-.LP
-.\"The first field is the number of blocks the file would use if uncompressed.
-.\"The second file is the number of blocks the file actually uses (same as
-.\"the first field if the file is not compressed).
-.\"The third field is the compression ratio, i.e.,
-.\"the number of block actually used expressed as a percentage of the original size.
-.\"The fourth field is the name of the file.
-第1フィールドは、ファイルが圧縮されていなかったとしたら使用していたであろう、
-ブロック数である。
-第2フィールドは、ファイルが実際に使用している、ブロック数である。(ファイルが
-圧縮されていなければ、この値は第1フィールドのものと同じである。)
-第3フィールドは、圧縮率(つまり、ファイルが実際に占めているブロックの、オリジナルのサイズに対する、百分率)である。
-第4フィールドは、ファイル名である。
-
-.LP
-.\"With the
-.\".I -b
-.\"option, only the last two fields are displayed.
-.I -b
-オプションを用いれば、第3、第4フィールドのみを表示できる。
-
-.\".SH OPTIONS
-.SH オプション
-
-.TP
-.I -a
-.\"Generate an entry for each file.
-.\"The default behaviour is to generate an entry only for directories.
-個々のファイルに対してエントリー(entry)を作成する。
-ディレクトリ毎にエントリー(entry)を作成するのが、デフォルトの振る舞いである。
-
-.TP
-.I -b
-.\"Only show the last two fields (i.e. ratio and file name).
-第3、第4フィールドのみを表示できる。(つまり、圧縮率とファイル名を表示する。)
-
-.TP
-.I -s
-.\"Only display the grand total for each of the specified files.
-指定のファイルに対する値の総計のみ表示する。
-
-.TP
-.I -f
-.\"Display the compression factor instead of the compression ratio, i.e., the
-.\"original size of the file divided by the actual size.
-圧縮率の代わりに、圧縮比を表示する。（つまり、オリジナルのサイズを、実際のサイズで割った値が、表示される。)
-
-.TP
-.I -l
-.\"Generate the usual four-field entries. (Over-rides `-b'.)
-すべてのフィールドを含むエントリー(entry)を作成する。(`-b'オプションを上書きする)
-
-.\".SH BUGS
-.\"The ratio is computed rather than stored in the inode.
-.\"This is expensive because it requires to read every cluster head in the file.
-.SH バグ
-圧縮率は、inodeに格納せずに、計算している。このやり方は、ファイル中のクラスタ
-(cluster)の先頭部をすべて読む必要があるため、処理が重い。
-
-.LP
-.\"Several files may appear more than once if they are hard links.
-.\"The total ratio is probably false in this case, as well as the
-.\" total number of blocks reported.
-ハードリンクされたファイルは、二回以上処理されることがある。
-このような場合、全体の圧縮率の表示はおそらく間違った値となる。ブロック数についても、同様である。
-
-.\".SH AUTHOR
-.\".B e2ratio
-.\"has been quickly written by Antoine de Maricourt <dumesnil@etca.fr> as part
-.\"of the e2compr patch.
-.\"It could be improved.
-.SH 著者
-.B e2ratio
-は、e2compr パッチの一部として、Antoine de Maricourt <dumesnil@etca.fr>
-により、手早く作られた。改善の余地がある。
-
-.\".SH AVAILABILITY
-.\".B e2ratio
-.\"is included in the e2compr distribution.
-.SH 入手方法
-.B e2ratio
-は、e2compr パッケージに含まれている。
-
-.\".SH SEE ALSO
-.SH 関連項目
-.BR chattr (1)
-,
-.BR lsattr (1)
-,
-.BR e2compress (1)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+++ /dev/null
-e2fsprogs-e2c is given as a patch to the e2fsprogs pkg.
-It's available at http://www.netspace.net.au/~reiter/e2compr/.
-
-Current trans (and the originals at subdir) is based on the
-0.3 series of e2compr, but 0.4 development is underway,
-the latter of which does not contain e2compress.1...
-
-1999-08-11, NAKANO Takeo wrote this.
+++ /dev/null
-.\" -*- nroff -*-
-.TH CHATTR 1 "December 1998" "E2fsprogs vers 1.12-e2c036"
-.SH NAME
-chattr \- change file attributes on a Linux second extended file system
-.SH SYNOPSIS
-.B chattr
-[
-.B \-ERV
-]
-[
-.B -v
-version
-]
-[
-.B -b
-cluster_size
-]
-[
-.B -m
-compression_method
-]
-[
-mode
-]
-.I files...
-.SH DESCRIPTION
-.B chattr
-changes the file attributes on a Linux second extended file system.
-.PP
-The format of a symbolic mode is +-=[ASXacdisu].
-.PP
-The operator `+' causes the selected attributes to be added to the
-existing attributes of the files; `-' causes them to be removed; and
-`=' causes them to be the only attributes that the files have.
-.PP
-The letters `ASXacdisu' select the new attributes for the files:
-don't update atime (A), synchronous updates (S),
-disable de/compression on I/O (X), append only (a),
-compressed (c), immutable (i), no dump (d),
-secure deletion (s), and undeletable (u).
-The 'E' (compression error) attribute may only be cleared, not set.
-.SH OPTIONS
-.TP
-.I -R
-Recursively change attributes of directories and their contents.
-.TP
-.I -V
-Verbosely describe changed attributes.
-.TP
-.I -v version
-Set the files version.
-.TP
-.I -b cluster_size
-Set the cluster size for compressed files.
-The only supported cluster sizes are 4, 8, 16 or 32 blocks per cluster.
-Depending on the file system and/or the kernel, some of these values
-may not be supported.
-.TP
-.I -m compression_method
-Set the algorithm used for compression.
-Currently, the only supported algorithms are `lzv1', `lzrw3a' and
-`gzip1', `gzip2', ..., `gzip9' where the number is equivalent to the
-compression level used for gzip.
-The name `lzv' is an alias for `lzv1', and `gzip' is an alias for `gzip6'.
-Depending on the file system and/or the kernel, some of these values
-may not be supported.
-.SH ATTRIBUTES
-When a file with the 'A' attribute set is modified, its atime record is
-not modified. This avoids a certain amount of disk I/O for laptop
-systems.
-.PP
-A file with the `a' attribute set can only be open in append mode for writing.
-Only the superuser can set or clear this attribute.
-.PP
-A file with the `c' attribute set is automatically compressed on the disk
-by the kernel. A read from this file returns uncompressed data. A write to
-this file is followed by an attempt to compress the data written.
-.PP
-Directories also can be marked with the `c' attribute; in such a case,
-nothing is compressed, but any newly created file in the directory
-will automatically be marked with the `c' attribute. Similarly, a
-directory can be given an algorithm name and/or cluster size,
-so that newly created files
-will use this algorithm / cluster size.
-New files in the directory will only inherit
-the flags if they get a new inode, not if they are simply given a new
-link in that directory (e.g. with `mv' or `ln').
-.PP
-A file with the `d' attribute set is not candidate for backup when the
-.BR dump (8)
-program is run.
-.PP
-A file with the `i' attribute cannot be modified: it cannot be deleted or
-renamed, no link can be created to this file and no data can be written
-to the file. Only the superuser can set or clear this attribute.
-.PP
-When a file with the `s' attribute set is deleted, its blocks are
-either zeroed or filled with random data (depending on the kernel
-version) and written back to the disk.
-.PP
-When a file with the `S' attribute set is modified,
-the changes are written synchronously on the disk; this is equivalent to
-the `sync' mount option applied to a subset of the files.
-.PP
-When a file with the `u' attribute set is deleted, its contents are saved.
-This allows the user to ask for its undeletion.
-.PP
-.SH AUTHOR
-.B chattr
-was originally
-written by Remy Card <card@masi.ibp.fr>, the developer and maintainer
-of the ext2 fs.
-Modifications to display information related to file compression were
-written by Antoine de Maricourt <dumesnil@etca.fr>.
-.SH BUGS AND LIMITATIONS
-As of ext2 fs 0.5a, the `u' attribute is not honoured by the kernel
-code. As of the Linux 2.0 kernel, the 'A' attribute is not supported by
-the kernel code; but it is supported in the latest kernels.
-.PP
-The `c' attribute is implemented in the kernel for the ext2 fs 0.5a,
-iff the e2compr patch has been applied.
-The
-.I -m
-and
-.I -b
-options are also accepted only if the patch has been applied.
-.PP
-It is currently not possible to change the cluster size for an already
-compressed file.
-You must first decompress the file, and then compress it again with
-the new cluster size.
-.PP
-Changing the compression algorithm will not recompress the already
-compressed clusters with the new algorithm.
-Only newly written data will be compressed with the new algorithm.
-If you want to recompress the complete file with the new algorithm,
-you must first decompress it, and then recompress it with the new
-algorithm.
-.SH AVAILABILITY
-This version of
-.B chattr
-is part of the e2compr package,
-found at <http://debs.fuller.edu/e2compr/software-03x.html>.
-.SH SEE ALSO
-.BR lsattr (1)
-,
-.BR e2compress (1)
-,
-.BR e2ratio (1)
-,
-.BR e2bitmap (1)
+++ /dev/null
-.\" -*- nroff -*-
-.TH E2COMPRESS 1 "April 1997" "E2Compress Utilities"
-.SH NAME
-e2compress, e2decompress \- compress file in a format readable by the kernel on a Linux second extended file system
-.SH SYNOPSIS
-(N.B. This manual page is not up to date. The results of `e2compress --help' are reasonably
-correct, as is the information in the Texinfo file: *See
-(e2compr)e2compress.)
-
-.B e2compress
-[
-.B \-vf
-]
-[
-.B -m
-algorithm_name
-]
-[
-.B -b
-cluster_size
-]
-[
-.B -S
-suffix
-]
-.I files ...
-.PP
-.B e2decompress
-[
-.B \-vf
-]
-[
-.B -S
-suffix
-]
-.I files ...
-.SH DESCRIPTION
-.B e2compress
-compresses the files directly into the format readable by the kernel
-on a second extended file system.
-Unlike
-.B chattr +c,
-.B e2compress
-does the compression jobs in the user space.
-This may have some advantages.
-.B e2compress
-opens the file it is working on, and creates a new temporary file
-(whose name is derived from the original file by adding
-.B suffix
-(`~z~' by default)) for
-which the automatic compression will be turned off.
-It then reads from the input file, compresses each cluster in memory, verifies
-the compression by decompressing to a work area and comparing with the original,
-and then writes the compressed data to the temporary
-file, using the lseek() system call to create the necessary holes as it goes.
-When it is done, automatic compression is turned on again for the
-temporary file, and the temporary file is renamed to replace the original file.
-.LP
-When
-.B e2decompress
-or
-.B e2compress -d
-is called to decompress a file,
-we create a temporary file, remove the compression attribute, attempt to disable automatic decompression
-on the input file, and do decompression in user space, performing some
-checks on the way.
-.LP
-Using
-.B e2compress
-instead of
-.B chattr +c
-has some advantages.
-The main one is that the resulting file will not be fragmented as it
-would be with
-.B chattr
-: this comes from the fact that
-.B e2compress
-does not free some blocks as the kernel would do.
-Also, the compression is done in the user space.
-Some people may consider it is better.
-.B e2compress
-is also more safe, since the compressed data is
-immediatly checked for decompression.
-.LP
-One disadvantage of using
-.B e2compress
-is that the original file and the temporay must coexist.
-This may be not possible if the file system is completely full.
-.B chattr +c
-will work even on a completely full file system.
-.SH OPTIONS
-.TP
-.I -m algorithm_name
-Set the algorithm used for compression.
-Valid algorithms are the same as for the
-.B chattr
-utility.
-.TP
-.I -S suffix
-Uses the provided suffix to create the temporary file, instead of the
-default suffix (which is `~z~').
-.TP
-.I -b cluster_size
-Set the cluster size (measured in filesystem blocks) for compressed files.
-Valid sizes are the same as for the
-.B chattr
-utility.
-.TP
-.I -c
-Compress files. This is the default behaviour, unless the program is
-called under the name
-.B e2decompress
-.TP
-.I -d
-Decompress files.
-.TP
-.I -f
-Force compression. If this flag is not used,
-.B e2compress
-will stop if the input file has more than one link, or if the temporary file
-already exists.
-If this flag is used,
-.B e2compress
-will continue.
-No verification will be performed when you use this flag.
-.TP
-.I -h
-Display a short help message.
-.TP
-.I -v
-Display some statistics about clusters.
-.SH AUTHOR
-.B e2compress
-was first written by Antoine de Maricourt <dumesnil@etca.fr>, and has
-been extensively modified by Peter Moulder <reiter@netspace.net.au>.
-.SH BUGS AND LIMITATIONS
-This program still isn't finished -- but it's now ready enough that the author uses it
-to compress directory trees (find DIRS -type f -print0|xargs -0 e2compress -mgzip9 -b32).
-.LP
-The precise behaviour of this program in certain circumstances has changed.
-This will continue to occur until it is considered `finished' in some sense.
-.LP
-Any writes to the file while e2compress is in action (that is to say
-after e2compress has read the file but before the file is replaced
-with the compressed version) are lost. (For decompressing, no writes
-are possible because the NOCOMPR flag is set on the input file, which
-prevents any other processes from having the file open.) In both
-cases (compressing and decompressing) the results of ,any `chmod', `chown' or
-`touch' operation during this period` will be lost.
-.SH AVAILABILITY
-The latest release of this program is available from the e2compr home page,
-<http://netspace.net.au/~reiter/e2compr/software.html#ancillary>
-.SH SEE ALSO
-.BR chattr (1)
-,
-.BR e2ratio (1)
-,
-.BR lsattr (1)
+++ /dev/null
-.\" -*- nroff -*-
-.TH E2RATIO 1 "July 97" "E2Compr Utilities"
-.SH NAME
-e2ratio \- display the compression ratio on a Linux second extended file system
-.SH SYNOPSIS
-.B e2ratio
-[
-.B \-abslf
-]
-[
-files ...
-]
-.SH DESCRIPTION
-.B e2ratio
-is similar to
-.B du
-but displays the compression ratio for the given files instead of the
-number of blocks used.
-.LP
-.B e2ratio
-recursively descends into directories.
-.LP
-The first field is the number of blocks the file
-would use if uncompressed.
-The second file is the number of blocks the file actually uses (same as
-the first field if the file is not compressed).
-The third field is the compression ratio, i.e.,
-the number of block actually used
-expressed as a percentage of the original size.
-The fourth field is the name of the file.
-.LP
-With the
-.I -b
-option, only the last two fields are displayed.
-.SH OPTIONS
-.TP
-.I -a
-Generate an entry for each file.
-The default behaviour is to generate an entry only for directories.
-.TP
-.I -b
-Only show the last two fields (i.e. ratio and file name).
-.TP
-.I -s
-Only display the grand total for each of the specified files.
-.TP
-.I -f
-Display the compression factor instead of the compression ratio, i.e., the
-original size of the file divided by the actual size.
-.TP
-.I -l
-Generate the usual four-field entries. (Over-rides `-b'.)
-.SH BUGS
-The ratio is computed rather than stored in the inode.
-This is expensive because it requires to read every cluster head in the file.
-.LP
-Several files may appear more than once if they are hard links.
-The total ratio is probably false in this case, as well as the total number of
-blocks reported.
-.SH AUTHOR
-.B e2ratio
-has been quickly written by Antoine de Maricourt <dumesnil@etca.fr> as part
-of the e2compr patch.
-It could be improved.
-.SH AVAILABILITY
-.B e2ratio
-is included in the e2compr distribution.
-.SH SEE ALSO
-.BR chattr (1)
-,
-.BR lsattr (1)
-,
-.BR e2compress (1)
+++ /dev/null
-.\" -*- nroff -*-
-.TH LSATTR 1 "December 1998" "E2fsprogs vers 1.12-e2c036"
-.SH NAME
-lsattr \- list file attributes on a Linux second extended file system
-.SH SYNOPSIS
-.B lsattr
-[
-.B \-ARadruv
-]
-[
-files...
-]
-.SH DESCRIPTION
-.B lsattr
-lists file attributes on a second extended file system.
-This version is able to display compression informations provided by
-the e2compr patch, but will also work on unpatched kernels.
-.SH OPTIONS
-.TP
-.I -A
-List almost every file in directories, including files that start with `.', but not
-special files `.' and `..'.
-.TP
-.I -R
-Recursively list attributes of directories and their contents.
-.TP
-.I -a
-List all files in directories, including files that start with `.'.
-.TP
-.I -d
-List directories like other files, rather than listing their contents.
-.TP
-.I -r
-Show the compression ratio, i.e. actual disk usage divided by disk
-usage if uncompressed.
-.TP
-.I -r
-Show space usage information. The left column represents how much
-space would be taken up by the file if it weren't compressed. The
-right column shows how much space is actually taken up by the file.
-.LP
-The units for both columns are kilobytes.
-.TP
-.I -v
-List the file version.
-.LP
-.B lsattr
-displays three to seven fields that represent the file attributes,
-followed by the file name.
-.LP
-The first field is a set of seven attributes that are represented
-by a simple letter when they are set, or by `-' when they are cleared.
-Attributes are displayed in the following order: `sucSiad' (see
-.B chattr
-(1) for their meaning).
-.LP
-The `c' attribute may be replaced by `E' which means
-that there was a compression error when
-accessing this file earlier.
-See section `compression error' in the e2compr user manual.
-.LP
-The `c' attribute may alternatively be replaced by `*', which
-indicates that transparent de/compression is disabled for this file:
-what you read or write is what's stored on disk, not the uncompressed
-version of that. Only one process can access a file for which
-compression is disabled. This state is mainly useful for files with a
-compression error.
-.LP
-The second field is displayed only if the `c' attribute is set or if
-the file contains one or more compressed clusters.
-It represents the cluster size for this file (4, 8, 16 or 32 blocks).
-If the `c' attribute is cleared, this field is `-'.
-It may occur that the field shows a cluster size while the `c' attribute
-is cleared.
-In this case, the file still holds some compressed clusters that have
-not been uncompressed because space were missing on the disk when the
-`c' attribute has been cleared.
-Such clusters will be uncompressed the next time the file is accessed,
-provided there is space on the disk.
-.LP
-The third field is displayed only if the `c' attribute is set.
-This is the name
-of the compression algorithm used for this file.
-If the `c' attribute is cleared, this field is `-'.
-The displayed algorithm will be used when compressing new data
-written to the file.
-Already compressed data may have been compressed using another
-algorithm.
-.LP
-If the
-.B -v
-option is used, there is a fourth field that is the file version's
-number.
-It is displayed first, before the three others fields.
-.SH EXAMPLES
-.LP
-.SH AUTHOR
-The original version of
-.B lsattr
-was written by Remy Card <card@masi.ibp.fr>, the developer and maintainer
-of the ext2 fs.
-The current version has been modified by the e2compression folks to display
-information related to file compression.
-.SH BUGS AND LIMITATIONS
-In e2compr versions 0.3.6 and previous, ,the calculation of the amount
-of space that would be taken by the uncompressed file` is slightly
-wrong (usually by no more than 1%). This is believed to be fixed in
-the as-yet-unfinished version 0.4.0.
-.LP
-.B lsattr
-and
-.B e2ratio
-ought to display in units of 512-byte blocks if the environment
-variable POSIXLY_CORRECT is set (as
-.B du
-does).
-.LP
-Error messages are somewhat confusing. E.g. `not a typewriter' means
-`this file is not on an ext2 fs' or `this kernel does not have
-e2compression enabled'.
-.LP
-Note that older versions of lsattr for e2compr had the `-a' and
-`-A' flags the wrong way around. If shell scripts depend on the old
-behaviour, they will need changing.
-.SH AVAILABILITY
-This version of
-.B lsattr
-is part of the e2compr package,
-found at <http://debs.fuller.edu/e2compr/software-03x.html>.
-.SH SEE ALSO
-.BR chattr (1)
-,
-.BR e2ratio (1)
-,
-.BR e2compress (1)
+++ /dev/null
-×:e2compr-ancillary:981212:1998/12/??:chattr:1:::::it's the patched page. original is in e2fsprogs.
-△:e2compr-ancillary:971220=>981212:1997/04/01:e2compress:1:1999/1/10:G:nmasu@ma3.justnet.ne.jp:Masuichi Noritoshi:
-△:e2compr-ancillary:971220=>981212:1997/07/??:e2ratio:1:1999/1/10:G:nmasu@ma3.justnet.ne.jp:Masuichi Noritoshi:
-×:e2compr-ancillary:981212:1998/12/??:lsattr:1:::::
+++ /dev/null
-Tue Oct 24 23:06:05 2000 Yuichi SATO <sato@complex.eng.hokudai.ac.jp>
-
- * original/*/* : 5.3 → 5.4 に更新。
- * translation_list : 上記を反映。
-
-Sat Oct 2 19:05:19 1999 NAKANO Takeo <nakano@apm.seikei.ac.jp>
-
- * translation_list: 書式変更.
-
-Mon Jul 26 09:01:16 1999 NAKANO Takeo <nakano@apm.seikei.ac.jp>
-
- * original/fdutils-5.3.lsm: 新規追加.
+++ /dev/null
-Begin3
-Title: fdutils - Floppy utilities
-Version: 5.4
-Entered-date: 03JUN00
-Description: This package contains utilities for configuring and
- debugging the Linux floppy driver, for formatting
- extra capacity disks (up to 1992K on a high density
- disk), for sending raw commands to the floppy
- controller, for automatic floppy disk mounting and
- unmounting, etc
-Keywords: floppy 2m xdf superformat floppycontrol fdrawcmd
-Author: alain@linux.lu
-Maintained-by: alain@linux.lu
-Primary-site: ftp.tux.org /pub/knaff/fdutils
- 187kB fdutils-5.4.tar.gz
-Alternate-site: metalab.unc.edu /pub/Linux/utils/disk-management
- tsx-11.mit.edu /pub/linux/sources/sbin
-Platforms: Linux 2.0 or later
-Copying-policy: GNU General Public License, v.2 or later
-End
+++ /dev/null
-.TH diskd 1 "02jun00" fdutils-5.4
-.SH Name
-diskd - disk daemon; wait for disk to be inserted
-'\" t
-.de TQ
-.br
-.ns
-.TP \\$1
-..
-
-.tr \(is'
-.tr \(if`
-.tr \(pd"
-
-.SH Note
-This manpage has been automatically generated from fdutils's texinfo
-documentation. However, this process is only approximative, and some
-items, such as crossreferences, footnotes and indices are lost in this
-translation process. Indeed, this items have no appropriate
-representation in the manpage format. Moreover, only the items specific
-to each command have been translated, and the general information about
-fdutils has been dropped in the manpage version. Thus I strongly advise
-you to use the original texinfo doc.
-.TP
-* \ \
-To generate a printable copy from the texinfo doc, run the following
-commands:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make dvi; dvips fdutils.dvi
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-* \ \
-To generate a html copy, run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make html
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fRA premade html can be found at:
-\&\fR\&\f(CW\(ifhttp://www.tux.org/pub/knaff/fdutils\(is\fR
-.TP
-* \ \
-To generate an info copy (browsable using emacs' info mode), run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make info
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The texinfo doc looks most pretty when printed or as html. Indeed, in
-the info version certain examples are difficult to read due to the
-quoting conventions used in info.
-.SH Description
-.iX "p diskd"
-.PP
-The diskd command has the following syntax:
-.PP
-
-.nf
-.ft 3
-.in +0.3i
-\&\fR\&\f(CWdiskd [\fR\&\f(CW-d \fIdrive\fR\&\f(CW] [\fR\&\f(CW-i \fImsdosfiles\fR\&\f(CW] [\fR\&\f(CW-e \fIcommand\fR\&\f(CW]
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-Diskd waits for a disk to be inserted into a given \fIdrive\fR, and then
-either executes the \fIcommand\fR or exits. This program can be used to
-automatically mount a disk as soon as it is inserted.
-.PP
-.SH Warning
-.PP
-This program works by switching the motor on for a very short
-interval, and then seeking to track -1. This might damage hardware in
-the long run. Amigas, which also use these techniques, are known for
-having problems with their disk drives no longer spinning up properly
-after a few month of usage.
-.PP
-.SH Options
-.TP
-\&\fR\&\f(CW-d\ \fIdrive\fR\&\f(CW\fR\
-Selects the drive to observe for disk insertion. By default, drive 0
-(\fR\&\f(CW/dev/fd0\fR) is observed.
-.TP
-\&\fR\&\f(CW-i\ \fIinterval\fR\&\f(CW\fR\
-Selects the polling interval. The interval is given in tenths of
-seconds. Default is 10 (one second).
-.TP
-\&\fR\&\f(CW-e\ \fIcommand\fR\&\f(CW\fR\
-Gives the command to be executed when a disk is inserted. If no
-command is given the program simply exits. Typically, the command
-mounts the disk. It can be a shell scripts which probes for several
-filesystems and disk geometries until it succeeds.
-.PP
-.SH Bugs
-.IP
-.TP
-* \ \
-Automatic unmounting cannot yet be handled. It is indeed not enough to
-scan for disk removal, because when the disk is removed, it is already
-too late: There might be some buffers needing flushing. However, the
-\&\fR\&\f(CWfdmountd\fR program allows automatic unmounting by using the
-\&\fR\&\f(CWSYNC\fR mount options, which switches off write buffering
-(see section fdmount).
-.TP
-* \ \
-The drive motor is running all the time, and on some computers, the
-drive led flickers at each time the drive is polled.
-.SH See Also
-Fdutils' texinfo doc
+++ /dev/null
-.TH diskseekd 1 "02jun00" fdutils-5.4
-.SH Name
-diskseek, diskseekd - disk seek daemon; simulates Messy Dos' drive cleaning effect
-'\" t
-.de TQ
-.br
-.ns
-.TP \\$1
-..
-
-.tr \(is'
-.tr \(if`
-.tr \(pd"
-
-.SH Note
-This manpage has been automatically generated from fdutils's texinfo
-documentation. However, this process is only approximative, and some
-items, such as crossreferences, footnotes and indices are lost in this
-translation process. Indeed, this items have no appropriate
-representation in the manpage format. Moreover, only the items specific
-to each command have been translated, and the general information about
-fdutils has been dropped in the manpage version. Thus I strongly advise
-you to use the original texinfo doc.
-.TP
-* \ \
-To generate a printable copy from the texinfo doc, run the following
-commands:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make dvi; dvips fdutils.dvi
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-* \ \
-To generate a html copy, run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make html
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fRA premade html can be found at:
-\&\fR\&\f(CW\(ifhttp://www.tux.org/pub/knaff/fdutils\(is\fR
-.TP
-* \ \
-To generate an info copy (browsable using emacs' info mode), run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make info
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The texinfo doc looks most pretty when printed or as html. Indeed, in
-the info version certain examples are difficult to read due to the
-quoting conventions used in info.
-.SH Description
-.iX "p diskseekd"
-.iX "c dust (shaking it off from a drive)"
-.iX "c shaking off dust from a drive"
-.PP
-Several people have noticed that Linux has a bad tendency of killing
-floppy drives. These failures remained completely mysterious, until
-somebody noticed that they were due to huge layers of dust accumulating
-in the floppy drives. This cannot happen under Messy Dos, because this
-excuse for an operating system is so unstable that it crashes roughly
-every 20 minutes (actually less if you are running Windows). When
-rebooting, the BIOS seeks the drive, and by doing this, it shakes the
-dust out of the drive mechanism. \fR\&\f(CWdiskseekd\fR simulates this effect
-by seeking the drive periodically. If it is called as \fR\&\f(CWdiskseek\fR,
-the drive is seeked only once.
-.PP
-.SH Options
-.PP
-The syntax for \fR\&\f(CWdiskseekd\fR is as follows:
-
-.nf
-.ft 3
-.in +0.3i
-\&\fR\&\f(CWdiskseekd [\fR\&\f(CW-d \fIdrive\fR\&\f(CW] [\fR\&\f(CW-i \fIinterval\fR\&\f(CW] [\fR\&\f(CW-p \fIpidfile\fR\&\f(CW]
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-\&\fR\&\f(CW-d\ \fIdrive\fR\&\f(CW\fR\
-Selects the drive to seek. By default, drive 0 (\fR\&\f(CW\(if/dev/fd0\(is\fR) is seeked.
-.TP
-\&\fR\&\f(CW-i\ \fIinterval\fR\&\f(CW\fR\
-Selects the cleaning interval, in seconds. If the interval is 0, a
-single seek is done. This is useful when calling diskseek from a
-crontab. The default is 1000 seconds (about 16 minutes) for
-\&\fR\&\f(CWdiskseekd\fR and 0 for \fR\&\f(CWdiskseek\fR.
-.TP
-\&\fR\&\f(CW-p\ \fIpidfile\fR\&\f(CW\fR\
-Stores the process id of the diskseekd daemon into \fIpidfile\fR instead
-of the default \fR\&\f(CW\(if/var/run/diskseekd.pid\(is\fR.
-.PP
-.SH Bugs
-.TP
-1.\
-Other aspects of Messy Dos' flakiness are not simulated.
-.TP
-2.\
-This section lacks a few smileys.
-.SH See Also
-Fdutils' texinfo doc
+++ /dev/null
-.TH fdmount 1 "02jun00" fdutils-5.4
-.SH Name
-fdmount - Floppy disk mount utility
-'\" t
-.de TQ
-.br
-.ns
-.TP \\$1
-..
-
-.tr \(is'
-.tr \(if`
-.tr \(pd"
-
-.SH Note
-This manpage has been automatically generated from fdutils's texinfo
-documentation. However, this process is only approximative, and some
-items, such as crossreferences, footnotes and indices are lost in this
-translation process. Indeed, this items have no appropriate
-representation in the manpage format. Moreover, only the items specific
-to each command have been translated, and the general information about
-fdutils has been dropped in the manpage version. Thus I strongly advise
-you to use the original texinfo doc.
-.TP
-* \ \
-To generate a printable copy from the texinfo doc, run the following
-commands:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make dvi; dvips fdutils.dvi
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-* \ \
-To generate a html copy, run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make html
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fRA premade html can be found at:
-\&\fR\&\f(CW\(ifhttp://www.tux.org/pub/knaff/fdutils\(is\fR
-.TP
-* \ \
-To generate an info copy (browsable using emacs' info mode), run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make info
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The texinfo doc looks most pretty when printed or as html. Indeed, in
-the info version certain examples are difficult to read due to the
-quoting conventions used in info.
-.SH Description
-.iX "p fdmount"
-.iX "p fdmountd"
-.iX "p fdlist"
-.iX "p fdumount"
-.iX "c automounting"
-.PP
-
-.nf
-.ft 3
-.in +0.3i
-\&\fR\&\f(CWfdmount [\fR\&\f(CW-l] [\fR\&\f(CW--list] [\fR\&\f(CW-d] [\fR\&\f(CW--daemon] [\fR\&\f(CW--detach]
-[\fR\&\f(CW-i \fIinterval\fR\&\f(CW] [\fR\&\f(CW--interval \fIinterval\fR\&\f(CW] [\fR\&\f(CW-o \fImount-options\fR\&\f(CW]
-[\fR\&\f(CW-r] [\fR\&\f(CW-readonly] [\fR\&\f(CW-s] [\fR\&\f(CW--sync] [\fR\&\f(CW--nosync] [\fR\&\f(CW--nodev]
-[\fR\&\f(CW--nosuid] [\fR\&\f(CW--noexec] [\fR\&\f(CW-f] [\fR\&\f(CW--force] [\fR\&\f(CW-h] [\fR\&\f(CW--help]
-[\fIdrivename\fR\&\f(CW] [\fImountpoint\fR\&\f(CW]
-\&\&
-\&\fR\&\f(CWfdumount [\fR\&\f(CW-f] [\fR\&\f(CW--force] [\fIdrivename\fR\&\f(CW]
-\&\&
-\&\fR\&\f(CWfdlist
-\&\&
-\&\fR\&\f(CWfdmountd [\fR\&\f(CW-i \fIinterval\fR\&\f(CW] [\fR\&\f(CW--interval \fIinterval\fR\&\f(CW] [\fR\&\f(CW-r]
-[\fR\&\f(CW-readonly] [\fR\&\f(CW-s] [\fR\&\f(CW--sync] [\fR\&\f(CW--nosync] [\fR\&\f(CW--nodev]
-[\fR\&\f(CW--nosuid] [\fR\&\f(CW--noexec] [\fR\&\f(CW--help] [\fIdrivename\fR\&\f(CW] [\fImountpoint\fR\&\f(CW]]
-\&\&
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The \fR\&\f(CWfdmount\fR program mounts a floppy disk in the specified
-drive. It tries to figure out the exact format and filesystem type of
-the disk from data in the disk's boot sector or super block and the
-auto-detected track layout.
-.PP
-Currently, fdmount supports the filesystems \fR\&\f(CWminix\fR, \fR\&\f(CWext\fR,
-\&\fR\&\f(CWext2\fR, \fR\&\f(CWxia\fR, and \fR\&\f(CWmsdos\fR, and includes special support
-for disks formatted by the \fR\&\f(CW2M\fR utility for MS-DOS.
-.PP
-It also checks whether the disk is write protected, in which case
-it is mounted read-only.
-.PP
-The symbolic \fIdrivename\fR is (currently) one of \fR\&\f(CW\(iffd[0-7]\(is\fR,
-corresponding to the special device files \fR\&\f(CW\(if/dev/fd[0-7]\(is\fR. If
-\&\fIdrivename\fR is not specified, \fR\&\f(CW\(iffd0\(is\fR is assumed.
-.PP
-The disk is mounted on the directory \fImountpoint\fR, if specified, or
-on \fR\&\f(CW\(if/fd[0-7]\(is\fR. In either case, the mount point must be an
-existing, writable directory.
-.PP
-\&\fBDue to a bug in the floppy driver (?), the polling interval (-i
-flag) must be longer than the spindown offset. Thus you need to do (for
-example) floppycontrol --spindown 99 before starting fdmountd in daemon
-mode\fR
-.PP
-.SH Options
-.IP
-.TP
-\&\fR\&\f(CW-l\ \fI--list\fR\&\f(CW\fR\
-List all known drives with their symbolic name, type, and mount
-status.
-.TP
-\&\fR\&\f(CW-d\ \fI--daemon\fR\&\f(CW\fR\
-Run in daemon mode (see below).
-.TP
-\&\fR\&\f(CW--detach\fR\
-Runs daemon in background, and detaches it from its tty. Messages
-produced after the fork are logged to syslog.
-.TP
-\&\fR\&\f(CW-p\ \fIfile\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--pidfile\ \fIfile\fR\&\f(CW\fR
-.IP
-Dumps the process id of the daemon to
-\&\fIfile\fR. This makes killing the daemon easier:
-\&\fR\&\f(CWkill -9 `cat \fIfile\fR\&\f(CW`\fR
-.TP
-\&\fR\&\f(CW-i\ \fIinterval\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--interval\ \fIinterval\fR\&\f(CW\fR
-Set the polling interval for daemon mode. The unit for \fIinterval\fR is
-0.1 seconds, the default value is 10 (i.e. 1 second).
-.TP
-\&\fR\&\f(CW-o\ \fIoptions\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--options\ \fIoptions\fR\&\f(CW\fR
-Sets filesystem-specific options. So far, these are only available for
-DOS and Ext2 disks. The following DOS options are supported:
-\&\fR\&\f(CWcheck\fR, \fR\&\f(CWconv\fR, \fR\&\f(CWdotsOK\fR, \fR\&\f(CWdebug\fR, \fR\&\f(CWfat\fR,
-\&\fR\&\f(CWquiet\fR, \fR\&\f(CWblocksize\fR. The following Ext2 options are
-supported: \fR\&\f(CWcheck\fR, \fR\&\f(CWerrors\fR, \fR\&\f(CWgrpid\fR, \fR\&\f(CWbsdgroups\fR,
-\&\fR\&\f(CWnogrpid\fR, \fR\&\f(CWsysvgroups\fR, \fR\&\f(CWbsddf\fR, \fR\&\f(CWminixdf\fR,
-\&\fR\&\f(CWresgid\fR, \fR\&\f(CWdebug\fR, \fR\&\f(CWnocheck\fR. When running as a daemon,
-options not applying to the disk that is inserted (because of its
-filesystem type) are not passed to mount.
-.TP
-\&\fR\&\f(CW-r\ \fI--readonly\fR\&\f(CW\fR\
-Mount the disk read-only. This is automatically assumed if the
-disk is write protected.
-.TP
-\&\fR\&\f(CW-s\ \fI--sync\fR\&\f(CW\fR\
-Mount with the \fR\&\f(CWSYNC\fR option.
-.TP
-\&\fR\&\f(CW--nosync\fR\
-Mounts without the \fR\&\f(CWSYNC\fR option, even when running as daemon.
-.TP
-\&\fR\&\f(CW--nodev\fR\
-Mount with the \fR\&\f(CWNODEV\fR option. Ignored for \fR\&\f(CWmsdos\fR
-filesystems, otherwise always set for non-root users.
-.TP
-\&\fR\&\f(CW--nosuid\fR\
-Mount with the \fR\&\f(CWNOSUID\fR option. Ignored for \fR\&\f(CWmsdos\fR
-filesystems, otherwise always set for non-root users.
-.TP
-\&\fR\&\f(CW--noexec\fR\
-Mount with the \fR\&\f(CWNOEXEC\fR option.
-.TP
-\&\fR\&\f(CW-f\ \fI--force\fR\&\f(CW\fR\
-Attempt a mount or unmount operation even \fR\&\f(CW\(if/etc/mtab\(is\fR says that
-the drive is already mounted, or not mounted, respectively.
-This option is useful if \fR\&\f(CW\(if/etc/mtab\(is\fR got out of sync with the
-actual state for some reason.
-.TP
-\&\fR\&\f(CW-h\ \fI--help\fR\&\f(CW\fR\
-Show short parameter description
-.PP
-.SH Security
-.PP
-When mounting on the default mount point, the mount points' owner is set
-to the current user, and the access flags according to the user's umask.
-For a specified mountpoint, owner and permissions are left
-unchanged. Default mount points are called \fR\&\f(CW/fd0\fR, \fR\&\f(CW/fd1\fR,
-\&\&... , \fR\&\f(CW/fd7\fR.
-.PP
-The user running fdmount must have read access to the floppy device for
-read only mounts, and read/write access for read/write mounts.
-.PP
-Fdmount can be run suid root, allowing users to mount floppy
-disks. The following restrictions are placed upon non-root
-users:
-.TP
-* \ \
-If a mountpoint is specified explicitly, it must be owned by the user.
-.TP
-* \ \
-A user may only unmount a disk if the mount point is owned by the user,
-or if it the disk has been mounted by the same user.
-.TP
-* \ \
-Non-msdos disks are automatically mounted with the \fR\&\f(CWnodev\fR and
-\&\fR\&\f(CWnosuid\fR flags set.
-.PP
-However, \fBdo not rely on fdmount being secure at the moment\fR.
-.PP
-.SH Daemon\ mode
-.PP
-In daemon mode, the specified drive is periodically checked and if a
-disk is inserted, it is automatically mounted.
-.PP
-When the disk is removed, it is automatically unmounted. However, it is
-recommended to unmount the disk manually \fIbefore\fR removing it. In
-order to limit corruption, disks are mounted with the SYNC option when
-running in daemon mode, unless the \fR\&\f(CW--nosync\fR flag is given.
-.PP
-Note that this mode has some potential drawbacks:
-.TP
-* \ \
-Some floppy drives have to move the drive head physically in order to
-reset the disk change signal. It is strongly recommended not to use
-daemon mode with these drives. See section floppycontrol, for details.
-.TP
-* \ \
-If a disk does not contain a filesystem (e.g. a tar archive),
-the mount attempt may slow down initial access.
-.TP
-* \ \
-As fdmount cannot identify the user trying to use the disk drive,
-there is no way to protect privacy. Disks are always mounted with
-public access permissions set.
-.PP
-.SH Diagnostics
-.IP
-.TP
-\&\fR\&\f(CWerror\ opening\ device\ \fIname\fR\&\f(CW\fR\
-.TP
-\&\fR\&\f(CWerror\ reading\ boot/super\ block\fR\
-fdmount failed to read the first 1K of the disk. The disk might be
-damaged, unformatted, or it may have a format wich is unsupported by the
-FDC or the Linux kernel.
-.TP
-\&\fR\&\f(CWunknown\ filesystem\ type\fR\
-No magic number of any of the supported filesystems (see above)
-could be identified.
-.TP
-\&\fR\&\f(CWsorry,\ can\(fmt\ figure\ out\ format\ (\fIfs\fR\&\f(CW\ filesystem)\fR\
-The size of the filesystem on the disk is incompatible with
-the track layout detected by the kernel and an integer number of
-tracks. This may occur if the filesystem uses only part of the
-disk, or the track layout was detected incorrectly by the kernel.
-.TP
-\&\fR\&\f(CWfailed\ to\ mount\ \fIfs>\ <size\fR\&\f(CWK-disk\fR\
-The actual \fR\&\f(CWmount\fR system call failed.
-.TP
-\&\fR\&\f(CWfailed\ to\ unmount\fR\
-The actual \fR\&\f(CWunmount\fR system call failed.
-.TP
-\&\fR\&\f(CWcannot\ create\ lock\ file\ /etc/mtab~\fR\
-If \fR\&\f(CW\(if/etc/mtab~\(is\fR exists, you should probably delete it. Otherwise,
-check permissions.
-.TP
-\&\fR\&\f(CWCan\(fmt\ access\ \fImountpoint\fR\&\f(CW\fR\
-Most probably, the default or specified mount point does not exist.
-Use mkdir.
-.TP
-\&\fR\&\f(CW\fImountpoint\fR\&\f(CW\ is\ not\ a\ directory\fR\
-The mountpoint is not a directory.
-.TP
-\&\fR\&\f(CWnot\ owner\ of\ \fImountpoint\fR\&\f(CW\fR\
-Non-root users must own the directory specified as mount point.
-(This does not apply for the default mount points, /fd[0-3].)
-.TP
-\&\fR\&\f(CWNo\ write\ permission\ to\ \fImountpoint\fR\&\f(CW\fR\
-Non-root users must have write permission on the mount point
-directory.
-.TP
-\&\fR\&\f(CWNot\ owner\ of\ mounted\ directory:\ UID=\fIuid\fR\&\f(CW\fR\
-Non-root users cannot unmount if the mount point is owned
-(i.e. the disk was mounted) by another user.
-.TP
-\&\fR\&\f(CWinvalid\ drive\ name\fR\
-Valid drive names are \fR\&\f(CW\(iffd0\(is\fR, \fR\&\f(CW\(iffd1\(is\fR, etc.
-.TP
-\&\fR\&\f(CWdrive\ \fIname\fR\&\f(CW\ does\ not\ exist\fR\
-The drive does not exist physically, is unknown to the Linux kernel, or
-is an unknown type.
-.TP
-\&\fR\&\f(CWDrive\ \fIname\fR\&\f(CW\ is\ mounted\ already\fR\
-Trying to mount a drive which appears to be mounted already. Use the
-\&\fR\&\f(CW--force\fR option if you think this is wrong.
-.TP
-\&\fR\&\f(CWDrive\ \fIname\fR\&\f(CW\ is\ not\ mounted\fR\
-Trying to unmount a drive which does not appear to be mounted. Use the
-\&\fR\&\f(CW--force\fR option if you think this is wrong.
-.TP
-\&\fR\&\f(CWioctl(...)\ failed\fR\
-If this occurs with the \fR\&\f(CWFDGETDRVTYP\fR or \fR\&\f(CWFDGETDRVSTAT\fR,
-ioctl's you should probably update your Linux kernel.
-.TP
-\&\fR\&\f(CWmounted\ \fIfs\fR\&\f(CW\ \fIsize\fR\&\f(CW-disk\ (\fIoptions\fR\&\f(CW)\fR\
-Success message.
-.PP
-.SH Bugs
-.TP
-* \ \
-Fdmount should be more flexible about drive names and default
-mount points (currently hard coded).
-.TP
-* \ \
-Probably not very secure yet (when running suid root).
-Untested with ext and xia filesystems.
-.TP
-* \ \
-Can't specify filesystem type and disk layout explicitly.
-.TP
-* \ \
-In daemon mode, the drive light stays on all the time.
-.TP
-* \ \
-Some newer filesystem types, such as vfat are not yet supported.
-.IP
-.SH See Also
-Fdutils' texinfo doc
+++ /dev/null
-.TH fdrawcmd 1 "02jun00" fdutils-5.4
-.SH Name
-fdrawcmd - send raw commands to the floppy disk controller
-'\" t
-.de TQ
-.br
-.ns
-.TP \\$1
-..
-
-.tr \(is'
-.tr \(if`
-.tr \(pd"
-
-.SH Note
-This manpage has been automatically generated from fdutils's texinfo
-documentation. However, this process is only approximative, and some
-items, such as crossreferences, footnotes and indices are lost in this
-translation process. Indeed, this items have no appropriate
-representation in the manpage format. Moreover, only the items specific
-to each command have been translated, and the general information about
-fdutils has been dropped in the manpage version. Thus I strongly advise
-you to use the original texinfo doc.
-.TP
-* \ \
-To generate a printable copy from the texinfo doc, run the following
-commands:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make dvi; dvips fdutils.dvi
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-* \ \
-To generate a html copy, run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make html
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fRA premade html can be found at:
-\&\fR\&\f(CW\(ifhttp://www.tux.org/pub/knaff/fdutils\(is\fR
-.TP
-* \ \
-To generate an info copy (browsable using emacs' info mode), run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make info
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The texinfo doc looks most pretty when printed or as html. Indeed, in
-the info version certain examples are difficult to read due to the
-quoting conventions used in info.
-.SH Description
-.iX "p fdrawcmd"
-.iX "c raw command"
-.iX "c low level interaction with floppy driver"
-.iX "c direct interaction with floppy driver"
-.PP
-
-.nf
-.ft 3
-.in +0.3i
-\&\fR\&\f(CWfdrawcmd [\fR\&\f(CWdrive=\fIdrive\fR\&\f(CW] [\fR\&\f(CWrate=\fIrate\fR\&\f(CW]
-[\fR\&\f(CWlength=\fIlength\fR\&\f(CW] [\fR\&\f(CWrepeat=\fIrepeat\fR\&\f(CW]
-[\fR\&\f(CWcylinder=\fIphysical-cyl\fR\&\f(CW] \fIcommand\fR\&\f(CW [\fIparamters\fR\&\f(CW \&...] [\fImode\fR\&\f(CW]
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-\&\fR\&\f(CWfdrawcmd\fR
-is used to send raw commands to the floppy disk controller, after
-having selected a given drive. You must have write permission to the
-selected drive.
-.PP
-When writing to a disk, data is read from stdin; when reading, data
-is printed to stdout. Diagnostic messages, return values from the
-controller, and the value of the disk change line after the command are
-printed to stderr.
-.PP
-.SH Options
-.PP
-All numbers may be given in octal (0211), decimal (137), or hexadecimal
-(0x89).
-.IP
-.TP
-\&\fR\&\f(CWdrive=\fIdrive\fR\&\f(CW\fR\
-Selects the drive. The default is drive 0 (\fR\&\f(CW\(if/dev/fd0\(is\fR).
-.TP
-\&\fR\&\f(CWrate=\fIrate\fR\&\f(CW\fR\
-Selects the data transfer rate. Use 0 for high density disks, 1 for
-double density 5 1/4 disks (or 2 Mbps tapes, if the appropriate rate
-table is selected), and 2 for double density 3 1/2 disks.
-.TP
-\&\fR\&\f(CWlength=\fIlength\fR\&\f(CW\fR\
-Describes the length of the transferred data for commands reading from
-and writing to the disk. The default is to continue until end of file.
-.TP
-\&\fR\&\f(CWrepeat=\fIcount\fR\&\f(CW\fR\
-Repeat the command \fIcount\fR times. This only works correctly for
-commands which don't do any data transfer.
-.TP
-\&\fR\&\f(CWcylinder=\fIcount\fR\&\f(CW\fR\
-Seek to the given cylinder before executing the command
-.TP
-\&\fR\&\f(CW\fIcommand\fR\&\f(CW\fR\
-The name of the command to send. \fIcommand\fR may be a spelled out
-name (like \fR\&\f(CWread\fR or \fR\&\f(CWwrite\fR), or a number representing the
-commands floppy disk controller opcode. A named command has already a
-mode associated with it, whereas for a number the mode parameter should
-be described using the \fR\&\f(CWmode\fR option.
-.IP
-.TP
-\&\fR\&\f(CW\fIparameters\fR\&\f(CW\fR\
-The parameters for the command (optional, not all commands need
-parameters).
-.TP
-\&\fR\&\f(CW\fImode\fR\&\f(CW\fR\
-Various flags or'ed together describing the properties of the command.
-.PP
-.SH Commands
-.PP
-The description of the various floppy commands given in this manpage is
-very sketchy. For more details get the 82078 spec sheet which can be
-found at:
-
-.nf
-.ft 3
-.in +0.3i
-http://www-techdoc.intel.com/docs/periph/fd_contr/datasheets/
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-Look for the chapter \fR\&\f(CWCOMMAND SET/DESCRIPTIONS\fR. Older FDCs only
-support a subset of the commands described therein, but the syntax for
-the commands that do exist is the same.
-.PP
-.SS Commands\ available\ on\ all\ FDCs
-.IP
-.TP
-\&\fR\&\f(CWread\ \fIdrvsel\ cyl\ head\ sect\ szcod\ spt\ rw-gap\ szcod2\fR\&\f(CW\fR\
-Reads \fIlength\fR bytes of data from the disk. \fIdrvsel\fR is the
-drive selector. Bit 0 and 1 describe the drive, and bit 2 describes the
-head. The remaining parameters give the cylinder, head (yes, again),
-sector, size of the sector (128 * 2 ^ \fIszcod\fR), sectors per track
-(\fR\&\f(CWspt\fR, this is used to switch to the second head when the first
-side has been read), and size of the read-write gap. \fIszcod2\fR should
-be 0xff. \fR\&\f(CWread\fR returns \fIST0 ST1 ST2\fR and \fIcyl head sect
-szcod\fR of the next sector to be read; see
-\&\fR\&\f(CW\(if/usr/include/linux/fdreg.h\(is\fR .
-.IP
-N.B. Certain newer floppy disk controllers are buggy, and do not
-correctly recognize the end of transfer when operating in virtual DMA
-mode. For these, you need to set \fR\&\f(CWspt\fR to the id of the last
-sector to be read (for example, if you intend to read sectors 2, 3, 4,
-set \fR\&\f(CWspt\fR to 4, even if the disk has more sectors), and set the
-\&\fR\&\f(CWno-mt\fR flag.
-.TP
-\&\fR\&\f(CWwrite\ \fIdrvsel\ cyl\ head\ sect\ szcod\ spt\ rw-gap\ szcod2\fR\&\f(CW\fR\
-Analogous to
-\&\fR\&\f(CWread\fR.
-.TP
-\&\fR\&\f(CWsense\ \fIdrvsel\fR\&\f(CW\fR\
-Returns the third status byte (\fIST3\fR)
-.TP
-\&\fR\&\f(CWrecalibrate\ \fIdrvsel\fR\&\f(CW\fR\
-Recalibrates the drive and returns \fIST0 ST1\fR.
-.TP
-\&\fR\&\f(CWseek\ \fIdrvsel\ cyl\fR\&\f(CW\fR\
-Moves the head to \fIcyl\fR and returns \fIST0 ST1\fR.
-.TP
-\&\fR\&\f(CWspecify\ \fIdrvsel\ spec1\ spec2\fR\&\f(CW\fR\
-Specify various parameters to the drive.
-.TP
-\&\fR\&\f(CWformat\ \fIdrvsel\ szcod\ sect-per-track\ fmt-gap\ fmt-fill\fR\&\f(CW\fR\
-Formats the cylinder. The new sectors are filled with \fIfmt-fill\fR.
-The header information comes from the input, which is made up of
-\&\fIcyl head sect szcod\fR quadruples. The \fIszcod\fR parameter
-from the command line is used to describe the actual size of the
-sectors, and the \fIszcod\fR from the input is used to write into the
-header. However, the first write to these sectors will use the header
-information, and might overwrite the following sectors if the
-\&\fIszcod\fR parameter from the command line was too small.
-.TP
-\&\fR\&\f(CWreadid\ \fIdrvsel\fR\&\f(CW\fR\
-reads the first sector header that comes and returns
-\&\fIST0 ST1 ST2 \fR
-and
-\&\fIcyl head sect szcod \fR
-of the encountered header.
-.PP
-.SS Commands\ available\ on\ 82072\ and\ later
-.TP
-\&\fR\&\f(CWdumpregs\fR\
-Prints the contents of the FDCs registers, if supported.
-.PP
-.SS Commands\ available\ on\ 82072A\ and\ later
-.TP
-\&\fR\&\f(CWconfigure\ \fIconf1\ conf2\ conf3\fR\&\f(CW\fR\
-Configures FIFO operation.
-.PP
-.SS Commands\ available\ on\ 82077\ and\ later
-.TP
-\&\fR\&\f(CWversion\fR\
-Echoes 0x90 if the FDC is more recent than 82072A, and 0x80 otherwise
-.TP
-\&\fR\&\f(CWperpendicular\ \fIrate\fR\&\f(CW\fR\
-Sets the perpendicular mode. Use 0 for normal, 2 for 500kb/s
-perpendicular, and 3 for 1 Mb/s perpendicular.
-.TP
-\&\fR\&\f(CWseek-out\ \fIdrvsel\ n\fR\&\f(CW\fR\
-does a relative seek of
-\&\fIn\fR
-cylinders towards cylinder 0.
-.TP
-\&\fR\&\f(CWseek-in\ \ \fIdrvsel\ n\fR\&\f(CW\fR\
-does a relative seek of \fIn\fR cylinders away from cylinder 0.
-.PP
-.SS Commands\ available\ on\ 82077AA\ and\ later
-.TP
-\&\fR\&\f(CWlock\fR\
-Locks the FIFO configuration, so that it survives a FDC software reset.
-.TP
-\&\fR\&\f(CWunlock\fR\
-Unlock the FIFO configuration
-.PP
-.SS Commands\ available\ on\ 82078
-.TP
-\&\fR\&\f(CWpartid\fR\
-echoes a byte describing the type of the FDC in the 3 high bits, and
-the stepping in the three low bits.
-.TP
-\&\fR\&\f(CWpowerdown\ \fIpowerconf\fR\&\f(CW\fR\
-configures automatic power down of the FDC. The old configuration is echoed
-.TP
-\&\fR\&\f(CWoption\ \fIiso\fR\&\f(CW\fR\
-enables/disables ISO formats. Odd values of
-\&\fIiso\fR
-enable these formats, whereas even values disable them. ISO formats
-don't have index headers, and thus allow to fit slightly more data on
-a disk.
-.TP
-\&\fR\&\f(CWsave\fR\
-prints out 16 internal registers of the FDC.
-.TP
-\&\fR\&\f(CWrestore\ \fIr1\ r2\ r3\ ...\ r16\fR\&\f(CW\fR\
-restores the 16 internal registers of the FDC.
-.TP
-\&\fR\&\f(CWformat_n_write\ \fIdrvsel\ szcod\ sect-per-track\ fmt-gap\ fmt-fill\fR\&\f(CW\fR\
-formats the cylinder and writes initial data to it. The input data is
-made up of a sequence of headers (4 bytes) and data:
-\&\fIheader1 data1 header2 data2 ... headern datan\fR
-.TP
-\&\fR\&\f(CWdrivespec\ \fIdspec1\ dspec2\ ...\ specn\ terminator\fR\&\f(CW\fR\
-chooses rate tables for various drives. Each dspec byte describes one
-drive. Bits 0 and 1 say which drive is described. Bits 2 and 3 describe
-the rate table. Only tables 0 and 2 are interesting. Both tables only
-differ in the meaning og rate 1. For table 0 (the default) rate 0 is 300
-kb/s (used for 5 1/4 DD disks), whereas for table 1 it is 2 Mbps (used
-for fast floppy tape drives). Bit 4 is the precompensation table select
-bit. It should be set to 0. Bit 5-7 should be zero as well. The
-\&\fIterminator\fR byte ends the \fR\&\f(CWdrivespec\fR command. It is either
-0xc0 or 0x80. If it is 0xc0, no result phase follows; if it is 0x80, the
-current data rate table configuration for the four drives is echoed.
-.PP
-.SH Modes
-The mode option is only needed when you describe the command as a
-numerical value. Some mode names are also valid command names. They
-are considered as command name if the command name has not yet been
-given, and as mode name otherwise.
-.PP
- If you give a command name followed by explicit modes, both the
-implicit flags of the command name, and the explicit modes are or'ed
-together.
-.PP
- If on the other hand you give a command name preceded by explicit
-modes, only the explicit modes are or'ed together.
-.TP
-\&\fR\&\f(CWread\fR\
-Read data from disk using DMA.
-.TP
-\&\fR\&\f(CWwrite\fR\
-Write data to the disk.
-.TP
-\&\fR\&\f(CWintr\fR\
-Wait for an interrupt.
-.TP
-\&\fR\&\f(CWspin\fR\
-wait for the disk to spin up
-.TP
-\&\fR\&\f(CWdisk\fR\
-Aborts the operation if no disk is in the drive. This only works if you
-also chose a physical cylinder to seek to.
-.TP
-\&\fR\&\f(CWno-motor\fR\
-Don't switch on the drive motor while issuing the command
-.TP
-\&\fR\&\f(CWno-motor-after\fR\
-Switch off the motor immediately after the command returns.
-.TP
-\&\fR\&\f(CWfm\fR\
-Uses the FM version of the \fR\&\f(CWread\fR, \fR\&\f(CWreadid\fR, \fR\&\f(CWwrite\fR and
-\&\fR\&\f(CWformat\fR commands.
-.TP
-\&\fR\&\f(CWno-mt\fR\
-Do not use MT (multitrack) mode for the \fR\&\f(CWread\fR, \fR\&\f(CWreadid\fR and
-\&\fR\&\f(CWwrite\fR commands. This is needed on certain broken FDC's which
-don't recognize end of transfer when running in \fR\&\f(CWnodma\fR mode. In
-order to use these safely, set \fR\&\f(CWno-mt\fR, and chose the id of the
-last sector to be read as \fR\&\f(CWsect-per-track\fR.
-.PP
-\&\fR\&\f(CWfdrawcmd\fR opens the device node with the \fR\&\f(CWNDELAY\fR flag. This
-means that the driver should not try to autodetect the disk type (it
-might not be formatted), and that it should not reset the FDC. If a
-reset was needed, the command simply fails. If that happens, execute
-\&\fR\&\f(CWfloppycontrol --resetnow 0\fR , and try again.
-.PP
-.SH See Also
-Fdutils' texinfo doc
+++ /dev/null
-.TH floppycontrol 1 "02jun00" fdutils-5.4
-.SH Name
-floppycontrol - floppy driver configuration utility
-'\" t
-.de TQ
-.br
-.ns
-.TP \\$1
-..
-
-.tr \(is'
-.tr \(if`
-.tr \(pd"
-
-.SH Note
-This manpage has been automatically generated from fdutils's texinfo
-documentation. However, this process is only approximative, and some
-items, such as crossreferences, footnotes and indices are lost in this
-translation process. Indeed, this items have no appropriate
-representation in the manpage format. Moreover, only the items specific
-to each command have been translated, and the general information about
-fdutils has been dropped in the manpage version. Thus I strongly advise
-you to use the original texinfo doc.
-.TP
-* \ \
-To generate a printable copy from the texinfo doc, run the following
-commands:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make dvi; dvips fdutils.dvi
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-* \ \
-To generate a html copy, run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make html
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fRA premade html can be found at:
-\&\fR\&\f(CW\(ifhttp://www.tux.org/pub/knaff/fdutils\(is\fR
-.TP
-* \ \
-To generate an info copy (browsable using emacs' info mode), run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make info
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The texinfo doc looks most pretty when printed or as html. Indeed, in
-the info version certain examples are difficult to read due to the
-quoting conventions used in info.
-.SH Description
-.iX "p floppycontrol"
-.iX "c configuration of floppy driver"
-.PP
-
-.nf
-.ft 3
-.in +0.3i
-\&\fR\&\f(CWfloppycontrol [\fR\&\f(CW-p] [\fR\&\f(CW--pollstate] [\fR\&\f(CW--printfdstate]
-[\fR\&\f(CW-a \fIoperation-abort-threshold\fR\&\f(CW] [\fR\&\f(CW-c \fIread-track-threshold\fR\&\f(CW]
-[\fR\&\f(CW-r \fIrecalibrate-threshold\fR\&\f(CW] [\fR\&\f(CW-R \fIreset-threshold\fR\&\f(CW]
-[\fR\&\f(CW-e \fIreporting-threshold\fR\&\f(CW] [\fR\&\f(CW-f] [\fR\&\f(CW-x] [\fR\&\f(CW-d \fIdrive\fR\&\f(CW][\fR\&\f(CW-F] [\fR\&\f(CW-T]
-[\fR\&\f(CW-reset \fIcondition\fR\&\f(CW] [\fR\&\f(CW--debug] [\fR\&\f(CW--nodebug] [\fR\&\f(CW--messages]
-[\fR\&\f(CW--nomessages] [\fR\&\f(CW--broken_dcl] [\fR\&\f(CW--working_dcl] [\fR\&\f(CW--inverted_dcl]
-[\fR\&\f(CW--no_inverted_dcl] [\fR\&\f(CW--silent_dcl_clear] [\fR\&\f(CW--noisy_dcl_clear]
-[\fR\&\f(CW-c\fIcmos-type\fR\&\f(CW] [\fR\&\f(CW-hlt \fIhlt\fR\&\f(CW] [\fR\&\f(CW-hut \fIhut\fR\&\f(CW] [\fR\&\f(CW-srt \fIsrt\fR\&\f(CW] [\fR\&\f(CW-o \fIspindown\fR\&\f(CW]
-[\fR\&\f(CW-u \fIspinup\fR\&\f(CW] [\fR\&\f(CW-s \fIselect-delay\fR\&\f(CW] [\fR\&\f(CW-rps \fIrotations-per-second\fR\&\f(CW]
-[\fR\&\f(CW-O \fIspindown-offset\fR\&\f(CW] [\fR\&\f(CW-track \fImax-tracks\fR\&\f(CW] [\fR\&\f(CW-timeout \fIseconds\fR\&\f(CW]
-[\fR\&\f(CW-C \fIcheck-interval\fR\&\f(CW] [\fR\&\f(CW-n \fInative-format\fR\&\f(CW]
-[\fR\&\f(CW-autodetect \fIautodetection-sequence\fR\&\f(CW] [\fR\&\f(CW-P] [\fR\&\f(CW--clrwerror]
-[\fR\&\f(CW--printwerror] [\fR\&\f(CW-h]
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The \fR\&\f(CWfloppycontrol\fR program is used to configure the floppy driver.
-.PP
-.SH General\ Options
-.IP
-.TP
-\&\fR\&\f(CW-h\fR\
-.TQ
-\&\fR\&\f(CW--help\fR
-Print a help screen.
-.TP
-\&\fR\&\f(CW-d\ \fIdrive\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--drive\ \fI\ drive\fR\&\f(CW\fR
-Selects the drive to configure. The default is drive 0
-(\fR\&\f(CW\(if/dev/fd0\(is\fR).
-.PP
-.SH One\ time\ actions
-.iX "c ejecting a disk"
-.iX "c flushing floppy cache"
-.iX "c resetting controller"
-.PP
-The following \fR\&\f(CWfloppycontrol\fR options don't set a configuration
-parameter, but perform a one-time action. They are available to anybody
-who has write access to the drive
-.TP
-\&\fR\&\f(CW-f\ \ \fR\
-.TQ
-\&\fR\&\f(CW--flush\fR
-Flushes (throws away) the dirty data buffers associated with this drive.
-.TP
-\&\fR\&\f(CW-x\ \ \fR\
-.TQ
-\&\fR\&\f(CW--eject\fR
-Ejects the disk out of the drive (Sparc). The dirty buffers are first
-committed to disk before ejecting it. Fails if the disk is mounted.
-.TP
-\&\fR\&\f(CW--reset\ \fI\ condition\fR\&\f(CW\fR\
-Resets the FDC under
-\&\fIcondition\fR . Condition may be one of the following:
-.RS
-.TP
-\&\fR\&\f(CW0\fR\
-resets the FDC only if a reset is needed anyways,
-.TP
-\&\fR\&\f(CW1\fR\
-resets the FDC
-also if a raw command has been performed since the last reset, and
-.TP
-\&\fR\&\f(CW2\ \fR\
-resets the FDC unconditionally.
-.RE
-.IP
-This command may be needed after some failed raw commands
-(see section fdrawcmd).
-.IP
-.TP
-\&\fR\&\f(CW-F\fR\
-.TQ
-\&\fR\&\f(CW--formatend\fR
-Issues an end format ioctl. This might be needed after exiting a
-\&\fR\&\f(CWfdformat\fR in an unclean way. \fR\&\f(CWsuperformat\fR is not subject to
-this.
-.PP
-.SH Printing\ current\ settings
-.iX "c printing current settings"
-.iX "c determining drive type"
-.iX "c detecting a disk change"
-.IP
-.TP
-\&\fR\&\f(CW-T\fR\
-.TQ
-\&\fR\&\f(CW--type\fR
-Print out the drive name of a floppy device. This is used by the
-\&\fR\&\f(CWMAKEFLOPPIES\fR script. The drive name is a letter (describing the
-drive type) followed by the capacity of the format in bytes. The letter
-is E for 3.5 ED drives, H for 3.5 HD drives, D for 3.5 DD drives, h for
-5.25 HD drives and d for 5.25 DD drives. The drive type letter
-corresponds to the oldest drive type supporting the format of this
-device node (not necessarily the type of the drive refered by this
-node.) For the generic format nodes (/dev/fd0 et al.) the name of
-"native format" of the drive is printed, and for the default formats, if
-a generic format has been redefined, its name becomes \fR\&\f(CW(null)\fR.
-.TP
-\&\fR\&\f(CW-p\fR\
-.TQ
-\&\fR\&\f(CW--print\fR
-Prints out the configuration of the drive. The names of the various
-fields are the same as the names of the option to set them, see below.
-.TP
-\&\fR\&\f(CW-P\fR\
-.TQ
-\&\fR\&\f(CW--printstate\fR
-Prints out the cached internal state of the driver. The first line lists
-various attributes about the disk:
-.RS
-.TP
-\&\fR\&\f(CWdrive\ present\fR\
-.TQ
-\&\fR\&\f(CWdisk\ present\fR
-.TQ
-\&\fR\&\f(CWdisk\ writable\fR
-These are only updated when the drive is accessed.
-.TP
-\&\fR\&\f(CWspinup\fR\
-is the time when the motor became switched on for the last time.
-.TP
-\&\fR\&\f(CWselect\fR\
-is the time when the drive became selected for the last time
-.TP
-\&\fR\&\f(CWfirst_read\fR\
-is the time when the first read request after the last spin up
-completed.
-.TP
-\&\fR\&\f(CWprobed_fmt\fR\
-is the the index of the autodetected format in the autodetection
-sequence for this drive.
-.TP
-\&\fR\&\f(CWcylinder\fR\
-is the cylinder where the drive head currently sits. If this number is negative, it has the following meaning:
-.RS
-.TP
-* \ \
--1 means that the driver doesn't know, but the controller does (a seek
-command must be issued).
-.TP
-* \ \
--2 means that the controller doesn't know either, but is sure that it
-not beyond the 80th track. The drive needs a recalibration.
-.TP
-* \ \
--3 means that the head may be beyond the 80th track. The drive needs
-two successive recalibrations, because at each recalibration, the
-controller only issues 80 move head commands per recalibration.
-.RE
-.TP
-\&\fR\&\f(CWmaxblock\fR\
-is the highest block number that has been read.
-.TP
-\&\fR\&\f(CWmaxcylinder\fR\
-is a boolean which is set when a sector that is not on cylinder 0/head 0
-has been read. These are used for smart invalidation of the buffer
-cache on geometry change. The buffer cache of the drive is only
-invalidated on geometry change when this change actually implies that a
-block that has already been read changes position. This optimization is
-useful for mtools which changes the geometry after reading the boot
-sector.
-.TP
-\&\fR\&\f(CWgeneration\fR\
-is roughly the number of disk changes noticed since boot. Disk changes
-are noticed if the disk is actually changed, or if a flush command is
-issued and for both cases if any I/O to/from the disk occurs. (i.e. if
-you insert several disks, but don't do any I/O to them, the generation
-number stays the same.)
-.TP
-\&\fR\&\f(CWrefs\fR\
-is number of open file descriptors for this drive. It is always at
-least one, because floppycontrol's file descriptor is counted too.
-.TP
-\&\fR\&\f(CWdevice\fR\
-is format type (as derived from the minor device number) which is
-currently being used.
-.TP
-\&\fR\&\f(CWlast_checked\fR\
-is date (in jiffies) when the drive was last checked for a disk
-change, and a disk was actually in the drive.
-.RE
-.IP
-.TP
-\&\fR\&\f(CW--pollstate\fR\
-Polls the drive and then prints out the internal state of the
-driver.(\fR\&\f(CW--Printstate\fR only prints out the cached information
-without actually polling the drive for a disk change.)
-.TP
-\&\fR\&\f(CW--printfdcstate\fR\
-Prints out the state of the controller where the target drive is
-attached to.
-.RS
-.TP
-\&\fR\&\f(CWspec1\fR\
-.TQ
-\&\fR\&\f(CWspec2\fR
-are the current values of those registers.
-.TP
-\&\fR\&\f(CWrate\fR\
-is current data transfer rate
-.TP
-\&\fR\&\f(CWrawcmd\fR\
-is true if a raw command has been executed since the last reset. If this
-is the case, a reset will be triggered when a drive on the same FDC is
-next opened.
-.TP
-\&\fR\&\f(CWdor\fR\
-is the value of the digital output register. The 4 high bits are a bit
-mask describing which drives are spinning, the 2 low bits describe the
-selected drive, bit 2 is used to reset the FDC, and bit 3 describes
-whether this FDC has hold of the interrupt and the DMA. If you have two
-FDCs, bit 3 is only set on one of them.
-.TP
-\&\fR\&\f(CWversion\fR\
-is the version of the FDC. See \fR\&\f(CW\(iflinux/include/linux/fdreg.h\(is\fR for a
-listing of the FDC version numbers.
-.TP
-\&\fR\&\f(CWreset\fR\
-is true if a reset needs to be issued to the FDC before processing the
-next request.
-.TP
-\&\fR\&\f(CWneed_configure\fR\
-is true if this FDC needs configuration by the \fR\&\f(CWFD_CONFIGURE\fR
-command.
-.TP
-\&\fR\&\f(CWhas_fifo\fR\
-is set if the FDC understands the \fR\&\f(CWFD_CONFIGURE\fR command.
-.TP
-\&\fR\&\f(CWperp_mode\fR\
-describes the perpendicular mode of this FDC. 0 is non-perpendicular mode,
-2 is HD perpendicular mode, 3 is ED perpendicular mode, and 1 is unknown.
-.TP
-\&\fR\&\f(CWaddress\fR\
-is the address of the first I/O port of the FDC. Normally, this is
-0x3f0 for the first FDC and 0x370 for the second.
-.RE
-.PP
-.SH Drive\ type\ configuration\ and\ autodetection
-.iX "c CMOS type"
-.iX "c drive type"
-.iX "c swapping drives"
-.PP
-The following options handle the different available drive types, such
-as double density vs. high density vs. extra density drives, and 5 1/4
-drives vs 3 1/2 drives. Usually the drive type is stored in a
-non-volatile memory, called CMOS, under the form of an integer ranging
-from 1 to 6.
-.PP
-Different drive types are able to handle and autodetect different
-formats (different autodetection lists). They also have different
-"native format name". The native format is the "usual" format with the
-highest capacity supported by the drive. (For example 720KB on a double
-density 3 1/2 drive, and 1.2MB on a high density 5 1/4 drive.)
-.PP
-These settings are only changeable by the super user.
-.TP
-\&\fR\&\f(CW-c\ \fIcmos-type\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--cmos\ \fI\ cmos-type\fR\&\f(CW\fR
-Set the virtual CMOS type of the floppy drive. This is useful if
-.RS
-.TP
-* \ \
-the physical CMOS type is wrong (this may happen with BIOSes
-which use a non-standard mapping),
-.TP
-* \ \
-you have more than two drives
-(the physical CMOS may only describe up to two drives).
-.TP
-* \ \
-you have a BIOS that allows swapping drives A: and B: for DOS.
-.RE
-
-Right now, this CMOS parameter is not used by the kernel, except for
-feeding it back to other applications (for instance \fR\&\f(CWsuperformat\fR,
-\&\fR\&\f(CWfloppymeter\fR or \fR\&\f(CWMAKEFLOPPIES\fR). It is also possible to
-supply a virtual CMOS type with the \fR\&\f(CWcmos\fR boot option
-(see section Boottime configuration). If possible, I recommend you use the
-boot option, rather than \fR\&\f(CWfloppycontrol\fR, because the boot option
-also sets any parameters derived from the CMOS type, such as the
-autodetection list and the native format, whereas \fR\&\f(CWfloppycontrol\fR
-does not.
-.TP
-\&\fR\&\f(CW-A\ \ \fIautodetect-seq\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--autodetect\ \fI\ autodetect-seq\fR\&\f(CW\fR
-Set the autodetection sequence (see section Autodetection) The autodetection
-sequence is a comma-separated list of at most eight format
-descriptors. Each format descriptor is a format number optionally
-followed by the letter \fR\&\f(CWt\fR. For drive 0, the format number is the
-minor device number divided by 4. The autodetection sequence is used by
-the driver to find out the format of a newly inserted disk. The formats
-are tried one after the other, and the first matching format is
-retained. To test the format, the driver tries to read the first sector
-on the first track on the first head when \fR\&\f(CWt\fR is not given, or the
-whole first track when \fR\&\f(CWt\fR is given. Thus, autodetection cannot
-detect the number of tracks. However, this information is contained in
-the boot sector, which is now accessible. The boot sector can then be
-used by mtools to configure the correct number of tracks.
-.IP
-Example:
-
-.nf
-.ft 3
-.in +0.3i
-7,4,24t,25
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fRmeans to try out the formats whose minor device numbers are 28 (1.44M),
-16 (720KB), 96 (1.76MB), and 100 (1.92MB), in this order. For the 1.76MB
-format, try to read the whole track at once.
-.IP
-Reading the whole track at once allows you to distinguish between two
-formats which differ only in the number of sectors. (The format with the
-most sectors must be tried first.) If you use mtools, you do not need this feature, as mtools can figure out
-the number of sectors without any help from the floppy driver, by
-looking at the boot sector.
-.IP
-Reading the whole track at once may also speed up the first read by 200
-milliseconds. However, if, on the other hand, you try to read a disk
-which has less sectors than the format, you lose some time.
-.IP
-I suggest that you put the most often used format in the first place
-(barring other constraints), as each format that is tried out takes
-400 milliseconds.
-.TP
-\&\fR\&\f(CW-n\ \fInative-format\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--native_format\ \fI\ native-format\fR\&\f(CW\fR
-Set the native format of this drive. The native format of a drive is the
-highest standard format available for this drive. (Example: For a 5 1/4
-HD drive it is the usual 1200K format.) This is format is used to make
-up the format name for the generic device (which is the name of the
-native format). This drive name is read back from the kernel by the
-\&\fR\&\f(CWMAKEFLOPPIES\fR script which uses it to decide which device nodes to
-create.
-.PP
-.SH Configuration\ of\ the\ disk\ change\ line
-.iX "c disk change line"
-.iX "c Thinkpad"
-.iX "c disk change detection"
-.iX "c disk absent during operation (false alert)"
-.TP
-\&\fR\&\f(CW--broken_dcl\fR\
-Assumes that the disk change line of the drive is broken. If this is
-set, disk changes are assumed to happen whenever the device node is
-first opened. The physical disk change line is ignored.
-.IP
-This option should be used if disk changes are either not detected at
-all, or if disk changes are detected when the disk was actually not
-changed. If this option fixes the problem, I'd recommend that you try to
-trace the root cause of the problem. Indeed, this options results in
-reduced performance due to spurious cache flushes.
-.IP
-The following hardware problems may lead to a bad disk change line:
-.RS
-.TP
-* \ \
-If the floppy cable is not inserted straight, or if it is kinked, the
-disk change line is likely to suffer, as it is on the edge of the cable.
-Gently press on both connectors of the cable (drive and controller) to
-insure that all wires make contact. Visually inspect the cable, and if
-it shows obvious traces of damage, get a new one.
-.TP
-* \ \
-On some drives, the locations disk change line may be chosen by
-jumper. Make sure that your floppy controller and your drive agree on
-which line is the disk change line.
-.TP
-* \ \
-Some older drives (mostly double density 5 1/4 drives) don't have a disk
-change line. In this case, you have no choice other than to leave the
-\&\fR\&\f(CWbroken_dcl\fR option on.
-.RE
-.TP
-\&\fR\&\f(CW--working_dcl\fR\
-Assumes that the disk change line works all right. Switching from
-broken to working may lead to unexpected results after the first disk
-change.
-.TP
-\&\fR\&\f(CW--inverted_dcl\fR\
-Assumes that this disk drive uses an inverted disk change
-line. Apparently this is the case for IBM thinkpads.
-.TP
-\&\fR\&\f(CW--no_inverted_dcl\fR\
-Assumes that this drive follows the standard convention for the disk
-change line.
-.TP
-\&\fR\&\f(CW--noisy_dcl_clear\fR\
-Switches off silent disk change line clearing for this drive.
-.PP
-.SH Timing\ Parameters
-.iX "c strange noises during seek"
-.PP
-This section describes how to configure drive timings. To set these
-parameters, you need superuser privileges. All times are in "jiffy"
-units (10 milliseconds), unless otherwise specified.
-.TP
-\&\fR\&\f(CW--hlt\ \fI\ hlt\fR\&\f(CW\fR\
-Set the head load time (in microseconds) for this floppy drive. The
-head load time describes how long the floppy controller waits after
-seeking or changing heads before allowing access to a track.
-.TP
-\&\fR\&\f(CW--hut\ \fI\ hut\fR\&\f(CW\fR\
-Set the head unload time (in microseconds) for this floppy drive. The
-head unload time describes how long the floppy controller waits after an
-access before directing its attention to the other head, or before
-seeking.
-.TP
-\&\fR\&\f(CW--srt\ \fI\ srt\fR\&\f(CW\fR\
-Set the step rate (in microseconds) for this floppy drive. The step
-rate describes how long the drive head stays on one cylinder when
-seeking. Setting this value to low (too fast seeks) may make seeks
-fail, because the motor doesn't follow fast enough.
-.TP
-\&\fR\&\f(CW-u\ \fIspinup-time\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--spinup\ \fI\ spinup-time\fR\&\f(CW\fR
-Set the spinup time of the floppy drive. In order to do read or write
-to the floppy disk, it must spin. It takes a certain time for the
-motor to reach enough speed to read or write. This parameter describes
-this time. The floppy driver doesn't try to access the drive before
-the spinup time has elapsed. With modern controllers, you may set this time
-to zero, as the controller itself enforces the right delay.
-.TP
-\&\fR\&\f(CW-o\ \fIspindown-time\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--spindown\ \fI\ spindown-time\fR\&\f(CW\fR
-Set the spindown time of this floppy drive. The motor is not stopped
-immediately after the operation completes, because there might be more
-operations following. The spindown time is the time the driver waits
-before switching off the motor.
-.TP
-\&\fR\&\f(CW-O\ \fIspindown-offset\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--spindown_offset\ \fI\ spindown-offset\fR\&\f(CW\fR
-Set the spindown offset of this floppy drive. This parameter is used
-to set the position in which the disk stops. This is useful to
-minimize the next access time. (If the first sector is just near the
-head at the very moment at which the disk has reached enough speed,
-you win 200 milliseconds against the most unfavorable situation).
-.IP
-This is done by clocking the time where the first I/O request
-completes, and using this time to calculate the current position of
-the disk.
-.TP
-\&\fR\&\f(CW-s\ \fIselect-delay\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--select_delay\ \fI\ select-delay\fR\&\f(CW\fR
-Set the \fIselect delay\fR of this floppy drive. This is the delay that
-the driver waits after selecting the drive and issuing the first command
-to it. For modern controllers/drives, you may set this to zero.
-.TP
-\&\fR\&\f(CW-C\ \fIcheck-interval\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--checkfreq\ \fI\ check-interval\fR\&\f(CW\fR
-Set the maximal disk change check interval. The disk change line is
-checked whenever a read or write to the device is issued, and it has not
-been checked for more than \fIinterval\fR jiffies.
-.PP
-.SH Debugging\ messages
-.PP
-This subsection describes how to switch the available debugging messages
-on and off.
-.IP
-.TP
-\&\fR\&\f(CW--debug\fR\
-Switch debugging output on. The debugging information includes timing
-information. This option might be useful to fine-tune the timing
-options for your local setups. (But for most normal purposes, the
-default values are good enough.)
-.TP
-\&\fR\&\f(CW--nodebug\fR\
-Switch debugging output off.
-.TP
-\&\fR\&\f(CW--messages\fR\
-Print informational messages after autodetection, geometry parameter
-clearing and dma over/underruns.
-.TP
-\&\fR\&\f(CW--nomessages\fR\
-Don't print informational messages after these events.
-.PP
-.SH Error\ Handling\ Options
-.PP
-The following options configure the behavior of the floppy driver in
-case of read/write errors. They may be used by any user who has write
-privileges for the drive. Whenever the floppy driver encounters an
-error, a retry counter is incremented. If the value of this counter gets
-bigger than the thresholds described below, the corresponding actions
-are performed at the next retry. The counter is reset when the read or
-write finally terminates, whether successfully or not.
-.TP
-\&\fR\&\f(CW-a\ \fIoperation-abort-trshld\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--abort\ \fI\ operation-abort-trshld\fR\&\f(CW\fR
-Tell the floppy driver to stop trying to read/write a sector after
-\&\fIoperation-abort-trshld\fR
-retries, and signal the I/O error to the user.
-.TP
-\&\fR\&\f(CW-t\ \fIread-track-trshld\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--readtrack\ \fI\ read-track-trshld\fR\&\f(CW\fR
-Tell the floppy driver to switch from track-reading mode to
-sector-at-a-time-mode after
-\&\fIread-track-trshld\fR
-retries.
-.TP
-\&\fR\&\f(CW-r\ \fIrecalibrate-trshld\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--recalibrate\ \fI\ recalibrate-trshld\fR\&\f(CW\fR
-Tell the floppy driver to recalibrate the drive after
-\&\fIrecalibrate-trshld\fR retries.
-.TP
-\&\fR\&\f(CW-R\ \fIreset-treshold\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--reset\ \fI\ reset-threshold\fR\&\f(CW\fR
-Tell the floppy driver to reset the controller after
-\&\fIreset-threshold\fR retries. After a controller reset, the floppy
-driver also recalibrates all drives connected to that controller.
-.IP
-.TP
-\&\fR\&\f(CW-e\ \fIerror-report-trshld\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--reporting\ \fI\ error-report-trshld\fR\&\f(CW\fR
-Tell the floppy driver to start printing error messages to the console
-after \fIerror-report-trshld\fR retries.
-.PP
-.SH Write\ error\ reporting
-.PP
-Due to the buffer cache, write errors cannot always be reported to the
-writing user program as soon as the write system call returns. Indeed,
-the actual writing may take place much later. If a write error is
-encountered, the floppy driver stores information about it in its per
-drive write error structure. This write error structure stays until
-explicitly cleared. It can for example be queried by a backup program
-which wants to make sure that the data has been written successfully.
-.IP
-.TP
-\&\fR\&\f(CW--clrwerror\fR\
-Clears the write error structure.
-.TP
-\&\fR\&\f(CW--printwerror\fR\
-Prints the contents of the write error structure:
-.RS
-.TP
-\&\fR\&\f(CWwrite_errors\fR\
-is a count of how many write errors have occurred since the structure was last
-cleared.
-.TP
-\&\fR\&\f(CWbadness\fR\
-is the maximal number of retries that were needed to complete an
-operation (reads, writes and formats).
-.TP
-\&\fR\&\f(CWfirst_error_sector\fR\
-is where the first (chronologically) write error occurred.
-.TP
-\&\fR\&\f(CWfirst_error_generation\fR\
-is the disk change generation in which did the first write error
-occurred. The disk change generation is a number which is incremented
-at each disk change.
-.TP
-\&\fR\&\f(CWlast_error_sector\fR\
-and
-.TP
-\&\fR\&\f(CWlast_error_generation\fR\
-are similar.
-.RE
-.PP
-.SH Other\ drive\ configuration\ options
-.PP
-This subsection lists per drive configuration options, which don't fit
-in any other category. They are available only to the superuser:
-.IP
-.TP
-\&\fR\&\f(CW--tracks\ \fI\ max-tracks\fR\&\f(CW\fR\
-Set the maximal numbers of physical tracks that this drive may
-handle. If you have a drive which is only able to handle 80 tracks
-(making strange noises when you try to format or read a disk with more
-than 80 tracks), use this option to prevent unprivileged users of
-damaging your drive by repeatedly reading disks with more than 80
-tracks.
-.IP
-If you trust your users and your disks, you don't need this. With most
-drives you don't need to worry anyways. See section More cylinders, for
-details.
-.TP
-\&\fR\&\f(CW-i\ \fIsector-interleave\fR\&\f(CW\ \fR\
-.TQ
-\&\fR\&\f(CW--interleave\ \fIsector-interleave\fR\&\f(CW\fR
-Set the number of sectors beyond which sector interleaving will be used.
-This option will only be used by the \fR\&\f(CWFDFMTTRK\fR ioctl. The
-\&\fR\&\f(CWfdformat\fR command, which is now considered obsolete, uses
-\&\fR\&\f(CWFDFMTTRK\fR ioctl, but \fR\&\f(CWsuperformat\fR does not.
-.IP
-.SH See Also
-Fdutils' texinfo doc
+++ /dev/null
-.TH floppymeter 1 "02jun00" fdutils-5.4
-.SH Name
-floppymeter - measure raw capacity and exact rotation speed of floppy drive
-'\" t
-.de TQ
-.br
-.ns
-.TP \\$1
-..
-
-.tr \(is'
-.tr \(if`
-.tr \(pd"
-
-.SH Note
-This manpage has been automatically generated from fdutils's texinfo
-documentation. However, this process is only approximative, and some
-items, such as crossreferences, footnotes and indices are lost in this
-translation process. Indeed, this items have no appropriate
-representation in the manpage format. Moreover, only the items specific
-to each command have been translated, and the general information about
-fdutils has been dropped in the manpage version. Thus I strongly advise
-you to use the original texinfo doc.
-.TP
-* \ \
-To generate a printable copy from the texinfo doc, run the following
-commands:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make dvi; dvips fdutils.dvi
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-* \ \
-To generate a html copy, run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make html
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fRA premade html can be found at:
-\&\fR\&\f(CW\(ifhttp://www.tux.org/pub/knaff/fdutils\(is\fR
-.TP
-* \ \
-To generate an info copy (browsable using emacs' info mode), run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make info
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The texinfo doc looks most pretty when printed or as html. Indeed, in
-the info version certain examples are difficult to read due to the
-quoting conventions used in info.
-.SH Description
-.iX "p floppymeter"
-.iX "c rotation speed"
-.iX "c raw capacity"
-.PP
-
-.nf
-.ft 3
-.in +0.3i
-\&\fR\&\f(CWfloppymeter [\fR\&\f(CW-f] [\fR\&\f(CW-w \fIwarmup-delay\fR\&\f(CW] [\fR\&\f(CW-W \fIwindow\fR\&\f(CW]
-[\fR\&\f(CW-c \fIcycles\fR\&\f(CW] [\fR\&\f(CW-h] \fIdrive\fR\&\f(CW
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The \fR\&\f(CWfloppymeter\fR program measures characteristic parameters of a
-floppy drive and floppy controller, such as the rotation speed of the
-drive, the data transfer rate of the controller, and the resulting raw
-capacity of a disk track. To use this program, insert a disposable
-floppy in the drive, and type \fR\&\f(CWfloppymeter --\fR\fIdensity\fR, where
-density describes the density of the disk used for the test. (Should be
-one of \fR\&\f(CWdd, hd\fR or \fR\&\f(CWed\fR). \fBCAUTION: the data on the
-disk will be erased\fR. This program should be used to verify whether the
-drive and controller are out of tolerance if you experience problems
-with some high capacity formats. It only needs to be run once per
-drive: although a disk is needed to perform the measurements, the
-measured data only depend on the drive and the controller, and not on
-the disk.
-.PP
-To measure the raw capacity of the disk track, the floppymeter program
-formats the first track of the drive in a special way that allows it to
-read the raw data (gaps and headers) of the disk. \fBThus, all data
-previously stored on that disk is lost\fR.
-.PP
-The rotation speed is measured by timing the return time of a
-\&\fR\&\f(CWreadid\fR command. In order to gain more precision, the command is
-issued many times in a row. During this phase, the number of rotations
-til the start of the test, the average time per rotation til the start,
-and a sliding average of the times of the last 30 rotations is printed,
-and updated continously.
-.PP
-The data transfer rate is deduced from the two parameters above.
-.PP
-At the end of the program, all parameters (raw capacity, duration of one
-rotation, and data transfer rate) are printed again, as well as their
-relative deviation to the standard value. Finally, it suggests a
-capacity deviation description line, which can be directly pasted into
-the drive definition file (See section Drive descriptions.).
-.PP
-Usually, the data transfer rate should not deviate more than 150 ppm
-from the expected value, and the rotation speed of the drive should not
-deviate more than 3000 ppm from the expected value. If these deviations
-are bigger, you may get problems with certain high capacity formats.
-.PP
-If the raw capacity of the drive is too small, some high capacity
-formats may become unformattable on this drive/controller combo.
-.PP
-If on the other hand, the raw capacity of the drive is too big, you may
-get problems when writing to a disk formatted by this drive on another
-drive with a smaller raw capacity. In order to avoid this, increase
-superformats gap parameter (\fR\&\f(CW-G\fR).
-.IP
-.TP
-\&\fR\&\f(CW-h\fR\
-Prints a short help
-.TP
-\&\fR\&\f(CW--dd\fR\
-Tells the program that we use a Double Density disk.
-.TP
-\&\fR\&\f(CW--hd\fR\
-Tells the program that we use a High Density disk.
-.TP
-\&\fR\&\f(CW--ed\fR\
-Tells the program that we use an Extra Density disk.
-.TP
-\&\fR\&\f(CW-f\fR\
-Runs the measurement non interactively. With this option, the program
-doesn't ask for confirmation, and doesn't display the continously
-updated values during the rotation speed measurement.
-.TP
-\&\fR\&\f(CW-W\ \fIWindow\fR\&\f(CW\fR\
-This value describes how many rotations are used for the computation of
-the sliding average. Default is 30.
-.TP
-\&\fR\&\f(CW-c\ \fIcycles\fR\&\f(CW\fR\
-Describes the number of rotations clocked during the rotations speed
-determination test. Default is 1000.
-.PP
-.SH Bugs
-.PP
-This program is quite new, and may have bugs. Here are a few suggested
-tests to check its sanity:
-.TP
-* \ \
-The deviation of the data transfer rate solely depends on the
-controller. It should not be different between two drives connected to
-the same controller. However, the drive rotation speed may be different
-for different drives.
-.TP
-* \ \
-All data transfer rates (for double, high and extra density) are derived
-from a same master frequency. Thus the \fIdeviation\fR of the data
-transfer rate should be independant of the density used.
-.SH See Also
-Fdutils' texinfo doc
+++ /dev/null
-.TH getfdprm 1 "02jun00" fdutils-5.4
-.SH Name
-getfdprm - print the current format information
-'\" t
-.de TQ
-.br
-.ns
-.TP \\$1
-..
-
-.tr \(is'
-.tr \(if`
-.tr \(pd"
-
-.SH Note
-This manpage has been automatically generated from fdutils's texinfo
-documentation. However, this process is only approximative, and some
-items, such as crossreferences, footnotes and indices are lost in this
-translation process. Indeed, this items have no appropriate
-representation in the manpage format. Moreover, only the items specific
-to each command have been translated, and the general information about
-fdutils has been dropped in the manpage version. Thus I strongly advise
-you to use the original texinfo doc.
-.TP
-* \ \
-To generate a printable copy from the texinfo doc, run the following
-commands:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make dvi; dvips fdutils.dvi
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-* \ \
-To generate a html copy, run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make html
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fRA premade html can be found at:
-\&\fR\&\f(CW\(ifhttp://www.tux.org/pub/knaff/fdutils\(is\fR
-.TP
-* \ \
-To generate an info copy (browsable using emacs' info mode), run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make info
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The texinfo doc looks most pretty when printed or as html. Indeed, in
-the info version certain examples are difficult to read due to the
-quoting conventions used in info.
-.SH Description
-.iX "p getfdprm"
-.iX "c reading back the geometry information"
-.iX "c geometry information (reading back)"
-.PP
-
-.nf
-.ft 3
-.in +0.3i
-\&\fR\&\f(CWgetfdprm [\fIdrive\fR\&\f(CW]
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-\&\fR\&\f(CWgetfdprm\fR
-prints the current geometry information for \fIdrive\fR .
-This information can be set using
-\&\fR\&\f(CWsetfdprm\fR
-.PP
-.SH See Also
-Fdutils' texinfo doc
+++ /dev/null
-.TH makefloppies 1 "02jun00" fdutils-5.4
-.SH Name
-MAKEFLOPPIES - Creates the default floppy device nodes.
-'\" t
-.de TQ
-.br
-.ns
-.TP \\$1
-..
-
-.tr \(is'
-.tr \(if`
-.tr \(pd"
-
-.SH Note
-This manpage has been automatically generated from fdutils's texinfo
-documentation. However, this process is only approximative, and some
-items, such as crossreferences, footnotes and indices are lost in this
-translation process. Indeed, this items have no appropriate
-representation in the manpage format. Moreover, only the items specific
-to each command have been translated, and the general information about
-fdutils has been dropped in the manpage version. Thus I strongly advise
-you to use the original texinfo doc.
-.TP
-* \ \
-To generate a printable copy from the texinfo doc, run the following
-commands:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make dvi; dvips fdutils.dvi
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-* \ \
-To generate a html copy, run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make html
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fRA premade html can be found at:
-\&\fR\&\f(CW\(ifhttp://www.tux.org/pub/knaff/fdutils\(is\fR
-.TP
-* \ \
-To generate an info copy (browsable using emacs' info mode), run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make info
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The texinfo doc looks most pretty when printed or as html. Indeed, in
-the info version certain examples are difficult to read due to the
-quoting conventions used in info.
-.SH Description
-.PP
-
-.nf
-.ft 3
-.in +0.3i
-\&\fR\&\f(CWMAKEFLOPPIES [\fR\&\f(CW-tlvng] [\fIdrives\fR\&\f(CW]
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The \fR\&\f(CWMAKEFLOPPIES\fR shell script creates the new floppy block device
-node. It uses the floppycontrol program to translate the minor device
-numbers into meaningful names. It also uses these names to decide
-whether to create a given block device file or not, depending on the
-type of the physical drive (for instance, for a 3 1/2 drive, the formats
-corresponding to a 5 1/4 drive are not created).
-.PP
-If you have more than two floppy drives, you need to tell the kernel
-the CMOS types of those additional drives using the
-\&\fR\&\f(CWfloppy=\fR\fIdrive\fR\fR\&\f(CW,\fR\fItype\fR\fR\&\f(CW,cmos\fR lilo option.
-.PP
-If the \fIdrives \fR parameter is given, only the device nodes for the
-listed drives are made. By default, all only the two first drives are
-tried.
-.PP
-\&\fR\&\f(CWMAKEFLOPPIES\fR does not work if you redefine your default formats.
-.PP
-\&\fBCaution\fR:
-\&\fR\&\f(CWMAKEFLOPPIES\fR removes already existing floppy device nodes.
-.PP
-.SH Options
-.IP
-.TP
-\&\fR\&\f(CW-t\fR\
-Use the old naming convention for 3 1/2 devices (e.g. \fR\&\f(CW\(iffd0H720\(is\fR
-instead of \fR\&\f(CW\(iffd0u720\(is\fR).
-.TP
-\&\fR\&\f(CW-m\fR\
-Base the name for the created devices on the type of the media
-(e.g. \fR\&\f(CW\(iffd0h720\(is\fR instead of \fR\&\f(CW\(iffd0u720\(is\fR).
-.TP
-\&\fR\&\f(CW-l\fR\
-Local. Creates device nodes in the local directory, not /dev
-.TP
-\&\fR\&\f(CW-v\fR\
-Verbose
-.TP
-\&\fR\&\f(CW-n\fR\
-Dry run. (just report what would be done, do not do anything)
-.TP
-\&\fR\&\f(CW-g\fR\
-Group. Allow read/write access to floppy devices only for group
-\&\fR\&\f(CW\(iffloppy\(is\fR
-.PP
-.SH Bugs
-The Makefloppies script does not work on redefined "default" formats, If
-you redefine default formats, you need to create the needed device nodes
-manually.
-.SH See Also
-Fdutils' texinfo doc
+++ /dev/null
-.TH setfdprm 1 "02jun00" fdutils-5.4
-.SH Name
-setfdprm - sets user-provided floppy disk parameters
-'\" t
-.de TQ
-.br
-.ns
-.TP \\$1
-..
-
-.tr \(is'
-.tr \(if`
-.tr \(pd"
-
-.SH Note
-This manpage has been automatically generated from fdutils's texinfo
-documentation. However, this process is only approximative, and some
-items, such as crossreferences, footnotes and indices are lost in this
-translation process. Indeed, this items have no appropriate
-representation in the manpage format. Moreover, only the items specific
-to each command have been translated, and the general information about
-fdutils has been dropped in the manpage version. Thus I strongly advise
-you to use the original texinfo doc.
-.TP
-* \ \
-To generate a printable copy from the texinfo doc, run the following
-commands:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make dvi; dvips fdutils.dvi
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-* \ \
-To generate a html copy, run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make html
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fRA premade html can be found at:
-\&\fR\&\f(CW\(ifhttp://www.tux.org/pub/knaff/fdutils\(is\fR
-.TP
-* \ \
-To generate an info copy (browsable using emacs' info mode), run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make info
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The texinfo doc looks most pretty when printed or as html. Indeed, in
-the info version certain examples are difficult to read due to the
-quoting conventions used in info.
-.SH Description
-.iX "p setfdprm"
-.iX "c setting the geometry information"
-.iX "c geometry information (setting)"
-.PP
-
-.nf
-.ft 3
-.in +0.3i
-\&\fR\&\f(CWsetfdprm [\fR\&\f(CW-p] \fIdevice\fR\&\f(CW \fImedia-description\fR\&\f(CW
-\&\&
-\&\fR\&\f(CWsetfdprm [\fR\&\f(CW-c | \fR\&\f(CW-y | \fR\&\f(CW-n] \fIdevice\fR\&\f(CW
-\&\&
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-\&\fR\&\f(CWsetfdprm\fR is a utility that can be used to load disk parameters
-into the auto-detecting floppy devices and "fixed parameter" floppy
-devices, to clear old parameter sets and to disable or enable diagnostic
-messages. These parameters are derived from a media-description,
-see section Media description for more details.
-.PP
-Without any options, \fR\&\f(CWsetfdprm\fR loads the \fIdevice\fR (for example
-\&\fR\&\f(CW\(if/dev/fd0\(is\fR or \fR\&\f(CW\(if/dev/fd1\(is\fR) with a new parameter set with the
-\&\fIname\fR entry found in \fR\&\f(CW\(if/etc/fdprm\(is\fR (usually named 360/360,
-etc.). For autodetecting floppy devices, these parameters stay in
-effect until the media is changed. For "fixed parameter" devices, they
-stay in effect until they are changed again.
-.PP
-\&\fR\&\f(CWSetfdprm\fR can also be used by the superuser to redefine the
-default formats.
-.PP
-.SH Options
-.IP
-.TP
-\&\fR\&\f(CW-p\ \fIdevice\ name\fR\&\f(CW\fR\
-Permanently loads a new parameter set for the specified auto-configuring
-floppy device for the configuration with \fIname\fR in
-\&\fR\&\f(CW\(if/etc/fdprm\(is\fR. Alternatively, the parameters can be given directly
-from the command line.
-.TP
-\&\fR\&\f(CW-c\ \fIdevice\fR\&\f(CW\fR\
-Clears the parameter set of the specified auto-configuring floppy device.
-.TP
-\&\fR\&\f(CW-y\ \fIdevice\fR\&\f(CW\fR\
-Enables format detection messages for the specified auto-configuring floppy
-device.
-.TP
-\&\fR\&\f(CW-n\ \fIdevice\fR\&\f(CW\fR\
-Disables format detection messages for the specified auto-configuring
-floppy device.
-.PP
-.SH Bugs
-This documentation is grossly incomplete.
-.SH See Also
-Fdutils' texinfo doc
+++ /dev/null
-.TH superformat 1 "02jun00" fdutils-5.4
-.SH Name
-superformat - format floppies
-'\" t
-.de TQ
-.br
-.ns
-.TP \\$1
-..
-
-.tr \(is'
-.tr \(if`
-.tr \(pd"
-
-.SH Note
-This manpage has been automatically generated from fdutils's texinfo
-documentation. However, this process is only approximative, and some
-items, such as crossreferences, footnotes and indices are lost in this
-translation process. Indeed, this items have no appropriate
-representation in the manpage format. Moreover, only the items specific
-to each command have been translated, and the general information about
-fdutils has been dropped in the manpage version. Thus I strongly advise
-you to use the original texinfo doc.
-.TP
-* \ \
-To generate a printable copy from the texinfo doc, run the following
-commands:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make dvi; dvips fdutils.dvi
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-* \ \
-To generate a html copy, run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make html
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fRA premade html can be found at:
-\&\fR\&\f(CW\(ifhttp://www.tux.org/pub/knaff/fdutils\(is\fR
-.TP
-* \ \
-To generate an info copy (browsable using emacs' info mode), run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make info
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The texinfo doc looks most pretty when printed or as html. Indeed, in
-the info version certain examples are difficult to read due to the
-quoting conventions used in info.
-.SH Description
-.iX "p superformat"
-.iX "c formatting disks (non XDF)"
-.PP
-
-.nf
-.ft 3
-.in +0.3i
-\&\fR\&\f(CWsuperformat [\fR\&\f(CW-D \fIdos-drive\fR\&\f(CW] [\fR\&\f(CW-v \fIverbosity-level\fR\&\f(CW] [\fR\&\f(CW-b \fIbegin-track\fR\&\f(CW]
-[\fR\&\f(CW-e \fIend-track\fR\&\f(CW] [\fR\&\f(CW--superverify] [\fR\&\f(CW--dosverify]
-[\fR\&\f(CW--noverify] [\fR\&\f(CW--verify_later] [\fR\&\f(CW--zero-based]
-[\fR\&\f(CW-G \fIformat-gap\fR\&\f(CW] [\fR\&\f(CW-F \fIfinal-gap\fR\&\f(CW] [\fR\&\f(CW-i \fIinterleave\fR\&\f(CW] [\fR\&\f(CW-c \fIchunksize\fR\&\f(CW]
-[\fR\&\f(CW-g \fIgap\fR\&\f(CW] [\fR\&\f(CW--absolute-skew \fIabsolute-skew\fR\&\f(CW] [\fR\&\f(CW--head-skew \fIhead-skew\fR\&\f(CW]
-[\fR\&\f(CW--track-skew \fItrack-skew\fR\&\f(CW] [\fR\&\f(CW--biggest-last] \fIdrive\fR\&\f(CW [\fImedia-description\fR\&\f(CW]
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-\&\fR\&\f(CWsuperformat\fR is used to format disks with a capacity of up to
-1992K HD or 3984K ED. See section Extended formats, for a detailed
-description of these formats. See section Media description, for a detailed
-description of the syntax for the media description. If no media
-description is given, superformat formats a disk in the highest
-available density for that drive, using standard parameters (i.e. no
-extra capacity formats).
-.PP
-When the disk is formatted, \fR\&\f(CWsuperformat\fR automatically invokes
-\&\fR\&\f(CWmformat\fR in order to put an MS-DOS filesystem on it. You may
-ignore this filesystem, if you don't need it.
-.PP
-Supeformat allows to format 2m formats. Be aware, however, that these
-\&\fR\&\f(CW2m\fR formats were specifically designed to hold an MS-DOS
-filesystem, and that they take advantage of the fact that the MS-DOS
-filesystem uses redundant sectors on the first track (the FAT, which is
-represented twice). The second copy of the FAT is \fInot\fR represented
-on the disk.
-.PP
-High capacity formats are sensitive to the exact rotation speed of the
-drive and the resulting difference in raw capacity. That's why
-\&\fR\&\f(CWsuperformat\fR performs a measurement of the disks raw capacity
-before proceeding with the formatting. This measurement is rather time
-consuming, and can be avoided by storing the relative deviation of the
-drive capacity into the drive definition file file. See section Drive
-descriptions, for more details on this file. The line to be inserted
-into the drive definition file is printed by superformat after
-performing its measurement. However, this line depends on the drive and
-the controller. Do not copy it to other computers. Remove it before
-installing another drive or upgrade your floppy controller. Swap the
-drive numbers if you swap the drives in your computer.
-.PP
-.SH Common\ Options
-Many options have a long and a short form.
-.TP
-\&\fR\&\f(CW-h\fR\
-.TQ
-\&\fR\&\f(CW--help\fR
-Print the help.
-.TP
-\&\fR\&\f(CW-D\ \fIdrive\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--dosdrive\ \fIdos-drive\fR\&\f(CW\fR
-Selects DOS drive letter for \fR\&\f(CWmformat\fR (for example \fR\&\f(CWa:\fR or
-\&\fR\&\f(CWb:\fR). The colon may be omitted. The default is derived from the
-minor device number. If the drive letter cannot be guessed, and is not
-given on the command line, \fR\&\f(CWmformat\fR is skipped.
-.TP
-\&\fR\&\f(CW-v\ \fIverbosity-level\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--verbosity\ \fIverbosity-level\fR\&\f(CW\fR
-Sets the verbosity level. 1 prints a dot for each formatted track. 2
-prints a changing sign for each formatted track (- for formatting the
-first head, = for formatting the second head, x for verifying the
-first head, and + for verifying the second head). 3 prints a complete
-line listing head and track. 6 and 9 print debugging information.
-.TP
-\&\fR\&\f(CW--superverify\fR\
-Verifies the disk by first reading the track, than writing a pattern of
-U's, and then reading it again. This is useful as some errors only show
-up after the disk has once been written. However, this is also slower.
-.TP
-\&\fR\&\f(CW-B\fR\
-.TQ
-\&\fR\&\f(CW--dosverify\fR
-Verifies the disk using the \fR\&\f(CWmbadblocks\fR program.
-\&\fR\&\f(CWmbadblocks\fR marks the bad sectors as bad in the FAT. The
-advantage of this is that disks which are only partially bad can still
-be used for MS-DOS filesystems.
-.TP
-\&\fR\&\f(CW-V\fR\
-.TQ
-\&\fR\&\f(CW--verify_later\fR
-Verifies the whole disk at the end of the formatting process instead
-of at each track. Verifying the disk at each track has the advantage
-of detecting errors early on.
-.TP
-\&\fR\&\f(CW-f\fR\
-.TQ
-\&\fR\&\f(CW--noverify\fR
-Skips the verification altogether.
-.PP
-.SH Advanced\ Options
-Usually, superformat uses sensible default values for these options,
-which you normally don't need to override. They are intended for expert
-users. Most of them should only be needed in cases where the hardware
-or superformat itself has bugs.
-.IP
-.TP
-\&\fR\&\f(CW-b\ \fIbegin-track\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--begin_track\ \ \fIbegin-track\fR\&\f(CW\fR
-Describes the track where to begin formatting. This is useful if the
-previous formatting failed halfway through. The default is 0.
-.TP
-\&\fR\&\f(CW-e\ \fIend-track\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--end_track\ \fIend-track\fR\&\f(CW\fR
-Describes where to stop formatting. \fIend_track\fR is the last track to
-be formatted plus one. This is mainly useful for testing purposes. By
-default, this is the same as the total number of tracks. When the
-formatting stops, the final skew is displayed (to be used as absolute
-skew when you'll continue).
-.TP
-\&\fR\&\f(CW-S\ \fIsizecode\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--sizecode\ \fIsizecode\fR\&\f(CW\fR
-Set the sector size to be used. The sector size is 128 * (2 ^
-\&\fIsizecode\fR). Sector sizes below 512 bytes are not supported, thus
-sizecode must be at least 2. By default 512 is assumed, unless you ask
-for more sectors than would fit with 512 bytes.
-.TP
-\&\fR\&\f(CW--stretch\ \fIstretch\fR\&\f(CW\fR\
-Set the stretch factor. The stretch factor describes how many physical
-tracks to skip to get to the next logical track (2 ^ \fIstretch\fR). On
-double density 5 1/4 disks, the tracks are further apart from each
-other.
-.TP
-\&\fR\&\f(CW-G\ \fIfmt-gap\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--format_gap\ \fIfmt-gap\fR\&\f(CW\fR
-Set the formatting gap. The formatting gap tells how far the sectors
-are away from each other. By default, this is chosen so as to evenly
-distribute the sectors along the track.
-.TP
-\&\fR\&\f(CW-F\ \fIfinal-gap\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--final_gap\ \fIfinal-gap\fR\&\f(CW\fR
-Set the formatting gap to be used after the last sector.
-.TP
-\&\fR\&\f(CW-i\ \fIinterleave\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--interleave\ \fIinterleave\fR\&\f(CW\fR
-Set the sector interleave factor.
-.TP
-\&\fR\&\f(CW-c\ \fIchunksize\fR\&\f(CW\fR\
-.TQ
-\&\fR\&\f(CW--chunksize\ \fIchunksize\fR\&\f(CW\fR
-Set the size of the chunks. The chunks are small auxiliary sectors
-used during formatting. They are used to handle heterogeneous sector
-sizes (i.e. not all sectors have the same size) and negative
-formatting gaps.
-.TP
-\&\fR\&\f(CW--biggest-last\fR\
-For MSS formats, make sure that the biggest sector is last on the track.
-This makes the format more reliable on drives which are out of spec.
-.TP
-\&\fR\&\f(CW--zero-based\fR\
-Formats the disk with sector numbers starting at 0, rather than
-1. Certain CP/M boxes or Music synthesizers use this format. Those disks
-can currently not be read/written to by the standard Linux read/write
-API; you have to use fdrawcmd to access them. As disk verifying is done
-by this API, verifying is automatically switched off when formatting
-zero-based.
-.PP
-.SH Sector\ skewing\ options
-.PP
-In order to maximize the user data transfer rate, the sectors are
-arranged in such a way that sector 1 of the new track/head comes under
-the head at the very moment when the drive is ready to read from that
-track, after having read the previous track. Thus the first sector of
-the second track is not necessarily near the first sector of the first
-track. The skew value describes for each track how far sector number
-1 is away from the index mark. This skew value changes for each head
-and track. The amount of this change depends on how fast the disk
-spins, and on how much time is needed to change the head or the track.
-.TP
-\&\fR\&\f(CW--absolute_skew\ \fIabsolute-skew\fR\&\f(CW\fR\
-Set the absolute skew. (The skew value used for the first formatted
-track)
-.TP
-\&\fR\&\f(CW--head_skew\ \fIhead-skew\fR\&\f(CW\fR\
-Set the head skew. (The skew added for passing from head 0 to head 1)
-.TP
-\&\fR\&\f(CW--track_skew\ \fItrack-skew\fR\&\f(CW\fR\
-Set the track skew. (The skew added for seeking to the next track)
-.PP
-Example: (absolute skew=3, head skew=1, track skew=2)
-.PP
-
-.nf
-.ft 3
-.in +0.3i
-track 0 head 0: 4,5,6,1,2,3 (skew=3)
-track 0 head 1: 3,4,5,6,1,2 (skew=4)
-\&\&
-track 1 head 0: 1,2,3,4,5,6 (skew=0)
-track 1 head 1: 6,1,2,3,4,5 (skew=1)
-\&\&
-track 2 head 0: 4,5,6,1,2,3 (skew=3)
-track 2 head 1: 3,4,5,6,1,2 (skew=4)
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-.SH Examples
-In all the examples of this section, we assume that drive 0 is a 3 1/2
-and drive 1 a 5 1/4.
-.PP
-The following example shows how to format a 1440K disk in drive 0:
-
-.nf
-.ft 3
-.in +0.3i
-superformat /dev/fd0 hd
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The following example shows how to format a 1200K disk in drive 1:
-
-.nf
-.ft 3
-.in +0.3i
-superformat /dev/fd1 hd
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The following example shows how to format a 1440K disk in drive 1:
-
-.nf
-.ft 3
-.in +0.3i
-superformat /dev/fd1 hd sect=18
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The following example shows how to format a 720K disk in drive 0:
-
-.nf
-.ft 3
-.in +0.3i
-superformat /dev/fd0 dd
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The following example shows how to format a 1743K disk in drive 0 (83
-cylinders times 21 sectors):
-
-.nf
-.ft 3
-.in +0.3i
-superformat /dev/fd0 sect=21 cyl=83
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The following example shows how to format a 1992K disk in drive 0 (83
-cylinders times 2 heads times 12 KB per track)
-
-.nf
-.ft 3
-.in +0.3i
-superformat /dev/fd0 tracksize=12KB cyl=83 mss
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The following example shows how to format a 1840K disk in drive 0. It
-will have 5 2048-byte sectors, one 1024-byte sector, and one 512-byte
-sector per track:
-
-.nf
-.ft 3
-.in +0.3i
-superformat /dev/fd0 tracksize=23b mss 2m ssize=2KB
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-All these formats can be autodetected by mtools, using the floppy
-driver's default settings.
-.PP
-.SH Troubleshooting
-.TP
-\&\fR\&\f(CWFDC\ busy,\ sleeping\ for\ a\ second\fR\
-When another program accesses a disk drive on the same controller as the
-one being formatted, \fR\&\f(CWsuperformat\fR has to wait until the other
-access is finished. If this happens, check whether any other program
-accesses a drive (or whether a drive is mounted), kill that program (or
-unmount the drive), and the format should proceed normally.
-.TP
-\&\fR\&\f(CWI/O\ errors\ during\ verification\fR\
-Your drive may be too far out of tolerance, and you may thus need to
-supply a margin parameter. Run \fR\&\f(CWfloppymeter\fR (see section floppymeter)
-to find out an appropriate value for this parameter, and add the
-suggested \fR\&\f(CWmargin\fR parameter to the command line
-.PP
-.SH Bugs
-Opening up new window while \fR\&\f(CWsuperformat\fR is running produces
-overrun errors. These errors are benign, as the failed operation is
-automatically retried until it succeeds.
-.SH See Also
-Fdutils' texinfo doc
+++ /dev/null
-.TH xdfcopy 1 "02jun00" fdutils-5.4
-.SH Name
-xdfcopy - Program to copy and format Xdf disks in Linux
-'\" t
-.de TQ
-.br
-.ns
-.TP \\$1
-..
-
-.tr \(is'
-.tr \(if`
-.tr \(pd"
-
-.SH Note
-This manpage has been automatically generated from fdutils's texinfo
-documentation. However, this process is only approximative, and some
-items, such as crossreferences, footnotes and indices are lost in this
-translation process. Indeed, this items have no appropriate
-representation in the manpage format. Moreover, only the items specific
-to each command have been translated, and the general information about
-fdutils has been dropped in the manpage version. Thus I strongly advise
-you to use the original texinfo doc.
-.TP
-* \ \
-To generate a printable copy from the texinfo doc, run the following
-commands:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make dvi; dvips fdutils.dvi
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-* \ \
-To generate a html copy, run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make html
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fRA premade html can be found at:
-\&\fR\&\f(CW\(ifhttp://www.tux.org/pub/knaff/fdutils\(is\fR
-.TP
-* \ \
-To generate an info copy (browsable using emacs' info mode), run:
-
-.nf
-.ft 3
-.in +0.3i
- ./configure; make info
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-The texinfo doc looks most pretty when printed or as html. Indeed, in
-the info version certain examples are difficult to read due to the
-quoting conventions used in info.
-.SH Description
-.iX "p xdfcopy"
-.iX "c XDF (formatting and copying disks)"
-.iX "c formatting XDF disks"
-.PP
-
-.nf
-.ft 3
-.in +0.3i
-\&\fR\&\f(CWxdfcopy [\fR\&\f(CW-\fIformat-id\fR\&\f(CW] [\fR\&\f(CW-d] [\fR\&\f(CW-n] [\fR\&\f(CW-h \fIhead-skew\fR\&\f(CW] [\fR\&\f(CW-t \fIcylinder-skew\fR\&\f(CW] [\fR\&\f(CW-T
-\&\fIend-cylinder\fR\&\f(CW] [\fIsource\fR\&\f(CW] \fItarget\fR\&\f(CW
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.PP
-\&\fR\&\f(CWXdfcopy\fR is a utility to copy and format XDF disks. XDF (eXtended
-Density Format) is a format used by OS/2 which can hold 1840KB of data
-(on a 3 1/2 high density disk). Its advantage over 2m formats is that it
-is faster: 38KB/s. Because of this fast speed, I extended the XDF
-standard to higher capacities (1992KB) with a transfer rate of 45KB/s. I
-called the new formats XXDF.
-.PP
-This program works best with kernels newer than 2.0.0.
-.PP
-If both source and target are given, xdfcopy copies the disk image from
-file to floppy disk or vice-versa. When copying to a floppy disk, the
-disk is first formatted, unless the \fR\&\f(CW-n\fR option is given.
-.PP
-If no source is given, the target is only formatted. In this case, the
-target must be a floppy drive.
-.PP
-.SH Options
-.PP
-.SS Selecting\ a\ format
-.PP
-Formats are selected by the format_id. The following formats are understood:
-.IP
-.TP
-\&\fR\&\f(CW0\fR\
-Formats a 5 1/4 XDF disk (1520 KB, 45.6 KB/s).
-.TP
-\&\fR\&\f(CW1\fR\
-Formats a 3 1/2 high density XDF disk (1840 KB, 38.3 KB/s).
-.TP
-\&\fR\&\f(CW2\fR\
-Formats a 3 1/2 extra density XDF disk (3680 KB, 102 KB/s)
-.TP
-\&\fR\&\f(CW3\fR\
-Formats a 3 1/2 high density XXDF disk (1920 KB, 45 KB/s)
-.TP
-\&\fR\&\f(CW4\fR\
-Formats a 3 1/2 extra density XXDF disk (3840 KB, 90 KB/s)
-.PP
-.SH Misc\ options
-.TP
-\&\fR\&\f(CW-D\ \fIdosdrive\fR\&\f(CW\fR\
-Describes the DOS drive letter for mformat. If this option is given, an
-MS-DOS filesystem is automatically installed on the disk after the
-low-level format is complete. In order for this to work, the drive has
-to be configured to accept the 23x2x80 geometry in your /etc/mtools or
-your ~/.mtoolsrc file. Moreover, this only works with a version of
-mtools that is more recent than 3.0.
-.IP
-Example of a working mtoolsrc line:
-
-.nf
-.ft 3
-.in +0.3i
-A /dev/fd0 0 0 0 0
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.IP
-Examples of a non-working mtoolsrc line:
-
-.nf
-.ft 3
-.in +0.3i
-A /dev/fd0 12 80 2 18
-.fi
-.in -0.3i
-.ft R
-.lp
-
-\&\fR
-.TP
-\&\fR\&\f(CW-n\fR\
-Don't format the disk before copying the disk image to the disk.
-.PP
-.SH Options\ for\ power\ users
-.IP
-.TP
-\&\fR\&\f(CW-t\ \fIcylinder\ skew\fR\&\f(CW\fR\
-Uses a different track skew than the default (14). For more details on
-skews, see section superformat. In this version of xdfcopy, the \fR\&\f(CW-t\fR
-parameter is ignored.
-.TP
-\&\fR\&\f(CW-h\ \fIhead\ skew\fR\&\f(CW\fR\
-Uses a different head skew than the default (0) In this version, this
-parameter is ignored
-.TP
-\&\fR\&\f(CW-d\fR\
-Debugging. For each read or write operation, the time it took to
-complete the operation is printed (in milliseconds). This can be used
-to optimize the skews.
-.TP
-\&\fR\&\f(CW-T\ \fIend-cylinders\fR\&\f(CW\fR\
-Tells how many cylinders to format. With the XXDF formats, it is
-actually possible to format up to 83 cylinders, yielding a format of
-up to 1992KB on a 3 1/2 high density disk.
-.IP
-.SH See Also
-Fdutils' texinfo doc
+++ /dev/null
-'\" t
-.\"{{{}}}
-.\"{{{ Notes
-.\" Copyright (c) 1993 Michael Haardt (michael@cantor.informatik.rwth-aachen.de)
-.\" and 1994,1995, 1997 Alain Knaff (alain@linux.lu)
-.\"
-.\" This is free documentation; you can redistribute it and/or
-.\" modify it under the terms of the GNU General Public License as
-.\" published by the Free Software Foundation; either version 2 of
-.\" the License, or (at your option) any later version.
-.\"
-.\" The GNU General Public License's references to "object code"
-.\" and "executables" are to be interpreted as the output of any
-.\" document formatting or typesetting system, including
-.\" intermediate and printed output.
-.\"
-.\" This manual is distributed in the hope that it will be useful,
-.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-.\" GNU General Public License for more details.
-.\"
-.\" You should have received a copy of the GNU General Public
-.\" License along with this manual; if not, write to the Free
-.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
-.\" USA.
-.\"}}}
-.\"{{{ Title
-.TH FD 4 "Jul 3, 1999" "Linux" "Special files"
-.\"}}}
-.\"{{{ Name
-.SH NAME
-fd \- floppy disk device
-.\"}}}
-.\"{{{ Configuration
-.SH CONFIGURATION
-Floppy drives are block devices with major number 2. Typically they
-are owned by root.floppy and have either mode 0660 (access checking via
-group membership) or mode 0666 (everybody has access). For the
-following devices, \fIn\fP is the drive number. It is 0 for the first
-drive, 1 for the second etc. To get a minor number for a specific
-drive connected to the first controller, add \fIn\fP to the minor base
-number. If it is connected to the second controller, add \fIn\fP+128 to
-the minor base number. \fBWarning: If you use formats with more tracks
-than supported by your drive, you may damage it mechanically.\fP Trying
-once if more tracks than the usual 40/80 are supported should not
-damage it, but no warranty is given for that. Don't create device
-entries for those formats to prevent their usage if you are not sure.
-.PP
-.\"{{{ drive independent
-Drive independent device files which automatically detect the media
-format and capacity:
-.PP
-.TS
-l l.
-Name Base minor #
-_
-\fBfd\fP\fIn\fP 0
-.TE
-.\"}}}
-.PP
-.\"{{{ 5.25 DD
-5.25 inch double density device files:
-.PP
-.TS
-lw(1i) l l l l l.
-Name Capac. Cyl. Sect. Heads Base minor #
-_
-\fBfd\fP\fIn\fP\fBd360\fP 360K 40 9 2 4
-.TE
-.\"}}}
-.PP
-.\"{{{ 5.25 HD
-5.25 inch high density device files:
-.PP
-.TS
-lw(1i) l l l l l.
-Name Capac. Cyl. Sect. Heads Base minor #
-_
-\fBfd\fP\fIn\fP\fBh360\fP 360K 40 9 2 20
-\fBfd\fP\fIn\fP\fBh410\fP 410K 41 10 2 48
-\fBfd\fP\fIn\fP\fBh420\fP 420K 42 10 2 64
-\fBfd\fP\fIn\fP\fBh720\fP 720K 80 9 2 24
-\fBfd\fP\fIn\fP\fBh880\fP 880K 80 11 2 80
-\fBfd\fP\fIn\fP\fBh1200\fP 1200K 80 15 2 8
-\fBfd\fP\fIn\fP\fBh1440\fP 1440K 80 18 2 40
-\fBfd\fP\fIn\fP\fBh1476\fP 1476K 82 18 2 56
-\fBfd\fP\fIn\fP\fBh1494\fP 1494K 83 18 2 72
-\fBfd\fP\fIn\fP\fBh1600\fP 1600K 80 20 2 92
-.TE
-.\"}}}
-.PP
-.\"{{{ 3.5 DD
-3.5 inch double density device files:
-.PP
-.TS
-lw(1i) l l l l l.
-Name Capac. Cyl. Sect. Heads Base minor #
-_
-\fBfd\fP\fIn\fP\fBu360\fP 360K 80 9 1 12
-\fBfd\fP\fIn\fP\fBu720\fP 720K 80 9 2 16
-\fBfd\fP\fIn\fP\fBu800\fP 800K 80 10 2 120
-\fBfd\fP\fIn\fP\fBu1040\fP 1040K 80 13 2 84
-\fBfd\fP\fIn\fP\fBu1120\fP 1120K 80 14 2 88
-.TE
-.\"}}}
-.PP
-.\"{{{ 3.5 HD
-3.5 inch high density device files:
-.PP
-.TS
-lw(1i) l l l l l.
-Name Capac. Cyl. Sect. Heads Base minor #
-_
-\fBfd\fP\fIn\fP\fBu360\fP 360K 40 9 2 12
-\fBfd\fP\fIn\fP\fBu720\fP 720K 80 9 2 16
-\fBfd\fP\fIn\fP\fBu820\fP 820K 82 10 2 52
-\fBfd\fP\fIn\fP\fBu830\fP 830K 83 10 2 68
-\fBfd\fP\fIn\fP\fBu1440\fP 1440K 80 18 2 28
-\fBfd\fP\fIn\fP\fBu1600\fP 1600K 80 20 2 124
-\fBfd\fP\fIn\fP\fBu1680\fP 1680K 80 21 2 44
-\fBfd\fP\fIn\fP\fBu1722\fP 1722K 82 21 2 60
-\fBfd\fP\fIn\fP\fBu1743\fP 1743K 83 21 2 76
-\fBfd\fP\fIn\fP\fBu1760\fP 1760K 80 22 2 96
-\fBfd\fP\fIn\fP\fBu1840\fP 1840K 80 23 2 116
-\fBfd\fP\fIn\fP\fBu1920\fP 1920K 80 24 2 100
-.TE
-.\"}}}
-.PP
-.\"{{{ 3.5 ED
-3.5 inch extra density device files:
-.PP
-.TS
-lw(1i) l l l l l.
-Name Capac. Cyl. Sect. Heads Base minor #
-_
-\fBfd\fP\fIn\fP\fBu2880\fP 2880K 80 36 2 32
-\fBfd\fP\fIn\fP\fBu3200\fP 3200K 80 40 2 104
-\fBfd\fP\fIn\fP\fBu3520\fP 3520K 80 44 2 108
-\fBfd\fP\fIn\fP\fBu3840\fP 3840K 80 48 2 112
-.TE
-.\"}}}
-.\"}}}
-.\"{{{ Description
-.SH DESCRIPTION
-\fBfd\fP special files access the floppy disk drives in raw mode.
-The following
-.IR ioctl (2)
-calls are supported by \fBfd\fP devices:
-.\"{{{ FDCLRPRM
-.IP \fBFDCLRPRM\fP
-clears the media information of a drive (geometry of disk in drive).
-.\"}}}
-.\"{{{ FDCLRPRM
-.IP \fBFDSETPRM\fP
-sets the media information of a drive. The media information will be
-lost when the media is changed.
-.\"}}}
-.IP \fBFDDEFPRM\fP
-sets the media information of a drive (geometry of disk in drive). The
-media information will not be lost when the media is changed. This
-will disable autodetection. In order to re-enable autodetection, you
-have to issue an \fBFDCLRPRM\fP .
-.\"}}}
-.\"{{{ FDGETDRVTYP
-.IP \fBFDGETDRVTYP\fP
-returns the type of a drive (name parameter). For formats which work
-in several drive types, \fBFDGETDRVTYP\fP returns a name which is
-appropriate for the oldest drive type which supports this format.
-.\"}}}
-.\"{{{ FDFLUSH
-.IP \fBFDFLUSH\fP
-invalidates the buffer cache for the given drive.
-.\"}}}
-.\"{{{ FDSETMAXERRS
-.IP \fBFDSETMAXERRS\fP
-sets the error thresholds for reporting errors, aborting the operation,
-recalibrating, resetting, and reading sector by sector.
-.\"}}}
-.\"{{{ FDGETMAXERRS
-.IP \fBFDSETMAXERRS\fP
-gets the current error thresholds.
-.\"}}}
-.\"{{{ FDGETDRVTYP
-.IP \fBFDGETDRVTYP\fP
-gets the internal name of the drive.
-.\"}}}
-.\"{{{ FDWERRORCLR
-.IP \fBFDWERRORCLR\fP
-clears the write error statistics.
-.\"}}}
-.\"{{{ FDWERRORGET
-.IP \fBFDWERRORGET\fP
-reads the write error statistics. These include the total number of
-write errors, the location and disk of the first write error, and the
-location and disk of the last write error. Disks are identified by a
-generation number which is incremented at (almost) each disk change.
-.\"}}}
-.\"{{{ FDTWADDLE
-.IP \fBFDTWADDLE\fP
-Switch the drive motor off for a few microseconds. This might be
-needed in order to access a disk whose sectors are too close together.
-.\"}}}
-.\"{{{ FDSETDRVPRM
-.IP \fBFDSETDRVPRM\fP
-sets various drive parameters.
-.\"}}}
-.\"{{{ FDGETDRVPRM
-.IP \fBFDGETDRVPRM\fP
-reads these parameters back.
-.\"}}}
-.\"{{{ FDGETDRVSTAT
-.IP \fBFDGETDRVSTAT\fP
-gets the cached drive state (disk changed, write protected et al.)
-.\"}}}
-.\"{{{ FDPOLLDRVSTAT
-.IP \fBFDPOLLDRVSTAT\fP
-polls the drive and return its state.
-.\"}}}
-.\"{{{ FDGETFDCSTAT
-.IP \fBFDGETFDCSTAT\fP
-gets the floppy controller state.
-.\"}}}
-.\"{{{ FDRESET
-.IP \fBFDRESET\fP
-resets the floppy controller under certain conditions.
-.\"}}}
-.\"{{{ FDRAWCMD
-.IP \fBFDRAWCMD\fP
-sends a raw command to the floppy controller.
-.\"}}}
-.PP
-For more precise information, consult also the <linux/fd.h> and
-<linux/fdreg.h> include files, as well as the manual page for
-floppycontrol.
-.\"}}}
-.\"{{{ Notes
-.SH NOTES
-The various formats allow to read and write many types of disks.
-However, if a floppy is formatted with a too small inter sector gap,
-performance may drop, up to needing a few seconds to access an entire
-track. To prevent this, use interleaved formats. It is not possible to
-read floppies which are formatted using GCR (group code recording),
-which is used by Apple II and Macintosh computers (800k disks).
-Reading floppies which are hard sectored (one hole per sector, with
-the index hole being a little skewed) is not supported. This used to
-be common with older 8 inch floppies.
-.\"}}}
-.\"{{{ Files
-.SH FILES
-/dev/fd*
-.\"}}}
-.\"{{{ Authors
-.SH AUTHORS
-Alain Knaff (Alain@linux.lu), David Niemi
-(niemidc@tux.org), Bill Broadhurst (bbroad@netcom.com).
-.\"}}}
-.\"{{{ See also
-.SH "SEE ALSO"
-.BR floppycontrol (1),
-.BR mknod (1),
-.BR chown (1),
-.BR getfdprm (1),
-.BR superformat (1),
-.BR mount (8),
-.BR setfdprm (1)
-.\"}}}
+++ /dev/null
-×:fdutils:5.4:2000/06/02:diskd:1:::::
-×:fdutils:5.4:2000/06/02:diskseekd:1:::::
-×:fdutils:5.4:2000/06/02:fdmount:1:::::
-※:fdutils:5.4:2000/06/02:fdumount:1:fdmount:1:
-※:fdutils:5.4:2000/06/02:fdlist:1:fdmount:1:
-※:fdutils:5.4:2000/06/02:fdmountd:1:fdmount:1:
-×:fdutils:5.4:2000/06/02:fdrawcm:1:::::
-×:fdutils:5.4:2000/06/02:floppycontrol:1:::::
-×:fdutils:5.4:2000/06/02:floppymeter:1:::::
-×:fdutils:5.4:2000/06/02:getfdprm:1:::::
-×:fdutils:5.4:2000/06/02:makefloppies:1:::::
-×:fdutils:5.4:2000/06/02:setfdprm:1:::::
-×:fdutils:5.4:2000/06/02:superformat:1:::::
-×:fdutils:5.4:2000/06/02:xdfcopy:1:::::
-※:fdutils:5.4:2000/06/02:xdfformat:1:xdfcopy:1:
-×:fdutils:5.4:1999/07/03:fd:4:::::
+++ /dev/null
-Sat Oct 18 17:15:02 JST 2003 Kentaro Shirakata <argrath@ub32.org>
-
- * draft/{cat8, man8}/majordomo.8: cat ファイルを roff 化。
- * translation_list: 上記反映。
-
-Fri Oct 20 01:32:20 2000 Yuichi SATO <sato@complex.eng.hokudai.ac.jp>
-
- * translation_list : 1.94.4 → 1.94.5 で original 変更なし。
- 第 3 フィールドを更新。
- bounce と bounce-remind のリンク関係を修正。
-
-Sat Oct 2 19:05:19 1999 NAKANO Takeo <nakano@apm.seikei.ac.jp>
-
- * translation_list: 書式変更.
-
-Wed Aug 11 21:58:09 1999 NAKANO Takeo <nakano@apm.seikei.ac.jp>
-
- * translation_list: add info about 1.94.4.
-
-Wed Aug 11 21:00:15 1999 Tenkou N. Hattori <tnh@aurora.dti.ne.jp>
-
- * draft/cat8/majordomo.8: add from Linux ML
-
+++ /dev/null
-.\" Translated by Masami Ogoshi <ogochan@nurs.or.jp>
-.\" Roff-ed by Kentaro Shirakata <argrath@ub32.org>
-.TH MAJORDOMO 8
-.\"O .SH NAME
-.SH 名前
-.\"O Majordomo \- manage multiple mailing lists
-Majordomo - 複数のメーリングリストを管理します
-.\"O .SH SYNOPSIS
-.SH 書式
-.B Majordomo
-.\"O .SH "DESCRIPTION"
-.SH 説明
-.\"O .B Majordomo
-.\"O is a perl script which automates the management of Internet mailing lists.
-.\"O It is executed via electronic mail; users send e-mail to
-.\"O .B Majordomo
-.\"O with instructions in the body of the message, and the perl script performs
-.\"O the requested actions and responds with the results. Any text in the
-.\"O "Subject:" line is ignored.
-.B Majordomo
-はインターネット上のメーリングリストを自動的に管理する
-perl の script です。これはユーザから
-.B Majordomo
-に対するメール本文中に書かれた命令を実行したり、
-perl の script を実行したりし、結果を返します。
-この時の"Subject:"行は無視されます。
-.\"O .SH "COMMANDS"
-.SH コマンド
-.\"O .B Majordomo
-.\"O understands the following commands (arguments in "[]" are optional):
-.B Majordomo
-は以下のコマンドを理解します([]でくくられた引数はオプションです)。
-.TP 5
-.B
-subscribe \fIlist\fR [\fIaddress\fR]
-.P
-.\"O Subscribe yourself (or
-.\"O .I address
-.\"O if specified) to the named
-.\"O .IR list .
-.I list
-を講読します(
-.I address
-の指定も出来ます)。
-.TP 5
-.B
-unsubscribe \fIlist\fR [\fIaddress\fR]
-.P
-.\"O Unsubscribe yourself (or
-.\"O .I address
-.\"O if specified) from the named
-.\"O .IR list .
-.\"O If
-.\"O .IR list
-.\"O is ``*'' (an asterisk), unsubscribe from all lists on this Majordomo
-.\"O server.
-.I list
-の講読を中止します(<address>の指定も出来ます)。
-.TP 5
-.B
-auth \fIspecial-word\fP subscribe \fIlist address\fP
-.P
-.\"O If the
-.\"O .I list
-.\"O subscribe policy setting includes \fI+confirm\fR,
-.\"O Majordomo will ask for confirmation before a subscription
-.\"O is approved.
-.\"O The conformation request will show the
-.\"O .I special-word
-.\"O to send with
-.\"O .I auth .
-*TBT*
-.TP 5
-.B
-get \fIlist\fR \fIfile\fR
-.P
-.\"O Get the
-.\"O .I file
-.\"O related to
-.\"O .IR list .
-.I list
-に関係あるファイル
-.I file
-を取得します。
-.TP 5
-.B
-index \fIlist\fR
-.P
-.\"O Return an index of the files you can
-.\"O .I get
-.\"O associated with
-.\"O .IR list .
-.I get
-出来る
-.I list
-に関連つけられたファイルの索引を返します。
-.TP 5
-.B
-which [\fIaddress\fR]
-.P
-.\"O Find out to which lists you (or
-.\"O .I address
-.\"O if specified) are subscribed.
-あなた(
-.I address
-指定出来ます)が講読しているメーリングリストを調べます。
-.TP 5
-.B
-who \fIlist\fR
-.P
-.\"O Find out who is on the named
-.\"O .IR list .
-誰が
-.I list
-にいるか調べます。
-.TP 5
-.B
-info \fIlist\fR
-.P
-.\"O Retrieve the general introductory information for the named
-.\"O .IR list .
-.I list
-の紹介文を返します。
-.TP 5
-.B
-intro \fIlist\fR
-.P
-.\"O Retrieve the introductory message sent to new users
-.\"O of
-.\"O .IR list .
-.\"O Non-subscribers may not be able to retrieve this.
-*TBT*
-.TP 5
-.B
-lists
-.P
-.\"O Show the lists served by this Majordomo server. It will also show a 50
-.\"O character list description if one has been provided.
-この Majordomo で提供されているメーリングリストを見ます。これは
-提供されていれば、だいたい 50 文字くらいのものです。
-.TP 5
-.B
-help
-.P
-.\"O Retrieve an informational message, a brief synopsis of the user portion of
-.\"O this manual page.
-ユーザマニュアルのメッセージを返します。
-.TP 5
-.B
-end
-.P
-.\"O Stop processing commands (useful if your mailer adds a signature).
-コマンドを終了します(使っているメールソフトがsignatureを勝手に
-つける場合に便利です)。
-.PP
-.\"O A command may be split across multiple lines if all of the lines in
-.\"O the command except the last end with a backslash "\\".
-一つのコマンドが複数行にわたる場合、(そのコマンドの)最後の行を
-除いたそれぞれの行の末尾にはbackslash("\")をつけます。
-.PP
-.\"O In addition, the owner of the list can issue the following commands:
-追加、メーリングリストのownerは以下のようなコマンドも発行出来ます。
-.TP 5
-.B
-approve \fIpassword\fR subscribe \fIlist\fR \fIaddress\fR
-.P
-.\"O Instruct Majordomo to add
-.\"O .I address
-.\"O to
-.\"O .IR list .
-.\"O The password is required to authenticate the list owner. This is very weak
-.\"O authentication as the password is transmitted in the clear in an e-mail
-.\"O message. No claims are made that it will provide anything other than
-.\"O rudimentary protection against abuse of the Majordomo server.
-.I address
-の人を
-.I list
-メーリングリストに登録するよう Majordomo に
-指示します。この<password>はそのメーリングリストの owner である
-ことを認証するために要求されます。これは電子メールのメッセージで
-パスワードを送るので、そう強力な認証系とは言えません。
-Majordomo への攻撃を守れるより強い保護機構を要求しないで下さい。
-.TP 5
-.B
-approve \fIpassword\fR unsubscribe \fIlist\fR \fIaddress\fR
-.P
-.\"O Instruct Majordomo to delete
-.\"O .I address
-.\"O from
-.\"O .IR list .
-.\"O The password is required to authenticate the list owner. See the comments
-.\"O above regarding the password.
-.I address
-の人を
-.I list
-メーリングリストから外すよう Majordomo に
-指示します。この<password>はそのメーリングリストの owner である
-ことを認証するために要求されます。パスワードに関しては、コメントを見るように。
-.TP 5
-.B
-newinfo \fIlist\fR \fIpassword\fR
-.P
-.\"O Update the informational message for
-.\"O .I list
-.\"O with the text which follows on subsequent lines. No formatting of the
-.\"O message occurs, so the list owner should be careful to constrain the message
-.\"O to eighty columns. Majordomo will include everything up to the string
-.\"O .B EOF
-.\"O or to the end of the mail message, whichever comes first. This is useful in
-.\"O case the owner wants to verify the new message immediately, e.g.,
-.I list
-メーリングリストに関する情報をこの行に続く文章に更新します。
-特にフォーマットは実行されませんので、メーリングリストの所有者は
-メッセージが 80 桁になるように注意しなくてはなりません。
-Majordomo は
-.B EOF
-という文字列が来るか、メールの終わりが来るまでの全てを含めます。
-これは所有者が新しいメッセージを確認する時に有効です。例えば、
-.sp 1
-.RS 10
-To: majordomo
-.sp 0
-newinfo list password
-.sp
-.\"O This is new information for the "list" list.
-.sp
-EOF
-.sp 0
-info list
-.sp
-.RE
-.RS 5
-.\"O This will simultaneously update the information for the list, and then
-.\"O retrieve it for verification. Note that blank lines are preserved in the
-.\"O message.
-この例では、インフォメーションの更新と同時にそれがうまく行ったか
-確認することが出来ます。
-(注意。空白行はメッセージに含まれるものです)
-.RE
-.TP 5
-.B
-newintro \fIlist\fR \fIpassword\fR
-.P
-.\"O Similar to
-.\"O .I newinfo ,
-.\"O but updates the (optional) introductory message sent to new
-.\"O .I list
-.\"O subscribers.
-*TBT*
-.B
-passwd \fIlist\fR \fIold-password\fR \fInew-password\fR
-.P
-.\"O Replace the password for
-.\"O .I list
-.\"O with
-.\"O .IR new-password .
-.I list
-に与えられたパスワードを
-.I new-password
-にします。
-.TP 5
-.B
-config \fIlist\fR \fIpassword\fR
-.P
-.\"O retrieve a self-documenting configuration file for
-.\"O the list <list>. The \fIpassword\fR can be the password
-.\"O contained in the file <listname>.passwd or the
-.\"O admin_password in the configuration file.
-.I list
-の設定ファイルを返します。\fIpassword\fR は <listname>.passwd
-か環境設定ファイル中の admin_password で指定されたものです。
-.TP 5
-.B
-newconfig \fIlist\fR \fIpassword\fR
-.P
-.\"O Validates and installs a new configuration file. The config file
-.\"O includes everything up to the string
-.\"O .B EOF
-.\"O or to the end of the mail message, whichever comes first. The config
-.\"O file is expected to be a complete config file as returned by the
-.\"O "config" command. Incremental changing of the config file is not yet
-.\"O supported. As soon as the config file is validated and installed its
-.\"O settings are available for use. This is useful to remember if you have
-.\"O multiple commands in your mail message since they will be subject to
-.\"O the settings of the new config file. If there is an error in the
-.\"O config file (incorrect value...), the config file will not be accepted
-.\"O and the error message identifying the problem line(s) will be returned
-.\"O to the sender. Note that only the errors are returned to the
-.\"O sender not the entire config file.
-新しい環境設定ファイルの確認とインストールを行います。
-この環境ファイルとしては
-.B EOF
-という文字列が来るまでか、メールの終わりまでのいずれか早い方までになります。
-環境ファイルは config コマンドで返して来るのと同じように
-完全なものであると仮定されます。部分的な変更については、
-まだサポートしていません。(このコマンド実行後)すぐに環境設定ファイルの確認と
-インストールは使えるようになります。
-これは覚えておくと便利ですが、複数のコマンドをメールに含めた場合、
-新しい環境設定ファイルで設定した直後から設定は有効になります。
-もし、新しい環境設定ファイルに間違いがあった場合(例えば変な値とか)、
-新しい環境設定ファイルは受理されず、間違いのある行が示された
-エラーメッセージが送信者に返されます。注意しなければならないことは、
-あくまでもエラーのみが返されることです。
-環境設定ファイルのエントリではありません。
-.TP 5
-.B
-writeconfig \fIlist\fR \fIpassword\fR
-.P
-.\"O Write a new config in standard form. All of the config
-.\"O file documentation is optional. Only the keywords and
-.\"O values are necessary. If a config file, stripped of
-.\"O all comments is installed using newconfig, that is
-.\"O what is returned by config. Writeconfig forces a
-.\"O rewrite of the config file with all comments and
-.\"O default values in place. It is useful to use after an
-.\"O upgrade of majordomo since it will add the new
-.\"O keywords for people to change. It also updates the
-.\"O documentation in the file if that has changed.
-新しい環境設定ファイルを標準形式で書き込みます。全ての環境設定
-ファイルの記述が選択可能です。キーワードと値(の組)が必須であるに
-過ぎません。仮にconfigによって得た情報を使いnewconfigを使って環境設定
-ファイルを持ち込む時に、全てのコメントが除いてあったとします。
-writeconfig は強制的に全てのコメントとデフォルト値を規定の場所に
-再書き込みします。これは Majordomo を新しくして新しいキーワードを追加して
-変更しようとする時に便利です。また、
-ファイルの記述を変えようとする時も同様です。
-.TP 5
-.B mkdigest
-.I digest-list-name
-[
-.I outgoing-address
-]
-.I password
-.P
-.\"O This will force a digest for the specified list to be created. It is
-.\"O most useful if you don't have an account on the machine that handles
-.\"O the digest for your list.
-.\"O The optional
-.\"O .I outgoing-address
-.\"O will override the default address,
-.\"O .IR listname -outgoing ,
-.\"O for distributing the digests;
-.\"O this is usually done for security.
-このコマンドは指定されたメーリングリストのダイジェストを作ります。
-これはあなたが自分がカウントを持たない機械にメーリングリストを
-持っている時に便利です。
-*TBT*
-.\"O .SH CONFIGURATION
-.SH 設定
-.\"O (Note that this section has not been updated to majordomo version 1.90).
-(注意 この章はまだMajordomo Ver 1.90用に更新していません)
-.\"O .B Majordomo
-.\"O supports
-.\"O .I open
-.\"O and
-.\"O .I closed
-.\"O lists. An
-.\"O .I open
-.\"O list is one to which anyone can subscribe themselves. A subscription
-.\"O request sent to
-.\"O .B Majordomo
-.\"O for a
-.\"O .I closed
-.\"O list is forwarded to the owner of the list for approval. If a user tries to
-.\"O subscribe an address which is different from their own (for example, a local
-.\"O list exploder),
-.\"O .B Majordomo
-.\"O will forward the request to the list owner for approval, regardless of the
-.\"O open or closed status of the list.
-Majordomoは
-.I 公開
-された、あるいは
-.I 非公開
-のメーリングリストをサポー
-トしています。
-.I 公開
-されたメーリングリストは、誰でもが自分自身で
-講読を開始することが出来ます。
-.I 非公開
-のメールングリスト用
-.B Majordomo
-に講読の要求をした場合、そのメッセージは承認のために
-そのメールリングリストの所有者に回されます。もし講読をしようと
-した人のアドレスが、その人本来のアドレスと違う場合(例えば、ローカルな
-メーリングリスト分配機構等によって)、
-.B Majordomo
-は当該メーリングリストが公開か非公開かにかかわらず、
-その要求をメーリングリストの所有者に許可申請のために回します。
-.PP
-.\"O .B Majordomo
-.\"O depends on the existence of certain system mail aliases. The first three
-.\"O are for running the perl script on incoming e-mail and specifying the
-.\"O responsible person in charge of the server:
-.B Majordomo
-は正しく書かれたシステムのメールエリアスの内容によって動作を決定します。
-最初の 3 行はメールが届いた時にサーバに何か指示をして
-変更させる時に perl のスクリプトが走るためのものです。
-.sp 1
-majordomo: "|/usr/local/mail/majordomo/wrapper majordomo"
-.sp 0
-majordomo-owner: brent
-.sp 0
-owner-majordomo: brent
-.sp 1
-.\"O These next few aliases are for a list called "sample":
-次のいくつかのエリアスは"sample"というメーリングリストのためのものです。
-.sp 1
-sample: :include:/usr/local/mail/lists/sample
-.sp 0
-owner-sample: sample-owner
-.sp 0
-sample-request: "|/usr/local/mail/majordomo/wrapper request-answer sample"
-.sp 0
-owner-sample-request: sample-owner
-.sp 0
-sample-owner: brent
-.sp 0
-sample-approval: brent
-.sp 1
-
-.\"O .SH FILES
-.SH ファイル
-/etc/majordomo.cf
-.sp 0
-/usr/local/lib/mail/majordomo/
-
-.\"O .SH BUGS
-.SH バグ
-.\"O This man page has not been fully updated to conform to majordomo 1.90.
-この man page は Ver 1.90 の機能を完全に記述してはいません。
-
-.\"O .SH AUTHORS
-.SH 著者
-.\"O Majordomo and most of the ancillary perl code was written by Brent Chapman,
-.\"O <brent@GreatCircle.COM>. The latest version of the code is available by
-.\"O anonymous FTP from FTP.GreatCircle.COM, in directory pub/majordomo.
-.\"O This man page was written by Jim Duncan, <jim@math.psu.edu>. Minimal
-.\"O update of the man page by John Rouillard <rouilj@cs.umb.edu>.
-Majordomo と多くの補助的な perl のコードは
-Brent Chapman<brent@GreatCircle.COM>によって書かれました。
-最新版のコードは FTP.GreatCircle.COM の pub/majordomo ディレクトリから
-anonymous FTP によって入手出来ます。この man page はJim Duncan
-<jim@math.psu.edu> によって書かれ、John Rouillard<rouilj@cs.umb.edu>
-によって少し更新されています。
+++ /dev/null
-primary site is:
-ftp://ftp.greatcircle.com/pub/majordomo/
-
+++ /dev/null
-'\" t
-.TH APPROVE 1
-.SH NAME
-approve \- approve a Majordomo request
-.SH SYNOPSIS
-.B approve [filename]
-.SH "DESCRIPTION"
-.B approve
-automates the task of replying to an approval request from Majordomo. Input
-is the e-mail message containing Majordomo's request, read from
-.IR filename ,
-or read from standard input if no filename is specified.
-.PP
-.B approve
-currently understands two types of requests; those requesting
-subscription to a
-.I closed
-list, and those which bounced due to a lack of permission to post to a
-moderated, or
-.IR private ,
-mailing list.
-.B approve
-reads the body of the message from Majordomo to determine the appropriate
-action. Assuming a message containing a subscription request like the
-following:
-.sp 1
-.RS 3
-From: Majordomo@This.COM
-.sp 0
-To: this-list-approval@This.COM
-.sp 1
-Joe User <User@Fubar.COM> requests you approve the following:
-.sp 1
-.RS 3
-subscribe this-list Joe User <User@Fubar.COM>
-.RE
-.sp 1
-If you approve, send a line such as the following to Majordomo@This.COM:
-.sp 1
-.RS 3
-approve PASSWD subscribe this-list Joe User <User@Fubar.COM>
-.RE
-.RE
-.sp 1
-then running
-.B approve
-on the message by saving it in a file, e.g.,
-.sp 1
-.RS 3
-approve /tmp/request
-.RE
-.sp 1
-or
-.sp 1
-.RS 3
-approve < /tmp/request
-.RE
-.sp 1
-will result in the following reply to Majordomo:
-.sp 1
-.RS 3
-To: Majordomo@This.COM
-.sp 1
-approve PASSWD subscribe this-list User@Fubar.COM (Joe User)
-.sp 1
-.RE
-If
-.B approve
-is on the user's path, then it's possible to execute it via a shell escape,
-piping the current message to
-.B approve
-from a mail program, e.g.,
-.sp
-.RS 3
-!approve
-.RE
-.sp
-would
-.I approve
-the current message in /usr/ucb/Mail.
-.PP
-If, in the latter case, the "Subject:" line of the request from Majordomo is
-"BOUNCE <list>: <reason>", the message is treated as a posting rejected by
-.B resend
-for some reason, and is reformatted with appropriate "Approved:" headers to
-cause it to succeed, and then it is resubmitted to Majordomo for posting.
-This provides an easy mechanism for the moderator of a mailing list to
-approve postings to the list.
-.SH CONFIGURATION
-.B approve
-assumes that the
-.I approve
-password for each list is the same as the
-.I approval
-password used by
-.BR resend ,
-and that this password is stored
-in a file called
-.I .majordomo
-in the user's home directory. The file has the following format:
-.RS 5
-.TS
-l l l .
-.sp
-this-list passwd1 Majordomo@This.COM
-other-list passwd2 Majordomo@Other.GOV
-.sp
-.TE
-.RE
-The first column specifies the name of the mailing list, the second column
-specifies the list-owner's password for the given list, and the third column
-specifies the e-mail address of the associated Majordomo server. It is
-assumed that the value in the third column is an Internet-style
-"something@somewhere" address, and that postings for "List" should be sent
-to "List@somewhere". Since this file
-.B only
-needs to be read by the user, it should be mode 600 to protect the
-passwords.
-.SH FILES
-~/.majordomo
-.sp 0
-/usr/local/lib/mail/majordomo/
-.SH SEE ALSO
-majordomo(8),perl(1),resend(1).
-.SH BUGS
-There is no direct support for MH(1), so MH users will have to run
-.B approve
-directly on the message file in their inbox.
-.sp
-The
-.I .majordomo
-file requires an at-sign, "@", in the address of the Majordomo server, even
-if it colocated on the same system as the list-owner.
-.SH AUTHORS
-Majordomo and most of the ancillary perl code was written by Brent Chapman,
-<brent@GreatCircle.COM>.
-This man page was written by Jim Duncan, <jim@math.psu.edu>.
+++ /dev/null
-.TH bounce 1
-.SH NAME
-bounce, bounce-remind \- handle majordomo list subscribers whose mail is undeliverable
-.LP
-.SH SYNOPSIS
-.B bounce [\-d] [\-f
-.I config-file
-.B ] [\-majordomo
-.I server-address
-.B ] [\-unsub]
-.I majordomo-list user-address
-.LP
-.B bounce [\-d] [\-f
-.I config-file
-.B ] [\-majordomo
-.I server-address
-.B ] \-expire [\-maxage
-.I days
-.B ]
-.I bounce-address-file
-.LP
-.B bounce-remind
-.LP
-.SH AVAILABILITY
-Provided with distributions of Majordomo.
-.LP
-.SH DESCRIPTION
-.B bounce
-and
-.B bounce-remind
-are perl scripts which help list owners
-handle subscribers whose mail is bouncing. Mail is "bounced"
-in this context when it is undeliverable because hosts or
-addresses are unreachable or because of other mail errors.
-.LP
-Mail is also "bounced" by the resend script for various administrative
-reasons; these bounces are described in
-.BR approve (1).
-.LP
-When a list owner observes that an email address consistently causes
-mail errors, the owner may use
-.B bounce
-to remove the address from the list and place the address on a special
-.BR bounces
-mailing list.
-.LP
-.B bounce-remind,
-which should be run nightly by
-.BR cron (4M),
-sends a message to each of the user addresses on the
-.BR bounces
-list, on the chance that the mail error has been corrected.
-The message informs the addressee that their mail has been
-undeliverable and that they have been removed from one or
-more majordomo lists. It also instructs them how to unsubscribe
-from the
-.BR bounces
-list and re-subscribe to the list of their choice.
-.LP
-.B bounce
-can also be used to expire addresses off the
-.BR bounces
-list after a predetermined number of days.
-.LP
-If
-.B bounce
-is invoked under a name that contains ``unsub'' it will simply
-unsubscribe the offending address from the majordomo list; it
-will not place the address on the
-.BR bounces
-list.
-.LP
-.SH OPTIONS
-These options relate to
-.B bounce; bounce-remind
-takes no arguments or options.
-.LP
-.TP 10
-.B \-d
-Debug; print what would be done, but don't do it.
-.TP
-.B \-f config-file
-Use the specified configuration file. The default is
-.BR ~/.majordomo,
-and the format for this file is described in the
-.BR CONFIGURATION
-section of the
-.BR approve (1)
-man page. This file provides the list-owner's password for
-each list and the address of the corresponding Majordomo
-server.
-.TP
-.B \-majordomo server-address
-Use this
-.IR server-address
-for majordomo rather than the address from the configuration file.
-.TP
-.B \-unsub
-Unsubscribes the offending address from the majordomo list,
-without entering that address on the
-.BR bounces
-list. This is equivalent to invoking
-.BR bounce
-under a name containing ``unsub''.
-.TP
-.B \-expire
-Expire entries from the specified
-.BR bounces
-list.
-.TP
-.B \-maxage days
-Expire entries older than
-.BI days.
-The default is coded into the
-.BR bounce
-script as
-.BI $default_maxage
-days. It is set to 21 days in the majordomo distribution.
-.LP
-.SH OPERANDS
-.TP 10
-.B majordomo-list
-The list from which the offending user-address should be removed.
-.TP
-.B user-address
-The address to which mail is currently undeliverable.
-.TP
-.B bounce-address-file
-The name of the file that contains the
-.BR bounces
-list.
-.LP
-.SH CONFIGURATION
-If
-.B bounce
-is going to be used only to unsubscribe users, a link can be
-created whose name contains ``unsub'' so that users could be
-unsubscribed simply by typing
-.sp 1
-.RS 3
-unsub firewalls-digest fury@world.std.com
-.RE
-.sp 1
-for example.
-.LP
-In any case, a configuration file must exist and must contain
-the names of the owner's lists, along with their respective
-passwords and the email address of the associated Majordomo
-server. The format of this file is given in the
-.B CONFIGURATION
-section of the
-.BR approve (1)
-man page. The default name for this file is
-.BR ~/.majordomo,
-and the same file can serve for both the
-.B approve
-and
-.B bounce
-scripts.
-.LP
-The
-.B bounces
-list, if it is used, must be created. It is like any other
-Majordomo list excepting that the priority of this list
-should be set to
-.B junk
-and its owner and sender should be
-.B nobody.
-Of course, the ``nobody'' mail alias must exist; it is should
-be set to /dev/null. That is,
-.sp 1
-.RS 3
-nobody: /dev/null
-.RE
-.sp 1
-This will spare the human list owner as well as the postmaster
-from having to deal with mail bouncing from the
-.B bounces
-list.
-.LP
-A
-.BR cron (1M)
-job should be set up to run
-.B bounce-remind
-every night.
-.B bounce-remind
-must run on the same server as the
-.B bounces
-list; it mails a message to everyone on the list advising
-them that they have been removed from one or more Majordomo
-lists and instructs them how to get off the
-.B bounces
-list and back on the list of their choice.
-.LP
-.B bounce
-can only expire addresses if it has a copy of the
-.B bounces
-subscriber file, so this can either be run on the server
-occasionally by the Majordomo administrator or by a cron
-job. It can also be run remotely with a copy of the
-.B bounces
-file retrived by the use of the ``who bounces'' command
-to majordomo.
-.LP
-.SH FILES
-.PD 0
-.TP 20
-.B /etc/aliases
-.TP
-.B /etc/majordomo.cf
-.PD
-.LP
-.SH SEE ALSO
-.B majordomo(8),approve(1)
-.LP
-.SH AUTHOR
-Majordomo and most of the ancillary perl code was written by
-Brent Chapman <brent@GreatCircle.COM>.
-Majordomo is available via anonymous FTP
-from FTP.GreatCircle.COM, in the directory pub/majordomo. This
-man page was written by Kevin Kelleher <fury@world.std.com>.
+++ /dev/null
-.TH digest 1
-.SH NAME
-digest \- receive a file for a digest, or create and mail a digest
-.LP
-.SH SYNOPSIS
-.B digest \-r|R|m|p \-C \-l
-.I majordomo-listname recipient
-.LP
-.B digest \-r|R|m|p
-[
-.B \-c
-.I configuration-file
-]
-.LP
-.SH AVAILABILITY
-Provided with distributions of Majordomo.
-.LP
-.SH DESCRIPTION
-The digest script is a perl script which automates the
-management of digests of electronic mail. It can be
-run in a standalone configuration or as part of Majordomo.
-.LP
-It requires two directories: a work directory and an
-archive directory. Incoming email messages are held
-in the work directory until they are collected into a
-digest. The digests are created and stored
-in the archive directory.
-.LP
-Incoming email messages are given
-numerical names starting with ``001'' and are numbered in
-order of arrival. The digests are named according to volume
-and number. For example, the filename ``v01.n028'' indicates
-volume 1, number 28 of the digest.
-.LP
-It should be noted that digest needs a configuration file
-to define all of its operating parameters. If no such
-file is specified, digest will use the
-.SB $HOME/.digestrc
-file.
-.LP
-Several aspects of digest configuration determine how and
-when a digest is created. A digest can be created at
-regular intervals (as long as there are incoming messages)
-or whenever certain configurable conditions are met. These
-conditions are: how large the digest can be (in characters),
-how long the digest can be (in lines), and how old the messages
-in the digest can be (in days).
-.LP
-.SH OPTIONS
-.TP 10
-.B \-r
-Receive an email message via standard input
-and place the file into the working directory.
-If any one of the conditions for digest creation
-are met, create and mail a digest. These conditions
-are the same as those described under option
-.BR \-p.
-.TP
-.B \-R
-Similar to
-.BR \-r,
-except that it will not create a digest. It simply
-places the message in the work directory and stops.
-.TP
-.B \-m
-If there are any numbered files in the working
-directory, create and mail a digest. Store the
-digest in the archive directory. This is the
-option used by majordomo's mkdigest command.
-.TP
-.B \-p
-Conditionally creates a digest. If any one of the
-conditions for digest creation are met, the digest
-is created and sent. There are three conditions,
-which are connected to three limits: the digest
-size in characters, the digest length in lines, and
-the age of the oldest message in days. If one of the
-files is older than the age limit, a digest is created.
-If the sum of the messages exceeds either of the size
-limits, a digest is created. The size limit in characters
-must be configured; the other two limits are optional.
-.TP
-.B \-c configuration-file
-Use the parameters defined in
-.IR configuration-file.
-.TP
-.B \-C
-Read the majordomo configuration file
-(either /etc/majordomo.cf or ~majordomo/majordomo.cf)
-and the configuration file for the Majordomo list specified in the
-.BR \-l
-option to define operational parameters. If both
-.BR \-C
-and
-.BR \-c
-options are specified (not recommended) only the
-.BR \-C
-option will be used.
-.TP
-.B \-l majordomo-listname
-This option is ignored if used without the
-.BR \-C
-option. Specifies the Majordomo email list.
-.LP
-.SH OPERANDS
-.TP 10
-.B recipient
-Email recipient of the digest. This operand is ignored if used
-without the
-.BR \-C
-option. It specifies one of the system mail
-aliases created for the Majordomo list named in the
-.BR \-l
-option.
-.LP
-.SH MAJORDOMO DIGEST CONFIGURATION
-When used as a part of Majordomo, digest takes these parameters
-from
-.B majordomo.cf
-(either /etc/majordomo.cf or ~majordomo/majordomo.cf):
-.LP
-.PD 0
-.B $listdir
-\- the location of the mailing lists
-.LP
-.B $digest_work_dir
-\- parent directory for the digests' work directories
-.LP
-.B $filedir
-\- parent directory for archive directories
-.LP
-.B $filedir_suffix
-\- an optional identifier (may be the null string)
-.PD
-.LP
-Incoming messages for
-.B $listname-digest
-will be held in
-.B $digest_work_dir/$listname-digest.
-.LP
-Digests will be stored in
-.B $filedir/$listname-digest$filedir_suffix.
-.LP
-The list's configuration file will be
-.B $listdir/$listname-digest.config.
-.LP
-Examples of these values are given in
-.SB EXAMPLES,
-below.
-.LP
-The list's configuration file contains several digest parameters that
-are not yet implemented and/or should NOT be changed from their defaults
-(blank):
-.B digest_archive, digest_rm_footer, digest_rm_fronter, digest_work_dir.
-.LP
-The parameters which specifically deal with digest creation
-and maintenance are:
-.LP
-.PD 0
-.B digest_name
-\- the title of the digest
-.LP
-.B digest_volume
-\- volume number
-.LP
-.B digest_issue
-\- issue number
-.LP
-.B digest_maxdays
-\- age limit in days for oldest message in the digest
-.LP
-.B digest_maxlines
-\- maximum number of lines in a digest
-.LP
-.B maxlength
-\- maximum number of characters in a digest
-.LP
-.B message_fronter
-\- text prepended to the digest
-.LP
-.B message_footer
-\- text appended to the digest
-.PD
-.LP
-The last three parameters are also used in the configuration of
-an ordinary (non-digest) Majordomo list.
-.LP
-Each digest begins with the a line containing the
-.B digest_name, current date, digest_volume and digest_issue.
-. The digest script will update the issue number in the configuration file.
-.LP
-A blank line follows, and then the text from the
-.B message_fronter,
-if any. The message fronter may contain the
-.SB _SUBJECT_
-token, which will be replaced by the subject lines from the messages
-in the digest.
-.LP
-The text in the
-.B message_footer,
-if any, will be appended to the digest.
-.LP
-To embed a blank line in the
-.B message_footer
-or
-.B message_fronter,
-put a `-' as the first and ONLY character on the line. To
-preserve whitespace at the beginning of a line, put a `-'
-on the line before the whitespace to be preserved. To put
-a literal `-' at the beginning of a line, double it.
-.LP
-Both message_footer and message_fronter may also use the tokens
-.SB $LIST, $SENDER,
-and
-.SB $VERSION,
-which will be expanded to,
-respectively: the name of the current list, the sender as taken
-from the from line, and the current version of Majordomo.
-.LP
-Examples of the aliases usually used with the digest are
-given in
-.SB EXAMPLES,
-below.
-.LP
-The list owner can prompt Majordomo to build a digest by
-sending the command
-.LP
-mkdigest
-.I digest-name
-[
-.I outgoing-address
-]
-.I digest-password
-.LP
-to majordomo either via email or from cron. The cron
-command has the format:
-.LP
-echo mkdigest
-.I digest-name
-[
-.I outgoing-address
-]
-.I digest-password
-| mail majordomo@domain.com
-.LP
-.SH STANDALONE DIGEST CONFIGURATION
-The Majordomo distribution comes with a ``digest'' subdirectory.
-The sample configuration file is called firewalls-digest.cf.
-A file in this format must be used if digest is invoked in
-standalone configuration.
-.LP
-If no configuration file is specified when digest is invoked,
-it looks for a file named
-.SB $HOME/.digestrc
-that must be in the same format as the example file.
-.LP
-The configuration file defines the email addresses of the
-sender and recipient of the digest. It also locates the
-work and archive directories, the digest's size limit,
-and the names of the files that contain the digest's volume,
-number, header and footer.
-.LP
-The easiest way to configure a standalone digest is to copy
-the five files (firewalls-digest.*) and edit them to taste.
-.LP
-Incoming mail is piped to digest with the
-.B \-r
-option. This can be done from some mail-reading programs, through
-the command line, or via mail aliases similar to those
-found in
-.SB EXAMPLES,
-below.
-.LP
-.SH EXAMPLES
-.LP
-1. Example values from
-.B /etc/majordomo.cf:
-.LP
-.PD 0
-.B $listdir = ``usr/local/mail/lists'';
-.LP
-.B $digest_work_dir = ``usr/local/mail/digest'';
-.LP
-.B $filedir = ``listdir'';
-.LP
-.B $filedir_suffix ``archive'';
-.PD
-.LP
-If our digest's name is banjo-digest, the work directory will
-be /usr/local/mail/digest/banjo-digest; the archive directory
-will be /usr/local/mail/lists/banjo-digest.archive. Note
-that these are names of directories, not files.
-.LP
-2. Typical aliases for Majordomo digests:
-.LP
-Usually a Majordomo digest is associated to a regular (non-digest)
-list. The digest's name is the regular listname plus ``-digest''.
-The list ``banjo'' will have the digest ``banjo-digest''.
-.LP
-.PD 0
-.B banjo-digest-approval: kevink
-.LP
-.B banjo-digest-outgoing: :include:/usr/local/lists/banjo-digest
-.LP
-.B owner-banjo-digest-outgoing: kevink
-.LP
-.B banjo-digestify: ``|usr/majordomo/wrapper digest \-r
-.B \-C \-l banjo-digest banjo-digest-outgoing''
-.LP
-.B banjo-digest: banjo
-.PD
-.LP
-Note that mail to ``banjo-digest'' is routed to the regular list.
-The ``digestify'' alias must be added to the regular list's outgoing
-alias:
-.LP
-.B banjo-outgoing: :include:/usr/local/lists/banjo,banjo-digestify
-.LP
-.SH NOTES
-The volume number does not change automatically; it must be
-incremented manually.
-.LP
-For testing/debugging purposes there is a ``hidden'' option
-.B -d
-that creates the digest as /tmp/testdigest.nnn
-(where
-.I nnn
-is the current digest number). Since it is for testing and
-debugging purposes, it does not mail the digest, it does not
-place the digest in the archive directory, and it does not
-update the digest number.
-.LP
-.SH EXIT STATUS
-The following exit values are returned:
-.TP 10
-.B 0
-Successful completion.
-.TP
-.B >0
-An error occurred.
-.LP
-.SH FILES
-.PD 0
-.TP 20
-.B /etc/aliases
-.TP
-.B /etc/majordomo.cf
-.PD
-.LP
-.SH SEE ALSO
-.B majordomo(8)
-.LP
-.SH AUTHOR
-The digest script was written by Brent Chapman <brent@GreatCircle.COM>.
-It is available with distributions of Majordomo via anonymous FTP
-from FTP.GreatCircle.COM, in the directory pub/majordomo. This
-man page was written by Kevin Kelleher <fury@world.std.com>.
+++ /dev/null
-.TH resend 1
-.SH NAME
-resend \- resend messages after evaluation
-.LP
-.SH SYNOPSIS
-.B resend
-.B [\-A]
-.B [\-C config-file]
-.B [\-I file-list]
-.B [\-M max-msg-length]
-.B [\-R]
-.B [\-a passwd]
-.B [\-d]
-.B [\-f from-addr]
-.B [\-h host-name]
-.B \-l list-name
-.B [\-n]
-.B [\-p precedence]
-.B [\-r reply-to]
-.B [\-s]
-.B destination
-.LP
-.SH AVAILABILITY
-Provided with distributions of Majordomo.
-.LP
-.SH DESCRIPTION
-.B resend
-is a perl script that is usually used to redirect mail messages to
-a mailing list after evaluating and parsing the headers. Mail is
-"resent" by handing it off to the mailer again with an alternate
-destination as specified by the final operand.
-.LP
-Any message that
-.B resend
-doesn't like is sent to the list owner (the
-"-f" address, or "<list-name>-owner" if -f isn't used) along with a
-comment indicating what "resend" didn't like about it. To go ahead
-and send the message, just feed it to resend without the flag that
-caused it to reject it (in other words, if it rejected it because it
-was too long, omit the "-M <>" flag; if it rejected it because it was
-administrivia, omit the "-s" flag).
-.LP
-If you specify "-a <passwd>" flag, this "approval" password can be
-used in an "Approved: <passwd>" line to override most of the other
-checks (those enabled by "-s", "-M", and so forth). The "Approved:
-<passwd>" line can either be one of the mail headers, or the first
-line of the body of the message. If it is in the headers, the rest
-of the headers are resent as part of the approved message. If it is
-in the body, the current headers are discarded in favor of the headers
-from the original message which should follow the "Approved:" line in
-the body.
-.LP
-The owner of a mailing list can thus post messages that were initially
-bounced by adding an "Approved: <passwd>" line and resubmitting the
-message. Any "Approved: <passwd>" line is stripped before the message
-is sent to the mailing list, so that list members won't learn the
-password. If the <passwd> argument to the "-a" flag begins with a "/",
-it is assumed to be a file name from which the actual password is read.
-.LP
-You can make a list "moderated" by specifying the "-A" flag. If the
-"-A" flag is set, then any messages not containing a valid "Approved:"
-line are sent to the list owner, rather than the whole list.; the
-list owner can then review the message, add an appropriate "Approved:"
-line, and resubmit them (these last two steps can be done easily with
-the "approve" command that comes with Majordomo). If you specify
-the "-A" flag, you must also specify the "-a <passwd>" flag, so that
-resend knows what approval password to use.
-.LP
-If you only want to accept messages from members of a list, you can
-use the "-I <file-list>" flag to do this. "<file-list>" should be a
-colon-separated list of files in the $listdir directory (specified in
-the config file) that "resend" will check the address in "From:" line
-of a message against. If the address doesn't show up in one of those
-files, and the message doesn't have a valid "approved" header on it,
-it will be bounced to the list owner.
-.LP
-.SH OPTIONS
-The following options can be used with resend:
-.LP
-.TP 10
-.B \-A
-Approve; enable list moderation by requiring an Approved: header to be
-present in the message before resending. Messages without an Approved:
-header will be redirected to the list owner for approval.
-.TP
-.B \-C config-file
-Alternate configuration file; tell resend to use the file
-.TP
-.B config-file
-instead of the default list-name.config.
-.TP
-.B \-I file-list
-Include; ensure that the message sender (as represented in the From:
-line of the incoming message) is in one of the file(s) specified in
-.BR file-list .
-.B file-list
-may contain multiple colon separated pathnames. Each pathname should
-point to a file that contains a sendmail-style mailing list.
-.TP
-.B [\-M max-msg-length]
-Maximum; Specify the maximum length of the relayed message in octets.
-.TP
-.B [\-R]
-Delete the "Received:" lines in the incoming message header. This can
-make the relayed messages considerably shorter at the expense of
-losing some potentially interesting debugging information.
-.TP
-.B [\-a passwd_file]
-Specify the pathname of the file containing the approval password for
-the list. This password is used to check Approved: headers when
-relaying messages to lists that are marked as moderated through the
-.B \-A
-option above.
-.TP
-.B [\-d]
-Debug; print what would be done, but don't do it.
-.TP
-.B [\-f from-addr]
-Set the From: address to
-.B from-addr
-.TP
-.B [\-h host-name]
-Set the name of the local host to
-.BR host-name .
-This name will be used in the From: and To: lines when updating the
-headers.
-.TP
-.B \-l list-name
-Specify the name of the mailing list as
-.BR list-name .
-This option is required, as
-.B resend
-uses this name to derive the names
-of many other files.
-.TP
-.B [\-n]
-Assign a sequence number to each message as it comes through. The next
-sequence number is stored in the file lists/list-name.seq. If the
-string $SEQNUM is found in the $subject-prefix configuration variable,
-it is replaced with the current sequence number. Thus, a
-$subject_prefix of "($LIST $SEQNUM)" would render a Subject: line of
-(list-name sequence-number).
-.TP
-.B [\-p precedence]
-Set the Precedence: header to
-.BR precedence .
-.TP
-.B [\-r reply-to]
-Set the Reply-To: header to
-.BR reply-to .
-.TP
-.B [\-s]
-Administrivia; Search the message for strings commonly found in
-administrative messages send to majordomo mailing lists (e.g.
-subscribe, unsubscribe). If these are found in the first 10 or so
-lines of the message, the message will be relayed to the list owner
-instead of being sent on to the mailing list.
-.SH OPERANDS
-.TP 10
-.B destination
-The alias to which to redirect the message if it is a proper list
-submission.
-.LP
-.SH CONFIGURATION
-.LP
-.SH FILES
-.PD 0
-.TP 20
-.B /etc/aliases
-.TP
-.B /etc/majordomo.cf
-.TP
-.B lists/list-name.config
-.PD
-.LP
-.SH SEE ALSO
-.B majordomo(8),approve(1)
-.LP
-.SH AUTHOR
-Majordomo and most of the ancillary perl code was written by
-Brent Chapman <brent@GreatCircle.COM>.
-Majordomo is available via anonymous FTP
-from FTP.GreatCircle.COM, in the directory pub/majordomo. This
-man page was written by Shane McCarron <ahby@themacs.com>.
+++ /dev/null
-.TH MAJORDOMO 8
-.SH NAME
-Majordomo \- manage multiple mailing lists
-.SH SYNOPSIS
-.B Majordomo
-.SH "DESCRIPTION"
-.B Majordomo
-is a perl script which automates the management of Internet mailing lists.
-It is executed via electronic mail; users send e-mail to
-.B Majordomo
-with instructions in the body of the message, and the perl script performs
-the requested actions and responds with the results. Any text in the
-"Subject:" line is ignored.
-.SH "COMMANDS"
-.B Majordomo
-understands the following commands (arguments in "[]" are optional):
-.TP 5
-.B
-subscribe \fIlist\fR [\fIaddress\fR]
-.P
-Subscribe yourself (or
-.I address
-if specified) to the named
-.IR list .
-.TP 5
-.B
-unsubscribe \fIlist\fR [\fIaddress\fR]
-.P
-Unsubscribe yourself (or
-.I address
-if specified) from the named
-.IR list .
-If
-.IR list
-is ``*'' (an asterisk), unsubscribe from all lists on this Majordomo
-server.
-.TP 5
-.B
-auth \fIspecial-word\fP subscribe \fIlist address\fP
-.P
-If the
-.I list
-subscribe policy setting includes \fI+confirm\fR,
-Majordomo will ask for confirmation before a subscription
-is approved.
-The conformation request will show the
-.I special-word
-to send with
-.I auth .
-.TP 5
-.B
-get \fIlist\fR \fIfile\fR
-.P
-Get the
-.I file
-related to
-.IR list .
-.TP 5
-.B
-index \fIlist\fR
-.P
-Return an index of the files you can
-.I get
-associated with
-.IR list .
-.TP 5
-.B
-which [\fIaddress\fR]
-.P
-Find out to which lists you (or
-.I address
-if specified) are subscribed.
-.TP 5
-.B
-who \fIlist\fR
-.P
-Find out who is on the named
-.IR list .
-.TP 5
-.B
-info \fIlist\fR
-.P
-Retrieve the general introductory information for the named
-.IR list .
-.TP 5
-.B
-intro \fIlist\fR
-.P
-Retrieve the introductory message sent to new users
-of
-.IR list .
-Non-subscribers may not be able to retrieve this.
-.TP 5
-.B
-lists
-.P
-Show the lists served by this Majordomo server. It will also show a 50
-character list description if one has been provided.
-.TP 5
-.B
-help
-.P
-Retrieve an informational message, a brief synopsis of the user portion of
-this manual page.
-.TP 5
-.B
-end
-.P
-Stop processing commands (useful if your mailer adds a signature).
-.PP
-A command may be split across multiple lines if all of the lines in
-the command except the last end with a backslash "\\".
-.PP
-In addition, the owner of the list can issue the following commands:
-.TP 5
-.B
-approve \fIpassword\fR subscribe \fIlist\fR \fIaddress\fR
-.P
-Instruct Majordomo to add
-.I address
-to
-.IR list .
-The password is required to authenticate the list owner. This is very weak
-authentication as the password is transmitted in the clear in an e-mail
-message. No claims are made that it will provide anything other than
-rudimentary protection against abuse of the Majordomo server.
-.TP 5
-.B
-approve \fIpassword\fR unsubscribe \fIlist\fR \fIaddress\fR
-.P
-Instruct Majordomo to delete
-.I address
-from
-.IR list .
-The password is required to authenticate the list owner. See the comments
-above regarding the password.
-.TP 5
-.B
-newinfo \fIlist\fR \fIpassword\fR
-.P
-Update the informational message for
-.I list
-with the text which follows on subsequent lines. No formatting of the
-message occurs, so the list owner should be careful to constrain the message
-to eighty columns. Majordomo will include everything up to the string
-.B EOF
-or to the end of the mail message, whichever comes first. This is useful in
-case the owner wants to verify the new message immediately, e.g.,
-.sp 1
-.RS 10
-To: majordomo
-.sp 0
-newinfo list password
-.sp
-This is new information for the "list" list.
-.sp
-EOF
-.sp 0
-info list
-.sp
-.RE
-.RS 5
-This will simultaneously update the information for the list, and then
-retrieve it for verification. Note that blank lines are preserved in the
-message.
-.RE
-.TP 5
-.B
-newintro \fIlist\fR \fIpassword\fR
-.P
-Similar to
-.I newinfo ,
-but updates the (optional) introductory message sent to new
-.I list
-subscribers.
-.B
-passwd \fIlist\fR \fIold-password\fR \fInew-password\fR
-.P
-Replace the password for
-.I list
-with
-.IR new-password .
-.TP 5
-.B
-config \fIlist\fR \fIpassword\fR
-.P
-retrieve a self-documenting configuration file for
-the list <list>. The \fIpassword\fR can be the password
-contained in the file <listname>.passwd or the
-admin_password in the configuration file.
-.TP 5
-.B
-newconfig \fIlist\fR \fIpassword\fR
-.P
-Validates and installs a new configuration file. The config file
-includes everything up to the string
-.B EOF
-or to the end of the mail message, whichever comes first. The config
-file is expected to be a complete config file as returned by the
-"config" command. Incremental changing of the config file is not yet
-supported. As soon as the config file is validated and installed its
-settings are available for use. This is useful to remember if you have
-multiple commands in your mail message since they will be subject to
-the settings of the new config file. If there is an error in the
-config file (incorrect value...), the config file will not be accepted
-and the error message identifying the problem line(s) will be returned
-to the sender. Note that only the errors are returned to the
-sender not the entire config file.
-.TP 5
-.B
-writeconfig \fIlist\fR \fIpassword\fR
-.P
-Write a new config in standard form. All of the config
-file documentation is optional. Only the keywords and
-values are necessary. If a config file, stripped of
-all comments is installed using newconfig, that is
-what is returned by config. Writeconfig forces a
-rewrite of the config file with all comments and
-default values in place. It is useful to use after an
-upgrade of majordomo since it will add the new
-keywords for people to change. It also updates the
-documentation in the file if that has changed.
-.TP 5
-.B mkdigest
-.I digest-list-name
-[
-.I outgoing-address
-]
-.I password
-.P
-This will force a digest for the specified list to be created. It is
-most useful if you don't have an account on the machine that handles
-the digest for your list.
-The optional
-.I outgoing-address
-will override the default address,
-.IR listname -outgoing ,
-for distributing the digests;
-this is usually done for security.
-.SH CONFIGURATION
-(Note that this section has not been updated to majordomo version 1.90).
-.B Majordomo
-supports
-.I open
-and
-.I closed
-lists. An
-.I open
-list is one to which anyone can subscribe themselves. A subscription
-request sent to
-.B Majordomo
-for a
-.I closed
-list is forwarded to the owner of the list for approval. If a user tries to
-subscribe an address which is different from their own (for example, a local
-list exploder),
-.B Majordomo
-will forward the request to the list owner for approval, regardless of the
-open or closed status of the list.
-.PP
-.B Majordomo
-depends on the existence of certain system mail aliases. The first three
-are for running the perl script on incoming e-mail and specifying the
-responsible person in charge of the server:
-.sp 1
-majordomo: "|/usr/local/mail/majordomo/wrapper majordomo"
-.sp 0
-majordomo-owner: brent
-.sp 0
-owner-majordomo: brent
-.sp 1
-These next few aliases are for a list called "sample":
-.sp 1
-sample: :include:/usr/local/mail/lists/sample
-.sp 0
-owner-sample: sample-owner
-.sp 0
-sample-request: "|/usr/local/mail/majordomo/wrapper request-answer sample"
-.sp 0
-owner-sample-request: sample-owner
-.sp 0
-sample-owner: brent
-.sp 0
-sample-approval: brent
-.sp 1
-
-.SH FILES
-/etc/majordomo.cf
-.sp 0
-/usr/local/lib/mail/majordomo/
-
-.SH BUGS
-This man page has not been fully updated to conform to majordomo 1.90.
-
-.SH AUTHORS
-Majordomo and most of the ancillary perl code was written by Brent Chapman,
-<brent@GreatCircle.COM>. The latest version of the code is available by
-anonymous FTP from FTP.GreatCircle.COM, in directory pub/majordomo.
-This man page was written by Jim Duncan, <jim@math.psu.edu>. Minimal
-update of the man page by John Rouillard <rouilj@cs.umb.edu>.
+++ /dev/null
-×:majordomo:1.94.5:1993/10/28:approve:1:::::
-×:majordomo:1.94.5:1996/10/01:bounce:1:::::
-※:majordomo:1.94.5:1996/10/01:bounce-remind:1:bounce:1:
-×:majordomo:1.94.5:1997/04/21:digenst:1:::::
-△:majordomo:unknown=>1.94.5:1997/04/21:majordomo:8:1998/06/26::ogochan@nurs.or.jp:Masami Ogoshi:
-×:majordomo:1.94.5:1996/12/11:resend:1:::::
+++ /dev/null
-Mon Mar 28 12:02:51 JST 2005 JM ML to CVS Gateway
-
- * translation_list: [JM:11623]
-
-Thu Mar 10 02:35:14 2005 Tatsuo Sekine <tsekine@sdri.co.jp>
-
- * original/*: smartmontools-5.33
+++ /dev/null
-http://smartmontools.sourceforge.net/
+++ /dev/null
-.ig
-Copyright (C) 2002-4 Bruce Allen <smartmontools-support@lists.sourceforge.net>
-
-$Id: smartd.conf.5.in,v 1.65 2004/09/07 13:01:51 ballen4705 Exp $
-
-This program is free software; you can redistribute it and/or modify it
-under the terms of the GNU General Public License as published by the Free
-Software Foundation; either version 2, or (at your option) any later
-version.
-
-You should have received a copy of the GNU General Public License (for
-example COPYING); if not, write to the Free Software Foundation, Inc., 675
-Mass Ave, Cambridge, MA 02139, USA.
-
-This code was originally developed as a Senior Thesis by Michael Cornwell
-at the Concurrent Systems Laboratory (now part of the Storage Systems
-Research Center), Jack Baskin School of Engineering, University of
-California, Santa Cruz. http://ssrc.soe.ucsc.edu/
-..
-.TH SMARTD.CONF 5 CURRENT_CVS_DATE CURRENT_CVS_VERSION CURRENT_CVS_DATE
-.SH NAME
-\fBsmartd.conf\fP \- SMART Disk Monitoring Daemon Configuration File\fP
-
-.SH FULL PATH
-.B /usr/local/etc/smartd.conf
-
-.SH PACKAGE VERSION
-CURRENT_CVS_VERSION released CURRENT_CVS_DATE at CURRENT_CVS_TIME
-
-.SH DESCRIPTION
-\fB/usr/local/etc/smartd.conf\fP is the configuration file for the \fBsmartd\fP
-daemon, which monitors the Self-Monitoring, Analysis and Reporting
-Technology (SMART) system built into many ATA-3 and later ATA, IDE and
-SCSI-3 hard drives.
-
-If the configuration file \fB/usr/local/etc/smartd.conf\fP is present,
-\fBsmartd\fP reads it at startup, before \fBfork\fP(2)ing into the
-background. If \fBsmartd\fP subsequently receives a \fBHUP\fP signal,
-it will then re-read the configuration file. If \fBsmartd\fP is
-running in debug mode, then an \fBINT\fP signal will also make it
-re-read the configuration file. This signal can be generated by typing
-\fB\<CONTROL-C\>\fP in the terminal window where \fBsmartd\fP is
-running.
-
-.\" DO NOT MODIFY THIS OR THE FOLLOWING TWO LINES. WHAT FOLLOWS
-.\" IS AUTOMATICALLY INCLUDED FROM THE FILE smartd.8.in
-.\" STARTINCLUDE
-
-.SH CONFIGURATION FILE /usr/local/etc/smartd.conf
-In the absence of a configuration file, under Linux
-\fBsmartd\fP
-will try to open the 20 ATA devices
-.B /dev/hd[a-t]
-and the 26 SCSI devices
-.B /dev/sd[a-z].
-Under FreeBSD,
-\fBsmartd\fP
-will try to open all existing ATA devices (with entries in /dev)
-.B /dev/ad[0-9]+
-and all existing SCSI devices
-.B /dev/da[0-9]+.
-Under NetBSD/OpenBSD,
-\fBsmartd\fP
-will try to open all existing ATA devices (with entries in /dev)
-.B /dev/wd[0-9]+c
-and all existing SCSI devices
-.B /dev/sd[0-9]+c.
-Under Solaris \fBsmartd\fP will try to open all entries \fB"/dev/rdsk/c?t?d?s?"\fP for IDE/ATA and SCSI disk
-devices, and entries \fB"/dev/rmt/*"\fP for SCSI tape devices.
-Under Windows \fBsmartd\fP will try to open all entries \fB"/dev/hd[a-j]"\fP ("\\\\.\\PhysicalDrive[0-9]")
-for IDE/ATA devices on WinNT4/2000/XP, \fB"/dev/hd[a-d]"\fP
-(bitmask from "\\\\.\\SMARTVSD") for IDE/ATA devices on Win95/98/98SE/ME,
-and \fB"/dev/scsi[0-3][0-7]"\fP (ASPI adapter 0-3, ID 0-7) for SCSI
-devices on all versions of Windows.
-Under Darwin, \fBsmartd\fP will open any ATA block storage device.
-
-This can be annoying if you have an ATA or SCSI device that hangs or
-misbehaves when receiving SMART commands. Even if this causes no
-problems, you may be annoyed by the string of error log messages about
-block-major devices that can\'t be found, and SCSI devices that can\'t
-be opened.
-
-One can avoid this problem, and gain more control over the types of
-events monitored by
-\fBsmartd\fP,
-by using the configuration file
-.B /usr/local/etc/smartd.conf.
-This file contains a list of devices to monitor, with one device per
-line. An example file is included with the
-.B smartmontools
-distribution. You will find this sample configuration file in
-\fB/usr/local/share/doc/smartmontools-5.1/\fP. For security, the configuration file
-should not be writable by anyone but root. The syntax of the file is as
-follows:
-.IP \(bu 4
-There should be one device listed per line, although you may have
-lines that are entirely comments or white space.
-.IP \(bu 4
-Any text following a hash sign \'#\' and up to the end of the line is
-taken to be a comment, and ignored.
-.IP \(bu 4
-Lines may be continued by using a backslash \'\e\' as the last
-non-whitespace or non-comment item on a line.
-.IP \(bu 4
-Note: a line whose first character is a hash sign \'#\' is treated as
-a white-space blank line, \fBnot\fP as a non-existent line, and will
-\fBend\fP a continuation line.
-.PP 0
-.fi
-Here is an example configuration file. It\'s for illustrative purposes
-only; please don\'t copy it onto your system without reading to the end
-of the
-.B DIRECTIVES
-Section below!
-
-.nf
-.B ################################################
-.B # This is an example smartd startup config file
-.B # /usr/local/etc/smartd.conf for monitoring three
-.B # ATA disks, three SCSI disks, and six ATA disks
-.B # behind two 3ware controllers.
-.B #
-.nf
-.B # First ATA disk on each of two interfaces. On
-.B # the second disk, start a long self-test every
-.B # Sunday between 3 and 4 am.
-.B #
-.B \ \ /dev/hda -a -m admin@example.com,root@localhost
-.B \ \ /dev/hdc -a -I 194 -I 5 -i 12 -s L/../../7/03
-.B #
-.nf
-.B # SCSI disks. Send a TEST warning email to admin on
-.B # startup.
-.B #
-.B \ \ /dev/sda
-.B \ \ /dev/sdb -m admin@example.com -M test
-.B #
-.nf
-.B # Strange device. It\'s SCSI. Start a scheduled
-.B # long self test between 5 and 6 am Monday/Thursday
-.B \ \ /dev/weird -d scsi -s L/../../(1|4)/05
-.B #
-.nf
-.B # Four ATA disks on a 3ware 6/7/8000 controller.
-.B # Start short self-tests daily between midnight and 1am,
-.B # 1-2, 2-3, and 3-4 am
-.B # (Note that the syntax /dev/twe0 is also allowed.)
-.B \ \ /dev/sdc -d 3ware,0 -a -s S/../.././00
-.B \ \ /dev/sdc -d 3ware,1 -a -s S/../.././01
-.B \ \ /dev/sdd -d 3ware,2 -a -s S/../.././02
-.B \ \ /dev/sdd -d 3ware,3 -a -s S/../.././03
-.B #
-.nf
-.B # Two ATA disks on a 3ware 9000 controller.
-.B # Start long self-tests Sundays between midnight and
-.B # 1am and 2-3 am
-.B \ \ /dev/twa0 -d 3ware,0 -a -s L/../../7/00
-.B \ \ /dev/twa0 -d 3ware,1 -a -s L/../../7/02
-.B #
-.nf
-.B # The following line enables monitoring of the
-.B # ATA Error Log and the Self-Test Error Log.
-.B # It also tracks changes in both Prefailure
-.B # and Usage Attributes, apart from Attributes
-.B # 9, 194, and 231, and shows continued lines:
-.B #
-.B \ \ /dev/hdd\ -l\ error\ \e
-.B \ \ \ \ \ \ \ \ \ \ \ -l\ selftest\ \e
-.B \ \ \ \ \ \ \ \ \ \ \ -t\ \e\ \ \ \ \ \ # Attributes not tracked:
-.B \ \ \ \ \ \ \ \ \ \ \ -I\ 194\ \e\ \ # temperature
-.B \ \ \ \ \ \ \ \ \ \ \ -I\ 231\ \e\ \ # also temperature
-.B \ \ \ \ \ \ \ \ \ \ \ -I 9\ \ \ \ \ \ # power-on hours
-.B #
-.B ################################################
-.fi
-
-.PP
-.SH CONFIGURATION FILE DIRECTIVES
-.PP
-
-If the first non-comment entry in the configuration file is the text
-string
-.B DEVICESCAN
-in capital letters, then
-\fBsmartd\fP
-will ignore any remaining lines in the configuration file, and will
-scan for devices.
-.B DEVICESCAN
-may optionally be followed by Directives that will apply to all
-devices that are found in the scan. Please see below for additional
-details.
-
-.sp 2
-The following are the Directives that may appear following the device
-name or
-.B DEVICESCAN
-on any line of the
-.B /usr/local/etc/smartd.conf
-configuration file. Note that
-.B these are NOT command-line options for
-\fBsmartd\fP.
-The Directives below may appear in any order, following the device
-name.
-
-.B For an ATA device,
-if no Directives appear, then the device will be monitored
-as if the \'\-a\' Directive (monitor all SMART properties) had been given.
-
-.B If a SCSI disk is listed,
-it will be monitored at the maximum implemented level: roughly
-equivalent to using the \'\-H \-l selftest\' options for an ATA disk.
-So with the exception of \'\-d\', \'\-m\', \'\-l selftest\', \'\-s\', and
-\'\-M\', the Directives below are ignored for SCSI disks. For SCSI
-disks, the \'\-m\' Directive sends a warning email if the SMART status
-indicates a disk failure or problem, if the SCSI inquiry about disk
-status fails, or if new errors appear in the self-test log.
-
-.B If a 3ware controller is used
-then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?
-or /dev/twa?) must be listed, along with the \'\-d 3ware,N\' Directive
-(see below). The individual ATA disks hosted by the 3ware controller
-appear to \fBsmartd\fP as normal ATA devices. Hence all the ATA
-directives can be used for these disks (but see note below).
-
-.TP
-.B \-d TYPE
-Specifies the type of the device. This Directive may be used multiple times
-for one device, but the arguments \fIata\fP, \fIscsi\fP, and \fI3ware,N\fP are
-mutually-exclusive. If more than one is given then
-\fBsmartd\fP
-will use the last one which appears.
-
-If none of these three arguments is given, then \fBsmartd\fP will
-first attempt to guess the device type by looking at whether the sixth
-character in the device name is an \'s\' or an \'h\'. This will work for
-device names like /dev/hda or /dev/sdb, and corresponds to choosing
-\fIata\fP or \fIscsi\fP respectively. If
-\fBsmartd\fP
-can\'t guess from this sixth character, then it will simply try to
-access the device using first ATA and then SCSI ioctl()s.
-
-The valid arguments to this Directive are:
-
-.I ata
-\- the device type is ATA. This prevents
-\fBsmartd\fP
-from issuing SCSI commands to an ATA device.
-
-.I scsi
-\- the device type is SCSI. This prevents
-\fBsmartd\fP
-from issuing ATA commands to a SCSI device.
-
-.I 3ware,N
-\- the device consists of one or more ATA disks connected to a 3ware
-RAID controller. The non-negative integer N (in the range from 0 to 15
-inclusive) denotes which disk on the controller is monitored. In log
-files and email messages this disk will be identified as 3ware_disk_XX
-with XX in the range from 00 to 15 inclusive.
-
-This Directive may at first appear confusing, because the 3ware
-controller is a SCSI device (such as /dev/sda) and should be listed as
-such in the the configuration file.
-However when the \'\-d 3ware,N\'
-Directive is used, then the corresponding disk is addressed using
-native ATA commands which are \'passed through\' the SCSI driver. All
-ATA Directives listed in this man page may be used. Note that while
-you may use \fBany\fP of the 3ware SCSI logical devices /dev/sd? to
-address \fBany\fP of the physical disks (3ware ports), error and log
-messages will make the most sense if you always list the 3ware SCSI
-logical device corresponding to the particular physical disks. Please
-see the \fBsmartctl\fP man page for further details.
-
-ATA disks behind 3ware controllers may alternatively be accessed via a
-character device interface /dev/twe0-15 (3ware 6000/7000/8000
-controllers) and /dev/twa0-15 (3ware 9000 series controllers). Note
-that the 9000 series controllers may \fBonly\fP be accessed using the
-character device interface /dev/twa0-15 and not the SCSI device
-interface /dev/sd?. Please see the \fBsmartctl\fP man page for
-further details.
-
-Note that older 3w-xxxx drivers do not pass the \'Enable Autosave\'
-(\fB-S on\fP) and \'Enable Automatic Offline\' (\fB-o on\fP) commands
-to the disk, if the SCSI interface is used, and produce these types of
-harmless syslog error messages instead: \fB\'3w-xxxx: tw_ioctl():
-Passthru size (123392) too big\'\fP. This can be fixed by upgrading to
-version 1.02.00.037 or later of the 3w-xxxx driver, or by applying a
-patch to older versions. See
-\fBhttp://smartmontools.sourceforge.net/\fP for instructions.
-Alternatively use the character device interfaces /dev/twe0-15 (3ware
-6/7/8000 series controllers) or /dev/twa0-15 (3ware 9000 series
-controllers).
-
-
-.B 3ware controllers are currently ONLY supported under Linux.
-
-.I removable
-\- the device or its media is removable. This indicates to
-\fBsmartd\fP
-that it should continue (instead of exiting, which is the default
-behavior) if the device does not appear to be present when
-\fBsmartd\fP is started. This Directive may be used in conjunction
-with the other \'\-d\' Directives.
-
-.TP
-.B \-n POWERMODE
-This \'nocheck\' Directive is used to prevent a disk from being
-spun-up when it is periodically polled by \fBsmartd\fP.
-
-ATA disks have five different power states. In order of increasing
-power consumption they are: \'OFF\', \'SLEEP\', \'STANDBY\', \'IDLE\',
-and \'ACTIVE\'. Typically in the OFF, SLEEP, and STANDBY modes the
-disk\'s platters are not spinning. But usually, in response to SMART
-commands issued by \fBsmartd\fP, the disk platters are spun up. So if
-this option is not used, then a disk which is in a low\-power mode may
-be spun up and put into a higher\-power mode when it is periodically
-polled by \fBsmartd\fP.
-
-Note that if the disk is in SLEEP mode when \fBsmartd\fP is started,
-then it won't respond to \fBsmartd\fP commands, and so the disk won't
-be registered as a device for \fBsmartd\fP to monitor. If a disk is in
-any other low\-power mode, then the commands issued by \fBsmartd\fP to
-register the disk will probably cause it to spin\-up.
-
-The \'\fB\-n\fP\' (nocheck) Directive specifies if \fBsmartd\fP\'s
-periodic checks should still be carried out when the device is in a
-low\-power mode. It may be used to prevent a disk from being spun\-up
-by periodic \fBsmartd\fP polling. The allowed values of POWERMODE
-are:
-
-.I never
-\- \fBsmartd\fP will poll (check) the device regardless of its power
-mode. This may cause a disk which is spun\-down to be spun\-up when
-\fBsmartd\fP checks it. This is the default behavior if the '\-n'
-Directive is not given.
-
-.I sleep
-\- check the device unless it is in SLEEP mode.
-
-.I standby
-\- check the device unless it is in SLEEP or STANDBY mode. In
-these modes most disks are not spinning, so if you want to prevent
-a laptop disk from spinning up each time that \fBsmartd\fP polls,
-this is probably what you want.
-
-.I idle
-\- check the device unless it is in SLEEP, STANDBY or IDLE mode.
-In the IDLE state, most disks are still spinning, so this is probably
-not what you want.
-
-
-.TP
-.B \-T TYPE
-Specifies how tolerant
-\fBsmartd\fP
-should be of SMART command failures. The valid arguments to this
-Directive are:
-
-.I normal
-\- do not try to monitor the disk if a mandatory SMART command fails, but
-continue if an optional SMART command fails. This is the default.
-
-.I permissive
-\- try to monitor the disk even if it appears to lack SMART
-capabilities. This may be required for some old disks (prior to
-ATA\-3 revision 4) that implemented SMART before the SMART standards
-were incorporated into the ATA/ATAPI Specifications. This may also be
-needed for some Maxtor disks which fail to comply with the ATA
-Specifications and don't properly indicate support for error\- or
-self\-test logging.
-
-[Please see the \fBsmartctl \-T\fP command-line option.]
-.TP
-.B \-o VALUE
-Enables or disables SMART Automatic Offline Testing when
-\fBsmartd\fP
-starts up and has no further effect. The valid arguments to this
-Directive are \fIon\fP and \fIoff\fP.
-
-The delay between tests is vendor-specific, but is typically four
-hours.
-
-Note that SMART Automatic Offline Testing is \fBnot\fP part of the ATA
-Specification. Please see the
-.B smartctl \-o
-command-line option documentation for further information about this
-feature.
-.TP
-.B \-S VALUE
-Enables or disables Attribute Autosave when \fBsmartd\fP
-starts up and has no further effect. The valid arguments to this
-Directive are \fIon\fP and \fIoff\fP. Also affects SCSI devices.
-[Please see the \fBsmartctl \-S\fP command-line option.]
-.TP
-.B \-H
-Check the SMART health status of the disk. If any Prefailure
-Attributes are less than or equal to their threshold values, then disk
-failure is predicted in less than 24 hours, and a message at loglevel
-.B \'LOG_CRITICAL\'
-will be logged to syslog. [Please see the
-.B smartctl \-H
-command-line option.]
-.TP
-.B \-l TYPE
-Reports increases in the number of errors in one of the two SMART logs. The
-valid arguments to this Directive are:
-
-.I error
-\- report if the number of ATA errors reported in the ATA Error Log
-has increased since the last check.
-
-.I selftest
-\- report if the number of failed tests reported in the SMART
-Self-Test Log has increased since the last check, or if the timestamp
-associated with the most recent failed test has increased. Note that
-such errors will \fBonly\fP be logged if you run self-tests on the
-disk (and it fails a test!). Self-Tests can be run automatically by
-\fBsmartd\fP: please see the \fB\'\-s\'\fP Directive below.
-Self-Tests can also be run manually by using the \fB\'\-t\ short\'\fP
-and \fB\'\-t\ long\'\fP options of \fBsmartctl\fP and the results of
-the testing can be observed using the \fBsmartctl \'\-l\ selftest\'\fP
-command-line option.]
-
-[Please see the \fBsmartctl \-l\fP and \fB\-t\fP command-line
-options.]
-.TP
-.B \-s REGEXP
-Run Self-Tests or Offline Immediate Tests, at scheduled times. A
-Self- or Offline Immediate Test will be run at the end of periodic
-device polling, if all 12 characters of the string \fBT/MM/DD/d/HH\fP
-match the extended regular expression \fBREGEXP\fP. Here:
-.RS 7
-.IP \fBT\fP 4
-is the type of the test. The values that \fBsmartd\fP will try to
-match (in turn) are: \'L\' for a \fBL\fPong Self-Test, \'S\' for a
-\fBS\fPhort Self-Test, \'C\' for a \fBC\fPonveyance Self-Test (ATA
-only), and \'O\' for an \fBO\fPffline Immediate Test (ATA only). As
-soon as a match is found, the test will be started and no additional
-matches will be sought for that device and that polling cycle.
-.IP \fBMM\fP 4
-is the month of the year, expressed with two decimal digits. The
-range is from 01 (January) to 12 (December) inclusive. Do \fBnot\fP
-use a single decimal digit or the match will always fail!
-.IP \fBDD\fP 4
-is the day of the month, expressed with two decimal digits. The
-range is from 01 to 31 inclusive. Do \fBnot\fP
-use a single decimal digit or the match will always fail!
-.IP \fBd\fP 4
-is the day of the week, expressed with one decimal digit. The
-range is from 1 (Monday) to 7 (Sunday) inclusive.
-.IP \fBHH\fP 4
-is the hour of the day, written with two decimal digits, and given in
-hours after midnight. The range is 00 (midnight to just before 1am)
-to 23 (11pm to just before midnight) inclusive. Do \fBnot\fP use a
-single decimal digit or the match will always fail!
-.RE
-.\" The following two lines are a workaround for a man2html bug. Please leave them.
-.\" They define a non-existent option; useful because man2html can't correctly reset the margins.
-.TP
-.B \&
-Some examples follow. In reading these, keep in mind that in extended
-regular expressions a dot \fB\'.\'\fP matches any single character, and
-a parenthetical expression such as \fB\'(A|B|C)\'\fP denotes any one of the three possibilities \fBA\fP,
-\fBB\fP, or \fBC\fP.
-
-To schedule a short Self-Test between 2-3am every morning, use:
-.nf
-\fB \-s S/../.././02\fP
-.fi
-To schedule a long Self-Test between 4-5am every Sunday morning, use:
-.nf
-\fB \-s L/../../7/04\fP
-.fi
-To schedule a long Self-Test between 10-11pm on the first and
-fifteenth day of each month, use:
-.nf
-\fB \-s L/../(01|15)/./22\fP
-.fi
-To schedule an Offline Immediate test after every midnight, 6am,
-noon,and 6pm, plus a Short Self-Test daily at 1-2am and a Long
-Self-Test every Saturday at 3-4am, use:
-.nf
-\fB \-s (O/../.././(00|06|12|18)|S/../.././01|L/../../6/03)\fP
-.fi
-
-Scheduled tests are run immediately following the regularly-scheduled
-device polling, if the current local date, time, and test type, match
-\fBREGEXP\fP. By default the regularly-scheduled device polling
-occurs every thirty minutes after starting \fBsmartd\fP. Take caution
-if you use the \'\-i\' option to make this polling interval more than
-sixty minutes: the poll times may fail to coincide with any of the
-testing times that you have specified with \fBREGEXP\fP, and so the
-self tests may not take place as you wish.
-
-Before running an offline or self-test, \fBsmartd\fP checks to be sure
-that a self-test is not already running. If a self-test \fBis\fP
-already running, then this running self test will \fBnot\fP be
-interrupted to begin another test.
-
-\fBsmartd\fP will not attempt to run \fBany\fP type of test if another
-test was already started or run in the same hour.
-
-Each time a test is run, \fBsmartd\fP will log an entry to SYSLOG.
-You can use these to verify that you constructed \fBREGEXP\fP
-correctly. The matching order (\fBL\fP before \fBS\fP before \fBC\fP
-before \fBO\fP) ensures that if multiple test types are all scheduled
-for the same hour, the longer test type has precedence. This is
-usually the desired behavior.
-
-Unix users: please beware that the rules for extended regular
-expressions [regex(7)] are \fBnot\fP the same as the rules for
-file\-name pattern matching by the shell [glob(7)]. \fBsmartd\fP will
-issue harmless informational warning messages if it detects characters
-in \fBREGEXP\fP that appear to indicate that you have made this
-mistake.
-
-.TP
-.B \-m ADD
-Send a warning email to the email address \fBADD\fP if the \'\-H\',
-\'\-l\', \'\-f\', \'\-C\', or \'\-O\' Directives detect a failure or a
-new error, or if a SMART command to the disk fails. This Directive
-only works in conjunction with these other Directives (or with the
-equivalent default \'\-a\' Directive).
-
-To prevent your email in-box from getting filled up with warning
-messages, by default only a single warning will be sent for each of
-the enabled alert types, \'\-H\', \'\-l\', \'\-f\', \'\-C\', or
-\'\-O\' even if more than one failure or error is detected or if the
-failure or error persists. [This behavior can be modified; see the
-\'\-M\' Directive below.]
-
-To send email to more than one user, please use the following "comma
-separated" form for the address: \fBuser1@add1,user2@add2,...,userN@addN\fP
-(with no spaces).
-
-To test that email is being sent correctly, use the \'\-M test\'
-Directive described below to send one test email message on
-\fBsmartd\fP
-startup.
-
-By default, email is sent using the system
-.B mail
-command. In order that
-\fBsmartd\fP
-find the mail command (normally /bin/mail) an executable named
-.B \'mail\'
-must be in the path of the shell or environment from which
-\fBsmartd\fP
-was started. If you wish to specify an explicit path to the mail
-executable (for example /usr/local/bin/mail) or a custom script to
-run, please use the \'\-M exec\' Directive below.
-
-Note that by default under Solaris, in the previous paragraph,
-\'\fBmailx\fP\' and \'\fB/bin/mailx\fP\' are used, since Solaris
-\'/bin/mail\' does not accept a \'\-s\' (Subject) command-line
-argument.
-
-On Windows, the \'\fBBlat\fP\' mailer
-(\fBhttp://blat.sourceforge.net/\fP) is used by default.
-This mailer uses a different command line syntax, see
-\'\-M exec\' below.
-
-Note also that there is a special argument
-.B <nomailer>
-which can be given to the \'\-m\' Directive in conjunction with the \'\-M
-exec\' Directive. Please see below for an explanation of its effect.
-
-If the mailer or the shell running it produces any STDERR/STDOUT
-output, then a snippet of that output will be copied to SYSLOG. The
-remainder of the output is discarded. If problems are encountered in
-sending mail, this should help you to understand and fix them. If
-you have mail problems, we recommend running \fBsmartd\fP in debug
-mode with the \'-d\' flag, using the \'-M test\' Directive described
-below.
-
-The following extension is available on Windows:
-By specifying \'\fBmsgbox\fP\' as a mail address, a warning
-"email" is displayed as a message box on the screen.
-Using both \'\fBmsgbox\fP\' and regular mail addresses is possible,
-if \'\fBmsgbox\fP\' is the first word in the comma separated list.
-With \'\fBsysmsgbox\fP\', a system modal (always on top) message box
-is used. If running as a service, a service notification message box
-(always shown on current visible desktop) is used.
-
-.TP
-.B \-M TYPE
-These Directives modify the behavior of the
-\fBsmartd\fP
-email warnings enabled with the \'\-m\' email Directive described above.
-These \'\-M\' Directives only work in conjunction with the \'\-m\'
-Directive and can not be used without it.
-
-Multiple \-M Directives may be given. If conflicting \-M Directives
-are given (example: \-M once \-M daily) then the final one (in the
-example, \-M daily) is used.
-
-The valid arguments to the \-M Directive are:
-
-.I once
-\- send only one warning email for each type of disk problem detected. This
-is the default.
-
-.I daily
-\- send additional warning reminder emails, once per day, for each type
-of disk problem detected.
-
-.I diminishing
-\- send additional warning reminder emails, after a one-day interval,
-then a two-day interval, then a four-day interval, and so on for each
-type of disk problem detected. Each interval is twice as long as the
-previous interval.
-
-.I test
-\- send a single test email
-immediately upon
-\fBsmartd\fP
-startup. This allows one to verify that email is delivered correctly.
-
-.I exec PATH
-\- run the executable PATH instead of the default mail command, when
-\fBsmartd\fP
-needs to send email. PATH must point to an executable binary file or
-script.
-
-By setting PATH to point to a customized script, you can make
-\fBsmartd\fP perform useful tricks when a disk problem is detected
-(beeping the console, shutting down the machine, broadcasting warnings
-to all logged-in users, etc.) But please be careful. \fBsmartd\fP
-will \fBblock\fP until the executable PATH returns, so if your
-executable hangs, then \fBsmartd\fP will also hang. Some sample
-scripts are included in
-/usr/local/share/doc/smartmontools-5.1/examplescripts/.
-
-The return status of the executable is recorded by \fBsmartd\fP in
-SYSLOG. The executable is not expected to write to STDOUT or
-STDERR. If it does, then this is interpreted as indicating that
-something is going wrong with your executable, and a fragment of this
-output is logged to SYSLOG to help you to understand the problem.
-Normally, if you wish to leave some record behind, the executable
-should send mail or write to a file or device.
-
-Before running the executable, \fBsmartd\fP sets a number of
-environment variables. These environment variables may be used to
-control the executable\'s behavior. The environment variables
-exported by \fBsmartd\fP are:
-.RS 7
-.IP \fBSMARTD_MAILER\fP 4
-is set to the argument of \-M exec, if present or else to \'mail\'
-(examples: /bin/mail, mail).
-.IP \fBSMARTD_DEVICE\fP 4
-is set to the device path (examples: /dev/hda, /dev/sdb).
-.IP \fBSMARTD_DEVICETYPE\fP 4
-is set to the device type (possible values: ata, scsi, 3ware,N). Here
-N=0,...,15 denotes the ATA disk behind a 3ware RAID controller.
-.IP \fBSMARTD_DEVICESTRING\fP 4
-is set to the device description. For SMARTD_DEVICETYPE of ata or
-scsi, this is the same as SMARTD_DEVICE. For 3ware RAID controllers,
-the form used is \'/dev/sdc [3ware_disk_01]\'. In this case the device
-string contains a space and is NOT quoted. So to use
-$SMARTD_DEVICESTRING in a bash script you should probably enclose it
-in double quotes.
-.IP \fBSMARTD_FAILTYPE\fP 4
-gives the reason for the warning or message email. The possible values that
-it takes and their meanings are:
-.nf
-.fi
-\fIEmailTest\fP: this is an email test message.
-.nf
-.fi
-\fIHealth\fP: the SMART health status indicates imminent failure.
-.nf
-.fi
-\fIUsage\fP: a usage Attribute has failed.
-.nf
-.fi
-\fISelfTest\fP: the number of self-test failures has increased.
-.nf
-.fi
-\fIErrorCount\fP: the number of errors in the ATA error log has increased.
-.nf
-.fi
-\fICurrentPendingSector\fP: one of more disk sectors could not be
-read and are marked to be reallocated (replaced with spare sectors).
-.nf
-.fi
-\fIOfflineUncorrectableSector\fP: during off\-line testing, or self\-testing,
-one or more disk sectors could not be read.
-.nf
-.fi
-\fIFailedHealthCheck\fP: the SMART health status command failed.
-.nf
-.fi
-\fIFailedReadSmartData\fP: the command to read SMART Attribute data failed.
-.nf
-.fi
-\fIFailedReadSmartErrorLog\fP: the command to read the SMART error log failed.
-.nf
-.fi
-\fIFailedReadSmartSelfTestLog\fP: the command to read the SMART self-test log failed.
-.nf
-.fi
-\fIFailedOpenDevice\fP: the open() command to the device failed.
-.IP \fBSMARTD_ADDRESS\fP 4
-is determined by the address argument ADD of the \'\-m\' Directive.
-If ADD is \fB<nomailer>\fP, then \fBSMARTD_ADDRESS\fP is not set.
-Otherwise, it is set to the comma-separated-list of email addresses
-given by the argument ADD, with the commas replaced by spaces
-(example:admin@example.com root). If more than one email address is
-given, then this string will contain space characters and is NOT
-quoted, so to use it in a bash script you may want to enclose it in
-double quotes.
-.IP \fBSMARTD_MESSAGE\fP 4
-is set to the one sentence summary warning email message string from
-\fBsmartd\fP.
-This message string contains space characters and is NOT quoted. So to
-use $SMARTD_MESSAGE in a bash script you should probably enclose it in
-double quotes.
-.IP \fBSMARTD_FULLMESSAGE\fP 4
-is set to the contents of the entire email warning message string from
-\fBsmartd\fP.
-This message string contains space and return characters and is NOT quoted. So to
-use $SMARTD_FULLMESSAGE in a bash script you should probably enclose it in
-double quotes.
-.IP \fBSMARTD_TFIRST\fP 4
-is a text string giving the time and date at which the first problem
-of this type was reported. This text string contains space characters
-and no newlines, and is NOT quoted. For example:
-.nf
-.fi
-Sun Feb 9 14:58:19 2003 CST
-.IP \fBSMARTD_TFIRSTEPOCH\fP 4
-is an integer, which is the unix epoch (number of seconds since Jan 1,
-1970) for \fBSMARTD_TFIRST\fP.
-.RE
-.\" The following two lines are a workaround for a man2html bug. Please leave them.
-.\" They define a non-existent option; useful because man2html can't correctly reset the margins.
-.TP
-.B \&
-The shell which is used to run PATH is system-dependent. For vanilla
-Linux/glibc it\'s bash. For other systems, the man page for
-\fBpopen\fP(3) should say what shell is used.
-
-If the \'\-m ADD\' Directive is given with a normal address argument,
-then the executable pointed to by PATH will be run in a shell with
-STDIN receiving the body of the email message, and with the same
-command-line arguments:
-.nf
--s "$SMARTD_SUBJECT" $SMARTD_ADDRESS
-.fi
-that would normally be provided to \'mail\'. Examples include:
-.nf
-.B -m user@home -M exec /bin/mail
-.B -m admin@work -M exec /usr/local/bin/mailto
-.B -m root -M exec /Example_1/bash/script/below
-.fi
-
-Note that on Windows, the syntax of the \'\fBBlat\fP\' mailer is
-used:
-.nf
-- -q -subject "$SMARTD_SUBJECT" -to "$SMARTD_ADDRESS"
-.fi
-
-If the \'\-m ADD\' Directive is given with the special address argument
-.B <nomailer>
-then the executable pointed to by PATH is run in a shell with
-.B no
-STDIN and
-.B no
-command-line arguments, for example:
-.nf
-.B -m <nomailer> -M exec /Example_2/bash/script/below
-.fi
-If the executable produces any STDERR/STDOUT output, then \fBsmartd\fP
-assumes that something is going wrong, and a snippet of that output
-will be copied to SYSLOG. The remainder of the output is then
-discarded.
-
-Some EXAMPLES of scripts that can be used with the \'\-M exec\'
-Directive are given below. Some sample scripts are also included in
-/usr/local/share/doc/smartmontools-5.1/examplescripts/.
-
-.TP
-.B \-f
-Check for \'failure\' of any Usage Attributes. If these Attributes are
-less than or equal to the threshold, it does NOT indicate imminent
-disk failure. It "indicates an advisory condition where the usage or
-age of the device has exceeded its intended design life period."
-[Please see the \fBsmartctl \-A\fP command-line option.]
-.TP
-.B \-p
-Report anytime that a Prefail Attribute has changed
-its value since the last check, 30 minutes ago. [Please see the
-.B smartctl \-A
-command-line option.]
-.TP
-.B \-u
-Report anytime that a Usage Attribute has changed its value
-since the last check, 30 minutes ago. [Please see the
-.B smartctl \-A
-command-line option.]
-.TP
-.B \-t
-Equivalent to turning on the two previous flags \'\-p\' and \'\-u\'.
-Tracks changes in \fIall\fP device Attributes (both Prefailure and
-Usage). [Please see the \fBsmartctl\fP \-A command-line option.]
-.TP
-.B \-i ID
-Ignore device Attribute number \fBID\fP when checking for failure of
-Usage Attributes. \fBID\fP must be a decimal integer in the range
-from 1 to 255. This Directive modifies the behavior of the \'\-f\'
-Directive and has no effect without it.
-
-This is useful, for example, if you have a very old disk and don\'t
-want to keep getting messages about the hours-on-lifetime Attribute
-(usually Attribute 9) failing. This Directive may appear multiple
-times for a single device, if you want to ignore multiple Attributes.
-.TP
-.B \-I ID
-Ignore device Attribute \fBID\fP when tracking changes in the
-Attribute values. \fBID\fP must be a decimal integer in the range
-from 1 to 255. This Directive modifies the behavior of the \'\-p\',
-\'\-u\', and \'\-t\' tracking Directives and has no effect without one
-of them.
-
-This is useful, for example, if one of the device Attributes is the disk
-temperature (usually Attribute 194 or 231). It\'s annoying to get reports
-each time the temperature changes. This Directive may appear multiple
-times for a single device, if you want to ignore multiple Attributes.
-.TP
-.B \-r ID
-When tracking, report the \fIRaw\fP value of Attribute \fBID\fP along
-with its (normally reported) \fINormalized\fP value. \fBID\fP must be
-a decimal integer in the range from 1 to 255. This Directive modifies
-the behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives
-and has no effect without one of them. This Directive may be given
-multiple times.
-
-A common use of this Directive is to track the device Temperature
-(often ID=194 or 231).
-
-.TP
-.B \-R ID
-When tracking, report whenever the \fIRaw\fP value of Attribute
-\fBID\fP changes. (Normally \fBsmartd\fP only tracks/reports changes
-of the \fINormalized\fP Attribute values.) \fBID\fP must be a decimal
-integer in the range from 1 to 255. This Directive modifies the
-behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives and
-has no effect without one of them. This Directive may be given
-multiple times.
-
-If this Directive is given, it automatically implies the \'\-r\'
-Directive for the same Attribute, so that the Raw value of the
-Attribute is reported.
-
-A common use of this Directive is to track the device Temperature
-(often ID=194 or 231). It is also useful for understanding how
-different types of system behavior affects the values of certain
-Attributes.
-
-.TP
-.B \-C ID
-[ATA only] Report if the current number of pending sectors is
-non-zero. Here \fBID\fP is the id number of the Attribute whose raw
-value is the Current Pending Sector count. The allowed range of
-\fBID\fP is 0 to 255 inclusive. To turn off this reporting, use
-ID\ =\ 0. If the \fB\-C ID\fP option is not given, then it defaults to
-\fB\-C 197\fP (since Attribute 197 is generally used to monitor
-pending sectors).
-
-A pending sector is a disk sector (containing 512 bytes of your data)
-which the device would like to mark as ``bad" and reallocate.
-Typically this is because your computer tried to read that sector, and
-the read failed because the data on it has been corrupted and has
-inconsistent Error Checking and Correction (ECC) codes. This is
-important to know, because it means that there is some unreadable data
-on the disk. The problem of figuring out what file this data belongs
-to is operating system and file system specific. You can typically
-force the sector to reallocate by writing to it (translation: make the
-device substitute a spare good sector for the bad one) but at the
-price of losing the 512 bytes of data stored there.
-
-.TP
-.B \-U ID
-[ATA only] Report if the number of offline uncorrectable sectors is
-non-zero. Here \fBID\fP is the id number of the Attribute whose raw
-value is the Offline Uncorrectable Sector count. The allowed range of
-\fBID\fP is 0 to 255 inclusive. To turn off this reporting, use
-ID\ =\ 0. If the \fB\-U ID\fP option is not given, then it defaults to
-\fB\-U 198\fP (since Attribute 198 is generally used to monitor
-offline uncorrectable sectors).
-
-
-An offline uncorrectable sector is a disk sector which was not
-readable during an off\-line scan or a self\-test. This is important
-to know, because if you have data stored in this disk sector, and you
-need to read it, the read will fail. Please see the previous \'\-C\'
-option for more details.
-
-.TP
-.B \-F TYPE
-[ATA only] Modifies the behavior of \fBsmartd\fP to compensate for
-some known and understood device firmware bug. The arguments to this
-Directive are exclusive, so that only the final Directive given is
-used. The valid values are:
-
-.I none
-\- Assume that the device firmware obeys the ATA specifications. This is
-the default, unless the device has presets for \'\-F\' in the device
-database.
-
-.I samsung
-\- In some Samsung disks (example: model SV4012H Firmware Version:
-RM100-08) some of the two- and four-byte quantities in the SMART data
-structures are byte-swapped (relative to the ATA specification).
-Enabling this option tells \fBsmartd\fP to evaluate these quantities
-in byte-reversed order. Some signs that your disk needs this option
-are (1) no self-test log printed, even though you have run self-tests;
-(2) very large numbers of ATA errors reported in the ATA error log;
-(3) strange and impossible values for the ATA error log timestamps.
-
-.I samsung2
-\- In more recent Samsung disks (firmware revisions ending in "\-23") the
-number of ATA errors reported is byte swapped. Enabling this option
-tells \fBsmartd\fP to evaluate this quantity in byte-reversed order.
-
-Note that an explicit \'\-F\' Directive will over-ride any preset
-values for \'\-F\' (see the \'\-P\' option below).
-
-
-[Please see the \fBsmartctl \-F\fP command-line option.]
-
-.TP
-.B \-v N,OPTION
-Modifies the labeling for Attribute N, for disks which use
-non-standard Attribute definitions. This is useful in connection with
-the Attribute tracking/reporting Directives.
-
-This Directive may appear multiple times. Valid arguments to this
-Directive are:
-
-.I 9,minutes
-\- Raw Attribute number 9 is power-on time in minutes. Its raw value
-will be displayed in the form \'Xh+Ym\'. Here X is hours, and Y is
-minutes in the range 0-59 inclusive. Y is always printed with two
-digits, for example \'06\' or \'31\' or \'00\'.
-
-.I 9,seconds
-\- Raw Attribute number 9 is power-on time in seconds. Its raw value
-will be displayed in the form \'Xh+Ym+Zs\'. Here X is hours, Y is
-minutes in the range 0-59 inclusive, and Z is seconds in the range
-0-59 inclusive. Y and Z are always printed with two digits, for
-example \'06\' or \'31\' or \'00\'.
-
-.I 9,halfminutes
-\- Raw Attribute number 9 is power-on time, measured in units of 30
-seconds. This format is used by some Samsung disks. Its raw value
-will be displayed in the form \'Xh+Ym\'. Here X is hours, and Y is
-minutes in the range 0-59 inclusive. Y is always printed with two
-digits, for example \'06\' or \'31\' or \'00\'.
-
-.I 9,temp
-\- Raw Attribute number 9 is the disk temperature in Celsius.
-
-.I 192,emergencyretractcyclect
-\- Raw Attribute number 192 is the Emergency Retract Cycle Count.
-
-.I 193,loadunload
-\- Raw Attribute number 193 contains two values. The first is the
-number of load cycles. The second is the number of unload cycles.
-The difference between these two values is the number of times that
-the drive was unexpectedly powered off (also called an emergency
-unload). As a rule of thumb, the mechanical stress created by one
-emergency unload is equivalent to that created by one hundred normal
-unloads.
-
-.I 194,10xCelsius
-\- Raw Attribute number 194 is ten times the disk temperature in
-Celsius. This is used by some Samsung disks (example: model SV1204H
-with RK100-13 firmware).
-
-.I 194,unknown
-\- Raw Attribute number 194 is NOT the disk temperature, and its
-interpretation is unknown. This is primarily useful for the -P
-(presets) Directive.
-
-.I 198,offlinescanuncsectorct
-\- Raw Attribute number 198 is the Offline Scan UNC Sector Count.
-
-.I 200,writeerrorcount
-\- Raw Attribute number 200 is the Write Error Count.
-
-.I 201,detectedtacount
-\- Raw Attribute number 201 is the Detected TA Count.
-
-.I 220,temp
-\- Raw Attribute number 220 is the disk temperature in Celsius.
-
-Note: a table of hard drive models, listing which Attribute
-corresponds to temperature, can be found at:
-http://coredump.free.fr/linux/hddtemp.db
-
-.I N,raw8
-\- Print the Raw value of Attribute N as six 8-bit unsigned base-10
-integers. This may be useful for decoding the meaning of the Raw
-value. The form \'N,raw8\' prints Raw values for ALL Attributes in this
-form. The form (for example) \'123,raw8\' only prints the Raw value for
-Attribute 123 in this form.
-
-.I N,raw16
-\- Print the Raw value of Attribute N as three 16-bit unsigned base-10
-integers. This may be useful for decoding the meaning of the Raw
-value. The form \'N,raw16\' prints Raw values for ALL Attributes in this
-form. The form (for example) \'123,raw16\' only prints the Raw value for
-Attribute 123 in this form.
-
-.I N,raw48
-\- Print the Raw value of Attribute N as a 48-bit unsigned base-10
-integer. This may be useful for decoding the meaning of the Raw
-value. The form \'N,raw48\' prints Raw values for ALL Attributes in
-this form. The form (for example) \'123,raw48\' only prints the Raw
-value for Attribute 123 in this form.
-
-.TP
-.B \-P TYPE
-Specifies whether
-\fBsmartd\fP
-should use any preset options that are available for this drive. The
-valid arguments to this Directive are:
-
-.I use
-\- use any presets that are available for this drive. This is the default.
-
-.I ignore
-\- do not use any presets for this drive.
-
-.I show
-\- show the presets listed for this drive in the database.
-
-.I showall
-\- show the presets that are available for all drives and then exit.
-
-[Please see the
-.B smartctl \-P
-command-line option.]
-
-.TP
-.B \-a
-Equivalent to turning on all of the following Directives:
-.B \'\-H\'
-to check the SMART health status,
-.B \'\-f\'
-to report failures of Usage (rather than Prefail) Attributes,
-.B \'\-t\'
-to track changes in both Prefailure and Usage Attributes,
-.B \'\-l\ selftest\'
-to report increases in the number of Self-Test Log errors,
-.B \'\-l\ error\'
-to report increases in the number of ATA errors,
-.B \'\-C 197\'
-to report nonzero values of the current pending sector count, and
-.B \'\-U 198\'
-to report nonzero values of the offline pending sector count.
-
-Note that \-a is the default for ATA devices. If none of these other
-Directives is given, then \-a is assumed.
-
-.TP
-.B #
-Comment: ignore the remainder of the line.
-.TP
-.B \e
-Continuation character: if this is the last non-white or non-comment
-character on a line, then the following line is a continuation of the current
-one.
-.PP
-If you are not sure which Directives to use, I suggest experimenting
-for a few minutes with
-.B smartctl
-to see what SMART functionality your disk(s) support(s). If you do
-not like voluminous syslog messages, a good choice of
-\fBsmartd\fP
-configuration file Directives might be:
-.nf
-.B \-H \-l\ selftest \-l\ error \-f.
-.fi
-If you want more frequent information, use:
-.B -a.
-
-.TP
-.B ADDITIONAL DETAILS ABOUT DEVICESCAN
-If the first non-comment entry in the configuration file is the text
-string \fBDEVICESCAN\fP in capital letters, then \fBsmartd\fP will
-ignore any remaining lines in the configuration file, and will scan
-for devices.
-
-If \fBDEVICESCAN\fP is not followed by any Directives, then smartd
-will scan for both ATA and SCSI devices, and will monitor all possible
-SMART properties of any devices that are found.
-
-\fBDEVICESCAN\fP may optionally be followed by any valid Directives,
-which will be applied to all devices that are found in the scan. For
-example
-.nf
-.B DEVICESCAN -m root@example.com
-.fi
-will scan for all devices, and then monitor them. It will send one
-email warning per device for any problems that are found.
-.nf
-.B DEVICESCAN -d ata -m root@example.com
-.fi
-will do the same, but restricts the scan to ATA devices only.
-.nf
-.B DEVICESCAN -H -d ata -m root@example.com
-.fi
-will do the same, but only monitors the SMART health status of the
-devices, (rather than the default \-a, which monitors all SMART
-properties).
-
-.TP
-.B EXAMPLES OF SHELL SCRIPTS FOR \'\-M exec\'
-These are two examples of shell scripts that can be used with the \'\-M
-exec PATH\' Directive described previously. The paths to these scripts
-and similar executables is the PATH argument to the \'\-M exec PATH\'
-Directive.
-
-Example 1: This script is for use with \'\-m ADDRESS -M exec PATH\'. It appends
-the output of
-.B smartctl -a
-to the output of the smartd email warning message and sends it to ADDRESS.
-
-.nf
-\fB
-#! /bin/bash
-
-# Save the email message (STDIN) to a file:
-cat > /root/msg
-
-# Append the output of smartctl -a to the message:
-/usr/local/sbin/smartctl -a -d $SMART_DEVICETYPE $SMARTD_DEVICE >> /root/msg
-
-# Now email the message to the user at address ADD:
-/bin/mail -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS < /root/msg
-\fP
-.fi
-
-Example 2: This script is for use with \'\-m <nomailer> \-M exec
-PATH\'. It warns all users about a disk problem, waits 30 seconds, and
-then powers down the machine.
-
-.nf
-\fB
-#! /bin/bash
-
-# Warn all users of a problem
-wall \'Problem detected with disk: \' "$SMARTD_DEVICESTRING"
-wall \'Warning message from smartd is: \' "$SMARTD_MESSAGE"
-wall \'Shutting down machine in 30 seconds... \'
-
-# Wait half a minute
-sleep 30
-
-# Power down the machine
-/sbin/shutdown -hf now
-\fP
-.fi
-
-Some example scripts are distributed with the smartmontools package,
-in /usr/local/share/doc/smartmontools-5.1/examplescripts/.
-
-Please note that these scripts typically run as root, so any files
-that they read/write should not be writable by ordinary users or
-reside in directories like /tmp that are writable by ordinary users
-and may expose your system to symlink attacks.
-
-As previously described, if the scripts write to STDOUT or STDERR,
-this is interpreted as indicating that there was an internal error
-within the script, and a snippet of STDOUT/STDERR is logged to SYSLOG.
-The remainder is flushed.
-
-.\" ENDINCLUDE
-.\" DO NOT MODIFY THIS OR PREVIOUS/NEXT LINES. THIS DEFINES THE
-.\" END OF THE INCLUDED SECTION FROM smartd.8.in
-
-.PP
-.SH AUTHOR
-\fBBruce Allen\fP smartmontools-support@lists.sourceforge.net
-.fi
-University of Wisconsin \- Milwaukee Physics Department
-
-.PP
-.SH CONTRIBUTORS
-The following have made large contributions to smartmontools:
-.nf
-\fBCasper Dik\fP (Solaris SCSI interface)
-\fBChristian Franke\fP (Windows interface)
-\fBDouglas Gilbert\fP (SCSI subsystem)
-\fBGuido Guenther\fP (Autoconf/Automake packaging)
-\fBGeoffrey Keating\fP (Darwin ATA interface)
-\fBEduard Martinescu\fP (FreeBSD interface)
-\fBFr\*'ed\*'eric L. W. Meunier\fP (Web site and Mailing list)
-\fBKeiji Sawada\fP (Solaris ATA interface)
-\fBSergey Svishchev\fP (NetBSD interface)
-\fBDavid Snyder and Sergey Svishchev\fP (OpenBSD interface)
-\fBPhil Williams\fP (User interface and drive database)
-.fi
-Many other individuals have made smaller contributions and corrections.
-
-.PP
-.SH CREDITS
-.fi
-This code was derived from the smartsuite package, written by Michael
-Cornwell, and from the previous ucsc smartsuite package. It extends
-these to cover ATA-5 disks. This code was originally developed as a
-Senior Thesis by Michael Cornwell at the Concurrent Systems Laboratory
-(now part of the Storage Systems Research Center), Jack Baskin School
-of Engineering, University of California, Santa
-Cruz. \fBhttp://ssrc.soe.ucsc.edu/\fP .
-.SH
-HOME PAGE FOR SMARTMONTOOLS:
-.fi
-Please see the following web site for updates, further documentation, bug
-reports and patches:
-.nf
-.B
-http://smartmontools.sourceforge.net/
-
-.SH
-SEE ALSO:
-\fBsmartd\fP(8), \fBsmartctl\fP(8), \fBsyslogd\fP(8),
-\fBsyslog.conf\fP(5), \fBbadblocks\fP(8), \fBide\-smart\fP(8), \fBregex\fP(7).
-
-.SH
-CVS ID OF THIS PAGE:
-$Id: smartd.conf.5.in,v 1.65 2004/09/07 13:01:51 ballen4705 Exp $
+++ /dev/null
-.ig
- Copyright (C) 2002-4 Bruce Allen <smartmontools-support@lists.sourceforge.net>
-
- $Id: smartctl.8.in,v 1.64 2004/09/10 04:13:41 ballen4705 Exp $
-
- This program is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the Free
- Software Foundation; either version 2, or (at your option) any later
- version.
-
- You should have received a copy of the GNU General Public License (for
- example COPYING); if not, write to the Free Software Foundation, Inc., 675
- Mass Ave, Cambridge, MA 02139, USA.
-
- This code was originally developed as a Senior Thesis by Michael Cornwell
- at the Concurrent Systems Laboratory (now part of the Storage Systems
- Research Center), Jack Baskin School of Engineering, University of
- California, Santa Cruz. http://ssrc.soe.ucsc.edu/
-
-..
-.TH SMARTCTL 8 CURRENT_CVS_DATE CURRENT_CVS_VERSION CURRENT_CVS_DATE
-.SH NAME
-\fBsmartctl\fP \- Control and Monitor Utility for SMART Disks
-
-.SH SYNOPSIS
-.B smartctl [options] device
-
-.SH FULL PATH
-.B /usr/local/sbin/smartctl
-
-.SH PACKAGE VERSION
-CURRENT_CVS_VERSION released CURRENT_CVS_DATE at CURRENT_CVS_TIME
-
-.SH DESCRIPTION
-\fBsmartctl\fP controls the Self\-Monitoring, Analysis and Reporting
-Technology (SMART) system built into many ATA\-3 and later ATA, IDE and
-SCSI\-3 hard drives. The purpose of SMART is to monitor the reliability
-of the hard drive and predict drive failures, and to carry out
-different types of drive self\-tests. This version of \fBsmartctl\fP
-is compatible with ATA/ATAPI\-7 and earlier standards (see REFERENCES
-below)
-
-\fBsmartctl\fP is a command line utility designed to perform SMART
-tasks such as printing the SMART self\-test and error logs, enabling
-and disabling SMART automatic testing, and initiating device
-self\-tests. Note: if the user issues a SMART command that is
-(apparently) not implemented by the device, \fBsmartctl\fP will print
-a warning message but issue the command anyway (see the \fB\-T,
-\-\-tolerance\fP option below). This should not cause problems: on
-most devices, unimplemented SMART commands issued to a drive are
-ignored and/or return an error.
-
-\fBsmartctl\fP also provides support for polling TapeAlert messages
-from SCSI tape drives and changers.
-
-The user must specify the device to be controlled or interrogated as
-the final argument to \fBsmartctl\fP. Device paths are as follows:
-.IP \fBLINUX\fP: 9
-Use the forms \fB"/dev/hd[a\-t]"\fP for IDE/ATA
-devices, and \fB"/dev/sd[a\-z]"\fP for SCSI devices. For
-SCSI Tape Drives and Changers with TapeAlert support use the devices
-\fB"/dev/nst*"\fP and \fB"/dev/sg*"\fP.
-More general paths (such as devfs ones) may also be specified.
-.IP \fBDARWIN\fP: 9
-Use the forms \fB/dev/disk[0\-9]\fP or equivalently \fBdisk[0\-9]\fP or equivalently
-\fB/dev/rdisk[0\-9]\fP. Long forms are also available: please use \'\-h\' to see some
-examples. Note that there is currently no Darwin SCSI support.
-.IP \fBFREEBSD\fP: 9
-Use the forms \fB"/dev/ad[0\-9]+"\fP for IDE/ATA
-devices and \fB"/dev/da[0\-9]+"\fP for SCSI devices.
-.IP \fBNETBSD/OPENBSD\fP: 9
-Use the form \fB"/dev/wd[0\-9]+c"\fP for IDE/ATA
-devices. For SCSI disk and tape devices, use the device names
-\fB"/dev/sd[0\-9]+c"\fP and \fB"/dev/st[0\-9]+c"\fP respectively.
-Be sure to specify the correct "whole disk" partition letter for
-your architecture.
-.IP \fBSOLARIS\fP: 9
-Use the forms \fB"/dev/rdsk/c?t?d?s?"\fP for IDE/ATA and SCSI disk
-devices, and \fB"/dev/rmt/*"\fP for SCSI tape devices.
-.IP \fBWINDOWS\fP: 9
-Use the forms \fB"/dev/hd[a\-j]"\fP for IDE/ATA devices
-"\\\\.\\PhysicalDrive[0\-9]" on WinNT4/2000/XP,
-\fB"/dev/hd[a\-d]"\fP for standard IDE/ATA devices on Win95/98/98SE/ME,
-and \fB"/dev/scsi[0\-9][0\-f]"\fP for SCSI devices on ASPI adapter 0\-9, ID 0\-15.
-The prefix \fB"/dev/"\fP is optional.
-.IP \fBCYGWIN\fP: 9
-See "WINDOWS" above.
-.PP
-Based on the device path, \fBsmartctl\fP will guess the device type
-(ATA or SCSI). If necessary, the \'\-d\' option can be used to over\-ride
-this guess
-
-Note that the printed output of \fBsmartctl\fP displays most numerical
-values in base 10 (decimal), but some values are displayed in base 16
-(hexidecimal). To distinguish them, the base 16 values are always
-displayed with a leading \fB"0x"\fP, for example: "0xff". This man
-page follows the same convention.
-
-.PP
-.SH OPTIONS
-.PP
-The options are grouped below into several categories. \fBsmartctl\fP
-will execute the corresponding commands in the order: INFORMATION,
-ENABLE/DISABLE, DISPLAY DATA, RUN/ABORT TESTS.
-
-SCSI devices only accept the options \fB\-h, \-V, \-i, \-a, \-A, \-d,
-\-s, \-S,\-H, \-t, \-C, \-l selftest, \-l error, \-r,\fP and
-\fB\-X\fP. TapeAlert devices only accept the options \fB\-h, \-V,
-\-i, \-a, \-A, \-d, \-s, \-S, \-t, \-l selftest, \-l error, \-r,\fP
-and \fB\-H\fP.
-
-Long options are not supported on all systems. Use
-.B \'smartctl \-h\'
-to see the available options.
-
-.TP
-.B SHOW INFORMATION OPTIONS:
-.TP
-.B \-h, \-\-help, \-\-usage
-Prints a usage message to STDOUT and exits.
-.TP
-.B \-V, \-\-version, \-\-copyright, \-\-license
-Prints version, copyright, license, home page and CVS\-id information
-for your copy of \fBsmartctl\fP to STDOUT and then exits. Please
-include this information if you are reporting bugs or problems.
-.TP
-.B \-i, \-\-info
-Prints the device model number, serial number, firmware version, and
-ATA Standard version/revision information. Says if the device
-supports SMART, and if so, whether SMART support is currently enabled
-or disabled. If the device supports Logical Block Address mode (LBA
-mode) print current user drive capacity in bytes. (If drive is has a
-user protected area reserved, or is "clipped", this may be smaller
-than the potential maximum drive capacity.)
-.TP
-.B \-a, \-\-all
-Prints all SMART information about the disk, or TapeAlert information
-about the tape drive or changer. For ATA devices this is equivalent
-to
-.nf
-\'\-H \-i \-c \-A \-l error \-l selftest -l selective\'
-.fi
-and for SCSI, this is equivalent to
-.nf
-\'\-H \-i \-A \-l error \-l selftest\'.
-.fi
-Note that for ATA disks this does \fBnot\fP enable the \'\-l
-directory\' option.
-
-.TP
-.B RUN\-TIME BEHAVIOR OPTIONS:
-.TP
-.B \-q TYPE, \-\-quietmode=TYPE
-Specifies that \fBsmartctl\fP should run in one of the two quiet modes
-described here. The valid arguments to this option are:
-
-.I errorsonly
-\- only print: For the \'\-l error\' option, if nonzero, the number
-of errors recorded in the SMART error log and the power\-on time when
-they occurred; For the \'\-l selftest\' option, errors recorded in the device
-self\-test log; For the \'\-H\' option, SMART "disk failing" status or device
-Attributes (pre\-failure or usage) which failed either now or in the
-past; For the \'\-A\' option, device Attributes (pre\-failure or usage)
-which failed either now or in the past.
-
-.I silent
-\- print no output. The only way to learn about what was found is to
-use the exit status of \fBsmartctl\fP (see RETURN VALUES below).
-.TP
-.B \-d TYPE, \-\-device=TYPE
-Specifies the type of the device. The valid arguments to this option
-are \fIata\fP, \fIscsi\fP, and \fI3ware,N\fP. If this option is not
-used then \fBsmartctl\fP will attempt to guess the device type from
-the device name.
-
-To look at ATA disks behind 3ware SCSI RAID controllers, use syntax
-such as:
-.nf
-\fBsmartctl \-a \-d 3ware,2 /dev/sda\fP
-.fi
-.nf
-\fBsmartctl \-a \-d 3ware,0 /dev/twe0\fP
-.fi
-.nf
-\fBsmartctl \-a \-d 3ware,1 /dev/twa0\fP
-.fi
-where in the argument \fI3ware,N\fP, the integer N is the disk number
-(3ware \'port\') within the 3ware ATA RAID controller. The allowed
-values of N are from 0 to 15 inclusive. The first two forms, which
-refer to devices /dev/sda-z and /dev/twe0-15, may be used with 3ware
-series 6000, 7000, and 8000 series controllers that use the 3x-xxxx
-driver. The final form, which refers to devices /dev/twa0-15, must be
-used with 3ware 9000 series controllers, which use the 3w-9xxx driver.
-
-Note that if the special character device nodes /dev/twa? and
-/dev/twe? do not exist, or exist with the incorrect major or minor
-numbers, smartctl will recreate them on the fly. Typically /dev/twa0
-refers to the first 9000-series controller, /dev/twa1 refers to the
-second 9000 series controller, and so on. Likewise /dev/twe0 refers to
-the first 6/7/8000-series controller, /dev/twa1 refers to the second
-6/7/8000 series controller, and so on.
-
-Note that for the 6/7/8000 controllers, \fBany\fP of the physical
-disks can be queried or examined using \fBany\fP of the 3ware's SCSI
-logical device /dev/sd? entries. Thus, if logical device /dev/sda is
-made up of two physical disks (3ware ports zero and one) and logical
-device /dev/sdb is made up of two other physical disks (3ware ports
-two and three) then you can examine the SMART data on \fBany\fP of the
-four physical disks using \fBeither\fP SCSI device /dev/sda \fBor\fP
-/dev/sdb. If you need to know which logical SCSI device a particular
-physical disk (3ware port) is associated with, use the dmesg or SYSLOG
-output to show which SCSI ID corresponds to a particular 3ware unit,
-and then use the 3ware CLI or 3dm tool to determine which ports
-(physical disks) correspond to particular 3ware units.
-
-If the value of N corresponds to a port that does \fBnot\fP exist on
-the 3ware controller, or to a port that does not physically have a
-disk attached to it, the behavior of \fBsmartctl\fP depends upon the
-specific controller model, firmware, Linux kernel and platform. In
-some cases you will get a warning message that the device does not
-exist. In other cases you will be presented with \'void\' data for a
-non\-existent device.
-
-Note that if the /dev/sd? addressing form is used, then older 3w\-xxxx
-drivers do not pass the "Enable Autosave"
-(\'\fB\-S on\fP\') and "Enable Automatic Offline" (\'\fB\-o on\fP\')
-commands to the disk, and produce these types of harmless syslog error
-messages instead: "\fB3w\-xxxx: tw_ioctl(): Passthru size (123392) too
-big\fP". This can be fixed by upgrading to version 1.02.00.037 or
-later of the 3w\-xxxx driver, or by applying a patch to older
-versions. See \fBhttp://smartmontools.sourceforge.net/\fP for
-instructions. Alternatively, use the character device /dev/twe0-15 interface.
-
-The selective self\-test functions (\'\-t select,A\-B\') are only supported
-using the character device interface /dev/twa0\-15 and /dev/twe0\-15.
-The necessary WRITE LOG commands can not be passed through the SCSI
-interface.
-
-.B 3ware controllers are currently ONLY supported under Linux and FreeBSD.
-
-.TP
-.B \-T TYPE, \-\-tolerance=TYPE
-Specifies how tolerant \fBsmartctl\fP should be of ATA and SMART command
-failures.
-
-The behavior of \fBsmartctl\fP depends upon whether the command is
-"\fBoptional\fP" or "\fBmandatory\fP". Here "\fBmandatory\fP" means
-"required by the ATA/ATAPI\-5 Specification if the device implements
-the SMART command set" and "\fBoptional\fP" means "not required by the
-ATA/ATAPI\-5 Specification even if the device implements the SMART
-command set." The "\fBmandatory\fP" ATA and SMART commands are: (1)
-ATA IDENTIFY DEVICE, (2) SMART ENABLE/DISABLE ATTRIBUTE AUTOSAVE, (3)
-SMART ENABLE/DISABLE, and (4) SMART RETURN STATUS.
-
-The valid arguments to this option are:
-
-.I normal
-\- exit on failure of any \fBmandatory\fP SMART command, and ignore
-all failures of \fBoptional\fP SMART commands. This is the default.
-Note that on some devices, issuing unimplemented optional SMART
-commands doesn\'t cause an error. This can result in misleading
-\fBsmartctl\fP messages such as "Feature X not implemented", followed
-shortly by "Feature X: enabled". In most such cases, contrary to the
-final message, Feature X is \fBnot\fP enabled.
-
-.I conservative
-\- exit on failure of any \fBoptional\fP SMART command.
-
-.I permissive
-\- ignore failure(s) of \fBmandatory\fP SMART commands. This option
-may be given more than once. Each additional use of this option will
-cause one more additional failure to be ignored. Note that the use of
-this option can lead to messages like "Feature X not implemented",
-followed shortly by "Error: unable to enable Feature X". In a few
-such cases, contrary to the final message, Feature X \fBis\fP enabled.
-
-.I verypermissive
-\- equivalent to giving a large number of \'\-T permissive\' options:
-ignore failures of \fBany number\fP of \fBmandatory\fP SMART commands.
-Please see the note above.
-
-.TP
-.B \-b TYPE, \-\-badsum=TYPE
-Specifies the action \fBsmartctl\fP should take if a checksum error is
-detected in the: (1) Device Identity Structure, (2) SMART Self\-Test
-Log Structure, (3) SMART Attribute Value Structure, (4) SMART
-Attribute Threshold Structure, or (5) ATA Error Log Structure.
-
-The valid arguments to this option are:
-
-.I warn
-\- report the incorrect checksum but carry on in spite of it. This is the
-default.
-
-.I exit
-\- exit \fBsmartctl\fP.
-
-.I ignore
-\- continue silently without issuing a warning.
-
-.TP
-.B \-r TYPE, \-\-report=TYPE
-Intended primarily to help \fBsmartmontools\fP developers understand
-the behavior of \fBsmartmontools\fP on non\-conforming or poorly
-conforming hardware. This option reports details of \fBsmartctl\fP
-transactions with the device. The option can be used multiple times.
-When used just once, it shows a record of the ioctl() transactions
-with the device. When used more than once, the detail of these
-ioctl() transactions are reported in greater detail. The valid
-arguments to this option are:
-
-.I ioctl
-\- report all ioctl() transactions.
-
-.I ataioctl
-\- report only ioctl() transactions with ATA devices.
-
-.I scsiioctl
-\- report only ioctl() transactions with SCSI devices. Invoking this once
-shows the SCSI commands in hex and the corresponding status. Invoking
-it a second time adds a hex listing of the first 64 bytes of data send to,
-or received from the device.
-
-Any argument may include a positive integer to specify the level of detail
-that should be reported. The argument should be followed by a comma then
-the integer with no spaces. For example,
-.I ataioctl,2
-The default
-level is 1, so \'\-r ataioctl,1\' and \'\-r ataioctl\' are equivalent.
-
-.TP
-.B SMART FEATURE ENABLE/DISABLE COMMANDS:
-.IP
-.B Note:
-if multiple options are used to both enable and disable a
-feature, then
-.B both
-the enable and disable commands will be issued. The enable command
-will always be issued
-.B before
-the corresponding disable command.
-.TP
-.B \-s VALUE, \-\-smart=VALUE
-Enables or disables SMART on device. The valid arguments to
-this option are \fIon\fP and \fIoff\fP. Note that the command \'\-s on\'
-(perhaps used with with the \'\-o on\' and \'\-S on\' options) should be placed
-in a start\-up script for your machine, for example in rc.local or rc.sysinit.
-In principle the SMART feature settings are preserved over
-power\-cycling, but it doesn\'t hurt to be sure. It is not necessary (or
-useful) to enable SMART to see the TapeAlert messages.
-.TP
-.B \-o VALUE, \-\-offlineauto=VALUE
-Enables or disables SMART automatic offline test, which scans the drive
-every four hours for disk defects. This command can be given during normal
-system operation. The valid arguments to this option are \fIon\fP
-and \fIoff\fP.
-
-Note that the SMART automatic offline test command is listed as
-"Obsolete" in every version of the ATA and ATA/ATAPI Specifications.
-It was originally part of the SFF\-8035i Revision 2.0 specification,
-but was never part of any ATA specification. However it is
-implemented and used by many vendors. [Good documentation can be found
-in IBM\'s Official Published Disk Specifications. For example the IBM
-Travelstar 40GNX Hard Disk Drive Specifications (Revision 1.1, 22
-April 2002, Publication # 1541, Document S07N\-7715\-02) page 164. You
-can also read the SFF\-8035i Specification \-\- see REFERENCES below.]
-You can tell if automatic offline testing is supported by seeing if
-this command enables and disables it, as indicated by the \'Auto
-Offline Data Collection\' part of the SMART capabilities report
-(displayed with \'\-c\').
-
-SMART provides \fBthree\fP basic categories of testing. The
-\fBfirst\fP category, called "online" testing, has no effect on the
-performance of the device. It is turned on by the \'\-s on\' option.
-
-The \fBsecond\fP category of testing is called "offline" testing. This
-type of test can, in principle, degrade the device performance. The
-\'\-o on\' option causes this offline testing to be carried out,
-automatically, on a regular scheduled basis. Normally, the disk will
-suspend offline testing while disk accesses are taking place, and then
-automatically resume it when the disk would otherwise be idle, so in
-practice it has little effect. Note that a one\-time offline test can
-also be carried out immediately upon receipt of a user command. See
-the \'\-t offline\' option below, which causes a one\-time offline test
-to be carried out immediately.
-
-The choice (made by the SFF\-8035i and ATA specification authors) of
-the word \fItesting\fP for these first two categories is unfortunate,
-and often leads to confusion. In fact these first two categories of
-online and offline testing could have been more accurately described
-as online and offline \fBdata collection\fP.
-
-The results of this automatic or immediate offline testing (data
-collection) are reflected in the values of the SMART Attributes.
-Thus, if problems or errors are detected, the values of these
-Attributes will go below their failure thresholds; some types of
-errors may also appear in the SMART error log. These are visible with
-the \'\-A\' and \'\-l error\' options respectively.
-
-Some SMART attribute values are updated only during off\-line data
-collection activities; the rest are updated during normal operation of
-the device or during both normal operation and off\-line testing. The
-Attribute value table produced by the \'\-A\' option indicates this in
-the UPDATED column. Attributes of the first type are labeled
-"Offline" and Attributes of the second type are labeled "Always".
-
-The \fBthird\fP category of testing (and the \fIonly\fP category for
-which the word \'testing\' is really an appropriate choice) is "self"
-testing. This third type of test is only performed (immediately) when
-a command to run it is issued. The \'\-t\' and \'\-X\' options can be
-used to carry out and abort such self\-tests; please see below for
-further details.
-
-Any errors detected in the self testing will be shown in the
-SMART self\-test log, which can be examined using the \'\-l selftest\'
-option.
-
-\fBNote:\fP in this manual page, the word \fB"Test"\fP is used in
-connection with the second category just described, e.g. for the
-"offline" testing. The words \fB"Self\-test"\fP are used in
-connection with the third category.
-.TP
-.B \-S VALUE, \-\-saveauto=VALUE
-Enables or disables SMART autosave of device vendor\-specific
-Attributes. The valid arguments to this option are \fIon\fP
-and \fIoff\fP. Note that this feature is preserved across disk power
-cycles, so you should only need to issue it once.
-
-For SCSI devices this toggles the value of the Global Logging Target
-Save Disabled (GLTSD) bit in the Control Mode Page. Some disk
-manufacturers set this bit by default. This prevents error counters,
-power\-up hours and other useful data from being placed in non\-volatile
-storage, so these values may be reset to zero the next time the device
-is power\-cycled. If the GLTSD bit is set then \'smartctl \-a\' will
-issue a warning. Use \fIon\fP to clear the GLTSD bit and thus enable
-saving counters to non\-volatile storage. For extreme streaming\-video
-type applications you might consider using \fIoff\fP to set the GLTSD
-bit.
-
-.TP
-.B SMART READ AND DISPLAY DATA OPTIONS:
-.TP
-.B \-H, \-\-health
-Check: Ask the device to report its SMART health status or pending
-TapeAlert messages. SMART status is based on
-information that it has gathered from online and offline
-tests, which were used to determine/update its
-SMART vendor\-specific Attribute values. TapeAlert status is obtained
-by reading the TapeAlert log page.
-
-If the device reports failing health status, this means
-.B either
-that the device has already failed,
-.B or
-that it is predicting its own failure within the next 24 hours. If
-this happens, use the \'\-a\' option to get more information, and
-.B get your data off the disk and someplace safe as soon as you can.
-.TP
-.B \-c, \-\-capabilities
-Prints only the generic SMART capabilities. These show
-what SMART features are implemented and how the device will
-respond to some of the different SMART commands. For example it
-shows if the device logs errors, if it supports offline surface
-scanning, and so on. If the device can carry out self\-tests, this
-option also shows the estimated time required to run those tests.
-
-Note that the time required to run the Self\-tests (listed in minutes)
-are fixed. However the time required to run the Immediate Offline
-Test (listed in seconds) is variable. This means that if you issue a
-command to perform an Immediate Offline test with the \'\-t offline\' option,
-then the time may jump to a larger value and then count down as the
-Immediate Offline Test is carried out. Please see REFERENCES below
-for further information about the the flags and capabilities described
-by this option.
-.TP
-.B \-A, \-\-attributes
-Prints only the vendor specific SMART Attributes. The Attributes are
-numbered from 1 to 253 and have specific names and ID numbers. For
-example Attribute 12 is "power cycle count": how many times has the
-disk been powered up.
-
-Each Attribute has a "Raw" value, printed under the heading
-"RAW_VALUE", and a "Normalized" value printed under the heading
-"VALUE". [Note: \fBsmartctl\fP prints these values in base\-10.] In
-the example just given, the "Raw Value" for Attribute 12 would be the
-actual number of times that the disk has been power\-cycled, for
-example 365 if the disk has been turned on once per day for exactly
-one year. Each vendor uses their own algorithm to convert this "Raw"
-value to a "Normalized" value in the range from 1 to 254. Please keep
-in mind that \fBsmartctl\fP only reports the different Attribute
-types, values, and thresholds as read from the device. It does
-\fBnot\fP carry out the conversion between "Raw" and "Normalized"
-values: this is done by the disk\'s firmware.
-
-The conversion from Raw value to a quantity with physical units is
-not specified by the SMART standard. In most cases, the values printed
-by \fBsmartctl\fP are sensible. For example the temperature Attribute
-generally has its raw value equal to the temperature in Celsius.
-However in some cases vendors use unusual conventions. For example
-the Hitachi disk on my laptop reports its power\-on hours in minutes,
-not hours. Some IBM disks track three temperatures rather than one, in
-their raw values. And so on.
-
-Each Attribute also has a Threshold value (whose range is 0 to 255)
-which is printed under the heading "THRESH". If the Normalized value
-is \fBless than or equal to\fP the Threshold value, then the Attribute
-is said to have failed. If the Attribute is a pre\-failure Attribute,
-then disk failure is imminent.
-
-Each Attribute also has a "Worst" value shown under the heading
-"WORST". This is the smallest (closest to failure) value that the
-disk has recorded at any time during its lifetime when SMART was
-enabled. [Note however that some vendors firmware may actually
-\fBincrease\fP the "Worst" value for some "rate\-type" Attributes.]
-
-The Attribute table printed out by \fBsmartctl\fP also shows the
-"TYPE" of the Attribute. Attributes are one of two possible types:
-Pre\-failure or Old age. Pre\-failure Attributes are ones which, if
-less than or equal to their threshold values, indicate pending disk
-failure. Old age, or usage Attributes, are ones which indicate
-end\-of\-product life from old\-age or normal aging and wearout, if
-the Attribute value is less than or equal to the threshold. \fBPlease
-note\fP: the fact that an Attribute is of type 'Pre\-fail' does
-\fBnot\fP mean that your disk is about to fail! It only has this
-meaning if the Attribute\'s current Normalized value is less than or
-equal to the threshold value.
-
-If the Attribute\'s current Normalized value is less than or equal to
-the threshold value, then the "WHEN_FAILED" column will display
-"FAILING_NOW". If not, but the worst recorded value is less than or
-equal to the threshold value, then this column will display
-"In_the_past". If the "WHEN_FAILED" column has no entry (indicated by
-a dash: \'\-\') then this Attribute is OK now (not failing) and has
-also never failed in the past.
-
-The table column labeled "UPDATED" shows if the SMART Attribute values
-are updated during both normal operation and off\-line testing, or
-only during offline testing. The former are labeled "Always" and the
-latter are labeled "Offline".
-
-So to summarize: the Raw Attribute values are the ones that might have
-a real physical interpretation, such as "Temperature Celsius",
-"Hours", or "Start\-Stop Cycles". Each manufacturer converts these,
-using their detailed knowledge of the disk\'s operations and failure
-modes, to Normalized Attribute values in the range 1\-254. The
-current and worst (lowest measured) of these Normalized Attribute
-values are stored on the disk, along with a Threshold value that the
-manufacturer has determined will indicate that the disk is going to
-fail, or that it has exceeded its design age or aging limit.
-\fBsmartctl\fP does \fBnot\fP calculate any of the Attribute values,
-thresholds, or types, it merely reports them from the SMART data on
-the device.
-
-Note that starting with ATA/ATAPI\-4, revision 4, the meaning of these
-Attribute fields has been made entirely vendor\-specific. However most
-ATA/ATAPI\-5 disks seem to respect their meaning, so we have retained
-the option of printing the Attribute values.
-
-For SCSI devices the "attributes" are obtained from the temperature
-and start-stop cycle counter log pages. Certain vendor specific
-attributes are listed if recognised. The attributes are output in a
-relatively free format (compared with ATA disk attributes).
-.TP
-.B \-l TYPE, \-\-log=TYPE
-Prints either the SMART Error Log, the SMART Self\-Test Log, the SMART
-Selective Self\-Test Log [ATA only], or the Log Directory [ATA only].
-The valid arguments to this option are:
-
-.I error
-\- prints only the SMART error log. SMART disks maintain a log of the
-most recent five non\-trivial errors. For each of these errors, the
-disk power\-on lifetime at which the error occurred is recorded, as is
-the device status (idle, standby, etc) at the time of the error. For
-some common types of errors, the Error Register (ER) and Status
-Register (SR) values are decoded and printed as text. The meanings of these
-are:
-.nf
- \fBABRT\fP: Command \fBAB\fPo\fBRT\fPed
- \fBAMNF\fP: \fBA\fPddress \fBM\fPark \fBN\fPot \fBF\fPound
- \fBCCTO\fP: \fBC\fPommand \fBC\fPompletion \fBT\fPimed \fBO\fPut
- \fBEOM\fP: \fBE\fPnd \fBO\fPf \fBM\fPedia
- \fBICRC\fP: \fBI\fPnterface \fBC\fPyclic \fBR\fPedundancy \fBC\fPode (CRC) error
- \fBIDNF\fP: \fBID\fPentity \fBN\fPot \fBF\fPound
- \fBILI\fP: (packet command\-set specific)
- \fBMC\fP: \fBM\fPedia \fBC\fPhanged
- \fBMCR\fP: \fBM\fPedia \fBC\fPhange \fBR\fPequest
- \fBNM\fP: \fBN\fPo \fBM\fPedia
- \fBobs\fP: \fBobs\fPolete
- \fBTK0NF\fP: \fBT\fPrac\fBK 0 N\fPot \fBF\fPound
- \fBUNC\fP: \fBUNC\fPorrectable Error in Data
- \fBWP\fP: Media is \fBW\fPrite \fBP\fProtected
-.fi
-In addition, up to the last five commands that preceded the error are
-listed, along with a timestamp measured from the start of the
-corresponding power cycle. This is displayed in the form
-Dd+HH:MM:SS.msec where D is the number of days, HH is hours, MM is
-minutes, SS is seconds and msec is milliseconds. [Note: this time
-stamp wraps after 2^32 milliseconds, or 49 days 17 hours 2 minutes and
-47.296 seconds.] The key ATA disk registers are also recorded in the
-log. The final column of the error log is a text\-string description
-of the ATA command defined by the Command Register (CR) and Feature
-Register (FR) values. Commands that are obsolete in the most current
-(ATA\-7) spec are listed like this: \fBREAD LONG (w/ retry) [OBS\-4]\fP,
-indicating that the command became obsolete with or in the ATA\-4
-specification. Similarly, the notation \fB[RET\-\fP\fIN\fP\fB]\fP is
-used to indicate that a command was retired in the ATA\-\fIN\fP
-specification. Some commands are not defined in any version of the
-ATA specification but are in common use nonetheless; these are marked
-\fB[NS]\fP, meaning non\-standard.
-
-The ATA Specification (ATA\-5 Revision 1c, Section 8.41.6.8.2) says:
-\fB"Error log structures shall include UNC errors, IDNF errors for
-which the address requested was valid, servo errors, write fault
-errors, etc. Error log data structures shall not include errors
-attributed to the receipt of faulty commands such as command codes not
-implemented by the device or requests with invalid parameters or
-invalid addresses."\fP The definitions of these terms are:
-.br
-\fBUNC\fP (\fBUNC\fPorrectable): data is uncorrectable. This refers
-to data which has been read from the disk, but for which the Error
-Checking and Correction (ECC) codes are inconsistent. In effect, this
-means that the data can not be read.
-.br
-\fBIDNF\fP (\fBID N\fPot \fBF\fPound): user\-accessible address could
-not be found. For READ LOG type commands, \fBIDNF\fP can also indicate
-that a device data log structure checksum was incorrect.
-
-If the command that caused the error was a READ or WRITE command, then
-the Logical Block Address (LBA) at which the error occurred will be
-printed in base 10 and base 16. The LBA is a linear address, which
-counts 512\-byte sectors on the disk, starting from zero. (Because of
-the limitations of the SMART error log, if the LBA is greater than
-0xfffffff, then either no error log entry will be made, or the error
-log entry will have an incorrect LBA. This may happen for drives with
-a capacity greater than 128 GiB or 137 GB.) On Linux systems the
-smartmontools web page has instructions about how to convert the LBA
-address to the name of the disk file containing the erroneous disk
-sector.
-
-Please note that some manufacturers \fBignore\fP the ATA
-specifications, and make entries in the error log if the device
-receives a command which is not implemented or is not valid.
-
-.I error [SCSI]
-\- prints the error counter log pages for reads, write and verifies.
-The verify row is only output if it has an element other than zero.
-
-.I selftest
-\- prints the SMART self\-test log. The disk maintains a self\-test log
-showing the results of the self tests, which can be run using the
-\'\-t\' option described below. For each of the most recent
-twenty\-one self\-tests, the log shows the type of test (short or
-extended, off\-line or captive) and the final status of the test. If
-the test did not complete successfully, then the percentage of the
-test remaining is shown. The time at which the test took place,
-measured in hours of disk lifetime, is also printed. If any errors
-were detected, the Logical Block Address (LBA) of the first error is
-printed in decimal notation. On Linux systems the smartmontools
-web page has instructions about how to convert this LBA address to the
-name of the disk file containing the erroneous block.
-
-.I selftest [SCSI]
-\- the self\-test log for a SCSI device has a slightly different format
-than for an ATA device. For each of the most recent twenty
-self\-tests, it shows the type of test and the status (final or in
-progress) of the test. SCSI standards use the terms "foreground" and
-"background" (rather than ATA\'s corresponding "captive" and
-"off\-line") and "short" and "long" (rather than ATA\'s corresponding
-"short" and "extended") to describe the type of the test. The printed
-segment number is only relevant when a test fails in the third or
-later test segment. It identifies the test that failed and consists
-of either the number of the segment that failed during the test, or
-the number of the test that failed and the number of the segment in
-which the test was run, using a vendor\-specific method of putting both
-numbers into a single byte. The Logical Block Address (LBA) of the
-first error is printed in hexadecimal notation. On Linux systems the
-smartmontools web page has instructions about how to convert this LBA
-address to the name of the disk file containing the erroneous block.
-If provided, the SCSI Sense Key (SK), Additional Sense Code (ASC) and
-Additional Sense Code Qualifier (ASQ) are also printed. The self tests
-can be run using the \'\-t\' option described below (using the ATA
-test terminology).
-
-.I selective [ATA]
-\- Some ATA\-7 disks (example: Maxtor) also maintain a selective
-self\-test log. Please see the \'\-t select\' option below for a
-description of selective self\-tests. The selective self\-test log
-shows the start/end Logical Block Addresses (LBA) of each of the five
-test spans, and their current test status. If the span is being
-tested or the remainder of the disk is being read\-scanned, the
-current 65536\-sector block of LBAs being tested is also displayed.
-The selective self\-test log also shows if a read\-scan of the
-remainder of the disk will be carried out after the selective
-self\-test has completed (see \'\-t afterselect\' option) and the time
-delay before restarting this read\-scan if it is interrupted (see
-\'\-t pending\' option). This is a new smartmontools feature; please
-report unusual or incorrect behavior to the smartmontools\-support
-mailing list.
-
-.I directory
-\- if the device supports the General Purpose Logging feature set
-(ATA\-6 and ATA\-7 only) then this prints the Log Directory (the log at
-address 0). The Log Directory shows what logs are available and their
-length in sectors (512 bytes). The contents of the logs at address 1
-[Summary SMART error log] and at address 6 [SMART self\-test log] may
-be printed using the previously\-described
-.I error
-and
-.I selftest
-arguments to this option. [Please note: this is a new, experimental
-feature. We would like to add support for printing the contents of
-extended and comprehensive SMART self\-test and error logs. If your
-disk supports these, and you would like to assist, please contact the
-\fBsmartmontools\fP developers.]
-
-.TP
-.B \-v N,OPTION, \-\-vendorattribute=N,OPTION
-Sets a vendor\-specific display OPTION for Attribute N. This option
-may be used multiple times. Valid arguments to this option are:
-
-.I help
-\- Prints (to STDOUT) a list of all valid arguments to this option,
-then exits.
-
-.I 9,minutes
-\- Raw Attribute number 9 is power\-on time in minutes. Its raw value
-will be displayed in the form "Xh+Ym". Here X is hours, and Y is
-minutes in the range 0\-59 inclusive. Y is always printed with two
-digits, for example "06" or "31" or "00".
-
-.I 9,seconds
-\- Raw Attribute number 9 is power\-on time in seconds. Its raw value
-will be displayed in the form "Xh+Ym+Zs". Here X is hours, Y is
-minutes in the range 0\-59 inclusive, and Z is seconds in the range
-0\-59 inclusive. Y and Z are always printed with two digits, for
-example "06" or "31" or "00".
-
-.I 9,halfminutes
-\- Raw Attribute number 9 is power\-on time, measured in units of 30
-seconds. This format is used by some Samsung disks. Its raw value
-will be displayed in the form "Xh+Ym". Here X is hours, and Y is
-minutes in the range 0\-59 inclusive. Y is always printed with two
-digits, for example "06" or "31" or "00".
-
-.I 9,temp
-\- Raw Attribute number 9 is the disk temperature in Celsius.
-
-.I 192,emergencyretractcyclect
-\- Raw Attribute number 192 is the Emergency Retract Cycle Count.
-
-.I 193,loadunload
-\- Raw Attribute number 193 contains two values. The first is the
-number of load cycles. The second is the number of unload cycles.
-The difference between these two values is the number of times that
-the drive was unexpectedly powered off (also called an emergency
-unload). As a rule of thumb, the mechanical stress created by one
-emergency unload is equivalent to that created by one hundred normal
-unloads.
-
-.I 194,10xCelsius
-\- Raw Attribute number 194 is ten times the disk temperature in
-Celsius. This is used by some Samsung disks (example: model SV1204H
-with RK100\-13 firmware).
-
-.I 194,unknown
-\- Raw Attribute number 194 is NOT the disk temperature, and its
-interpretation is unknown. This is primarily useful for the \-P
-(presets) option.
-
-.I 198,offlinescanuncsectorct
-\- Raw Attribute number 198 is the Offline Scan UNC Sector Count.
-
-.I 200,writeerrorcount
-\- Raw Attribute number 200 is the Write Error Count.
-
-.I 201,detectedtacount
-\- Raw Attribute number 201 is the Detected TA Count.
-
-.I 220,temp
-\- Raw Attribute number 220 is the disk temperature in Celsius.
-
-Note: a table of hard drive models, listing which Attribute
-corresponds to temperature, can be found at:
-http://coredump.free.fr/linux/hddtemp.db
-
-.I N,raw8
-\- Print the Raw value of Attribute N as six 8\-bit unsigned base\-10
-integers. This may be useful for decoding the meaning of the Raw
-value. The form \'N,raw8\' prints Raw values for ALL Attributes in this
-form. The form (for example) \'123,raw8\' only prints the Raw value for
-Attribute 123 in this form.
-
-.I N,raw16
-\- Print the Raw value of Attribute N as three 16\-bit unsigned base\-10
-integers. This may be useful for decoding the meaning of the Raw
-value. The form \'N,raw16\' prints Raw values for ALL Attributes in this
-form. The form (for example) \'123,raw16\' only prints the Raw value for
-Attribute 123 in this form.
-
-.I N,raw48
-\- Print the Raw value of Attribute N as a 48\-bit unsigned base\-10
-integer. This may be useful for decoding the meaning of the Raw
-value. The form \'N,raw48\' prints Raw values for ALL Attributes in
-this form. The form (for example) \'123,raw48\' only prints the Raw
-value for Attribute 123 in this form.
-
-.TP
-.B \-F TYPE, \-\-firmwarebug=TYPE
-Modifies the behavior of \fBsmartctl\fP to compensate for some known
-and understood device firmware bug. The arguments to this option are
-exclusive, so that only the final option given is used. The valid
-values are:
-
-.I none
-\- Assume that the device firmware obeys the ATA specifications. This
-is the default, unless the device has presets for \'\-F\' in the
-device database (see note below).
-
-.I samsung
-\- In some Samsung disks (example: model SV4012H Firmware Version:
-RM100\-08) some of the two\- and four\-byte quantities in the SMART data
-structures are byte\-swapped (relative to the ATA specification).
-Enabling this option tells \fBsmartctl\fP to evaluate these quantities
-in byte\-reversed order. Some signs that your disk needs this option
-are (1) no self\-test log printed, even though you have run self\-tests;
-(2) very large numbers of ATA errors reported in the ATA error log;
-(3) strange and impossible values for the ATA error log timestamps.
-
-.I samsung2
-\- In more recent Samsung disks (firmware revisions ending in "\-23")
-the number of ATA errors reported is byte swapped. Enabling this
-option tells \fBsmartctl\fP to evaluate this quantity in byte\-reversed
-order.
-
-Note that an explicit \'\-F\' option on the command line will
-over\-ride any preset values for \'\-F\' (see the \'\-P\' option
-below).
-
-.TP
-.B \-P TYPE, \-\-presets=TYPE
-Specifies whether \fBsmartctl\fP should use any preset options that
-are available for this drive. By default, if the drive is recognized
-in the \fBsmartmontools\fP database, then the presets are used.
-
-\fBsmartctl\fP can automatically set appropriate options for known
-drives. For example, the Maxtor 4D080H4 uses Attribute 9 to stores
-power\-on time in minutes whereas most drives use that Attribute to
-store the power\-on time in hours. The command\-line option \'\-v
-9,minutes\' ensures that \fBsmartctl\fP correctly interprets Attribute
-9 in this case, but that option is preset for the Maxtor 4D080H4 and
-so need not be specified by the user on the \fBsmartctl\fP command
-line.
-
-The argument
-.I show
-will show any preset options for your drive and the argument
-.I showall
-will show all known drives in the \fBsmartmontools\fP database, along
-with their preset options. If there are no presets for your drive and
-you think there should be (for example, a \-v or \-F option is needed
-to get \fBsmartctl\fP to display correct values) then please contact
-the \fBsmartmontools\fP developers so that this information can be
-added to the \fBsmartmontools\fP database. Contact information is at the
-end of this man page.
-
-The valid arguments to this option are:
-
-.I use
-\- if a drive is recognized, then use the stored presets for it. This
-is the default. Note that presets will NOT over\-ride additional
-Attribute interpretation (\'\-v N,something\') command\-line options or
-explicit \'\-F\' command\-line options..
-
-.I ignore
-\- do not use presets.
-
-.I show
-\- show if the drive is recognized in the database, and if so, its
-presets, then exit.
-
-.I showall
-\- list all recognized drives, and the presets that are set for them,
-then exit.
-
-.TP
-.B SMART RUN/ABORT OFFLINE TEST AND SELF\-TEST OPTIONS:
-.TP
-.B \-t TEST, \-\-test=TEST
-Executes TEST immediately. The \'\-C\' option can be used in
-conjunction with this option to run the short or long (and also for
-ATA devices, selective or conveyance) self\-tests in captive mode
-(known as "foreground mode" for SCSI devices). Note that only one
-test type can be run at a time, so only one test type should be
-specified per command line. Note also that if a computer is shutdown
-or power cycled during a self\-test, no harm should result. The
-self\-test will either be aborted or will resume automatically.
-
-The valid arguments to this option are:
-
-.I offline
-\- runs SMART Immediate Offline Test. This immediately
-starts the test described above. This command can be given during
-normal system operation. The effects of this test are visible only in
-that it updates the SMART Attribute values, and if errors are
-found they will appear in the SMART error log, visible with the \'\-l error\'
-option. [In the case of SCSI devices runs the default self test in
-foreground. No entry is placed in the self test log.]
-
-If the \'\-c\' option to \fBsmartctl\fP shows that the device has the
-"Suspend Offline collection upon new command" capability then you can
-track the progress of the Immediate Offline test using the \'\-c\'
-option to \fBsmartctl\fP. If the \'\-c\' option show that the device
-has the "Abort Offline collection upon new command" capability then
-most commands will abort the Immediate Offline Test, so you should not
-try to track the progress of the test with \'\-c\', as it will abort
-the test.
-
-.I short
-\- runs SMART Short Self Test (usually under ten minutes).
-[Note: in the case of SCSI devices,
-this command option runs the "Background short" self\-test.]
-This command can be given during normal system operation (unless run in
-captive mode \- see the \'\-C\' option below). This is a
-test in a different category than the immediate or automatic offline
-tests. The "Self" tests check the electrical and mechanical
-performance as well as the read performance of the disk. Their
-results are reported in the Self Test Error Log, readable with
-the \'\-l selftest\' option. Note that on some disks the progress of the
-self\-test can be monitored by watching this log during the self\-test; with other disks
-use the \'\-c\' option to monitor progress.
-
-.I long
-\- runs SMART Extended Self Test (tens of minutes).
-[Note: in the case of SCSI devices,
-this command option runs the "Background long" self\-test.]
-This is a
-longer and more thorough version of the Short Self Test described
-above. Note that this command can be given during normal
-system operation (unless run in captive mode \- see the \'\-C\' option below).
-
-.I conveyance
-\- [ATA ONLY] runs a SMART Conveyance Self Test (minutes). This
-self\-test routine is intended to identify damage incurred during
-transporting of the device. This self\-test routine should take on the
-order of minutes to complete. Note that this command can be given
-during normal system operation (unless run in captive mode \- see the
-\'\-C\' option below).
-
-.I select,N\-M
-
-\- [ATA ONLY] [NEW EXPERIMENTAL SMARTCTL FEATURE] runs a SMART
-Selective Self Test, to test a \fBrange\fP of disk Logical Block
-Addresses (LBAs), rather than the entire disk. Each range of LBAs
-that is checked is called a "span" and is specified by a starting LBA
-(N) and an ending LBA (M) with N less than or equal to M. For example
-the command:
-.nf
- smartctl \-t select,10\-20 /dev/hda
-.fi
-runs a self test on one span consisting of LBAs ten to twenty
-(inclusive). The \'\-t\' option can be given up to five times, to test
-up to five spans. For example the command:
-.nf
- smartctl \-t select,0\-100 \-t select,1000\-2000 /dev/hda
-.fi
-runs a self test on two spans. The first span consists of 101 LBAs
-and the second span consists of 1001 LBAs. Note that the spans can
-overlap partially or completely, for example:
-.nf
- smartctl \-t select,0\-10 \-t select,5\-15 \-t select,10\-20 /dev/hda
-.fi
-The results of the selective self\-test can be obtained (both during
-and after the test) by printing the SMART self\-test log, using the
-\'\-l selftest\' option to smartctl.
-
-Selective self tests are particularly useful as disk capacities
-increase: an extended self test (smartctl \-t long) can take several
-hours. Selective self\-tests are helpful if (based on SYSLOG error
-messages, previous failed self\-tests, or SMART error log entries) you
-suspect that a disk is having problems at a particular range of
-Logical Block Addresses (LBAs).
-
-Selective self\-tests can be run during normal system operation (unless
-done in captive mode \- see the \'\-C\' option below).
-
-[Note: this new experimental smartmontools feature is currently only
-available under Linux. The Linux kernel must be compiled with the
-configuration option CONFIG_IDE_TASKFILE_IO enabled. Please report
-unusual or incorrect behavior to the smartmontools\-support mailing
-list.]
-
-.I afterselect,on
-\- [ATA ONLY] perform an offline read scan after a Selective Self\-test
-has completed. This option must be used together with one or more of
-the \fIselect,N\-M\fP options above. If the LBAs that have been
-specified in the Selective self\-test pass the test with no errors
-found, then read scan the \fBremainder\fP of the disk. If the device
-is powered\-cycled while this read scan is in progress, the read scan
-will be automatically resumed after a time specified by the pending
-timer (see below). The value of this option is preserved between
-selective self\-tests.
-
-.I afterselect,off
-\- [ATA ONLY] do not read scan the remainder of the disk after a
-Selective self\-test has completed. This option must be use together
-with one or more of the \fIselect,N\-M\fP options above. The value of this
-option is preserved between selective self\-tests.
-
-.I pending,N
-\- [ATA ONLY] set the pending offline read scan timer to N minutes.
-Here N is an integer in the range from 0 to 65535 inclusive. If the
-device is powered off during a read scan after a Selective self\-test,
-then resume the test automatically N minutes after power\-up. This
-option must be use together with one or more of the \fIselect,N\-M\fP
-options above. The value of this option is preserved between selective
-self\-tests.
-
-.TP
-.B \-C, \-\-captive
-Runs self\-tests in captive mode. This has no effect with \'\-t
-offline\' or if the \'\-t\' option is not used. [Note: in the case of
-SCSI devices, this command option runs the self\-test in "Foreground"
-mode.]
-
-\fBWARNING: Tests run in captive mode may busy out the drive for the
-length of the test. Only run captive tests on drives without any
-mounted partitions!\fP
-
-.TP
-.B \-X, \-\-abort
-Aborts non\-captive SMART Self Tests. Note that this
-command will abort the Offline Immediate Test routine only if your
-disk has the "Abort Offline collection upon new command" capability.
-.PP
-.SH EXAMPLES
-.nf
-.B smartctl \-a /dev/hda
-.fi
-Print all SMART information for drive /dev/hda (Primary Master).
-.PP
-.nf
-.B smartctl \-s off /dev/hdd
-.fi
-Disable SMART on drive /dev/hdd (Secondary Slave).
-.PP
-.nf
-.B smartctl \-\-smart=on \-\-offlineauto=on \-\-saveauto=on /dev/hda
-.fi
-Enable SMART on drive /dev/hda, enable automatic offline
-testing every four hours, and enable autosaving of
-SMART Attributes. This is a good start\-up line for your system\'s
-init files. You can issue this command on a running system.
-.PP
-.nf
-.B smartctl \-t long /dev/hdc
-.fi
-Begin an extended self\-test of drive /dev/hdc. You can issue this
-command on a running system. The results can be seen in the self\-test
-log visible with the \'\-l selftest\' option after it has completed.
-.PP
-.nf
-.B smartctl \-s on \-t offline /dev/hda
-.fi
-Enable SMART on the disk, and begin an immediate offline test of
-drive /dev/hda. You can issue this command on a running system. The
-results are only used to update the SMART Attributes, visible
-with the \'\-A\' option. If any device errors occur, they are logged to
-the SMART error log, which can be seen with the \'\-l error\' option.
-.PP
-.nf
-.B smartctl \-A \-v 9,minutes /dev/hda
-.fi
-Shows the vendor Attributes, when the disk stores its power\-on time
-internally in minutes rather than hours.
-.PP
-.nf
-.B smartctl \-q errorsonly \-H \-l selftest /dev/hda
-.fi
-Produces output only if the device returns failing SMART status,
-or if some of the logged self\-tests ended with errors.
-.PP
-.nf
-.B smartctl \-q silent \-a /dev/hda
-.fi
-Examine all SMART data for device /dev/hda, but produce no
-printed output. You must use the exit status (the
-.B $?
-shell variable) to learn if any Attributes are out of bound, if the
-SMART status is failing, if there are errors recorded in the
-self\-test log, or if there are errors recorded in the disk error log.
-.PP
-.nf
-.B smartctl \-a \-d 3ware,0 /dev/sda
-.fi
-Examine all SMART data for the first ATA disk connected to a 3ware
-RAID controller card.
-.PP
-.nf
-.B smartctl \-t short \-d 3ware,3 /dev/sdb
-.fi
-Start a short self\-test on the fourth ATA disk connected to the 3ware RAID
-controller card which is the second SCSI device /dev/sdb.
-.nf
-.B smartctl \-t select,10\-100 \-t select,30\-300 \-t afterselect,on \-t pending,45 /dev/hda
-.fi
-Run a selective self\-test on LBAs 10 to 100 and 30 to 300. After the
-these LBAs have been tested, read\-scan the remainder of the disk. If the disk is
-power\-cycled during the read\-scan, resume the scan 45 minutes after power to the
-device is restored.
-.PP
-.SH RETURN VALUES
-The return values of \fBsmartctl\fP are defined by a bitmask. If all
-is well with the disk, the return value (exit status) of
-\fBsmartctl\fP is 0 (all bits turned off). If a problem occurs, or an
-error, potential error, or fault is detected, then a non\-zero status
-is returned. In this case, the eight different bits in the return
-value have the following meanings for ATA disks; some of these values
-may also be returned for SCSI disks.
-.TP
-.B Bit 0:
-Command line did not parse.
-.TP
-.B Bit 1:
-Device open failed, or device did not return an IDENTIFY DEVICE structure.
-.TP
-.B Bit 2:
-Some SMART command to the disk failed, or there was a checksum error
-in a SMART data structure (see \'\-b\' option above).
-.TP
-.B Bit 3:
-SMART status check returned "DISK FAILING".
-.TP
-.B Bit 4:
-SMART status check returned "DISK OK" but we found prefail Attributes <= threshold.
-.TP
-.B Bit 5:
-SMART status check returned "DISK OK" but we found that some (usage
-or prefail) Attributes have been <= threshold at some time in the
-past.
-.TP
-.B Bit 6:
-The device error log contains records of errors.
-.TP
-.B Bit 7:
-The device self\-test log contains records of errors.
-
-To test within the shell for whether or not the different bits are
-turned on or off, you can use the following type of construction (this
-is bash syntax):
-.nf
-.B smartstat=$(($? & 8))
-.fi
-This looks at only at bit 3 of the exit status
-.B $?
-(since 8=2^3). The shell variable
-$smartstat will be nonzero if SMART status check returned "disk
-failing" and zero otherwise.
-
-.PP
-.SH NOTES
-The TapeAlert log page flags are cleared for the initiator when the
-page is read. This means that each alert condition is reported only
-once by \fBsmartctl\fP for each initiator for each activation of the
-condition.
-
-.PP
-.SH AUTHOR
-\fBBruce Allen\fP smartmontools\-support@lists.sourceforge.net
-.fi
-University of Wisconsin \- Milwaukee Physics Department
-
-.PP
-.SH CONTRIBUTORS
-The following have made large contributions to smartmontools:
-.nf
-\fBCasper Dik\fP (Solaris SCSI interface)
-\fBChristian Franke\fP (Windows interface)
-\fBDouglas Gilbert\fP (SCSI subsystem)
-\fBGuido Guenther\fP (Autoconf/Automake packaging)
-\fBGeoffrey Keating\fP (Darwin ATA interface)
-\fBEduard Martinescu\fP (FreeBSD interface)
-\fBFr\*'ed\*'eric L. W. Meunier\fP (Web site and Mailing list)
-\fBKeiji Sawada\fP (Solaris ATA interface)
-\fBSergey Svishchev\fP (NetBSD interface)
-\fBDavid Snyder and Sergey Svishchev\fP (OpenBSD interface)
-\fBPhil Williams\fP (User interface and drive database)
-.fi
-Many other individuals have made smaller contributions and corrections.
-
-.PP
-.SH CREDITS
-.fi
-This code was derived from the smartsuite package, written by Michael
-Cornwell, and from the previous UCSC smartsuite package. It extends
-these to cover ATA\-5 disks. This code was originally developed as a
-Senior Thesis by Michael Cornwell at the Concurrent Systems Laboratory
-(now part of the Storage Systems Research Center), Jack Baskin School
-of Engineering, University of California, Santa
-Cruz. \fBhttp://ssrc.soe.ucsc.edu/\fP .
-.SH
-HOME PAGE FOR SMARTMONTOOLS:
-.fi
-Please see the following web site for updates, further documentation, bug
-reports and patches:
-.nf
-.B
-http://smartmontools.sourceforge.net/
-
-.SH
-SEE ALSO:
-\fBsmartd\fP(8), \fBbadblocks\fP(8), \fBide\-smart\fP(8).
-.SH
-REFERENCES FOR SMART
-.fi
-An introductory article about smartmontools is \fIMonitoring Hard
-Disks with SMART\fP, by Bruce Allen, Linux Journal, January 2004,
-pages 74-77. This is http://www.linuxjournal.com/article.php?sid=6983
-online.
-
-If you would like to understand better how SMART works, and what it
-does, a good place to start is Section 8.41 of the "AT Attachment with
-Packet Interface\-5" (ATA/ATAPI\-5) specification. This documents the
-SMART functionality which the \fBsmartmontools\fP utilities provide
-access to. You can find Revision 1 of this document at
-\fBhttp://www.t13.org/project/d1321r1c.pdf\fP .
-
-.fi
-Future versions of the specifications (ATA/ATAPI\-6 and ATA/ATAPI\-7),
-and later revisions (2, 3) of the ATA/ATAPI\-5 specification are
-available from \fBhttp://www.t13.org/#FTP_site\fP .
-
-.fi
-The functioning of SMART was originally defined by the SFF\-8035i
-revision 2 and the SFF\-8055i revision 1.4 specifications. These are
-publications of the Small Form Factors (SFF) Committee. Links to
-these documents may be found in the References section of the
-\fBsmartmontools\fP home page at
-\fBhttp://smartmontools.sourceforge.net/\fP .
-
-.SH
-CVS ID OF THIS PAGE:
-$Id: smartctl.8.in,v 1.64 2004/09/10 04:13:41 ballen4705 Exp $
-.\" Local Variables:
-.\" mode: nroff
-.\" End:
+++ /dev/null
-.ig
-Copyright (C) 2002-4 Bruce Allen <smartmontools-support@lists.sourceforge.net>
-
-$Id: smartd.8.in,v 1.87 2004/09/07 13:01:51 ballen4705 Exp $
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2, or (at your option)
-any later version.
-
-You should have received a copy of the GNU General Public License (for
-example COPYING); if not, write to the Free Software Foundation, Inc.,
-675 Mass Ave, Cambridge, MA 02139, USA.
-
-This code was originally developed as a Senior Thesis by Michael
-Cornwell at the Concurrent Systems Laboratory (now part of the Storage
-Systems Research Center), Jack Baskin School of Engineering,
-University of California, Santa Cruz. http://ssrc.soe.ucsc.edu/
-..
-.TH SMARTD 8 CURRENT_CVS_DATE CURRENT_CVS_VERSION CURRENT_CVS_DATE
-.SH NAME
-\fBsmartd\fP \- SMART Disk Monitoring Daemon
-
-.SH SYNOPSIS
-.B smartd [options]
-
-.SH FULL PATH
-.B /usr/local/sbin/smartd
-
-.SH PACKAGE VERSION
-CURRENT_CVS_VERSION released CURRENT_CVS_DATE at CURRENT_CVS_TIME
-
-.SH DESCRIPTION
-\fBsmartd\fP is a daemon that monitors the Self-Monitoring, Analysis
-and Reporting Technology (SMART) system built into many ATA-3 and
-later ATA, IDE and SCSI-3 hard drives. The purpose of SMART is to
-monitor the reliability of the hard drive and predict drive failures,
-and to carry out different types of drive self-tests. This version of
-\fBsmartd\fP is compatible with ATA/ATAPI-7 and earlier standards (see
-\fBREFERENCES\fP below).
-
-\fBsmartd\fP will attempt to enable SMART monitoring on ATA devices
-(equivalent to \fBsmartctl -s on\fP) and polls these and SCSI devices
-every 30 minutes (configurable), logging SMART errors and changes of
-SMART Attributes via the SYSLOG interface. The default location for
-these SYSLOG notifications and warnings is \fB/var/log/messages\fP.
-To change this default location, please see the \fB\'-l\'\fP
-command-line option described below.
-
-In addition to logging to a file, \fBsmartd\fP can also be configured
-to send email warnings if problems are detected. Depending upon the
-type of problem, you may want to run self\-tests on the disk, back up
-the disk, replace the disk, or use a manufacturer\'s utility to force
-reallocation of bad or unreadable disk sectors. If disk problems are
-detected, please see the \fBsmartctl\fP manual page and the
-\fBsmartmontools\fP web page/FAQ for further guidance.
-
-If you send a \fBUSR1\fP signal to \fBsmartd\fP it will immediately
-check the status of the disks, and then return to polling the disks
-every 30 minutes. See the \fB\'\-i\'\fP option below for additional
-details.
-
-\fBsmartd\fP can be configured at start-up using the configuration
-file \fB/usr/local/etc/smartd.conf\fP (Windows: \fB./smartd.conf\fP).
-If the configuration file is subsequently modified, \fBsmartd\fP
-can be told to re-read the configuration file by sending it a
-\fBHUP\fP signal, for example with the command:
-.fi
-\fBkillall -HUP smartd\fP.
-.fi
-(Windows: See NOTES below.)
-
-On startup, if \fBsmartd\fP finds a syntax error in the configuration
-file, it will print an error message and then exit. However if
-\fBsmartd\fP is already running, then is told with a \fBHUP\fP signal
-to re-read the configuration file, and then find a syntax error in
-this file, it will print an error message and then continue, ignoring
-the contents of the (faulty) configuration file, as if the \fBHUP\fP
-signal had never been received.
-
-When \fBsmartd\fP is running in debug mode, the \fBQUIT\fP signal
-(normally generated from a shell with CONTROL\-C) is treated in the
-same way as a \fBHUP\fP signal: it makes \fBsmartd\fP reload its
-configuration file. To exit \fBsmartd\fP use CONTROL-\e
-(Cygwin: 2x CONTROL\-C, Windows: CONTROL\-Break).
-
-On startup, in the absence of the configuration file
-\fB/usr/local/etc/smartd.conf\fP, the \fBsmartd\fP daemon first scans for all
-devices that support SMART. The scanning is done as follows:
-.IP \fBLINUX:\fP 9
-Examine all entries \fB"/dev/hd[a-t]"\fP for IDE/ATA
-devices, and \fB"/dev/sd[a-z]"\fP for SCSI devices.
-.IP \fBFREEBSD:\fP 9
-Examine all entries \fB"/dev/ad[0-9]+"\fP for IDE/ATA
-devices and \fB"/dev/da[0-9]+"\fP for SCSI devices.
-.IP \fBNETBSD/OPENBSD:\fP 9
-Authoritative list of disk devices is obtained from sysctl
-\'hw.disknames\'.
-.IP \fBSOLARIS:\fP 9
-Examine all entries \fB"/dev/rdsk/c?t?d?s?"\fP for IDE/ATA and SCSI disk
-devices, and entries \fB"/dev/rmt/*"\fP for SCSI tape devices.
-.IP \fBDARWIN:\fP 9
-The IOService plane is scanned for ATA block storage devices.
-.IP \fBWINDOWS:\fP 9
-Examine all entries \fB"/dev/hd[a-j]"\fP ("\\\\.\\PhysicalDrive[0-9]")
-for IDE/ATA devices on WinNT4/2000/XP, \fB"/dev/hd[a-d]"\fP
-(bitmask from "\\\\.\\SMARTVSD") for IDE/ATA devices on Win95/98/98SE/ME,
-and \fB"/dev/scsi[0-3][0-7]"\fP (ASPI adapter 0-3, ID 0-7) for SCSI
-devices on all versions of Windows.
-.IP \fBCYGWIN\fP: 9
-See "WINDOWS" above.
-.PP
-\fBsmartd\fP then monitors
-for \fIall\fP possible SMART errors (corresponding to the \fB\'\-a\'\fP
-Directive in the configuration file; see \fBCONFIGURATION FILE\fP
-below).
-
-.SH
-OPTIONS
-Long options are not supported on all systems. Use \fB\'smartd
-\-h\'\fP to see the available options.
-.TP
-.B \-c FILE, \-\-configfile=FILE
-
-Read \fBsmartd\fP configuration Directives from FILE, instead of from
-the default location \fB/usr/local/etc/smartd.conf\fP (Windows: \fB./smartd.conf\fP).
-If FILE does \fBnot\fP exist, then \fBsmartd\fP will print an error
-message and exit with nonzero status. Thus, \'\-c /usr/local/etc/smartd.conf\'
-can be used to verify the existence of the default configuration file.
-
-By using \'\-\' for FILE, the configuration is read from standard
-input. This is useful for commands like:
-.nf
-.B echo /dev/hdb \-m user@home \-M test | smartd \-c \- \-q onecheck
-.fi
-to perform quick and simple checks without a configuration file.
-
-.TP
-.B \-d, \-\-debug
-Runs \fBsmartd\fP in "debug" mode. In this mode, it displays status
-information to STDOUT rather than logging it to SYSLOG and does not
-\fBfork(2)\fP into the background and detach from the controlling
-terminal. In this mode, \fBsmartd\fP also prints more verbose
-information about what it is doing than when operating in "daemon"
-mode. In this mode, the \fBQUIT\fP signal (normally generated from a
-terminal with CONTROL\-C) makes \fBsmartd\fP reload its configuration
-file. Please use CONTROL-\e to exit
-(Cygwin: 2x CONTROL\-C, Windows: CONTROL\-Break).
-
-Windows only: The "debug" mode can be toggled by the command
-\fBsmartd sigusr2\fP. A new console for debug output is opened when
-debug mode is enabled.
-.TP
-.B \-D, \-\-showdirectives
-Prints a list (to STDOUT) of all the possible Directives which may
-appear in the configuration file /usr/local/etc/smartd.conf, and then exits.
-These Directives are also described later in this man page. They may
-appear in the configuration file following the device name.
-.TP
-.B \-h, \-\-help, \-\-usage
-Prints usage message to STDOUT and exits.
-.TP
-.B \-i N, \-\-interval=N
-Sets the interval between disk checks to \fIN\fP seconds, where
-\fIN\fP is a decimal integer. The minimum allowed value is ten and
-the maximum is the largest positive integer that can be represented on
-your system (often 2^31-1). The default is 1800 seconds.
-
-Note that the superuser can make \fBsmartd\fP check the status of the
-disks at any time by sending it the \fBSIGUSR1\fP signal, for example
-with the command:
-.nf
-.B kill -SIGUSR1 <pid>
-.fi
-where \fB<pid>\fP is the process id number of \fBsmartd\fP. One may
-also use:
-.nf
-.B killall -USR1 smartd
-.fi
-for the same purpose.
-.fi
-(Windows: See NOTES below.)
-
-.TP
-.B \-l FACILITY, \-\-logfacility=FACILITY
-Uses syslog facility FACILITY to log the messages from \fBsmartd\fP.
-Here FACILITY is one of \fIlocal0\fP, \fIlocal1\fP, ..., \fIlocal7\fP,
-or \fIdaemon\fP [default]. If this command-line option is not used,
-then by default messages from \fBsmartd\fP are logged to the facility
-\fIdaemon\fP.
-
-If you would like to have \fBsmartd\fP messages logged somewhere other
-than the default \fB/var/log/messages\fP location, this can typically
-be accomplished with (for example) the following steps:
-.RS 7
-.IP \fB[1]\fP 4
-Modify the script that starts \fBsmartd\fP to include the \fBsmartd\fP
-command-line argument \'\-l local3\'. This tells \fBsmartd\fP to log its
-messages to facility \fBlocal3\fP.
-.IP \fB[2]\fP 4
-Modify the \fBsyslogd\fP configuration file (typically
-\fB/etc/syslog.conf\fP) by adding a line of the form:
-.nf
-\fBlocal3.* /var/log/smartd.log\fP
-.fi
-This tells \fBsyslogd\fP to log all the messages from facility \fBlocal3\fP to
-the designated file: /var/log/smartd.log.
-.IP \fB[3]\fP 4
-Tell \fBsyslogd\fP to re-read its configuration file, typically by
-sending the \fBsyslogd\fP process a \fBSIGHUP\fP hang-up signal.
-.IP \fB[4]\fP 4
-Start (or restart) the \fBsmartd\fP daemon.
-.RE
-.\" The following two lines are a workaround for a man2html bug. Please leave them.
-.\" They define a non-existent option; useful because man2html can't correctly reset the margins.
-.TP
-.B \&
-For more detailed information, please refer to the man pages for
-\fBsyslog.conf\fP, \fBsyslogd\fP, and \fBsyslog\fP. You may also want
-to modify the log rotation configuration files; see the man pages for
-\fBlogrotate\fP and examine your system\'s /etc/logrotate.conf file.
-
-Cygwin: The current release of Cygwin writes \fBsyslog\fP(3)
-messages to Windows event log or to file \fBC:/CYGWIN_SYSLOG.TXT\fP
-if the event log is not available.
-The FACILITY parameter is always ignored by Cygwin.
-
-Windows: Some \fBsyslog\fP(3) functionality is implemented
-internally in \fBsmartd\fP as follows: If no \'\-l\' option
-(or \'\-l daemon\') is specified, messages are written to Windows
-event log or to file \fB./smartd.log\fP if event log is not available
-(Win9x/ME or access denied). By specifying other values of FACILITY,
-log output is redirected as follows:
-\'\-l local0\' to file \fB./smartd.log\fP,
-\'\-l local1\' to standard output (redirect with \'>\' to any file),
-\'\-l local2\' to standard error,
-\'\-l local[3-7]\': to file \fB./smartd[1-5].log\fP.
-
-When using the event log, the enclosed utility \fBsyslogevt.exe\fP
-should be registered as an event message file to avoid error
-messages from the event viewer. Use \'\fBsyslogevt -r smartd\fP\'
-to register, \'\fBsyslogevt -u smartd\fP\' to unregister and
-\'\fBsyslogevt\fP\' for more help.
-
-.TP
-.B \-p NAME, \-\-pidfile=NAME
-Writes pidfile \fINAME\fP containing the \fBsmartd\fP Process ID
-number (PID). To avoid symlink attacks make sure the directory to
-which pidfile is written is only writable for root. Without this
-option, or if the \-\-debug option is given, no PID file is written on
-startup. If \fBsmartd\fP is killed with a maskable signal then the
-pidfile is removed.
-.TP
-.B \-q WHEN, \-\-quit=WHEN
-Specifies when, if ever, \fBsmartd\fP should exit. The valid
-arguments are to this option are:
-
-.I nodev
-\- Exit if there are no devices to monitor, or if any errors are found
-at startup in the configuration file. This is the default.
-
-.I errors
-\- Exit if there are no devices to monitor, or if any errors are found
-in the configuration file /usr/local/etc/smartd.conf at startup or whenever it
-is reloaded.
-
-.I nodevstartup
-\- Exit if there are no devices to monitor at startup. But continue
-to run if no devices are found whenever the configuration file is
-reloaded.
-
-.I never
-\- Only exit if a fatal error occurs (no remaining system memory,
-invalid command line arguments). In this mode, even if there are no
-devices to monitor, or if the configuration file
-\fB/usr/local/etc/smartd.conf\fP has errors, \fBsmartd\fP will continue to run,
-waiting to load a configuration file listing valid devices.
-
-.I onecheck
-\- Start \fBsmartd\fP in debug mode, then register devices, then check
-device\'s SMART status once, and then exit with zero exit status if all
-of these steps worked correctly.
-
-This last option is intended for \'distribution-writers\' who want to
-create automated scripts to determine whether or not to automatically
-start up \fBsmartd\fP after installing smartmontools. After starting
-\fBsmartd\fP with this command-line option, the distribution\'s install
-scripts should wait a reasonable length of time (say ten seconds). If
-\fBsmartd\fP has not exited with zero status by that time, the script
-should send \fBsmartd\fP a SIGTERM or SIGKILL and assume that
-\fBsmartd\fP will not operate correctly on the host. Conversely, if
-\fBsmartd\fP exits with zero status, then it is safe to run
-\fBsmartd\fP in normal daemon mode. If \fBsmartd\fP is unable to
-monitor any devices or encounters other problems then it will return
-with non-zero exit status.
-.TP
-.B \-r TYPE, \-\-report=TYPE
-Intended primarily to help
-.B smartmontools
-developers understand the behavior of
-.B smartmontools
-on non-conforming or poorly-conforming hardware. This option reports
-details of
-\fBsmartd\fP
-transactions with the device. The option can be used multiple times.
-When used just once, it shows a record of the ioctl() transactions
-with the device. When used more than once, the detail of these ioctl()
-transactions are reported in greater detail. The valid arguments to
-this option are:
-
-.I ioctl
-\- report all ioctl() transactions.
-
-.I ataioctl
-\- report only ioctl() transactions with ATA devices.
-
-.I scsiioctl
-\- report only ioctl() transactions with SCSI devices.
-
-Any argument may include a positive integer to specify the level of
-detail that should be reported. The argument should be followed by a
-comma then the integer with no spaces. For example, \fIataioctl,2\fP
-The default level is 1, so \'\-r ataioctl,1\' and \'\-r ataioctl\' are
-equivalent.
-
-.TP
-.B \-\-service
-Windows only: Enables \fBsmartd\fP to run as a Windows service.
-It must be specified in the service command line as the first argument.
-See NOTES below for details.
-
-.TP
-.B \-V, \-\-version, \-\-license, \-\-copyright
-Prints license, copyright, and CVS version information onto
-STDOUT and then exits. Please include this information if you are
-reporting bugs, or have specific questions about the behavior of
-\fBsmartd\fP.
-
-.SH EXAMPLES
-
-.B
-smartd
-.fi
-Runs the daemon in forked mode. This is the normal way to run
-\fBsmartd\fP.
-Entries are logged to SYSLOG (by default
-.B /var/log/messages.)
-
-.B
-smartd -d -i 30
-.fi
-Run in foreground (debug) mode, checking the disk status
-every 30 seconds.
-
-.B
-smartd -q onecheck
-.fi
-Registers devices, and checks the status of the devices exactly
-once. The exit status (the bash
-.B $?
-variable) will be zero if all went well, and nonzero if no devices
-were detected or some other problem was encountered.
-
-.fi
-Note that \fBsmartmontools\fP provides a start-up script in
-\fB/usr/local/etc/rc.d/init.d/smartd\fP which is responsible for starting and
-stopping the daemon via the normal init interface. Using this script,
-you can start \fBsmartd\fP by giving the command:
-.nf
-.B /usr/local/etc/rc.d/init.d/smartd start
-.fi
-and stop it by using the command:
-.nf
-.B /usr/local/etc/rc.d/init.d/smartd stop
-
-.fi
-If you want \fBsmartd\fP to start running whenever your machine is
-booted, this can be enabled by using the command:
-.nf
-.B /sbin/chkconfig --add smartd
-.fi
-and disabled using the command:
-.nf
-.B /sbin/chkconfig --del smartd
-.fi
-
-.\" DO NOT MODIFY THIS OR THE FOLLOWING TWO LINES. THIS MATERIAL
-.\" IS AUTOMATICALLY INCLUDED IN THE FILE smartd.conf.5
-.\" STARTINCLUDE
-
-.SH CONFIGURATION FILE /usr/local/etc/smartd.conf
-In the absence of a configuration file, under Linux
-\fBsmartd\fP
-will try to open the 20 ATA devices
-.B /dev/hd[a-t]
-and the 26 SCSI devices
-.B /dev/sd[a-z].
-Under FreeBSD,
-\fBsmartd\fP
-will try to open all existing ATA devices (with entries in /dev)
-.B /dev/ad[0-9]+
-and all existing SCSI devices
-.B /dev/da[0-9]+.
-Under NetBSD/OpenBSD,
-\fBsmartd\fP
-will try to open all existing ATA devices (with entries in /dev)
-.B /dev/wd[0-9]+c
-and all existing SCSI devices
-.B /dev/sd[0-9]+c.
-Under Solaris \fBsmartd\fP will try to open all entries \fB"/dev/rdsk/c?t?d?s?"\fP for IDE/ATA and SCSI disk
-devices, and entries \fB"/dev/rmt/*"\fP for SCSI tape devices.
-Under Windows \fBsmartd\fP will try to open all entries \fB"/dev/hd[a-j]"\fP ("\\\\.\\PhysicalDrive[0-9]")
-for IDE/ATA devices on WinNT4/2000/XP, \fB"/dev/hd[a-d]"\fP
-(bitmask from "\\\\.\\SMARTVSD") for IDE/ATA devices on Win95/98/98SE/ME,
-and \fB"/dev/scsi[0-3][0-7]"\fP (ASPI adapter 0-3, ID 0-7) for SCSI
-devices on all versions of Windows.
-Under Darwin, \fBsmartd\fP will open any ATA block storage device.
-
-This can be annoying if you have an ATA or SCSI device that hangs or
-misbehaves when receiving SMART commands. Even if this causes no
-problems, you may be annoyed by the string of error log messages about
-block-major devices that can\'t be found, and SCSI devices that can\'t
-be opened.
-
-One can avoid this problem, and gain more control over the types of
-events monitored by
-\fBsmartd\fP,
-by using the configuration file
-.B /usr/local/etc/smartd.conf.
-This file contains a list of devices to monitor, with one device per
-line. An example file is included with the
-.B smartmontools
-distribution. You will find this sample configuration file in
-\fB/usr/local/share/doc/smartmontools-5.1/\fP. For security, the configuration file
-should not be writable by anyone but root. The syntax of the file is as
-follows:
-.IP \(bu 4
-There should be one device listed per line, although you may have
-lines that are entirely comments or white space.
-.IP \(bu 4
-Any text following a hash sign \'#\' and up to the end of the line is
-taken to be a comment, and ignored.
-.IP \(bu 4
-Lines may be continued by using a backslash \'\e\' as the last
-non-whitespace or non-comment item on a line.
-.IP \(bu 4
-Note: a line whose first character is a hash sign \'#\' is treated as
-a white-space blank line, \fBnot\fP as a non-existent line, and will
-\fBend\fP a continuation line.
-.PP 0
-.fi
-Here is an example configuration file. It\'s for illustrative purposes
-only; please don\'t copy it onto your system without reading to the end
-of the
-.B DIRECTIVES
-Section below!
-
-.nf
-.B ################################################
-.B # This is an example smartd startup config file
-.B # /usr/local/etc/smartd.conf for monitoring three
-.B # ATA disks, three SCSI disks, and six ATA disks
-.B # behind two 3ware controllers.
-.B #
-.nf
-.B # First ATA disk on each of two interfaces. On
-.B # the second disk, start a long self-test every
-.B # Sunday between 3 and 4 am.
-.B #
-.B \ \ /dev/hda -a -m admin@example.com,root@localhost
-.B \ \ /dev/hdc -a -I 194 -I 5 -i 12 -s L/../../7/03
-.B #
-.nf
-.B # SCSI disks. Send a TEST warning email to admin on
-.B # startup.
-.B #
-.B \ \ /dev/sda
-.B \ \ /dev/sdb -m admin@example.com -M test
-.B #
-.nf
-.B # Strange device. It\'s SCSI. Start a scheduled
-.B # long self test between 5 and 6 am Monday/Thursday
-.B \ \ /dev/weird -d scsi -s L/../../(1|4)/05
-.B #
-.nf
-.B # Four ATA disks on a 3ware 6/7/8000 controller.
-.B # Start short self-tests daily between midnight and 1am,
-.B # 1-2, 2-3, and 3-4 am
-.B # (Note that the syntax /dev/twe0 is also allowed.)
-.B \ \ /dev/sdc -d 3ware,0 -a -s S/../.././00
-.B \ \ /dev/sdc -d 3ware,1 -a -s S/../.././01
-.B \ \ /dev/sdd -d 3ware,2 -a -s S/../.././02
-.B \ \ /dev/sdd -d 3ware,3 -a -s S/../.././03
-.B #
-.nf
-.B # Two ATA disks on a 3ware 9000 controller.
-.B # Start long self-tests Sundays between midnight and
-.B # 1am and 2-3 am
-.B \ \ /dev/twa0 -d 3ware,0 -a -s L/../../7/00
-.B \ \ /dev/twa0 -d 3ware,1 -a -s L/../../7/02
-.B #
-.nf
-.B # The following line enables monitoring of the
-.B # ATA Error Log and the Self-Test Error Log.
-.B # It also tracks changes in both Prefailure
-.B # and Usage Attributes, apart from Attributes
-.B # 9, 194, and 231, and shows continued lines:
-.B #
-.B \ \ /dev/hdd\ -l\ error\ \e
-.B \ \ \ \ \ \ \ \ \ \ \ -l\ selftest\ \e
-.B \ \ \ \ \ \ \ \ \ \ \ -t\ \e\ \ \ \ \ \ # Attributes not tracked:
-.B \ \ \ \ \ \ \ \ \ \ \ -I\ 194\ \e\ \ # temperature
-.B \ \ \ \ \ \ \ \ \ \ \ -I\ 231\ \e\ \ # also temperature
-.B \ \ \ \ \ \ \ \ \ \ \ -I 9\ \ \ \ \ \ # power-on hours
-.B #
-.B ################################################
-.fi
-
-.PP
-.SH CONFIGURATION FILE DIRECTIVES
-.PP
-
-If the first non-comment entry in the configuration file is the text
-string
-.B DEVICESCAN
-in capital letters, then
-\fBsmartd\fP
-will ignore any remaining lines in the configuration file, and will
-scan for devices.
-.B DEVICESCAN
-may optionally be followed by Directives that will apply to all
-devices that are found in the scan. Please see below for additional
-details.
-
-.sp 2
-The following are the Directives that may appear following the device
-name or
-.B DEVICESCAN
-on any line of the
-.B /usr/local/etc/smartd.conf
-configuration file. Note that
-.B these are NOT command-line options for
-\fBsmartd\fP.
-The Directives below may appear in any order, following the device
-name.
-
-.B For an ATA device,
-if no Directives appear, then the device will be monitored
-as if the \'\-a\' Directive (monitor all SMART properties) had been given.
-
-.B If a SCSI disk is listed,
-it will be monitored at the maximum implemented level: roughly
-equivalent to using the \'\-H \-l selftest\' options for an ATA disk.
-So with the exception of \'\-d\', \'\-m\', \'\-l selftest\', \'\-s\', and
-\'\-M\', the Directives below are ignored for SCSI disks. For SCSI
-disks, the \'\-m\' Directive sends a warning email if the SMART status
-indicates a disk failure or problem, if the SCSI inquiry about disk
-status fails, or if new errors appear in the self-test log.
-
-.B If a 3ware controller is used
-then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?
-or /dev/twa?) must be listed, along with the \'\-d 3ware,N\' Directive
-(see below). The individual ATA disks hosted by the 3ware controller
-appear to \fBsmartd\fP as normal ATA devices. Hence all the ATA
-directives can be used for these disks (but see note below).
-
-.TP
-.B \-d TYPE
-Specifies the type of the device. This Directive may be used multiple times
-for one device, but the arguments \fIata\fP, \fIscsi\fP, and \fI3ware,N\fP are
-mutually-exclusive. If more than one is given then
-\fBsmartd\fP
-will use the last one which appears.
-
-If none of these three arguments is given, then \fBsmartd\fP will
-first attempt to guess the device type by looking at whether the sixth
-character in the device name is an \'s\' or an \'h\'. This will work for
-device names like /dev/hda or /dev/sdb, and corresponds to choosing
-\fIata\fP or \fIscsi\fP respectively. If
-\fBsmartd\fP
-can\'t guess from this sixth character, then it will simply try to
-access the device using first ATA and then SCSI ioctl()s.
-
-The valid arguments to this Directive are:
-
-.I ata
-\- the device type is ATA. This prevents
-\fBsmartd\fP
-from issuing SCSI commands to an ATA device.
-
-.I scsi
-\- the device type is SCSI. This prevents
-\fBsmartd\fP
-from issuing ATA commands to a SCSI device.
-
-.I 3ware,N
-\- the device consists of one or more ATA disks connected to a 3ware
-RAID controller. The non-negative integer N (in the range from 0 to 15
-inclusive) denotes which disk on the controller is monitored. In log
-files and email messages this disk will be identified as 3ware_disk_XX
-with XX in the range from 00 to 15 inclusive.
-
-This Directive may at first appear confusing, because the 3ware
-controller is a SCSI device (such as /dev/sda) and should be listed as
-such in the the configuration file.
-However when the \'\-d 3ware,N\'
-Directive is used, then the corresponding disk is addressed using
-native ATA commands which are \'passed through\' the SCSI driver. All
-ATA Directives listed in this man page may be used. Note that while
-you may use \fBany\fP of the 3ware SCSI logical devices /dev/sd? to
-address \fBany\fP of the physical disks (3ware ports), error and log
-messages will make the most sense if you always list the 3ware SCSI
-logical device corresponding to the particular physical disks. Please
-see the \fBsmartctl\fP man page for further details.
-
-ATA disks behind 3ware controllers may alternatively be accessed via a
-character device interface /dev/twe0-15 (3ware 6000/7000/8000
-controllers) and /dev/twa0-15 (3ware 9000 series controllers). Note
-that the 9000 series controllers may \fBonly\fP be accessed using the
-character device interface /dev/twa0-15 and not the SCSI device
-interface /dev/sd?. Please see the \fBsmartctl\fP man page for
-further details.
-
-Note that older 3w-xxxx drivers do not pass the \'Enable Autosave\'
-(\fB-S on\fP) and \'Enable Automatic Offline\' (\fB-o on\fP) commands
-to the disk, if the SCSI interface is used, and produce these types of
-harmless syslog error messages instead: \fB\'3w-xxxx: tw_ioctl():
-Passthru size (123392) too big\'\fP. This can be fixed by upgrading to
-version 1.02.00.037 or later of the 3w-xxxx driver, or by applying a
-patch to older versions. See
-\fBhttp://smartmontools.sourceforge.net/\fP for instructions.
-Alternatively use the character device interfaces /dev/twe0-15 (3ware
-6/7/8000 series controllers) or /dev/twa0-15 (3ware 9000 series
-controllers).
-
-
-.B 3ware controllers are currently ONLY supported under Linux.
-
-.I removable
-\- the device or its media is removable. This indicates to
-\fBsmartd\fP
-that it should continue (instead of exiting, which is the default
-behavior) if the device does not appear to be present when
-\fBsmartd\fP is started. This Directive may be used in conjunction
-with the other \'\-d\' Directives.
-
-.TP
-.B \-n POWERMODE
-This \'nocheck\' Directive is used to prevent a disk from being
-spun-up when it is periodically polled by \fBsmartd\fP.
-
-ATA disks have five different power states. In order of increasing
-power consumption they are: \'OFF\', \'SLEEP\', \'STANDBY\', \'IDLE\',
-and \'ACTIVE\'. Typically in the OFF, SLEEP, and STANDBY modes the
-disk\'s platters are not spinning. But usually, in response to SMART
-commands issued by \fBsmartd\fP, the disk platters are spun up. So if
-this option is not used, then a disk which is in a low\-power mode may
-be spun up and put into a higher\-power mode when it is periodically
-polled by \fBsmartd\fP.
-
-Note that if the disk is in SLEEP mode when \fBsmartd\fP is started,
-then it won't respond to \fBsmartd\fP commands, and so the disk won't
-be registered as a device for \fBsmartd\fP to monitor. If a disk is in
-any other low\-power mode, then the commands issued by \fBsmartd\fP to
-register the disk will probably cause it to spin\-up.
-
-The \'\fB\-n\fP\' (nocheck) Directive specifies if \fBsmartd\fP\'s
-periodic checks should still be carried out when the device is in a
-low\-power mode. It may be used to prevent a disk from being spun\-up
-by periodic \fBsmartd\fP polling. The allowed values of POWERMODE
-are:
-
-.I never
-\- \fBsmartd\fP will poll (check) the device regardless of its power
-mode. This may cause a disk which is spun\-down to be spun\-up when
-\fBsmartd\fP checks it. This is the default behavior if the '\-n'
-Directive is not given.
-
-.I sleep
-\- check the device unless it is in SLEEP mode.
-
-.I standby
-\- check the device unless it is in SLEEP or STANDBY mode. In
-these modes most disks are not spinning, so if you want to prevent
-a laptop disk from spinning up each time that \fBsmartd\fP polls,
-this is probably what you want.
-
-.I idle
-\- check the device unless it is in SLEEP, STANDBY or IDLE mode.
-In the IDLE state, most disks are still spinning, so this is probably
-not what you want.
-
-
-.TP
-.B \-T TYPE
-Specifies how tolerant
-\fBsmartd\fP
-should be of SMART command failures. The valid arguments to this
-Directive are:
-
-.I normal
-\- do not try to monitor the disk if a mandatory SMART command fails, but
-continue if an optional SMART command fails. This is the default.
-
-.I permissive
-\- try to monitor the disk even if it appears to lack SMART
-capabilities. This may be required for some old disks (prior to
-ATA\-3 revision 4) that implemented SMART before the SMART standards
-were incorporated into the ATA/ATAPI Specifications. This may also be
-needed for some Maxtor disks which fail to comply with the ATA
-Specifications and don't properly indicate support for error\- or
-self\-test logging.
-
-[Please see the \fBsmartctl \-T\fP command-line option.]
-.TP
-.B \-o VALUE
-Enables or disables SMART Automatic Offline Testing when
-\fBsmartd\fP
-starts up and has no further effect. The valid arguments to this
-Directive are \fIon\fP and \fIoff\fP.
-
-The delay between tests is vendor-specific, but is typically four
-hours.
-
-Note that SMART Automatic Offline Testing is \fBnot\fP part of the ATA
-Specification. Please see the
-.B smartctl \-o
-command-line option documentation for further information about this
-feature.
-.TP
-.B \-S VALUE
-Enables or disables Attribute Autosave when \fBsmartd\fP
-starts up and has no further effect. The valid arguments to this
-Directive are \fIon\fP and \fIoff\fP. Also affects SCSI devices.
-[Please see the \fBsmartctl \-S\fP command-line option.]
-.TP
-.B \-H
-Check the SMART health status of the disk. If any Prefailure
-Attributes are less than or equal to their threshold values, then disk
-failure is predicted in less than 24 hours, and a message at loglevel
-.B \'LOG_CRITICAL\'
-will be logged to syslog. [Please see the
-.B smartctl \-H
-command-line option.]
-.TP
-.B \-l TYPE
-Reports increases in the number of errors in one of the two SMART logs. The
-valid arguments to this Directive are:
-
-.I error
-\- report if the number of ATA errors reported in the ATA Error Log
-has increased since the last check.
-
-.I selftest
-\- report if the number of failed tests reported in the SMART
-Self-Test Log has increased since the last check, or if the timestamp
-associated with the most recent failed test has increased. Note that
-such errors will \fBonly\fP be logged if you run self-tests on the
-disk (and it fails a test!). Self-Tests can be run automatically by
-\fBsmartd\fP: please see the \fB\'\-s\'\fP Directive below.
-Self-Tests can also be run manually by using the \fB\'\-t\ short\'\fP
-and \fB\'\-t\ long\'\fP options of \fBsmartctl\fP and the results of
-the testing can be observed using the \fBsmartctl \'\-l\ selftest\'\fP
-command-line option.]
-
-[Please see the \fBsmartctl \-l\fP and \fB\-t\fP command-line
-options.]
-.TP
-.B \-s REGEXP
-Run Self-Tests or Offline Immediate Tests, at scheduled times. A
-Self- or Offline Immediate Test will be run at the end of periodic
-device polling, if all 12 characters of the string \fBT/MM/DD/d/HH\fP
-match the extended regular expression \fBREGEXP\fP. Here:
-.RS 7
-.IP \fBT\fP 4
-is the type of the test. The values that \fBsmartd\fP will try to
-match (in turn) are: \'L\' for a \fBL\fPong Self-Test, \'S\' for a
-\fBS\fPhort Self-Test, \'C\' for a \fBC\fPonveyance Self-Test (ATA
-only), and \'O\' for an \fBO\fPffline Immediate Test (ATA only). As
-soon as a match is found, the test will be started and no additional
-matches will be sought for that device and that polling cycle.
-.IP \fBMM\fP 4
-is the month of the year, expressed with two decimal digits. The
-range is from 01 (January) to 12 (December) inclusive. Do \fBnot\fP
-use a single decimal digit or the match will always fail!
-.IP \fBDD\fP 4
-is the day of the month, expressed with two decimal digits. The
-range is from 01 to 31 inclusive. Do \fBnot\fP
-use a single decimal digit or the match will always fail!
-.IP \fBd\fP 4
-is the day of the week, expressed with one decimal digit. The
-range is from 1 (Monday) to 7 (Sunday) inclusive.
-.IP \fBHH\fP 4
-is the hour of the day, written with two decimal digits, and given in
-hours after midnight. The range is 00 (midnight to just before 1am)
-to 23 (11pm to just before midnight) inclusive. Do \fBnot\fP use a
-single decimal digit or the match will always fail!
-.RE
-.\" The following two lines are a workaround for a man2html bug. Please leave them.
-.\" They define a non-existent option; useful because man2html can't correctly reset the margins.
-.TP
-.B \&
-Some examples follow. In reading these, keep in mind that in extended
-regular expressions a dot \fB\'.\'\fP matches any single character, and
-a parenthetical expression such as \fB\'(A|B|C)\'\fP denotes any one of the three possibilities \fBA\fP,
-\fBB\fP, or \fBC\fP.
-
-To schedule a short Self-Test between 2-3am every morning, use:
-.nf
-\fB \-s S/../.././02\fP
-.fi
-To schedule a long Self-Test between 4-5am every Sunday morning, use:
-.nf
-\fB \-s L/../../7/04\fP
-.fi
-To schedule a long Self-Test between 10-11pm on the first and
-fifteenth day of each month, use:
-.nf
-\fB \-s L/../(01|15)/./22\fP
-.fi
-To schedule an Offline Immediate test after every midnight, 6am,
-noon,and 6pm, plus a Short Self-Test daily at 1-2am and a Long
-Self-Test every Saturday at 3-4am, use:
-.nf
-\fB \-s (O/../.././(00|06|12|18)|S/../.././01|L/../../6/03)\fP
-.fi
-
-Scheduled tests are run immediately following the regularly-scheduled
-device polling, if the current local date, time, and test type, match
-\fBREGEXP\fP. By default the regularly-scheduled device polling
-occurs every thirty minutes after starting \fBsmartd\fP. Take caution
-if you use the \'\-i\' option to make this polling interval more than
-sixty minutes: the poll times may fail to coincide with any of the
-testing times that you have specified with \fBREGEXP\fP, and so the
-self tests may not take place as you wish.
-
-Before running an offline or self-test, \fBsmartd\fP checks to be sure
-that a self-test is not already running. If a self-test \fBis\fP
-already running, then this running self test will \fBnot\fP be
-interrupted to begin another test.
-
-\fBsmartd\fP will not attempt to run \fBany\fP type of test if another
-test was already started or run in the same hour.
-
-Each time a test is run, \fBsmartd\fP will log an entry to SYSLOG.
-You can use these to verify that you constructed \fBREGEXP\fP
-correctly. The matching order (\fBL\fP before \fBS\fP before \fBC\fP
-before \fBO\fP) ensures that if multiple test types are all scheduled
-for the same hour, the longer test type has precedence. This is
-usually the desired behavior.
-
-Unix users: please beware that the rules for extended regular
-expressions [regex(7)] are \fBnot\fP the same as the rules for
-file\-name pattern matching by the shell [glob(7)]. \fBsmartd\fP will
-issue harmless informational warning messages if it detects characters
-in \fBREGEXP\fP that appear to indicate that you have made this
-mistake.
-
-.TP
-.B \-m ADD
-Send a warning email to the email address \fBADD\fP if the \'\-H\',
-\'\-l\', \'\-f\', \'\-C\', or \'\-O\' Directives detect a failure or a
-new error, or if a SMART command to the disk fails. This Directive
-only works in conjunction with these other Directives (or with the
-equivalent default \'\-a\' Directive).
-
-To prevent your email in-box from getting filled up with warning
-messages, by default only a single warning will be sent for each of
-the enabled alert types, \'\-H\', \'\-l\', \'\-f\', \'\-C\', or
-\'\-O\' even if more than one failure or error is detected or if the
-failure or error persists. [This behavior can be modified; see the
-\'\-M\' Directive below.]
-
-To send email to more than one user, please use the following "comma
-separated" form for the address: \fBuser1@add1,user2@add2,...,userN@addN\fP
-(with no spaces).
-
-To test that email is being sent correctly, use the \'\-M test\'
-Directive described below to send one test email message on
-\fBsmartd\fP
-startup.
-
-By default, email is sent using the system
-.B mail
-command. In order that
-\fBsmartd\fP
-find the mail command (normally /bin/mail) an executable named
-.B \'mail\'
-must be in the path of the shell or environment from which
-\fBsmartd\fP
-was started. If you wish to specify an explicit path to the mail
-executable (for example /usr/local/bin/mail) or a custom script to
-run, please use the \'\-M exec\' Directive below.
-
-Note that by default under Solaris, in the previous paragraph,
-\'\fBmailx\fP\' and \'\fB/bin/mailx\fP\' are used, since Solaris
-\'/bin/mail\' does not accept a \'\-s\' (Subject) command-line
-argument.
-
-On Windows, the \'\fBBlat\fP\' mailer
-(\fBhttp://blat.sourceforge.net/\fP) is used by default.
-This mailer uses a different command line syntax, see
-\'\-M exec\' below.
-
-Note also that there is a special argument
-.B <nomailer>
-which can be given to the \'\-m\' Directive in conjunction with the \'\-M
-exec\' Directive. Please see below for an explanation of its effect.
-
-If the mailer or the shell running it produces any STDERR/STDOUT
-output, then a snippet of that output will be copied to SYSLOG. The
-remainder of the output is discarded. If problems are encountered in
-sending mail, this should help you to understand and fix them. If
-you have mail problems, we recommend running \fBsmartd\fP in debug
-mode with the \'-d\' flag, using the \'-M test\' Directive described
-below.
-
-The following extension is available on Windows:
-By specifying \'\fBmsgbox\fP\' as a mail address, a warning
-"email" is displayed as a message box on the screen.
-Using both \'\fBmsgbox\fP\' and regular mail addresses is possible,
-if \'\fBmsgbox\fP\' is the first word in the comma separated list.
-With \'\fBsysmsgbox\fP\', a system modal (always on top) message box
-is used. If running as a service, a service notification message box
-(always shown on current visible desktop) is used.
-
-.TP
-.B \-M TYPE
-These Directives modify the behavior of the
-\fBsmartd\fP
-email warnings enabled with the \'\-m\' email Directive described above.
-These \'\-M\' Directives only work in conjunction with the \'\-m\'
-Directive and can not be used without it.
-
-Multiple \-M Directives may be given. If conflicting \-M Directives
-are given (example: \-M once \-M daily) then the final one (in the
-example, \-M daily) is used.
-
-The valid arguments to the \-M Directive are:
-
-.I once
-\- send only one warning email for each type of disk problem detected. This
-is the default.
-
-.I daily
-\- send additional warning reminder emails, once per day, for each type
-of disk problem detected.
-
-.I diminishing
-\- send additional warning reminder emails, after a one-day interval,
-then a two-day interval, then a four-day interval, and so on for each
-type of disk problem detected. Each interval is twice as long as the
-previous interval.
-
-.I test
-\- send a single test email
-immediately upon
-\fBsmartd\fP
-startup. This allows one to verify that email is delivered correctly.
-
-.I exec PATH
-\- run the executable PATH instead of the default mail command, when
-\fBsmartd\fP
-needs to send email. PATH must point to an executable binary file or
-script.
-
-By setting PATH to point to a customized script, you can make
-\fBsmartd\fP perform useful tricks when a disk problem is detected
-(beeping the console, shutting down the machine, broadcasting warnings
-to all logged-in users, etc.) But please be careful. \fBsmartd\fP
-will \fBblock\fP until the executable PATH returns, so if your
-executable hangs, then \fBsmartd\fP will also hang. Some sample
-scripts are included in
-/usr/local/share/doc/smartmontools-5.1/examplescripts/.
-
-The return status of the executable is recorded by \fBsmartd\fP in
-SYSLOG. The executable is not expected to write to STDOUT or
-STDERR. If it does, then this is interpreted as indicating that
-something is going wrong with your executable, and a fragment of this
-output is logged to SYSLOG to help you to understand the problem.
-Normally, if you wish to leave some record behind, the executable
-should send mail or write to a file or device.
-
-Before running the executable, \fBsmartd\fP sets a number of
-environment variables. These environment variables may be used to
-control the executable\'s behavior. The environment variables
-exported by \fBsmartd\fP are:
-.RS 7
-.IP \fBSMARTD_MAILER\fP 4
-is set to the argument of \-M exec, if present or else to \'mail\'
-(examples: /bin/mail, mail).
-.IP \fBSMARTD_DEVICE\fP 4
-is set to the device path (examples: /dev/hda, /dev/sdb).
-.IP \fBSMARTD_DEVICETYPE\fP 4
-is set to the device type (possible values: ata, scsi, 3ware,N). Here
-N=0,...,15 denotes the ATA disk behind a 3ware RAID controller.
-.IP \fBSMARTD_DEVICESTRING\fP 4
-is set to the device description. For SMARTD_DEVICETYPE of ata or
-scsi, this is the same as SMARTD_DEVICE. For 3ware RAID controllers,
-the form used is \'/dev/sdc [3ware_disk_01]\'. In this case the device
-string contains a space and is NOT quoted. So to use
-$SMARTD_DEVICESTRING in a bash script you should probably enclose it
-in double quotes.
-.IP \fBSMARTD_FAILTYPE\fP 4
-gives the reason for the warning or message email. The possible values that
-it takes and their meanings are:
-.nf
-.fi
-\fIEmailTest\fP: this is an email test message.
-.nf
-.fi
-\fIHealth\fP: the SMART health status indicates imminent failure.
-.nf
-.fi
-\fIUsage\fP: a usage Attribute has failed.
-.nf
-.fi
-\fISelfTest\fP: the number of self-test failures has increased.
-.nf
-.fi
-\fIErrorCount\fP: the number of errors in the ATA error log has increased.
-.nf
-.fi
-\fICurrentPendingSector\fP: one of more disk sectors could not be
-read and are marked to be reallocated (replaced with spare sectors).
-.nf
-.fi
-\fIOfflineUncorrectableSector\fP: during off\-line testing, or self\-testing,
-one or more disk sectors could not be read.
-.nf
-.fi
-\fIFailedHealthCheck\fP: the SMART health status command failed.
-.nf
-.fi
-\fIFailedReadSmartData\fP: the command to read SMART Attribute data failed.
-.nf
-.fi
-\fIFailedReadSmartErrorLog\fP: the command to read the SMART error log failed.
-.nf
-.fi
-\fIFailedReadSmartSelfTestLog\fP: the command to read the SMART self-test log failed.
-.nf
-.fi
-\fIFailedOpenDevice\fP: the open() command to the device failed.
-.IP \fBSMARTD_ADDRESS\fP 4
-is determined by the address argument ADD of the \'\-m\' Directive.
-If ADD is \fB<nomailer>\fP, then \fBSMARTD_ADDRESS\fP is not set.
-Otherwise, it is set to the comma-separated-list of email addresses
-given by the argument ADD, with the commas replaced by spaces
-(example:admin@example.com root). If more than one email address is
-given, then this string will contain space characters and is NOT
-quoted, so to use it in a bash script you may want to enclose it in
-double quotes.
-.IP \fBSMARTD_MESSAGE\fP 4
-is set to the one sentence summary warning email message string from
-\fBsmartd\fP.
-This message string contains space characters and is NOT quoted. So to
-use $SMARTD_MESSAGE in a bash script you should probably enclose it in
-double quotes.
-.IP \fBSMARTD_FULLMESSAGE\fP 4
-is set to the contents of the entire email warning message string from
-\fBsmartd\fP.
-This message string contains space and return characters and is NOT quoted. So to
-use $SMARTD_FULLMESSAGE in a bash script you should probably enclose it in
-double quotes.
-.IP \fBSMARTD_TFIRST\fP 4
-is a text string giving the time and date at which the first problem
-of this type was reported. This text string contains space characters
-and no newlines, and is NOT quoted. For example:
-.nf
-.fi
-Sun Feb 9 14:58:19 2003 CST
-.IP \fBSMARTD_TFIRSTEPOCH\fP 4
-is an integer, which is the unix epoch (number of seconds since Jan 1,
-1970) for \fBSMARTD_TFIRST\fP.
-.RE
-.\" The following two lines are a workaround for a man2html bug. Please leave them.
-.\" They define a non-existent option; useful because man2html can't correctly reset the margins.
-.TP
-.B \&
-The shell which is used to run PATH is system-dependent. For vanilla
-Linux/glibc it\'s bash. For other systems, the man page for
-\fBpopen\fP(3) should say what shell is used.
-
-If the \'\-m ADD\' Directive is given with a normal address argument,
-then the executable pointed to by PATH will be run in a shell with
-STDIN receiving the body of the email message, and with the same
-command-line arguments:
-.nf
--s "$SMARTD_SUBJECT" $SMARTD_ADDRESS
-.fi
-that would normally be provided to \'mail\'. Examples include:
-.nf
-.B -m user@home -M exec /bin/mail
-.B -m admin@work -M exec /usr/local/bin/mailto
-.B -m root -M exec /Example_1/bash/script/below
-.fi
-
-Note that on Windows, the syntax of the \'\fBBlat\fP\' mailer is
-used:
-.nf
-- -q -subject "$SMARTD_SUBJECT" -to "$SMARTD_ADDRESS"
-.fi
-
-If the \'\-m ADD\' Directive is given with the special address argument
-.B <nomailer>
-then the executable pointed to by PATH is run in a shell with
-.B no
-STDIN and
-.B no
-command-line arguments, for example:
-.nf
-.B -m <nomailer> -M exec /Example_2/bash/script/below
-.fi
-If the executable produces any STDERR/STDOUT output, then \fBsmartd\fP
-assumes that something is going wrong, and a snippet of that output
-will be copied to SYSLOG. The remainder of the output is then
-discarded.
-
-Some EXAMPLES of scripts that can be used with the \'\-M exec\'
-Directive are given below. Some sample scripts are also included in
-/usr/local/share/doc/smartmontools-5.1/examplescripts/.
-
-.TP
-.B \-f
-Check for \'failure\' of any Usage Attributes. If these Attributes are
-less than or equal to the threshold, it does NOT indicate imminent
-disk failure. It "indicates an advisory condition where the usage or
-age of the device has exceeded its intended design life period."
-[Please see the \fBsmartctl \-A\fP command-line option.]
-.TP
-.B \-p
-Report anytime that a Prefail Attribute has changed
-its value since the last check, 30 minutes ago. [Please see the
-.B smartctl \-A
-command-line option.]
-.TP
-.B \-u
-Report anytime that a Usage Attribute has changed its value
-since the last check, 30 minutes ago. [Please see the
-.B smartctl \-A
-command-line option.]
-.TP
-.B \-t
-Equivalent to turning on the two previous flags \'\-p\' and \'\-u\'.
-Tracks changes in \fIall\fP device Attributes (both Prefailure and
-Usage). [Please see the \fBsmartctl\fP \-A command-line option.]
-.TP
-.B \-i ID
-Ignore device Attribute number \fBID\fP when checking for failure of
-Usage Attributes. \fBID\fP must be a decimal integer in the range
-from 1 to 255. This Directive modifies the behavior of the \'\-f\'
-Directive and has no effect without it.
-
-This is useful, for example, if you have a very old disk and don\'t
-want to keep getting messages about the hours-on-lifetime Attribute
-(usually Attribute 9) failing. This Directive may appear multiple
-times for a single device, if you want to ignore multiple Attributes.
-.TP
-.B \-I ID
-Ignore device Attribute \fBID\fP when tracking changes in the
-Attribute values. \fBID\fP must be a decimal integer in the range
-from 1 to 255. This Directive modifies the behavior of the \'\-p\',
-\'\-u\', and \'\-t\' tracking Directives and has no effect without one
-of them.
-
-This is useful, for example, if one of the device Attributes is the disk
-temperature (usually Attribute 194 or 231). It\'s annoying to get reports
-each time the temperature changes. This Directive may appear multiple
-times for a single device, if you want to ignore multiple Attributes.
-.TP
-.B \-r ID
-When tracking, report the \fIRaw\fP value of Attribute \fBID\fP along
-with its (normally reported) \fINormalized\fP value. \fBID\fP must be
-a decimal integer in the range from 1 to 255. This Directive modifies
-the behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives
-and has no effect without one of them. This Directive may be given
-multiple times.
-
-A common use of this Directive is to track the device Temperature
-(often ID=194 or 231).
-
-.TP
-.B \-R ID
-When tracking, report whenever the \fIRaw\fP value of Attribute
-\fBID\fP changes. (Normally \fBsmartd\fP only tracks/reports changes
-of the \fINormalized\fP Attribute values.) \fBID\fP must be a decimal
-integer in the range from 1 to 255. This Directive modifies the
-behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives and
-has no effect without one of them. This Directive may be given
-multiple times.
-
-If this Directive is given, it automatically implies the \'\-r\'
-Directive for the same Attribute, so that the Raw value of the
-Attribute is reported.
-
-A common use of this Directive is to track the device Temperature
-(often ID=194 or 231). It is also useful for understanding how
-different types of system behavior affects the values of certain
-Attributes.
-
-.TP
-.B \-C ID
-[ATA only] Report if the current number of pending sectors is
-non-zero. Here \fBID\fP is the id number of the Attribute whose raw
-value is the Current Pending Sector count. The allowed range of
-\fBID\fP is 0 to 255 inclusive. To turn off this reporting, use
-ID\ =\ 0. If the \fB\-C ID\fP option is not given, then it defaults to
-\fB\-C 197\fP (since Attribute 197 is generally used to monitor
-pending sectors).
-
-A pending sector is a disk sector (containing 512 bytes of your data)
-which the device would like to mark as ``bad" and reallocate.
-Typically this is because your computer tried to read that sector, and
-the read failed because the data on it has been corrupted and has
-inconsistent Error Checking and Correction (ECC) codes. This is
-important to know, because it means that there is some unreadable data
-on the disk. The problem of figuring out what file this data belongs
-to is operating system and file system specific. You can typically
-force the sector to reallocate by writing to it (translation: make the
-device substitute a spare good sector for the bad one) but at the
-price of losing the 512 bytes of data stored there.
-
-.TP
-.B \-U ID
-[ATA only] Report if the number of offline uncorrectable sectors is
-non-zero. Here \fBID\fP is the id number of the Attribute whose raw
-value is the Offline Uncorrectable Sector count. The allowed range of
-\fBID\fP is 0 to 255 inclusive. To turn off this reporting, use
-ID\ =\ 0. If the \fB\-U ID\fP option is not given, then it defaults to
-\fB\-U 198\fP (since Attribute 198 is generally used to monitor
-offline uncorrectable sectors).
-
-
-An offline uncorrectable sector is a disk sector which was not
-readable during an off\-line scan or a self\-test. This is important
-to know, because if you have data stored in this disk sector, and you
-need to read it, the read will fail. Please see the previous \'\-C\'
-option for more details.
-
-.TP
-.B \-F TYPE
-[ATA only] Modifies the behavior of \fBsmartd\fP to compensate for
-some known and understood device firmware bug. The arguments to this
-Directive are exclusive, so that only the final Directive given is
-used. The valid values are:
-
-.I none
-\- Assume that the device firmware obeys the ATA specifications. This is
-the default, unless the device has presets for \'\-F\' in the device
-database.
-
-.I samsung
-\- In some Samsung disks (example: model SV4012H Firmware Version:
-RM100-08) some of the two- and four-byte quantities in the SMART data
-structures are byte-swapped (relative to the ATA specification).
-Enabling this option tells \fBsmartd\fP to evaluate these quantities
-in byte-reversed order. Some signs that your disk needs this option
-are (1) no self-test log printed, even though you have run self-tests;
-(2) very large numbers of ATA errors reported in the ATA error log;
-(3) strange and impossible values for the ATA error log timestamps.
-
-.I samsung2
-\- In more recent Samsung disks (firmware revisions ending in "\-23") the
-number of ATA errors reported is byte swapped. Enabling this option
-tells \fBsmartd\fP to evaluate this quantity in byte-reversed order.
-
-Note that an explicit \'\-F\' Directive will over-ride any preset
-values for \'\-F\' (see the \'\-P\' option below).
-
-
-[Please see the \fBsmartctl \-F\fP command-line option.]
-
-.TP
-.B \-v N,OPTION
-Modifies the labeling for Attribute N, for disks which use
-non-standard Attribute definitions. This is useful in connection with
-the Attribute tracking/reporting Directives.
-
-This Directive may appear multiple times. Valid arguments to this
-Directive are:
-
-.I 9,minutes
-\- Raw Attribute number 9 is power-on time in minutes. Its raw value
-will be displayed in the form \'Xh+Ym\'. Here X is hours, and Y is
-minutes in the range 0-59 inclusive. Y is always printed with two
-digits, for example \'06\' or \'31\' or \'00\'.
-
-.I 9,seconds
-\- Raw Attribute number 9 is power-on time in seconds. Its raw value
-will be displayed in the form \'Xh+Ym+Zs\'. Here X is hours, Y is
-minutes in the range 0-59 inclusive, and Z is seconds in the range
-0-59 inclusive. Y and Z are always printed with two digits, for
-example \'06\' or \'31\' or \'00\'.
-
-.I 9,halfminutes
-\- Raw Attribute number 9 is power-on time, measured in units of 30
-seconds. This format is used by some Samsung disks. Its raw value
-will be displayed in the form \'Xh+Ym\'. Here X is hours, and Y is
-minutes in the range 0-59 inclusive. Y is always printed with two
-digits, for example \'06\' or \'31\' or \'00\'.
-
-.I 9,temp
-\- Raw Attribute number 9 is the disk temperature in Celsius.
-
-.I 192,emergencyretractcyclect
-\- Raw Attribute number 192 is the Emergency Retract Cycle Count.
-
-.I 193,loadunload
-\- Raw Attribute number 193 contains two values. The first is the
-number of load cycles. The second is the number of unload cycles.
-The difference between these two values is the number of times that
-the drive was unexpectedly powered off (also called an emergency
-unload). As a rule of thumb, the mechanical stress created by one
-emergency unload is equivalent to that created by one hundred normal
-unloads.
-
-.I 194,10xCelsius
-\- Raw Attribute number 194 is ten times the disk temperature in
-Celsius. This is used by some Samsung disks (example: model SV1204H
-with RK100-13 firmware).
-
-.I 194,unknown
-\- Raw Attribute number 194 is NOT the disk temperature, and its
-interpretation is unknown. This is primarily useful for the -P
-(presets) Directive.
-
-.I 198,offlinescanuncsectorct
-\- Raw Attribute number 198 is the Offline Scan UNC Sector Count.
-
-.I 200,writeerrorcount
-\- Raw Attribute number 200 is the Write Error Count.
-
-.I 201,detectedtacount
-\- Raw Attribute number 201 is the Detected TA Count.
-
-.I 220,temp
-\- Raw Attribute number 220 is the disk temperature in Celsius.
-
-Note: a table of hard drive models, listing which Attribute
-corresponds to temperature, can be found at:
-http://coredump.free.fr/linux/hddtemp.db
-
-.I N,raw8
-\- Print the Raw value of Attribute N as six 8-bit unsigned base-10
-integers. This may be useful for decoding the meaning of the Raw
-value. The form \'N,raw8\' prints Raw values for ALL Attributes in this
-form. The form (for example) \'123,raw8\' only prints the Raw value for
-Attribute 123 in this form.
-
-.I N,raw16
-\- Print the Raw value of Attribute N as three 16-bit unsigned base-10
-integers. This may be useful for decoding the meaning of the Raw
-value. The form \'N,raw16\' prints Raw values for ALL Attributes in this
-form. The form (for example) \'123,raw16\' only prints the Raw value for
-Attribute 123 in this form.
-
-.I N,raw48
-\- Print the Raw value of Attribute N as a 48-bit unsigned base-10
-integer. This may be useful for decoding the meaning of the Raw
-value. The form \'N,raw48\' prints Raw values for ALL Attributes in
-this form. The form (for example) \'123,raw48\' only prints the Raw
-value for Attribute 123 in this form.
-
-.TP
-.B \-P TYPE
-Specifies whether
-\fBsmartd\fP
-should use any preset options that are available for this drive. The
-valid arguments to this Directive are:
-
-.I use
-\- use any presets that are available for this drive. This is the default.
-
-.I ignore
-\- do not use any presets for this drive.
-
-.I show
-\- show the presets listed for this drive in the database.
-
-.I showall
-\- show the presets that are available for all drives and then exit.
-
-[Please see the
-.B smartctl \-P
-command-line option.]
-
-.TP
-.B \-a
-Equivalent to turning on all of the following Directives:
-.B \'\-H\'
-to check the SMART health status,
-.B \'\-f\'
-to report failures of Usage (rather than Prefail) Attributes,
-.B \'\-t\'
-to track changes in both Prefailure and Usage Attributes,
-.B \'\-l\ selftest\'
-to report increases in the number of Self-Test Log errors,
-.B \'\-l\ error\'
-to report increases in the number of ATA errors,
-.B \'\-C 197\'
-to report nonzero values of the current pending sector count, and
-.B \'\-U 198\'
-to report nonzero values of the offline pending sector count.
-
-Note that \-a is the default for ATA devices. If none of these other
-Directives is given, then \-a is assumed.
-
-.TP
-.B #
-Comment: ignore the remainder of the line.
-.TP
-.B \e
-Continuation character: if this is the last non-white or non-comment
-character on a line, then the following line is a continuation of the current
-one.
-.PP
-If you are not sure which Directives to use, I suggest experimenting
-for a few minutes with
-.B smartctl
-to see what SMART functionality your disk(s) support(s). If you do
-not like voluminous syslog messages, a good choice of
-\fBsmartd\fP
-configuration file Directives might be:
-.nf
-.B \-H \-l\ selftest \-l\ error \-f.
-.fi
-If you want more frequent information, use:
-.B -a.
-
-.TP
-.B ADDITIONAL DETAILS ABOUT DEVICESCAN
-If the first non-comment entry in the configuration file is the text
-string \fBDEVICESCAN\fP in capital letters, then \fBsmartd\fP will
-ignore any remaining lines in the configuration file, and will scan
-for devices.
-
-If \fBDEVICESCAN\fP is not followed by any Directives, then smartd
-will scan for both ATA and SCSI devices, and will monitor all possible
-SMART properties of any devices that are found.
-
-\fBDEVICESCAN\fP may optionally be followed by any valid Directives,
-which will be applied to all devices that are found in the scan. For
-example
-.nf
-.B DEVICESCAN -m root@example.com
-.fi
-will scan for all devices, and then monitor them. It will send one
-email warning per device for any problems that are found.
-.nf
-.B DEVICESCAN -d ata -m root@example.com
-.fi
-will do the same, but restricts the scan to ATA devices only.
-.nf
-.B DEVICESCAN -H -d ata -m root@example.com
-.fi
-will do the same, but only monitors the SMART health status of the
-devices, (rather than the default \-a, which monitors all SMART
-properties).
-
-.TP
-.B EXAMPLES OF SHELL SCRIPTS FOR \'\-M exec\'
-These are two examples of shell scripts that can be used with the \'\-M
-exec PATH\' Directive described previously. The paths to these scripts
-and similar executables is the PATH argument to the \'\-M exec PATH\'
-Directive.
-
-Example 1: This script is for use with \'\-m ADDRESS -M exec PATH\'. It appends
-the output of
-.B smartctl -a
-to the output of the smartd email warning message and sends it to ADDRESS.
-
-.nf
-\fB
-#! /bin/bash
-
-# Save the email message (STDIN) to a file:
-cat > /root/msg
-
-# Append the output of smartctl -a to the message:
-/usr/local/sbin/smartctl -a -d $SMART_DEVICETYPE $SMARTD_DEVICE >> /root/msg
-
-# Now email the message to the user at address ADD:
-/bin/mail -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS < /root/msg
-\fP
-.fi
-
-Example 2: This script is for use with \'\-m <nomailer> \-M exec
-PATH\'. It warns all users about a disk problem, waits 30 seconds, and
-then powers down the machine.
-
-.nf
-\fB
-#! /bin/bash
-
-# Warn all users of a problem
-wall \'Problem detected with disk: \' "$SMARTD_DEVICESTRING"
-wall \'Warning message from smartd is: \' "$SMARTD_MESSAGE"
-wall \'Shutting down machine in 30 seconds... \'
-
-# Wait half a minute
-sleep 30
-
-# Power down the machine
-/sbin/shutdown -hf now
-\fP
-.fi
-
-Some example scripts are distributed with the smartmontools package,
-in /usr/local/share/doc/smartmontools-5.1/examplescripts/.
-
-Please note that these scripts typically run as root, so any files
-that they read/write should not be writable by ordinary users or
-reside in directories like /tmp that are writable by ordinary users
-and may expose your system to symlink attacks.
-
-As previously described, if the scripts write to STDOUT or STDERR,
-this is interpreted as indicating that there was an internal error
-within the script, and a snippet of STDOUT/STDERR is logged to SYSLOG.
-The remainder is flushed.
-
-.\" ENDINCLUDE
-.\" DO NOT MODIFY THIS OR PREVIOUS/NEXT LINES. THIS DEFINES THE
-.\" END OF THE INCLUDE SECTION FOR smartd.conf.5
-
-.SH NOTES
-\fBsmartd\fP
-will make log entries at loglevel
-.B LOG_INFO
-if the Normalized SMART Attribute values have changed, as reported using the
-.B \'\-t\', \'\-p\',
-or
-.B \'\-u\'
-Directives. For example:
-.nf
-.B \'Device: /dev/hda, SMART Attribute: 194 Temperature_Celsius changed from 94 to 93\'
-.fi
-Note that in this message, the value given is the \'Normalized\' not the \'Raw\'
-Attribute value (the disk temperature in this case is about 22
-Celsius). The
-.B \'-R\'
-and
-.B \'-r\'
-Directives modify this behavior, so that the information is printed
-with the Raw values as well, for example:
-.nf
-.B \'Device: /dev/hda, SMART Attribute: 194 Temperature_Celsius changed from 94 [Raw 22] to 93 [Raw 23]\'
-.fi
-Here the Raw values are the actual disk temperatures in Celsius. The
-way in which the Raw values are printed, and the names under which the
-Attributes are reported, is governed by the various
-.B \'-v Num,Description\'
-Directives described previously.
-
-Please see the
-.B smartctl
-manual page for further explanation of the differences between
-Normalized and Raw Attribute values.
-
-\fBsmartd\fP
-will make log entries at loglevel
-.B LOG_CRIT
-if a SMART Attribute has failed, for example:
-.nf
-.B \'Device: /dev/hdc, Failed SMART Attribute: 5 Reallocated_Sector_Ct\'
-.fi
- This loglevel is used for reporting enabled by the
-.B \'\-H\', \-f\', \'\-l\ selftest\',
-and
-.B \'\-l\ error\'
-Directives. Entries reporting failure of SMART Prefailure Attributes
-should not be ignored: they mean that the disk is failing. Use the
-.B smartctl
-utility to investigate.
-
-Under Solaris with the default \fB/etc/syslog.conf\fP configuration,
-messages below loglevel \fBLOG_NOTICE\fP will \fBnot\fP be recorded.
-Hence all \fBsmartd\fP messages with loglevel \fBLOG_INFO\fP will be
-lost. If you want to use the existing daemon facility to log all
-messages from \fBsmartd\fP, you should change \fB/etc/syslog.conf\fP
-from:
-.nf
- ...;daemon.notice;... /var/adm/messages
-.fi
-to read:
-.nf
- ...;daemon.info;... /var/adm/messages
-.fi
-Alternatively, you can use a local facility to log messages: please
-see the \fBsmartd\fP '-l' command-line option described above.
-
-On Cygwin and Windows, the log messages are written to the event log
-or to a file. See documentation of the '-l FACILITY' option above for
-details.
-
-On Windows, the following built-in commands can be used to control
-\fBsmartd\fP, if running as a daemon:
-
-\'\fBsmartd status\fP\' \- check status
-
-\'\fBsmartd stop\fP\' \- stop smartd
-
-\'\fBsmartd reload\fP\' \- reread config file
-
-\'\fBsmartd restart\fP\' \- restart smartd
-
-\'\fBsmartd sigusr1\fP\' \- check disks now
-
-\'\fBsmartd sigusr2\fP\' \- toggle debug mode
-
-On WinNT4/2000/XP, \fBsmartd\fP can also be run as a Windows service:
-
-\'\fBsmartd install [options]\fP\' installs a service
-named "smartd" (display name "SmartD Service") using the command line
-\'/installpath/smartd.exe --service [options]\'.
-
-\'\fBsmartd remove\fP\' can later be used to remove the service entry
-from registry.
-
-Upon startup, the smartd service changes the working directory
-to its own installation path. If smartd.conf and blat.exe are stored
-in this directory, no \'-c\' option and \'-M exec\' directive is needed.
-
-The debug mode (\'-d\', \'-q onecheck\') does not work if smartd is
-running as service.
-
-The service can be controlled as usual with Windows commands \'net\'
-or \'sc\' (\'\fBnet start smartd\fP\', \'\fBnet stop smartd\fP\').
-
-Pausing the service (\'\fBnet pause smartd\fP\') sets the interval between
-disk checks (\'-i N\') to infinite.
-
-Continuing the paused service (\'\fBnet continue smartd\fP\') resets the
-interval and rereads the configuration file immediately (like \fBSIGHUP\fP):
-
-Continuing a still running service (\'\fBnet continue smartd\fP\' without
-preceding \'\fBnet pause smartd\fP\') does not reread configuration but
-checks disks immediately (like \fBSIGUSR1\fP).
-
-.SH LOG TIMESTAMP TIMEZONE
-
-When \fBsmartd\fP makes log entries, these are time-stamped. The time
-stamps are in the computer's local time zone, which is generally set
-using either the environment variable \'\fBTZ\fP\' or using a
-time-zone file such as \fB/etc/localtime\fP. You may wish to change
-the timezone while \fBsmartd\fP is running (for example, if you carry
-a laptop to a new time-zone and don't reboot it). Due to a bug in the
-\fBtzset(3)\fP function of many unix standard C libraries, the
-time-zone stamps of \fBsmartd\fP might not change. For some systems,
-\fBsmartd\fP will work around this problem \fIif\fP the time-zone is
-set using \fB/etc/localtime\fP. The work-around \fIfails\fP if the
-time-zone is set using the \'\fBTZ\fP\' variable (or a file that it
-points to).
-
-
-.SH RETURN VALUES
-The return value (exit status) of
-\fBsmartd\fP
-can have the following values:
-.TP
-.B 0:
-Daemon startup successful, or \fBsmartd\fP was killed by a SIGTERM (or in debug mode, a SIGQUIT).
-.TP
-.B 1:
-Commandline did not parse.
-.TP
-.B 2:
-There was a syntax error in the config file.
-.TP
-.B 3:
-Forking the daemon failed.
-.TP
-.B 4:
-Couldn\'t create PID file.
-.TP
-.B 5:
-Config file does not exist (only returned in conjunction with the \'-c\' option).
-.TP
-.B 6:
-Config file exists, but cannot be read.
-.TP
-.B 8:
-\fBsmartd\fP
-ran out of memory during startup.
-.TP
-.B 9:
-A compile time constant of\fB smartd\fP was too small. This can be caused by an
-excessive number of disks, or by lines in \fB /usr/local/etc/smartd.conf\fP that are too long.
-Please report this problem to \fB smartmontools-support@lists.sourceforge.net\fP.
-.TP
-.B 10
-An inconsistency was found in \fBsmartd\fP\'s internal data
-structures. This should never happen. It must be due to either a
-coding or compiler bug. \fIPlease\fP report such failures to
-smartmontools-support@lists.sourceforge.net.
-.TP
-.B 16:
-A device explicitly listed in
-.B /usr/local/etc/smartd.conf
-can\'t be monitored.
-.TP
-.B 17:
-\fBsmartd\fP
-didn\'t find any devices to monitor.
-.TP
-.B 254:
-When in daemon mode,
-\fBsmartd\fP
-received a SIGINT or SIGQUIT. (Note that in debug mode, SIGINT has
-the same effect as SIGHUP, and makes \fBsmartd\fP reload its
-configuration file. SIGQUIT has the same effect as SIGTERM and causes
-\fBsmartd\fP to exit with zero exit status.
-.TP
-.B 132 and above
-\fBsmartd\fP
-was killed by a signal that is not explicitly listed above. The exit
-status is then 128 plus the signal number. For example if
-\fBsmartd\fP
-is killed by SIGKILL (signal 9) then the exit status is 137.
-
-.PP
-.SH AUTHOR
-\fBBruce Allen\fP smartmontools-support@lists.sourceforge.net
-.fi
-University of Wisconsin \- Milwaukee Physics Department
-
-.PP
-.SH CONTRIBUTORS
-The following have made large contributions to smartmontools:
-.nf
-\fBCasper Dik\fP (Solaris SCSI interface)
-\fBChristian Franke\fP (Windows interface)
-\fBDouglas Gilbert\fP (SCSI subsystem)
-\fBGuido Guenther\fP (Autoconf/Automake packaging)
-\fBGeoffrey Keating\fP (Darwin ATA interface)
-\fBEduard Martinescu\fP (FreeBSD interface)
-\fBFr\*'ed\*'eric L. W. Meunier\fP (Web site and Mailing list)
-\fBKeiji Sawada\fP (Solaris ATA interface)
-\fBSergey Svishchev\fP (NetBSD interface)
-\fBDavid Snyder and Sergey Svishchev\fP (OpenBSD interface)
-\fBPhil Williams\fP (User interface and drive database)
-.fi
-Many other individuals have made smaller contributions and corrections.
-
-.PP
-.SH CREDITS
-.fi
-This code was derived from the smartsuite package, written by Michael
-Cornwell, and from the previous ucsc smartsuite package. It extends
-these to cover ATA-5 disks. This code was originally developed as a
-Senior Thesis by Michael Cornwell at the Concurrent Systems Laboratory
-(now part of the Storage Systems Research Center), Jack Baskin School
-of Engineering, University of California, Santa
-Cruz. \fBhttp://ssrc.soe.ucsc.edu/\fP .
-.SH
-HOME PAGE FOR SMARTMONTOOLS:
-.fi
-Please see the following web site for updates, further documentation, bug
-reports and patches:
-.nf
-.B
-http://smartmontools.sourceforge.net/
-
-.SH SEE ALSO:
-\fBsmartd.conf\fP(5), \fBsmartctl\fP(8), \fBsyslogd\fP(8),
-\fBsyslog.conf\fP(5), \fBbadblocks\fP(8), \fBide\-smart\fP(8), \fBregex\fP(7).
-
-.SH
-REFERENCES FOR SMART
-.fi
-An introductory article about smartmontools is \fIMonitoring Hard
-Disks with SMART\fP, by Bruce Allen, Linux Journal, January 2004,
-pages 74-77. This is http://www.linuxjournal.com/article.php?sid=6983
-online.
-
-If you would like to understand better how SMART works, and what
-it does, a good place to start is Section 8.41 of the \'AT
-Attachment with Packet Interface-5\' (ATA/ATAPI-5) specification. This
-documents the SMART functionality which the smartmontools
-utilities provide access to. You can find Revision 1 of this document
-at \fBhttp://www.t13.org/project/d1321r1c.pdf\fP .
-
-.fi
-Future versions of the specifications (ATA/ATAPI-6 and ATA/ATAPI-7),
-and later revisions (2, 3) of the ATA/ATAPI-5 specification are
-available from \fBhttp://www.t13.org/#FTP_site\fP .
-
-.fi
-The functioning of SMART was originally defined by the SFF-8035i
-revision 2 and the SFF-8055i revision 1.4 specifications. These are
-publications of the Small Form Factors (SFF) Committee. Links to
-these documents may be found in the References section of the
-smartmontools home page at \fBhttp://smartmontools.sourceforge.net/\fP .
-
-.SH
-CVS ID OF THIS PAGE:
-$Id: smartd.8.in,v 1.87 2004/09/07 13:01:51 ballen4705 Exp $
+++ /dev/null
-×:smartmontools:5.33:2004/09/07:smartd.conf:5::G:::
-▲:smartmontools:5.33:2004/09/10:smartctl:8:2005/03/28:G:tsekine@sdri.co.jp:Tatsuo Sekine:
-×:smartmontools:5.33:2004/09/07:smartd:8::G:::
OSDN Git Service
