.\" $Xorg: xauth.man,v 1.3 2000/08/17 19:54:12 cpqbld Exp $
.\" Copyright 1993, 1998  The Open Group
.\" 
.\" All Rights Reserved.
.\" 
.\" The above copyright notice and this permission notice shall be included
.\" in all copies or substantial portions of the Software.
.\" 
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
.\" OTHER DEALINGS IN THE SOFTWARE.
.\" 
.\" Except as contained in this notice, the name of The Open Group shall
.\" not be used in advertising or otherwise to promote the sale, use or
.\" other dealings in this Software without prior written authorization
.\" from The Open Group.
.\" 
.\" Copyright (c) 1998, 2001 The X Japanese Documentation Project.
.\" 
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish, dis-
.\" tribute, sublicense, and/or sell copies of the Software, and to permit
.\" persons to whom the Software is furnished to do so, subject to the fol-
.\" lowing conditions:
.\" 
.\" The above copyright notice and this permission notice shall be included
.\" in all copies or substantial portions of the Software.
.\" 
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
.\" ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT
.\" SHALL  THE X JAPANESE DOCUMENTATION PROJECT  BE  LIABLE  FOR  ANY CLAIM,
.\" DAMAGES OR OTHER LIABILITY,  WHETHER IN AN ACTION OF CONTRACT,  TORT OR
.\" OTHERWISE,  ARISING FROM,  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.\" 
.\" Except as contained in this notice, the name of The X Japanese
.\" Documentation Project shall not be used in advertising or otherwise to
.\" promote the sale, use or other dealings in this Software without prior
.\" written authorization from The X Japanese Documentation Project.
.\" 
.\" X Window System is a trademark of The Open Group.
.\"
.\" Translated Fri Nov 21 7:00:00 JST 1997
.\"         by Kazuyuki Okamoto <ikko-@pacific.rim.or.jp>
.\" Modified Thu Nov 26 00:54:19 JST 1998 for XFree86 3.3.3
.\"         by FUJIWARA Teruyoshi <fujiwara@linux.or.jp>
.\" Updated Thu Oct 18 02:03:16 JST 2001 for XFree86 4.1.0
.\"         by FUJIWARA Teruyoshi <fujiwara@linux.or.jp>
.\"
.\" $XFree86: xc/programs/xauth/xauth.man,v 1.6 2001/01/27 18:21:07 dawes Exp $
.\"
.TH XAUTH 1 "Release 6.5" "X Version 11"
.SH 名前
.\"0 xauth \- X authority file utility
xauth \- X の認証ファイルを扱うユーティリティ
.SH 書式
.B xauth
[ \fB\-f\fP \fIauthfile\fP ] [ \fB\-vqib\fP ] [ \fIcommand arg ...\fP ]
.SH 説明
.PP
.\"0 The \fIxauth\fP program is used to edit and display the authorization 
.\"0 information used in connecting to the X server.  This program is usually
.\"0 used to extract authorization records from one machine and merge them 
.\"0 in on another (as is the case when using remote logins or granting
.\"0 access to other users).  Commands (described below) may be entered
.\"0 interactively, on the \fIxauth\fP command line, or in scripts.  Note
.\"0 that this program does \fBnot\fP contact the X server except when the
.\"0 generate command is used.
.\"0 Normally \fIxauth\fP is not used to create the authority file entry in
.\"0 the first place; \fIxdm\fP does that.
\fIxauth\fP プログラムは X サーバと接続するための認証情報の編集と表示に
使用する。このプログラムは通常、あるマシンから認証レコードを取り出し、
(リモートログインや他のユーザへのアクセスを許可する場合のように)他のマ
シンの認証レコードにマージするのに使用される。次に述べるコマンドは
\fIxauth\fP コマンド行から対話的に入力するか、スクリプト内で指定する。
このプログラムを generate コマンドを使う時以外には X サーバに
\fB接続しない\fP点に注意すること。
通常、\fIxauth\fP は最初に認証ファイルを作成するためには使われない。
それは \fIxdm\fP が行う。
.SH オプション
.\"0 The following options may be used with \fIxauth\fP.  They may be given 
.\"0 individually (e.g., \fI\-q \-i\|\fP) or may combined (e.g., 
.\"0 \fI\-qi\|\fP).
\fIxauth\fP では次のオプションを使うことができる。
オプションは別々に指定する(例えば \fI\-q \-i\|\fP)か、繋げて指定
する(例えば \fI\-qi\|\fP)。
.TP 8
.B "\-f \fIauthfile\fP"
.\"0 This option specifies the name of the authority file to use.  By 
.\"0 default,
.\"0 \fIxauth\fP will use the file specified by the XAUTHORITY environment 
.\"0 variable
.\"0 or \fI\.Xauthority\fP in the user's home directory.
このオプションは使用する認証ファイルの名前を指定する。デフォルトでは、
\fIxauth\fP は XAUTHORITY 環境変数で指定されたファイルまたはユーザの
ホームディレクトリの \fI\.Xauthority\fP を使用する。
.TP 8
.B \-q
.\"0 This option indicates that \fIxauth\fP should operate quietly and not 
.\"0 print
.\"0 unsolicited status messages.  This is the default if an \fIxauth\fP 
.\"0 command is
.\"0 is given on the command line or if the standard output is not directed 
.\"0 to a
.\"0 terminal.
このオプションを指定すると \fIxauth\fP が出力を控えて動作し、余計な
状態メッセージを出力しない。
\fIxauth\fP のコマンドをコマンド行から与えた場合と、標準出力が端末に
リダイレクトされていない場合には、このオプションがデフォルトで有効となる。
.TP 8
.B \-v
.\"0 This option indicates that \fIxauth\fP should operate verbosely and 
.\"0 print
.\"0 status messages indicating the results of various operations (e.g., how 
.\"0 many
.\"0 records have been read in or written out).  This is the default if 
.\"0 \fIxauth\fP
.\"0 is reading commands from its standard input and its standard output is
.\"0 directed to a terminal.
このオプションを指定すると、\fIxauth\fP は動作の表示を詳しく行うように
なり、色々な動作の結果(例: レコードをいくつ読み書きしたか)を出力する。
\fIxauth\fP のコマンドが標準入力から与えられた場合と、標準出力
が端末にリダイレクトされている場合は、このオプションがデフォルトで有効
となる。
.TP 8
.B \-i
.\"0 This option indicates that \fIxauth\fP should ignore any authority file
.\"0 locks.  Normally, \fIxauth\fP will refuse to read or edit any authority 
.\"0 files
.\"0 that have been locked by other programs (usually \fIxdm\fP or another 
.\"0 \fIxauth\fP).
このオプションを指定すると、\fIxauth\fP は全ての認証ファイルのロックを
無視する。通常、\fIxauth\fP は他のプログラム(通常は \fIxdm\fP や他の
\fIxauth\fP)によるロックがかかった認証ファイルの読み込みや編集を拒否する。
.TP 8
.B \-b
.\"0 This option indicates that \fIxauth\fP should attempt to break any 
.\"0 authority
.\"0 file locks before proceeding.  Use this option only to clean up stale 
.\"0 locks.
このオプションを指定すると、\fIxauth\fP は続行する前にファイルのロック
を解除しようとする。
このオプションは無意味になったロックを取り除く場合にだけ使用すること。
.SH コマンド
.\"0 The following commands may be used to manipulate authority files:
次のコマンドを使って認証ファイルを操作することができる:
.TP 8
.B "add \fIdisplayname protocolname hexkey"
.\"0 An authorization entry for the indicated display using the given 
.\"0 protocol
.\"0 and key data is added to the authorization file.  The data is specified 
.\"0 as
.\"0 an even-lengthed string of hexadecimal digits, each pair representing 
.\"0 one octet.  The first digit of each pair gives the most significant 4 
.\"0 bits
.\"0 of the octet, and the second digit of the pair gives the least 
.\"0 significant 4
.\"0 bits.  For example, a 32 character hexkey would represent a 128-bit 
.\"0 value.
.\"0 A protocol name consisting of just a 
.\"0 single period is treated as an abbreviation for 
.\"0 \fIMIT-MAGIC-COOKIE-1\fP.
指定したディスプレイに対する認証エントリー
(与えたプロトコルと鍵データを使う)を認証ファイルに追加する。
データは長さが偶数の 16 進数で指定され、それぞれの 16 進数はふたつずつ
のペアとなってオクテットを表す。
各ペアの最初の桁はオクテットの上位 4 ビットを与え、
次の桁は下位の 4 ビットを与える。
例えば、32 文字の 16 進数の鍵は 128 ビットの値を表す。
プロトコル名が単にひとつのピリオドである場合には、これは
\fIMIT-MAGIC-COOKIE-1\fP の省略形として扱われる。
.TP 8
.B "generate \fIdisplayname protocolname\fP 
\fR[\fPtrusted|untrusted\fR]\fP"
.B \fR[\fPtimeout \fIseconds\fP\fR]\fP  \fR[\fPgroup 
\fIgroup-id\fP\fR]\fP \fR[\fBdata \fIhexdata\fR]

.\"0 This command is similar to add.  The main difference is that instead
.\"0 of requiring the user to supply the key data, it connects to the
.\"0 server specified in \fIdisplayname\fP and uses the SECURITY extension
.\"0 in order to get the key data to store in the authorization file.  If
.\"0 the server cannot be contacted or if it does not support the SECURITY
.\"0 extension, the command fails.  Otherwise, an authorization entry for
.\"0 the indicated display using the given protocol is added to the
.\"0 authorization file.  A protocol name consisting of just a single
.\"0 period is treated as an abbreviation for \fIMIT-MAGIC-COOKIE-1\fP.
このコマンドは add に似ている。主な違いはユーザに鍵データを与えるよ
うに求めないで、\fIdisplayname\fP で指定したサーバに接続し、SECURITY
機能拡張を使って鍵データを取得し、認証ファイルに格納する。サーバに接
続できない場合や、SECURITY 機能拡張が使用できない場合には、コマンドは
失敗する。そうでない場合には、与えたプロトコルを使っている指定した
ディスプレイ用の認証エントリー認証ファイルに追加される。プロトコル名が
ただひとつのピリオドである場合、これは \fIMIT-MAGIC-COOKIE-1\fP の省略形
として扱われる。

.\"0 If the \fBtrusted\fP option is used, clients that connect using this
.\"0 authorization will have full run of the display, as usual.  If
.\"0 \fBuntrusted\fP is used, clients that connect using this authorization
.\"0 will be considered untrusted and prevented from stealing or tampering
.\"0 with data belonging to trusted clients.  See the SECURITY extension
.\"0 specification for full details on the restrictions imposed on
.\"0 untrusted clients.  The default is \fBuntrusted\fP.
\fBtrusted\fP オプションを使うと、この認証を使用して接続するクライアント
は通常通り、ディスプレイ上で制限なしに実行できる。\fBuntrusted\fP を
使用すると、この認証を使って接続するクライアントは信頼されず、信頼され
たクライアントが持つデータの窃盗や改竄を行うことができない。信頼されな
いクライアントに課せられた制限の詳細については SECURITY 機能拡張の仕様
を参照すること。このオプションのデフォルト値は \fBuntrusted\fP である。

.\"0 The \fBtimeout\fP option specifies how long in seconds this
.\"0 authorization will be valid.  If the authorization remains unused (no
.\"0 clients are connected with it) for longer than this time period, the
.\"0 server purges the authorization, and future attempts to connect using
.\"0 it will fail.  Note that the purging done by the server does \fBnot\fP
.\"0 delete the authorization entry from the authorization file.  The
.\"0 default timeout is 60 seconds.
\fBtimeout\fP オプションは、この認証の有効時間を秒単位で指定する。認証
がこの期間以上使用されないまま(クライアントが接続しない)の場合、サーバ
は認証を削除し、それ以降は、この認証を使った接続の試みは失敗する。サーバ
による削除では、認証ファイル内の認証エントリーの削除は\fB行われない\fP点
に注意すること。timeout のデフォルト値は 60 秒である。

.\"0 The \fBgroup\fP option specifies the application group that clients
.\"0 connecting with this authorization should belong to.  See the
.\"0 application group extension specification for more details.  The
.\"0 default is to not belong to an application group.
\fBgroup\fP オプションは、この認証で接続するクライアントの属する
アプリケーショングループを指定する。詳細についてはアプリケーショングループ
機能拡張の仕様を参照すること。デフォルトではどのアプリケーショングループ
にも属していない。

.\"0 The \fBdata\fP option specifies data that the server should use to
.\"0 generate the authorization.  Note that this is \fBnot\fP the same data
.\"0 that gets written to the authorization file.  The interpretation of
.\"0 this data depends on the authorization protocol.  The \fIhexdata\fP is
.\"0 in the same format as the \fIhexkey\fP described in the add command.
.\"0 The default is to send no data.
\fBdata\fP オプションはサーバが認証を生成するために使用するデータを指定
する。これは認証ファイルに書き込まれるデータと同じでは\fBない\fP点に
注意すること。このデータの解釈は認証プロトコルに依存する。\fIhexdata\fP
の書式は add コマンドの中に記述する \fIhexkey\fP と同じである。
デフォルトではデータを送信しない。

.TP 8
.B "[n]extract \fIfilename displayname..."
.\"0 Authorization entries for each of the specified displays are written to 
.\"0 the 
.\"0 indicated file.  If the \fInextract\fP command is used, the entries are 
.\"0 written
.\"0 in a numeric format suitable for non-binary transmission (such as secure
.\"0 electronic mail).  The extracted entries can be read back in using the 
.\"0 \fImerge\fP and \fInmerge\fP commands.  If the filename consists of 
.\"0 just a single dash, the entries will be written to the standard output.
指定したディスプレイ毎の認証エントリーが指定したファイルに書き込まれる。
\fInextract\fP コマンドを使用すると、認証エントリーは(危険のない電子メール
のような)バイナリ形式でない送信に向いている数値書式で書かれる。
取り出されたエントリーは \fImerge\fP と \fInmerge\fP コマンドを使って読
み戻すことができる。ファイル名がハイフンひとつだけ ('-') である場合は、
エントリーは標準出力に書き出される。

.TP 8
.B "[n]list \fR[\fIdisplayname\fP...]"
.\"0 Authorization entries for each of the specified displays (or all if no
.\"0 displays are named) are printed on the standard output.  If the 
.\"0 \fInlist\fP
.\"0 command is used, entries will be shown in the numeric format used by 
.\"0 the \fInextract\fP command; otherwise, they are shown in a textual 
.\"0 format.
.\"0 Key data is always displayed in the hexadecimal format given in the
.\"0 description of the \fIadd\fP command.
指定したディスプレイ毎(ディスプレイ名が無い場合は全て)の認証エントリー
が標準出力に出力される。\fInlist\fP コマンドを使った場合は、
認証エントリーは \fInextract\fP コマンドの説明で示した数値形式で表示される。
そうでない場合には、文字列形式で表示される。
鍵データは常に \fIadd\fP コマンドで説明した16進数形式で表示される。
.TP 8
.B "[n]merge \fR[\fIfilename\fP...]"
.\"0 Authorization entries are read from the specified files and are merged 
.\"0 into
.\"0 the authorization database, superceding any matching existing entries. 
.\"0 If
.\"0 the \fInmerge\fP command is used, the numeric format given in the 
.\"0 description
.\"0 of the \fIextract\fP command is used.  If a filename consists of just a 
.\"0 single
.\"0 dash, the standard input will be read if it hasn't been read before.
認証エントリーが指定したファイルから読み込まれ、認証データベースに
マージされる。
この際、既存のエントリーに一致するエントリーは上書きされる。
\fInmerge\fP コマンドを使用する場合は、 \fIextract\fP コマンドの項目で
説明した数値形式が使われる。
ファイル名がダッシュひとつだけ(`-')である場合、標準入力が以前に
読み込まれていなければ、エントリーは標準入力から読み込まれる。
.TP 8
.B "remove \fIdisplayname\fR..."
.\"0 Authorization entries matching the specified displays are removed from 
.\"0 the
.\"0 authority file.
指定したディスプレイとマッチする認証エントリーは認証ファイルから取り除
かれる。
.TP 8
.B "source \fIfilename"
.\"0 The specified file is treated as a script containing \fIxauth\fP 
.\"0 commands
.\"0 to execute.  Blank lines and lines beginning with a sharp sign (#) are 
.\"0 ignored.  A single dash may be used to indicate the standard input, if 
.\"0 it
.\"0 hasn't already been read.
指定したファイルは、実行する \fIxauth\fP コマンドを持つスクリプトとし
て扱われる。空白行とシャープ(#)で始まる行は無視される。
ファイル名が単にダッシュひとつだけ(`-')である場合、標準入力が既に
読み込み済みでなければ、エントリーは標準入力から読み込まれる。
.TP 8
.B "info"
.\"0 Information describing the authorization file, whether or not any 
.\"0 changes
.\"0 have been made, and from where \fIxauth\fP commands are being read
.\"0 is printed on the standard output. 
認証ファイルを記述する情報、変更がなされているかどうか、\fIxauth\fP コ
マンドの読み込み元を標準出力に出力する。
.TP 8
.B "exit"
.\"0 If any modifications have been made, the authority file is written out 
.\"0 (if
.\"0 allowed), and the program exits.  An end of file is treated as an 
.\"0 implicit
.\"0 \fIexit\fP command.
変更があった場合は認証ファイルは(許可があれば)書き出され、プログラムは
終了する。ファイルの終りは暗黙の \fIexit\fP コマンドとして扱われる。
.TP 8
.B "quit"
.\"0 The program exits, ignoring any modifications.  This may also be 
.\"0 accomplished
.\"0 by pressing the interrupt character.
変更を無視してプログラムを終了する。割り込みキーを押しても同じ結果が得
られる。
.TP 8
.B "help [\fIstring\fP]"
.\"0 A description of all commands that begin with the given string (or all
.\"0 commands if no string is given) is printed on the standard output.
与えた文字列で始まるすべてのコマンド(省略したときは全コマンド)の説明を
標準出力に表示する。
.TP 8
.B "?"
.\"0 A short list of the valid commands is printed on the standard output.
利用できるコマンドの簡単な一覧を標準出力に表示される。
.\".SH "DISPLAY NAMES"
.SH "ディスプレイ名"
.\"0 Display names for the \fIadd\fP, \fI[n]extract\fP, \fI[n]list\fP,
.\"0 \fI[n]merge\fP, and \fIremove\fP commands use the same format as the
.\"0 DISPLAY environment variable and the common \fI\-display\fP command line
.\"0 argument.  Display-specific information (such as the screen number)
.\"0 is unnecessary and will be ignored.
.\"0 Same-machine connections (such as local-host sockets,
.\"0 shared memory, and the Internet Protocol hostname \fIlocalhost\fP) are 
.\"0 referred to as \fIhostname\fP/unix:\fIdisplaynumber\fP so that
.\"0 local entries for different machines may be stored in one authority 
.\"0 file.
\fIadd\fP, \fI[n]extract\fP, \fI[n]list\fP, \fI[n]merge\fP,
\fIremove\fP で用いるディスプレイ名では、環境変数 DISPLAY や共通の 
\fI\-display\fP コマンド行引き数と同じ形式が使われる。ディスプレイ
固有の情報(スクリーン番号など)は必須ではなく無視される。
同一マシン上での接続(ローカルホストソケット、共有メモリ、IP ホスト名
の \fIlocalhost\fPなど)は \fIhostname\fP/unix:\fIdisplaynumber\fP 
の形式で参照されるので、異なるマシンに対するローカルのエントリーは
ひとつの認証ファイルに格納することができる。
.SH 例
.PP
.\"0 The most common use for \fIxauth\fP is to extract the entry for the 
.\"0 current display, copy it to another machine, and merge it into the 
.\"0 user's authority file on the remote machine:
\fIxauth\fP のもっとも一般的な使用法は、現在のディスプレイのエントリー
を取り出し、これを他のマシンにコピーして、リモートマシンのユーザの認証
ファイルにマージすることである:
.sp
.nf
        %  xauth extract \- $DISPLAY | rsh otherhost xauth merge \-
.fi
.PP
.sp
.\"0 The following command contacts the server :0 to create an
.\"0 authorization using the MIT-MAGIC-COOKIE-1 protocol.  Clients that
.\"0 connect with this authorization will be untrusted.
次のコマンドはサーバ :0 に接続し、MIT-MAGIC-COOKIE-1 プロトコルを使用
して認証を作成する。この認証で接続するクライアントは信頼されない。
.nf
	%  xauth generate :0 .
.fi
.SH 環境変数
.\"0 This \fIxauth\fP program uses the following environment variables:
\fIxauth\fP プログラムは次の環境変数を使用する:
.TP 8
.B XAUTHORITY
.\"0 to get the name of the authority file to use if the \fI\-f\fP option 
.\"0 isn't
.\"0 used.
\fI\-f\fP オプションを使用していない場合に認証ファイルの名前を得る。
.TP 8
.B HOME
.\"to get the user's home directory if XAUTHORITY isn't defined.
XAUTHORITY が定義されていない場合にユーザのホームディレクトリを得る。
.SH ファイル
.TP 8
.I $HOME/.Xauthority
.\"0 default authority file if XAUTHORITY isn't defined.
XAUTHORITY が定義されていない場合のデフォルトの認証ファイル。
.SH バグ
.PP
.\"0 Users that have unsecure networks should take care to use encrypted 
.\"0 file transfer mechanisms to copy authorization entries between 
.\"0 machines.  
.\"0 Similarly, the \fIMIT-MAGIC-COOKIE-1\fP protocol is not very useful in
.\"0 unsecure environments.  Sites that are interested in additional security
.\"0 may need to use encrypted authorization mechanisms such as Kerberos.
安全でないネットワークを使っているユーザは、マシン間で認証エントリーを
コピーする際には暗号化されたファイル転送の機構を注意深く使用するべきで
ある。
同様に、\fIMIT-MAGIC-COOKIE-1\fP プロトコルは安全でない環境ではあまり
役に立たない。セキュリティ強化に留意しているサイトでは、
Kerberos のような暗号化認証機構を使用する必要があるだろう。
.PP
.\"0 Spaces are currently not allowed in the protocol name.  Quoting could be
.\"0 added for the truly perverse.
現在、プロトコル名では空白が使用できない。そんなひねくれた仕様に
しなくても、クォートを追加できたはずであるが。
.SH 著者
Jim Fulton, MIT X Consortium