.\" 	%NetBSD: ftp.1,v 1.101 2003/12/19 03:46:02 lukem Exp %
.\"
.\" Copyright (c) 1996-2003 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Luke Mewburn.
.\"
.\" 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. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the NetBSD
.\"	Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
.\"
.\"
.\" Copyright (c) 1985, 1989, 1990, 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.
.\"
.\"	@(#)ftp.1	8.3 (Berkeley) 10/9/94
.\" $FreeBSD$
.\"
.Dd December 19, 2003
.Dt FTP 1
.Os
.Sh 名称
.Nm ftp
.Nd
インターネットファイル転送プログラム
.Sh 書式
.Nm
.Op Fl 46AadefginpRtvV
.Bk -words
.Op Fl N Ar netrc
.Ek
.Bk -words
.Op Fl o Ar output
.Ek
.Bk -words
.Op Fl P Ar port
.Ek
.Bk -words
.Op Fl q Ar quittime
.Ek
.Bk -words
.Op Fl r Ar retry
.Ek
.Bk -words
.\" [-T dir,max[,inc]]
.Oo
.Fl T Xo
.Sm off
.Ar dir ,
.Ar max
.Op , Ar inc
.Sm on
.Xc
.Oc
.Ek
.Bk -words
.\" [[user@]host [port]]
.Oo
.Oo Ar user Ns Li \&@ Oc Ns Ar host
.Op Ar port
.Oc
.Ek
.Bk -words
.\" [[user@]host:[path][/]]
.Sm off
.Oo
.Op Ar user Li \&@
.Ar host Li \&:
.Op Ar path
.Op Li /
.Oc
.Sm on
.Ek
.Bk -words
.\" [file:///path]
.Sm off
.Oo
.Li file:/// Ar path
.Oc
.Sm on
.Ek
.Bk -words
.\" [ftp://[user[:password]@]host[:port]/path[/]]
.Sm off
.Oo
.Li ftp://
.Oo Ar user
.Op Li \&: Ar password
.Li \&@ Oc
.Ar host Oo Li \&: Ar port Oc
.Li / Ar path
.Op Li /
.Op Li ;type= Ar X
.Oc
.Sm on
.Ek
.Bk -words
.\" [http://[user[:password]@]host[:port]/path]
.Sm off
.Oo
.Li http://
.Oo Ar user
.Op Li \&: Ar password
.Li \&@ Oc
.Ar host Oo Li \&: Ar port Oc
.Li / Ar path
.Oc
.Sm on
.Ek
.Op Ar \&.\&.\&.
.Nm
.Bk -words
.Fl u Ar URL Ar file
.Ek
.Op Ar \&.\&.\&.
.Sh 解説
.Nm
は、
インターネット
標準の File Transfer Protocol (ファイル転送プロトコル)を用いて
ファイル転送を実現するためのコマンドです。
本コマンドは、リモートネットワークにあるサイトとの間で
ファイルを転送する手段をユーザに提供します。
.Pp
書式の後ろから 5 個の引数では、
.Tn HTTP
または
.Tn FTP
プロトコルを使うか、直接コピーするかにより、ファイルを
カレントディレクトリに取得します。
この機能はスクリプト用に最適です。
詳細な情報は、以下の
.Sx ファイルの自動取得
を参照して下さい。
.Pp
オプションは、コマンドライン上で指定するか、
コマンドインタプリタに対し指定できます。
.Bl -tag -width "port   "
.It Fl 4
.Nm
に IPv4 アドレスのみを使用するよう強制します。
.It Fl 6
.Nm
に IPv6 アドレスのみを使用するよう強制します。
.It Fl A
アクティブモード ftp の使用を強制します。
デフォルトでは、
.Nm
はパッシブモード ftp を試みたあとで、サーバがパッシブモードを
サポートしない場合、アクティブモードになります。
このオプションにより、
.Nm
は常にアクティブコネクションを使用するようになります。
これが有用なのは、パッシブモードを適切に実装していない
非常に古いサーバに接続するときだけです。
.It Fl a
.Nm
は通常のログイン手続きを飛ばして、かわりに anonymous ログインを
使います。
.It Fl d
デバッグを有効にします。
.It Fl e
コマンドラインでの編集を無効にします。
Emacs の ange-ftp モードで使うと有用です。
.It Fl f
.Tn FTP
プロキシまたは、
.Tn HTTP
プロキシ経由で転送する際に、キャッシュの再ロードを強制します。
.It Fl g
ファイル名展開を無効にします。
.It Fl i
複数ファイル転送を行っている間の対話的プロンプトモードを
オフにします。
.It Fl n
自動取得でない転送において、
最初に接続する際に
.Nm
に
.Dq 自動ログイン
を行なわせないようにします。
自動ログインが有効な場合は、
.Nm
はユーザのホームディレクトリの
.Pa .netrc
(下記参照) ファイルに、リモートマシンのアカウントを記述している
エントリがあるかどうかを調べます。
エントリが存在しない場合には、
.Nm
はリモートマシン上のログイン名 (デフォルトはローカルマシンでのユーザ
ID) を要求します。
そして、もし必要があればログイン用のパスワードと
アカウントの入力も促します。
自動取得の転送において自動ログインを上書きするためには、
ユーザ名 (と、場合によりパスワードと) を適切に指定してください。
.It Fl N Ar netrc
.Pa ~/.netrc
ではなく、
.Ar netrc
を使います。
これ以上の詳しい情報については、
.Sx .netrc ファイル
のセクションを参照してください。
.It Fl o Ar output
ファイルを自動取得する際、ファイル内容を
.Ar output
に格納します。
.Ar output
は、以下の、
.Sx ファイル名前付け規則
に従い解釈されます。
.Ar output
が
.Sq -
でもなく、また、
.Sq \&|
から始まらない場合は、指定されたファイルのうち最初のものだけを
取り込み、
.Ar output
に格納します。
他のファイル全てはリモート名のベースネームに
格納します。
.It Fl p
ファイアウォールを越える接続のためのパッシブモード操作を有効にします。
現在、
.Nm
はパッシブモードをまず試み、その後サーバがパッシブ接続を
サポートしていない場合にアクティブモードに移る動作が
デフォルトであるため、このオプションは推奨されていません。
.It Fl P Ar port
ポート番号を
.Ar port
に設定します。
.It Fl r Ar wait
接続に失敗した場合、
.Ar wait
秒待って、接続を再度試みます。
.It Fl q Ar quittime
接続が
.Ar quittime
秒以上止まると、終了します。
.It Fl R
プロキシを介さない自動取得の全てを再度開始します。
.It Fl t
パケットのトレースを有効にします。
.It Xo
.Fl T
.Sm off
.Ar direction ,
.Ar maximum
.Op , Ar increment
.Sm on
.Xc
.Ar direction
に対する最大転送速度を
.Ar maximum
バイト毎秒に設定します。
.Ar increment
が設定されていれば、増加幅を
.Ar increment
バイト毎秒に設定します。
詳細は、
.Ic rate
を参照下さい。
.It Fl u Ar URL file Op \&.\&.\&.
コマンド行で指定したファイルを、
.Ar URL
にアップロードします。
ここで、
.Ar URL
は、自動取得でサポートされる ftp URL タイプのいずれか 1 個です
(但し、ファイル 1 個だけアップロードする場合、ターゲットファイル名を
付けても構いません)。
.Ar file
は、アップロードするローカルファイル 1 個以上です。
.It Fl v
.Ic verbose
と
.Ic progress
を有効にします。
出力が端末である場合 (
.Ic progress
については、さらに
.Nm
がフォアグラウンドプロセスの場合)、これがデフォルトです。
.Nm
はデータ転送状況と、
リモートサーバからのすべてのレスポンスを表示します。
.It Fl V
入力が端末からの場合に、デフォルトの有効設定を上書きして、
.Ic verbose
と
.Ic progress
をともに無効にします。
.El
.Pp
.Nm
は、通信相手をコマンドラインで指定することが出来ます。
通信相手を
コマンドラインで指定した場合、
.Nm
は即座に指定したリモートマシンの
.Tn FTP
サーバプログラムとの接続を試みます。
それ以外の場合、
.Nm
は内部のコマンドインタプリタに入り、ユーザからの
コマンド入力を待ちます。
.Nm
がユーザからのコマンド入力待ち状態にあるときは、
.Ql ftp\*[Gt]
というプロンプトを出力します。
本状態の時には、
.Nm ftp
は以下のコマンドを受け付けます。
.Bl -tag -width Fl
.It Ic \&! Op Ar command Op Ar args
ローカルマシン上でシェルを起動します。
引数が指定された場合、最初の引数をコマンドとして実行し、
それ以降の引数はそのコマンドに対する引数として処理されます。
.It Ic \&$ Ar macro-name Op Ar args
.Ic macdef
コマンドで定義されたマクロ
.Ar macro-name
を実行します。
引数は展開されずにマクロに対して引き渡されます。
.It Ic account Op Ar passwd
一旦ログインに成功したあとで、資源にアクセスするためにリモートマシンから
要求される追加のパスワードを入力します。
引数が指定されない場合、ユーザに対してアカウントパスワード入力を
促すプロンプト表示がされます。
この場合の入力モードはエコーバック無しです。
.It Ic append Ar local-file Op Ar remote-file
ローカルファイルをリモートマシン上のファイルに追加書き込みします。
もし、
.Ar remote-file
が指定されていなければ、ローカルファイルの名前を
.Ic ntrans
や
.Ic nmap
の設定により修正した名前をリモートファイル名として使います。
ファイル転送では
.Ic type ,
.Ic format ,
.Ic mode ,
.Ic structure
の現在の設定が使われます。
.It Ic ascii
転送ファイルの
.Ic type
をネットワーク
.Tn ASCII
形式にします。
これはデフォルト時の設定です。
.It Ic bell
各ファイル転送コマンド終了時にベルを鳴らすように設定します。
.It Ic binary
ファイル転送
.Ic type
をバイナリイメージ転送をサポートするようにします。
.It Ic bye
リモートサーバとの
.Tn FTP
セッションを終了し、
.Nm ftp
を終了します。
EOF を入力した場合も同様に終了します。
.It Ic case
.Ic get ,
.Ic mget ,
.Ic mput
コマンドの際に行なわれる、リモートマシン上での
ファイル名前付けの大文字小文字の対応を切り替えます。
デフォルトでは
.Ic case
はオフですが、オンの場合にはリモートマシンファイル名の
すべての大文字が小文字に変換されて、ローカル マシンのディレクトリに
書き込まれます。
.It Ic \&cd Ar remote-directory
リモートマシン上での作業ディレクトリを
.Ar remote-directory
へ変更します。
.It Ic cdup
リモートマシン上での作業ディレクトリを親ディレクトリに変更します。
.It Ic chmod Ar mode remote-file
リモートマシン上のファイル
.Ar remote-file
の属性を、
.Ar mode
で指定したものに変更します。
.It Ic close
リモートサーバとの
.Tn FTP
セッションを終了します。
そしてコマンドインタプリタに戻ります。
定義されたマクロはすべて無効になります。
.It Ic \&cr
ASCII タイプでファイルの転送を行なう場合に、
復帰文字の除去を行なうかどうかを変更します。
ASCII 形式のファイル転送時には、
復帰/改行
の文字列によってレコードを表します。
.Ic \&cr
がオン (デフォルト) の時には、改行コードのみでレコードを区切る
.Ux
に適合するように、
復帰コードが転送データ列から除去されます。
.Ux
以外のリモートのシステムのレコードは
単独の改行文字を含む可能性があります。
ASCII タイプで転送を行った時には、そういった改行文字は
.Ic \&cr
がオフの場合にだけレコード区切り記号と区別して扱うことができます。
.It Ic debug Op Ar debug-value
デバッグモードを切り替えます。
.Ar debug-value
が指定されるとデバッグレベルとして設定されます。
デバッグモードが有効になると、
.Nm
はリモートマシンに送信されたコマンドを
.Ql \-\-\*[Gt]
に続けて表示します。
.It Ic delete Ar remote-file
リモートマシンのファイル
.Ar remote-file
を削除します。
.It Ic dir Op Ar remote-path Op Ar local-file
リモートマシン上のディレクトリの内容を表示します。
表示内容にはサーバが選択したシステム依存の情報を含みます。
例えば大部分の
.Ux
システムは
.Ql ls \-l
コマンドから得られる出力を表示します。
もし
.Ar remote-path
が指定されなければ、リモートマシン上のカレントディレクトリの内容が
表示されます。
もしプロンプトがオンだったら、
.Nm
は、最後の引数が本当に
.Ic dir
の出力を書き込むローカルファイルかどうか問い合わせます。
ローカルファイルの指定が無い場合、または
.Ar local-file
の指定が
.Sq Fl
だった場合は出力は画面に表示されます。
.It Ic disconnect
.Ic close
と同じです。
.It Ic edit
コマンドラインの編集機能、そして文脈に応じたコマンドとファイルの
補完機能を切り替えます。
これは入力が端末の場合は自動的に有効になり、そして
そうでなければ無効になります。
.It Ic epsv4
IPv4 コネクションで拡張コマンドである
.Dv EPSV ,
.Dv EPRT
コマンドを使用するかどうかを切り替えます。
まず、
.Dv EPSV /
.Dv EPRT
を試み、その後で、
.Dv PASV /
.Dv PORT
を行ないます。
デフォルトで有効になっています。
拡張コマンドに失敗すると、現在の接続の間だけ、
もしくは、
.Ic epsv4
を再度実行するまで、本オプションは一時的に無効とされます。
.It Ic exit
.Ic bye
と同じです。
.It Ic features
リモートサーバがどの機能をサポートしているかを
(コマンド
.Dv FEAT
を使い) 表示します。
.It Ic fget Ar localfile
.Ar localfile
中で一覧が指定されたファイルを取得します。
.Ar localfile
では、1 行 1 ファイル名です。
.It Ic form Ar format
ファイル転送形式を
.Ar format
と指定します。
デフォルトの (かつ唯一サポートされている) 形式は、
.Dq non-print
です。
.It Ic ftp Ar host Op Ar port
.Ic open
と同じです。
.It Ic gate Op Ar host Op Ar port
gate-ftp モードのオンオフを切替えます。
このモードは、TIS FWTK
や、Gauntlet ftp プロキシ経由の接続の際に使用します。
(ユーザが明示的に指定するか、
環境変数
.Ev FTPSERVER
で指定するかにより) gate-ftp サーバが設定されていない場合、
このモードの使用は許されません。
.Ar host
が与えられた場合、gate-ftp モードが有効になり、gate-ftp サーバとして
.Ar host
が設定されます。
これに加え、
.Ar port
も与えられた場合、gate-ftp サーバに接続するポートとして使用します。
.It Ic get Ar remote-file Op Ar local-file
リモートマシン上のファイル
.Ar remote-file
を取得してローカルマシン上に格納します。
ローカルファイル名
.Ar local-file
が指定されない場合、
ローカルファイル名は取得したファイルの
リモートマシン上の名前と同じになります。
ただし、その名前は
.Ic case ,
.Ic ntrans ,
.Ic nmap
の設定により変更される事があります。
ファイル転送の時には現在の
.Ic type ,
.Ic form ,
.Ic mode ,
.Ic structure
の設定が使用されます。
.It Ic glob
.Ic mdelete ,
.Ic mget ,
.Ic mput ,
.Ic mreget
を行なう場合のファイル名の展開のオン/オフを切り替えます。
.Ic glob
がオフの場合には、ファイル名は展開されずにそのままになります。
.Ic mput
でのファイル名展開の規則は
.Xr csh 1
のファイル名展開規則と同様です。
.Ic mdelete ,
.Ic mget ,
.Ic mreget
の場合には、
各々のリモートファイル名はリモートマシン上で別々に展開され、
リストはマージされません。
ディレクトリ名の展開は普通のファイル名の展開と異なる事があります。
つまり、展開の結果はリモートの OS と FTP サーバに依存しています。
これは
.Ql mls remote-files \-
を実行する事によってあらかじめ知ることができます。
注:
.Ic mget ,
.Ic mput ,
.Ic mreget
はファイルのディレクトリサブツリーを全て転送するものではありません。
そのようにしたい時はサブツリーの
.Xr tar 1
のアーカイブを作成してバイナリモードで転送します。
.It Ic hash Op Ar size
1 データブロック転送するごとに
ハッシュサイン (``#'') を出力するかどうかを切り替えます。
デフォルトでは 1 データブロックは 1024byte です。
これは
.Ar size
でバイト単位で指定する事で変更できます。
.Ic hash
を有効にすると、
.Ic progress
が無効になります。
.It Ic help Op Ar command
引数
.Ar command
の意味に関するヘルプメッセージを出力します。
引数が与えられない場合、
.Nm
は使用可能なコマンドの一覧を出力します。
.It Ic idle Op Ar seconds
リモートサーバ上のアイドルタイマを
.Ar seconds
秒に設定します。
.Ar seconds
が与えられない場合は現在のアイドルタイマ値を表示します。
.It Ic image
.Ic binary
と同じです。
.It Ic lcd Op Ar directory
ローカルマシン上の作業ディレクトリを変更します。
.Ar directory
名が与えられない場合はユーザのホームディレクトリに移動します。
.It Ic less Ar file
.Ic page
と同じです。
.It Ic lpage Ar local-file
.Ic "set pager"
オプションで指定したプログラムで
.Ar local-file
を表示します。
.It Ic lpwd
ローカルマシン上の作業ディレクトリを表示します。
.It Ic \&ls Op Ar remote-path Op Ar local-file
.Ic dir
と同じです。
.It Ic macdef Ar macro-name
マクロ定義を行ないます。
後続の行がマクロ
.Ar macro-name
として格納されます。
空行 (1 つのファイル内での連続した改行文字や端末からの連続した
復帰文字) は
マクロの入力モードを終了させます。
マクロの数の制限は 16 個で、定義されたマクロ全部で 4096
文字までがゆるされています。
マクロは
.Ic close
コマンドが実行されるまで定義された状態を持続します。
マクロプロセッサは `$' と `\e' を特別な文字として解釈します。
1つ以上の数字が続く `$' は、コマンドラインで呼び出したマクロの
対応する引数によって置き換えられます。
後ろに `i' が続く `$' は、マクロプロセッサに対して実行している
マクロのループを指示します。
最初のパスで `$i' はマクロを呼び出したコマンドラインの最初の引数に
置き換えられ、2 回目のパスで 2 つ目の引数に置き換えられ、それ以降も
同様に置き換えられます。
後ろに任意の文字が続いている `\e' はその文字に置き換えられます。
`\e' は `$' の特別な扱いを避けるために使用します。
.It Ic mdelete Op Ar remote-files
リモートマシンの
.Ar remote-files
を削除します。
.It Ic mdir Ar remote-files local-file
複数のリモートファイルを指定出来る点を除くと
.Ic dir
と同様です。
プロンプトがオンの時には、
.Nm
は最後の引数が
.Ic mdir
の出力を受け取るローカルファイルであるかをユーザに問い合わせます。
.It Ic mget Ar remote-files
リモートマシンで
.Ar remote-files
で指定されたファイルを展開し、展開により生成された各ファイル名の
ファイルに対して
.Ic get
を実行します。
ファイル名の展開の詳細は
.Ic glob
を参照してください。
生成されたファイル名は
.Ic case ,
.Ic ntrans ,
.Ic nmap
の設定に従い処理されます。
ファイルはローカルの作業ディレクトリに転送されます。
そのディレクトリは
.Ql lcd directory
で変更できます。
ローカルの新しいディレクトリは
.Ql "\&! mkdir directory"
で作成できます。
.It Ic mkdir Ar directory-name
リモートマシンにディレクトリを作ります。
.It Ic mls Ar remote-files local-file
複数のリモートファイル名を指定できる点と
.Ar local-file
を必ず指定しなければならない点を除くと
.Ic ls
と同様です。
プロンプトがオンの時には、
.Nm
は最後の引数が
.Ic mls
の出力を受け取る目標のローカルファイルであるかをユーザに確認します。
.It Ic mlsd Op Ar remote-path
.Ar remote-path
(指定のない場合はカレントディレクトリがデフォルトになります)
の内容を、
.Dv MLSD
を使い機械可読の形式で表示します。
表示形式は、
.Sq "remopts mlst ..."
により変更できます。
.It Ic mlst Op Ar remote-path
.Ar remote-path
(指定のない場合はカレントディレクトリがデフォルトになります)
の詳細な情報を、
.Dv MLST
を使い機械可読の形式で表示します。
表示形式は、
.Sq "remopts mlst ..."
により変更できます。
.It Ic mode Ar mode-name
ファイル転送モード
.Ic mode
を
.Ar mode-name
で指定したものに設定します。
デフォルトの (かつ唯一サポートされる) モードは、
.Dq stream
です。
.It Ic modtime Ar remote-file
リモートマシン上の指定ファイルの最終更新日時を参照します。
.It Ic more Ar file
.Ic page
と同じです。
.It Ic mput Ar local-files
引数として与えられたローカルファイルのリスト中の
ワイルドカードを展開し、
展開後の各ファイル名のファイルに対して
.Ic put
を実行します。
ファイル名の展開の詳細については
.Ic glob
を参照してください。
生成されたファイル名は
.Ic ntrans
と
.Ic nmap
の設定に従って処理されます。
.It Ic mreget Ar remote-files
.Ic mget
と同様ですが、
.Ic get
ではなく、
.Ic reget
を実行するところが異なります。
.It Ic msend Ar local-files
.Ic mput
と同じです。
.It Ic newer Ar remote-file Op Ar local-file
リモートマシンのファイルの最終更新日時の方が
ローカルマシンのファイルより新しい場合にのみファイルを取得します。
現在のシステムにファイルが無いときには、リモートファイルの方が
.Ic 新しい
ものとして扱われます。
その他については
.Ar get
と同じです。
.It Ic nlist Op Ar remote-path Op Ar local-file
.Ic ls
と同じです。
.It Ic nmap Op Ar inpattern outpattern
ファイル名のマッピング機能を設定したり解除したりします。
引数が無い場合にはマッピング機能が解除されます。
引数がある場合には、出力先のリモートファイル名の指定されていない
.Ic mput
コマンドと
.Ic put
コマンドの実行時に、リモートファイル名がマップされます。
同様な事が
.Ic mget
コマンドと
.Ic get
コマンドのローカルファイル名についても行われます。
このコマンドはファイルの命名規則、命名習慣が異なる非
.Ux
リモートマシンとの接続時に便利です。
マッピングは
.Ar inpattern
と
.Ar outpattern
によって設定されたパターンに従って行われます。
.Op Ar inpattern
は (すでに
.Ic ntrans
と
.Ic case
によって処理済の)
入力ファイル名のためのテンプレートです。
.Ar inpattern
に `$1', `$2', ..., `$9' の文字列を含むことによって、
変数を使用したテンプレートも使えます。
`$' を特別扱いしたくない時には
`\\' を使ってください。
他の文字はそのままその文字として扱われ、
.Ic nmap
の
.Op Ar inpattern
変数の値を決めるのに用いられます。
例えば、
.Ar inpattern
として $1.$2 が、
リモートファイルの名前として "mydata.data" が
与えられた時に、$1 は "mydata" という値となり、
$2 は "data" という値になります。
.Ar outpattern
は生成されるマッピング後のファイル名を決定します。
文字列の `$1', `$2', ...., `$9' は
.Ar inpattern
のテンプレートから生成される値に置き換えられます。
文字列の `$0' は元のファイル名で置き換えられます。
さらに、文字列の
.Ql Op Ar seq1 , Ar seq2
は
.Op Ar seq1
が空文字列でない時には
.Ar seq1
に、
空文字列の時には
.Ar seq2
に置き換えられます。
例えばコマンド
.Pp
.Bd -literal -offset indent -compact
nmap $1.$2.$3 [$1,$2].[$2,file]
.Ed
.Pp
は、
入力ファイル名 "myfile.data" と "myfile.data.old"
に対して出力ファイル名が "myfile.data" になり、
入力ファイル名 "myfile"
に対して出力ファイル名が "myfile.file" になり、
入力ファイル名 ".myfile" に対して
出力ファイル名が "myfile.myfile"になります。
例えば、`nmap $1 sed "s/  *$//" \*[Gt] $1'
のように、
.Ar outpattern
にはスペースが入っていても構いません。
文字 `$', `[', `]', `,' を特別扱いしたくない時には
`\e' を使ってください。
.It Ic ntrans Op Ar inchars Op Ar outchars
ファイル名の文字変換機能を設定したり解除したりします。
引数が無い場合には文字変換機能が解除されます。
引数がある場合には、出力先のリモートファイル名の指定されていない
.Ic mput
コマンドと
.Ic put
コマンドの実行時にリモートファイル名が変換されます。
同様な事が
.Ic mget
コマンドと
.Ic get
コマンドでもローカルファイルに対して行われます。
このコマンドは、異なるファイル命名規則、命名習慣を持つ非
.Ux
リモートマシンとの接続時に有効です。
ファイル名中の文字で、
.Ar inchars
の中の文字に一致するものが
.Ar outchars
の対応する文字に置き換えられます。
.Ar inchars
の中での文字の位置が
.Ar outchars
の長さを越えている時には、その文字はファイル名から削除されます。
.It Ic open Ar host Op Ar port
指定した
.Ar host
の
.Tn FTP
サーバとのコネクションを確立します。
ポート番号
.Ar port
を指定した場合、
.Nm
は指定したポート番号を用いて
.Tn FTP
サーバとのコネクションの確立を試みます。
.Ic "set auto-login"
オプションがオン (デフォルト時) の場合には、
.Nm
は自動的に
.Tn FTP
サーバに対してログインを行ないます (以下を参照)。
.It Ic page Ar file
.Ic file
を取得して、
.Ic "set pager"
オプションで指定されたプログラムを使って表示します。
.It Ic passive Op Cm auto
パッシブモードを切り替えます (引数を指定しない場合)。
.Cm auto
が与えられた場合、
.Ev FTPMODE
が
.Sq auto
に設定されたかのように動作します。
パッシブモードがオン 
(デフォルトの状態です) なら、
.Nm
は、全てのデータコネクションのためのコマンドとして、
.Dv PORT
コマンドの代わりに
.Dv PASV
コマンドを送ります。
.Dv PASV
コマンドはリモートのサーバにデータコネクションのためのポートを
開いて、そのポートのアドレスを返すよう要求します。
リモートサーバはそのポートで待ち (listen し)、クライアントはそこに
接続します。
より伝統的な
.Dv PORT
コマンドを使う場合は、クライアントがポートで待ち (listen し)、
そしてそのアドレスを
リモートサーバに送り、リモートサーバはそこに接続して来ます。
パッシブモードは
トラフィックの方向を制御するゲートウェイルータやホストを
経由して
.Nm
を使う場合に有用です。
(注意:
.Tn FTP
サーバが RFC 1123 の
.Dv PASV
コマンドをサポートしている必要がありますが、サポートしていない
ものもあります)
.It Ic pdir Op Ar remote-path
.Ic dir
.Op Ar remote-path
を実行し、その結果を
.Ic "set pager"
オプションで指定したプログラムを使い表示します。
.It Ic pls Op Ar remote-path
.Ic ls
.Op Ar remote-path
を実行し、その結果を
.Ic "set pager"
オプションで指定したプログラムを使い表示します。
.It Ic pmlsd Op Ar remote-path
.Ic mlsd
.Op Ar remote-path
を実行し、その結果を
.Ic "set pager"
オプションで指定したプログラムを使い表示します。
.It Ic preserve
受け取ったファイルの更新日時を保存するかどうかを切り替えます。
.It Ic progress
転送の進行状況を表す棒グラフ表示を切り替えます。
この棒グラフは、
.Ar ローカルファイル
として
.Sq Fl
か
.Sq \&|
で始まるコマンドが指定された転送では表示されません。
詳しくは
.Sx ファイル名の規則
を参照して下さい。
.Ic progress
を有効にすると、
.Ic hash
が無効になります。
.It Ic prompt
対話的プロンプトモードを切り替えます。
対話的プロンプトモードをオンにすることで、
複数ファイル転送時に転送ファイルの選択を行なえます。
対話的プロンプトモードをオフにすると (デフォルトはオン)、
.Ic mget
や
.Ic mput
で指定したファイルはすべて転送され、
.Ic mdelete
で指定したファイルはすべて削除されます。
.Pp
プロンプトモードがオンの時には、プロンプトにおいて以下の
コマンドが使用できます。
.Bl -tag -width 2n -offset indent
.It Cm a
現在のファイルについて
.Sq yes
とし、自動的に現在のコマンドに対する残りのすべての
ファイルに対しても
.Sq yes
とします。
.It Cm n
.Sq no
とし、ファイルを転送しません。
.It Cm p
現在のファイルについて
.Sq yes
とし、(
.Dq prompt off
が指定された場合と同様に) プロンプトモードをオフにします。
.It Cm q
現在の操作を終了します。
.It Cm y
.Sq yes
とし、ファイルを転送します。
.It Cm \&?
ヘルプメッセージを表示します。
.El
.Pp
これ以外の応答は現在のファイルに対する
.Sq yes
として扱われます。
.It Ic proxy Ar ftp-command
ftp コマンドを 2 本目の制御コネクション上で実行します。
本コマンドを用いることで、同時に 2 つのリモート
.Tn FTP
サーバとコネクションを確立し、
2 つのサーバ間でファイル転送を行なうようにすることができるようになります。
最初の
.Ic proxy
コマンドは
.Ic open
コマンドである必要があります。
これは、2 本目の制御コネクションを確立するために必要な操作です。
\&"proxy ?" とコマンドを実行することで、
2 本目のコネクションで使用可能な
.Tn FTP
コマンド一覧が表示されます。
以下のコマンドは
.Ic proxy
の後におかれた時には異なった働きをします。
.Ic open
は自動ログイン処理中には新しいマクロの定義を行いません。
.Ic close
はマクロの削除を行いません。
.Ic get
と
.Ic mget
は 1 本目の制御コネクションのホストから 2 本目の制御コネクションの
ホストにファイルの転送を行います。
.Ic put
と
.Ic mput
と
.Ic append
は 2 本目の制御コネクションのホストから 1 本目の制御コネクションの
ホストにファイルの転送を行います。
第三者によるファイル転送は、2 本目の制御コネクションのサーバが
.Tn FTP
プロトコルの
.Dv PASV
コマンドをサポートしているかどうかに依存します。
.It Ic put Ar local-file Op Ar remote-file
ローカルファイルをリモートマシンに転送します。
.Ar remote-file
が指定されない場合には、転送先でのファイル名は、
.Ic ntrans
か
.Ic nmap
の設定に基づく処理を行ったローカルファイルの名前が用いられます。
ファイル転送には
.Ic type ,
.Ic format ,
.Ic mode ,
.Ic structure
の現在の設定が用いられます。
.It Ic pwd
現在のリモートマシン上での作業ディレクトリを表示します。
.It Ic quit
.Ic bye
と同じです。
.It Ic quote Ar arg1 arg2 ...
引数で指定した文字列を、そのままリモート
.Tn FTP
サーバに送信します。
.It Xo
.Ic rate Ar direction
.Op Ar maximum Op Ar increment
.Xc
最大転送速度を
.Ar maximum
バイト毎秒に速度制限します。
.Ar maximum
が 0 の場合、速度制限は解除されます。
.Pp
.Ar direction
は、次のうちの 1 つです。
.Bl -tag -width "all" -offset indent -compact
.It Cm all
双方向とも。
.It Cm get
入り方向の転送。
.It Cm put
出方向の転送。
.El
.Pp
転送実行中に以下のシグナルを受けるたびに、最大転送速度
.Ar maximum
は
.Ar increment
バイト毎秒 (デフォルトは 1024) だけ増減されます。
シグナルは次の通りです。
.B
.Bl -tag -width "SIGUSR1" -offset indent
.It Dv SIGUSR1
.Ar maximum
を
.Ar increment
バイトだけ増加させます。
.It Dv SIGUSR2
.Ar maximum
を
.Ar increment
バイトだけ減少させます。
結果は必ず正の値になります。
.El
.Pp
.Ar maximum
が与えられない場合、現在の制限速度値が表示されます。
.Pp
注意:
ascii モード転送については、
.Ic rate
はまだ実装されていません。
.It Ic rcvbuf Ar size
ソケット受信バッファの大きさを
.Ar size
に設定します。
.It Ic recv Ar remote-file Op Ar local-file
.Ic get
と同じです。
.It Ic reget Ar remote-file Op Ar local-file
.Ic reget
は、
.Ic get
と似た動作を行ないますが、
.Ar local-file
が存在しており
.Ar remote-file
よりサイズが小さい場合には、
.Ar local-file
が
.Ar remote-file
が部分的にコピーされたものとみなして続きをコピーする点が異なります。
本コマンドは、コネクションが切断されがちなネットワーク経由で
大きいファイルを転送する際に有用です。
.It Ic remopts Ar command Op Ar command-options
リモート
.Tn FTP
サーバのオプションを設定します。
その際に、
.Ar command
に
.Ar command-options
を与えます
.Ns ( Ar command-options
の有無はコマンドにより扱われます)。
オプションをサポートすることが知られているリモート
.Tn FTP
コマンドには次のものがあります。
.Sq MLST
(これは
.Dv MLSD ,
.Dv MLST
に用いられます)。
.It Ic rename Op Ar from Op Ar to
リモートマシン上のファイル
.Ar from
が、
.Ar to
というファイル名にリネームされます。
.It Ic reset
リプライキューをクリアします。
本コマンドはリモート
.Tn FTP
サーバとの間でコマンド/リプライのシーケンスの再同期をとるのに使われます。
リモート
サーバにより
.Tn FTP
プロトコル違反が生じると、その後で、
再同期が必要になることがあります。
.It Ic restart Ar marker
このコマンドの直後の
.Ic get
や
.Ic put
を指定した
.Ar marker
位置から再開します。
.Ux
システムにおいては、通常 marker はファイルのバイトオフセットで指定します。
.It Ic rhelp Op Ar command-name
リモート
.Tn FTP
サーバからのヘルプを要求します。
.Ar command-name
を指定した場合、それも同様にサーバに渡されます。
.It Ic rmdir Ar directory-name
リモートマシン上のディレクトリを消去します。
.It Ic rstatus Op Ar remote-file
引数なしの場合、リモートマシンの状態を表示します。
.Ar remote-file
を指定した場合、リモートマシンの
.Ar remote-file
の状態を表示します。
.It Ic runique
ローカルマシンに保存されるファイルに対して
ユニークな名前を付加するかどうかを切り替えます。
.Ic get
や
.Ic mget
コマンドで目的のローカルファイルと同じ名前のファイルが既に存在する時には、
\&".1" が名前に付加されます。
その名前も既に存在する時には
\&".2" が付加されます。
このように順番に処理をし、
\&".99" になっても存在する時には
エラーメッセージが表示され、転送は行われません。
生成されたユニークなファイル名は報告されます。
注:
.Ic runique
はシェルコマンドで生成されるファイル名には効果がありません
(下記参照)。
デフォルトではオフになっています。
.It Ic send Ar local-file Op Ar remote-file
.Ic put
と同じです。
.It Ic sendport
.Dv PORT
コマンドを使用するかどうか切り替えます。
デフォルトでは、
.Nm
は各データ転送用のコネクションの確立の際に
.Dv PORT
コマンドの使用を試みます。
.Dv PORT
を使うことで複数ファイル転送を行なう場合の遅延を避けることが出来ます。
.Dv PORT
コマンドが失敗した場合、
.Nm
はデフォルトのデータポートを使用します。
.Dv PORT
コマンドが無効になった場合、データ転送時に
.Dv PORT
コマンドは使われません。
これはある種の
.Tn FTP
の実装で
.Dv PORT
コマンドは無視するが、誤っていて、受け入れたと返事を返すような
物に対して有効です。
.It Ic set Op Ar option Ar value
オプション
.Ar option
に、値
.Ar value
を設定します。
.Ar option ,
.Ar value
どちらも与えられない場合、全オプションとその値を表示します。
現在サポートされているオプションは次のとおりです。
.Bl -tag -width "http_proxy" -offset indent
.It Cm anonpass
デフォルトは
.Ev $FTPANONPASS
.It Cm ftp_proxy
デフォルトは
.Ev $ftp_proxy
.It Cm http_proxy
デフォルトは
.Ev $http_proxy
.It Cm no_proxy
デフォルトは
.Ev $no_proxy
.It Cm pager
デフォルトは
.Ev $PAGER
.It Cm prompt
デフォルトは
.Ev $FTPPROMPT
.It Cm rprompt
デフォルトは
.Ev $FTPRPROMPT
.El
.It Ic site Ar arg1 arg2 ...
引数で指定した文字列を、
.Dv SITE
コマンドの引数としてそのまま
.Tn FTP
サーバに送信します。
.It Ic size Ar remote-file
リモートマシン上の
.Ar remote-file
で指定したファイルのサイズを表示します。
.It Ic sndbuf Ar size
ソケットの送信バッファの大きさを
.Ar size
に設定します。
.It Ic status
.Nm ftp
の現在の状態を表示します。
.It Ic struct Ar struct-name
ファイル転送の
.Ar structure
を
.Ar struct-name
に設定します。
デフォルトの (そして唯一サポートされている) structure は、
.Dq file
です。
.It Ic sunique
リモートマシン上に転送するファイルのファイル名に対して、
一意な名前を付与するかどうかを切り替えます。
この機能が使えるためには、
リモートの
.Tn FTP
サーバが
.Tn FTP
プロトコルの
.Dv STOU
コマンドをサポートしていなければなりません。
リモートサーバがユニークな名前を報告します。
デフォルトではこの機能はオフになっています。
.It Ic system
リモートマシンで稼働している OS のタイプを表示します。
.It Ic tenex
.Tn TENEX
マシンと
通信するために必要なファイル転送モードを設定します。
.It Ic throttle
.Ic rate
と同じです。
.It Ic trace
パケットトレースをするかどうかを切り替えます。
.It Ic type Op Ar type-name
ファイル転送の
.Ic type
を
.Ar type-name
に変更します。
引数が指定されない場合には
現在のファイル転送タイプを表示します。
デフォルトタイプはネットワーク
.Tn ASCII
です。
.It Ic umask Op Ar newmask
リモートサーバのデフォルトの umask 値を
.Ar newmask
で指定した値に変更します。
.Ar newmask
が指定されていない場合は現在の umask 値を表示します。
.It Ic unset Ar option
オプション
.Ar option
の設定を解除します。
詳細については
.Ic set
を参照して下さい。
.It Ic usage Ar command
.Ar command
の使い方を表すメッセージを表示します。
.It Xo
.Ic user Ar user-name
.Op Ar password Op Ar account
.Xc
ユーザをリモート
.Tn FTP
サーバに認識させます。
.Ar password
が指定されていなくて、
.Tn FTP
サーバが必要とする場合は
(ローカルエコーをオフにしてから)
.Nm
がユーザに問い合わせます。
.Ar account
が指定されていなくて、
.Tn FTP
サーバが必要とする場合には、
.Nm
がユーザに問い合わせます。
リモートサーバがログイン時にアカウントを必要としないのに
.Ar account
フィールドが指定された場合には、ログイン処理の完了後に
account コマンドがリモートサーバに渡されます。
.Dq auto-login
を無効にした状態で
.Nm
が呼び出されない限り、
この処理は
.Tn FTP
サーバに最初につながった時に自動的に行われます。
.It Ic verbose
饒舌モードの切り替えをします。
饒舌モードの時には
.Tn FTP
サーバからの全ての応答が表示されます。
さらにこのモードがオンの時には、ファイル転送が終了した時に
転送効率に関する統計が報告されます。
デフォルトではオンになっています。
.It Ic xferbuf Ar size
ソケットの送信バッファ、受信バッファの大きさを
.Ar size
に設定します。
.It Ic \&? Op Ar command
.Ic help
コマンドと同じです。
.El
.Pp
スペースを含むコマンドの引数は、`"' マークで括って下さい。
.Pp
設定を切り替えるコマンドでは、設定を指定するために明示的に
.Ic on
か
.Ic off
を引数として指定できます。
.Pp
引数としてバイト数を取るコマンド (例えば、
.Ic hash ,
.Ic rate ,
.Ic xferbuf
など) は、その引数の後置オプションをサポートしており、引数の解釈を
変えることができます。サポートされる後置オプションは次のものです。
.Bl -tag -width 3n -offset indent -compact
.It Li b
無修正 (オプションです)
.It Li k
キロ。引数を 1024 倍します。
.It Li m
メガ。引数を 1048576 倍します。
.It Li g
ギガ。引数を 1073741824 倍します。
.El
.Pp
.Nm
が転送中にシグナル
.Dv SIGINFO
(
.Xr stty 1
の引数
.Dq status
を参照) か、
.Dv SIGQUIT
を受けると、その時点での転送レートの統計情報が
終了時の標準的なフォーマットと同じ形式で標準エラー出力に書き出されます。
.Sh ファイルの自動取得
標準的なコマンドに加えて、
このバージョンの
.Nm
は自動取得の機能をサポートします。
単にホスト名/ファイルのリストをコマンドラインで渡すだけで、
自動取得が有効になります。
.Pp
自動取得の要素として有効な構文は、以下の形式です。
.Bl -tag -width "FOO "
.\" [user@]host:[path][/]
.It Xo
.Sm off
.Op Ar user Li \&@
.Ar host Li \&:
.Op Ar path
.Op Li /
.Sm on
.Xc
.Dq 古典的な
.Tn FTP
の形式。
.Pp
.Ar path
に glob 文字が含まれており、ファイル名展開 (globbing) が
有効になっている場合 (
.Ic glob
を参照)、
.Ql mget path
と同等の処理が行なわれます。
.Pp
.Ar path
のディレクトリ要素に glob 文字が含まれていない場合、
.Ar path
のベースネーム
.Ns ( Xr basename 1
を参照) を名前として、
ファイルをローカルのカレントディレクトリに格納します。
そうでない場合、リモートの名前全体を、ローカルのルートディレクトリから
相対的に使用します。
.\" ftp://[user[:password]@]host[:port]/path[/][;type=X]
.It Xo
.Sm off
.Li ftp://
.Oo Ar user
.Op Li \&: Ar password
.Li \&@ Oc
.Ar host Oo Li \&: Ar port Oc
.Li / Ar path
.Op Li /
.Op Li ;type= Ar X
.Sm on
.Xc
.Tn FTP
URL 形式。
.Ic "set ftp_proxy"
が定義されていなければ
.Tn FTP
プロトコルで取得します。
そうでなければ
.Ic "set ftp_proxy"
で指定されたプロキシを経由した
.Tn HTTP
を使って URL を転送します。
.Ic "set ftp_proxy"
が定義されておらず、
.Ar user
が与えられている場合、
.Ar user
としてログインします。
この場合、
.Ar password
が与えられていれば、それを使います。
与えられていなければ、
プロンプトをユーザに表示して入力を促します。
.Pp
.Sq ;type=A
もしくは
.Sq ;type=I
のサフィックスが指定されると、転送タイプはそれぞれ、
ASCII または binary になります。
デフォルト転送タイプは binary です。
.Pp
.Cm RFC 1738
に準拠するために、
.Nm
は
.Dq ftp://
auto-fetch URL の
.Ar path
部分を次のように解釈します:
.Bl -bullet
.It
.Ar host Ns Oo Li \&: Ns Ar port Oc
の直後の
.Sq Li /
は、
.Ar path
の前のセパレータとして解釈され、
.Ar path
自身とは解釈されません。
.It
.Ar path
は、
.Sq Li /
で分離される、名前部分のリストであると解釈されます。
最後以外の各部分に対し、
.Nm
は
.Ic cd
に相当するコマンドを実行します。
最後のパス部分に対しては、
.Nm
は
.Ic get
に相当するコマンドを実行します。
.It
空の名前部分、すなわち
.Ar path
中の
.Sq Li //
や
.Ar path
の先頭の
.Sq Li /
は、ディレクトリ名無しの
.Ic cd
コマンドを実行させます。
これは有用ではないでしょう。
.It
パス部分の
.Sq Li \&% Ns Ar XX
は、
.Ar XX
が 16 進数文字コードであるとしてデコードされます。
これは、
.Ar path
が部分に分けられた後に実行されますが、各部分が
.Ic cd
や
.Ic get
のコマンドに相当する処理で使用される前に実行されます。
しばしば使用されるコードは、
.Sq Li \&%2F
(これは
.Sq Li /
を表現します) や
.Sq Li \&%7E
(これは
.Sq Li ~
を表現します) です。
.El
.Pp
上記の解釈の結果、次のようになります:
.Bl -bullet
.It
パスは、指定されたユーザもしくは
.Sq anonymous
ユーザのデフォルトログインディレクトリからの相対指定として解釈されます。
.Pa /
ディレクトリを要求する場合、パス先頭に
.Dq %2F
を使用して下さい。
ユーザのホームディレクトリを要求する場合
(そして、リモートサーバがその構文をサポートしている場合)、パス先頭に
.Dq %7Euser/
を使用して下さい。
例えば、
パスワード
.Sq mypass
を持つユーザ名
.Sq myname
として、
.Sq localhost
から
.Pa /etc/motd
を取得するには、
.Dq ftp://myname:mypass@localhost/%2fetc/motd
.It
正確な
.Ic cd
および
.Ic get
のコマンドの使用は、どこに
.Sq /
を使い、どこに
.Sq %2F
(または
.Sq %2f )
を使うかで制御可能です。
例えば、次の URL は指定されるコマンドに対応します:
.Bl -tag -width "ftp://host/%2Fdir1%2Fdir2%2Ffile"
.It ftp://host/dir1/dir2/file
.Dq "cd dir1" ,
.Dq "cd dir2" ,
.Dq "get file" .
.It ftp://host/%2Fdir1/dir2/file
.Dq "cd /dir1" ,
.Dq "cd dir2" ,
.Dq "get file" .
.It ftp://host/dir1%2Fdir2/file
.Dq "cd dir1/dir2" ,
.Dq "get file" .
.It ftp://host/%2Fdir1%2Fdir2/file
.Dq "cd /dir1/dir2" ,
.Dq "get file" .
.It ftp://host/dir1%2Fdir2%2Ffile
.Dq "get dir1/dir2/file" .
.It ftp://host/%2Fdir1%2Fdir2%2Ffile
.Dq "get /dir1/dir2/file" .
.El
.It
.Ic cd
に相当するコマンドで使用される各中間ディレクトリに対し、
適切なアクセスパーミッションが必要です。
.El
.\" http://[user[:password]@]host[:port]/path
.It Xo
.Sm off
.Li http://
.Oo Ar user
.Op Li \&: Ar password
.Li \&@ Oc
.Ar host Oo Li \&: Ar port Oc
.Li / Ar path
.Sm on
.Xc
.Tn HTTP
URL 形式です。
ファイル取得に
.Tn HTTP
プロトコルを用います。
.Ic "set http_proxy"
が定義されている場合、
.Tn HTTP
プロキシサーバへの URL として使用されます。
.Ar path
の取得に
.Tn HTTP
認証が必要であり、かつ、
.Sq user
(とオプションで
.Sq password
) が URL に含まれている場合、最初の認証処理にそれらを使います。
.\" file:///path
.It Xo
.Sm off
.Li file:/// Ar path
.Sm on
.Xc
ローカル URL 形式です。
ローカルホストの
.Pa / Ns Ar path
からコピーされます。
.El
.Pp
上で特に指定がない限り、かつ、
.Fl o Ar output
が指定されていない場合、ファイルはカレントディレクトリに
.Ar path
の
.Xr basename 1
として格納されます。
.Pp
古典的な形式または
.Tn FTP
URL形式で最後に
.Sq /
がある場合、もしくは
.Ar path
要素が空の場合、
.Nm
はそのサイトに接続して与えられたパスのディレクトリに
.Ic cd
し、以降の入力を受け付けるために対話モードに入ります。
これは
.Ic "set ftp_proxy"
が使用されている場合には動作しません。
.Pp
直接
.Tn HTTP
転送では HTTP 1.1 を使用します。
プロキシ経由の
.Tn FTP ,
.Tn HTTP
転送では、HTTP 1.0 を使用します。
.Pp
.Fl R
が指定されている場合、
.Tn FTP ,
.Tn HTTP
プロキシを介さない自動取得全てが再び開始されます。
.Tn FTP
に対しては、これは
.Nm get
でなく
.Nm reget
を使い実装されています。
.Tn HTTP
に対しては、これは、
.Tn "HTTP/1.1"
のディレクティブ
.Sq "Range: bytes="
を用いて実装されています。
.Pp
WWW 認証またはプロキシ WWW 認証が必要な場合、ユーザに対し
認証のためのユーザ名、パスワードの入力を促すプロンプトが
出力されます。
.Pp
URL にIPv6 の数値アドレスを指定した場合、例えば、
.Dq ftp://[::1]:21/
のように、アドレスを角括弧で囲う必要があります。
これは IPv6 の数値アドレスで使用するコロンが、ポート番号を区切る
セパレータでもあるためです。
.Sh ファイル転送の中止
ファイル転送を中断するためには、
端末のインタラプトキー (通常は Ctrl-C) を打鍵してください。
データ送信はただちに停止します。
データ受信は、
.Tn FTP
プロトコルの
.Dv ABOR
コマンドをリモートサーバに送ることで、サーバからのデータ送信が
止められます。
そしてそれ以降の受信データは捨てられます。
これが行われる速度は、リモートサーバが
.Dv ABOR
コマンドをサポートする方式に依存します。
リモートサーバが
.Dv ABOR
コマンドをサポートしていない時には、
要求したファイルをリモートサーバが送り終るまでプロンプトは現れません。
.Pp
.Nm
が ABOR 処理中のリモートサーバからの応答を待っている状態にある間に、
端末の割り込みキーシーケンスが使用された場合、コネクションは
閉じられます。
これは古くからの動作 (この状態では端末の割り込みは無視されます)
とは異なりますが、こちらの方がより便利と考えてのことです。
.Sh ファイル名の規則
.Nm
コマンドの引数として指定されたファイル名は、以下の規則で処理されます。
.Bl -enum
.It
ファイル名として
.Sq Fl
が指定された場合、
入力ファイル名の場合には標準入力
.Ar stdin
が、
出力ファイル名の場合には標準出力
.Ar stdout
が使用されます。
.It
ファイル名の先頭の文字が
.Sq \&|
の場合には、その後に指定された文字列はすべてシェルコマンドと解釈されます。
.Nm
は与えられた引数をつけて
.Xr popen 3
を用いてシェルを fork し、
標準出力から (標準入力へ) 読み出し (書き込み) ます。
シェルコマンドにスペースが含まれている時には
引数は引用符で囲まれなければなりません。
(例: 
.Dq Qq Li \&| ls\ \-lt
)
特に有用な例としては
.Dq Li dir \&"\&" \&|more
があります。
.It
上記のチェックにひっかからず、``globbing''
が有効になっている場合、
ローカルファイル名は
.Xr csh 1
のファイル名展開規則にしたがって展開されます。
(詳細は
.Ic glob
コマンドを参照)
ただし、
.Nm
のコマンドが 1 つのファイル名しか必要としない場合
(例えば
.Ic put )
は、ファイル名展開で生成された最初のファイル名だけが使用されます。
.It
.Ic mget
コマンドと
.Ic get
コマンドにおいてローカルファイル名が指定されない場合、
ローカルファイル名はリモートファイル名と同一になります。
ただし、これらのファイル名は
.Ic case  ,
.Ic ntrans ,
.Ic nmap
の設定によって変わることもあります。
結果として得られたファイル名は、
.Ic runique
が設定されていればさらに変わるかもしれません。
.It
.Ic mput
コマンドと
.Ic put
コマンドにおいてリモートファイル名が指定されない場合、
リモートファイル名はローカルファイル名と同一になります。
ただし、これらのファイル名は
.Ic ntrans ,
.Ic nmap
の設定によって変わることもあります。
結果として得られたファイル名は、
.Ic sunique
が設定されていればリモートサーバによって
さらに変えられる可能性があります。
.El
.Sh ファイル転送パラメータ
.Tn FTP
の仕様にはファイル転送時に影響を及ぼす多くのパラメータが規定されています。
.Ic type
は、
.Dq ascii ,
.Dq image
(binary),
.Dq ebcdic ,
.Dq local byte size
(ほとんど
.Tn PDP Ns -10
および
.Tn PDP Ns -20
のためのものです) のうちの 1 個が指定可能です。
.Nm
は、ascii と image のタイプを指定可能なのに加えて、
.Ic tenex
モードの転送を指定することにより
ローカルバイトサイズ 8 を指定することが可能です。
.Pp
.Nm
では、他の
.Ic mode ,
.Ic form ,
.Ic struct
のパラメータではデフォルト値だけが使用可能です。
.Sh .netrc ファイル
.Pa .netrc
ファイルは、自動ログイン処理のためのログイン情報および
初期設定情報を記述します。
.Fl N Ar netrc
オプションで上書きしない限り、かつ、環境変数
.Ev NETRC
で指定しない限り、
.Pa .netrc
ファイルは、ユーザのホームディレクトリに置きます。
.Pa .netrc
では以下のトークンが解釈されます。
これらはスペース、タブ、改行文字のいずれかによって分割されます。
.Bl -tag -width password
.It Ic machine Ar name
リモートマシン名
.Ar name
を定義します。
自動ログイン処理は、
.Pa .netrc
ファイル中を探し、
.Nm
のコマンドラインもしくは
.Ic open
コマンドの引数として指定されたリモートマシンに一致する
.Ic machine
トークンを探します。
一致するものがあった場合は、その後に続く
.Pa .netrc
トークンが処理され、その処理はファイル最後尾に行き着くか他の
.Ic machine
トークンまたは
.Ic default
トークンに出くわすまで続きます。
.It Ic default
任意の名前と一致すること以外は
.Ic machine
.Ar name
と同様です。
.Ic default
トークンは、
.Pa .netrc
ファイル中に 1 エントリだけが許され、
しかも他の全ての
.Ic machine
トークンより後ろでなければなりません。
通常は
.Pp
.Dl default login anonymous password user@site
.Pp
のように使用されます。
本エントリによって
.Pa .netrc
に指定の無いマシンに自動的に anonymous
.Tn FTP
ログインを試みるようになります。
自動ログインを無効にするために、
.Fl n
フラグを用いてこの処理を上書きすることができます。
.It Ic login Ar name
リモートマシンにおけるログイン名を指定します。
本トークンが与えられている場合、自動ログイン処理は指定した
.Ar name
を用いてログインを開始します。
.It Ic password Ar string
パスワードを指定します。
本トークンが指定されている場合でリモートサーバがログイン処理中に
パスワードを要求する場合は、自動ログイン処理は指定した文字列を
送ります。
.Pa .netrc
ファイルにおいて、
.Ar anonymous
以外のユーザに対し本トークンが存在している場合、
.Pa .netrc
がそのユーザ以外から読み込み可能ならば、
.Nm
は自動ログイン処理を中断します。
.It Ic account Ar string
追加のアカウントパスワードを指定します。
このトークンがあると、
追加のアカウントパスワードをリモートホストが必要とする時に
自動ログインプロセスが指定された文字列を与えます。
そうでない場合には、自動ログインプロセスは
.Dv ACCT
コマンドを与えます。
.It Ic macdef Ar name
マクロを定義します。
このトークンの機能は
.Nm
の
.Ic macdef
コマンドの機能に似ています。
マクロは指定された名前を用いて定義されます。
その内容は
.Pa .netrc
の次の行から始まり、空行 (改行文字の連続) が現れるまで続きます。
.Ic init
というマクロが定義されているならば、
自動ログイン処理の中での最後の段階で自動的に実行されます。
例えば
.Bd -literal -offset indent
default
macdef init
epsv4 off
.Ed
.Pp
が、空行の後に続きます。
.El
.Sh コマンドラインの編集機能
.Nm
は
.Xr editline 3
ライブラリを使った対話的なコマンドラインの編集をサポートします。
これは
.Ic edit
コマンドによって有効になり、そして入力が tty からの場合は
デフォルトで有効になっています。
カーソルキーで以前の行を呼び出して編集できます。
そして他にも GNU Emacs スタイルの編集用のキーが使えます。
.Pp
.Xr editline 3
ライブラリは
.Pa .editrc
ファイルで設定できます - より詳しくは
.Xr editrc 5
を参照して下さい。
.Pp
.Nm
には、文脈に依存したコマンドとファイル名の補完
(リモートファイルの補完を含む) 機能を提供するための
追加のキー割り当てが用意されています。
これを使うためには
.Xr editline 3
の
.Ic ftp-complete
コマンドにキーを割り当てて下さい。
これはデフォルトで TAB キーに割り当てられています。
.Sh コマンドラインプロンプト
デフォルトでは、
.Nm
は
.Dq "ftp\*[Gt] "
のコマンドラインプロンプトをユーザに表示します。
.Ic "set prompt"
コマンドを使うことでこれを変更できます。
.Pp
.Ic "set rprompt"
コマンドにより、スクリーンの右端 (コマンド入力の後) に
プロンプトを表示させることもできます。
.Pp
次の書式文字列は、与えられた情報で置き換えられます。
.Bl -tag -width "%% " -offset indent
.It Li \&%/
リモート側のカレントディレクトリ。
.\" %c[[0]n], %.[[0]n]
.It Xo
.Sm off
.Li \&%c
.Op Oo Li 0 Oc Ar n Ns ,
.Li \&%.
.Op Oo Li 0 Oc Ar n
.Sm on
.Xc
リモート側のカレントディレクトリの末尾の要素。
数字
.Em n
が与えられた場合は、末尾
.Em n
個の要素。
.Em n
が
.Sq 0
で始まる場合、
末尾要素の前に、スキップされた要素数が、
.Ns ( Sq \&%c
の場合) 書式
.\" ``/<number>trailing''
.Do
.Sm off
.Li / Li \*[Lt] Va number Li \*[Gt]
.Va trailing
.Sm on
.Dc
で、
.Ns ( Sq \&%.
の場合) 書式
.\" ``...trailing''
.Dq Li \&... Ns Va trailing
で置かれます。
.It Li \&%M
リモートホスト名。
.It Li \&%m
リモートホスト名のうち、最初の
.Sq \&.
までの部分。
.It Li \&%n
リモートユーザ名。
.It Li \&%%
.Sq %
1 文字。
.El
.Sh 環境変数
.Nm
は、以下の環境変数を使用します。
.Bl -tag -width "FTPSERVERPORT"
.It Ev FTPANONPASS
anonymous
.Tn FTP
転送の際に送付するパスワード。
デフォルトは、
.Dq Li `whoami`@
です。
.It Ev FTPMODE
デフォルトの動作モードを上書きします。
サポートする値は次のとおりです。
.Bl -tag -width "passive"
.It Cm active
アクティブモード。
.Tn FTP
のみ。
.It Cm auto
パッシブ / アクティブの自動判定 (これがデフォルトです)。
.It Cm gate
gate-ftp モード。
.It Cm passive
パッシブモード。
.Tn FTP
のみ。
.El
.It Ev FTPPROMPT
コマンド行プロンプト。
デフォルトは、
.Dq "ftp\*[Gt] "
です。
詳細は、
.Sx コマンドラインプロンプト
を参照して下さい。
.It Ev FTPRPROMPT
コマンド行右側のプロンプト。
デフォルトは
.Dq ""
です。
詳細は、
.Sx コマンドラインプロンプト
を参照して下さい。
.It Ev FTPSERVER
.Ic gate
が有効な時に gate-ftp サーバとして使用するホスト。
.It Ev FTPSERVERPORT
.Ic gate
が有効な時に gate-ftp サーバに接続するのに使うポート。
デフォルトは
.Dq ftpgate/tcp
で
.Fn getservbyname
を呼び出して返って来たポート。
.It Ev FTPUSERAGENT
.Tn HTTP
ユーザエージェントヘッダとして送る値。
.It Ev HOME
定義されていれば
.Pa .netrc
ファイルのデフォルトの置き場所となります。
.It Ev NETRC
.Pa .netrc
ファイルの別の置き場所。
.It Ev PAGER
各種コマンドでファイルを表示する際に使われます。
本環境変数が空か設定されていない場合のデフォルトは、
.Xr more 1
です。
.It Ev SHELL
デフォルトで起動するシェルを定義します。
.It Ev ftp_proxy
.Tn FTP
URL リクエストを発行する時に使う
.Tn FTP
プロキシの URL
(定義されていなければ標準の
.Tn FTP
プロトコルを使います)。
.Pp
.Em 注意 :
本環境変数はインタラクティブセッションでは使われません。
コマンド行での取得のためだけのものです。
.It Ev http_proxy
.Tn HTTP
URL リクエストを発行する時に使う
.Tn HTTP
プロキシの URL。
プロキシ認証が要求され、この URL ユーザ名とパスワードの指定がある場合、
そのプロキシに対し、最初に認証処理を試みる際にそれらを使用します。
.Pp
.Ev ftp_proxy ,
.Ev http_proxy
におけるユーザ名、パスワードの用法は、
(
.Xr lynx 1
など) それを使う他のプログラムとは互換性がないかもしれないことに
注意して下さい。
.Pp
.Em 注意 :
本環境変数はインタラクティブセッションでは使われません。
コマンド行での取得のためだけのものです。
.It Ev no_proxy
空白またはコンマで区切られたホスト名 (またはドメイン名) のリスト。
プロキシを使用しないホストやドメインを表します。
各エントリに対し、オプションで ":port" を指定できます。
これは、そのポートに対する接続のみにマッチングを制限します。
.El
.Sh 拡張パッシブモードとファイアウォール
ファイアウォールの設定によっては、
.Nm
は拡張パッシブモードが使えません。
単なる
.Ic ls
コマンドが、
.Pp
.Dl 229 Entering Extended Passive Mode (|||58551|)
.Pp
といったメッセージを表示した後にハングしたように見える場合には、
.Ic epsv4 off
として拡張パッシブモードを無効化する必要があります。
どのようにこれを自動化するかについては、前述の
.Sx .netrc ファイル
節を参照してください。
.Sh 関連項目
.Xr getservbyname 3 ,
.Xr editrc 5 ,
.Xr services 5 ,
.Xr ftpd 8
.Sh 規格
.Nm
は、以下の標準に準拠しているつもりです。
.Cm RFC 959 ,
.Cm RFC 1123 ,
.Cm RFC 1738 ,
.Cm RFC 2068 ,
.Cm RFC 2389 ,
.Cm RFC 2428 ,
.Cm RFC 2732 ,
.Cm draft-ietf-ftpext-mlst-11
.Sh 歴史
.Nm
コマンドは
.Bx 4.2
で現れました。
.Pp
コマンドラインの編集、文脈に依存したコマンドとファイルの補完、
進行状況を表す棒グラフ、ファイルや URL の自動取得、
更新時刻の保存、標準
.Bx
の
.Nm
に対するその他の拡張などといった多様な機能は、
.An Luke Mewburn
.Aq lukem@NetBSD.org
が、
.Nx 1.3
とそれ以後のリリースで実装しました。
.Pp
IPv6 サポートは  WIDE/KAME プロジェクトが追加しました (が、NetBSD
以外での本プログラムのバージョン全てでこの機能が存在するとは
限りません。
これは、オペレーティングシステムが IPv6 をサポートする際に、
KAME と類似のやりかたを取っているかどうかに依存します)。
.Sh バグ
多くのコマンド動作が正しいかどうかは、
リモートサーバの動作が適切かどうかに依存します。
.Pp
.Bx 4.2
の ascii モードでの転送時の復帰文字の取り扱いのエラーは訂正されています。
この訂正の結果として、
.Bx 4.2
のサーバとの間でバイナリファイルを ascii タイプを使用して転送した時に
不正転送をひき起こすことが
あります。
この問題を回避するためにはバイナリモードを用いて
ファイル転送をして下さい。
.Pp
.Nm
は、IPv4 マップドアドレス
.Po
.Li ::ffff:10.1.1.1
のような形式の IPv6アドレス
.Pc
の全てが
.Dv AF_INET
ソケットで扱うことができる IPv4 の宛先を表していると想定しています。
しかし、IPv6 の設定によっては、この想定が正しくないこともあります。
そのような環境では、IPv4 マップドアドレスは
.Dv AF_INET6
ソケットに直接渡さなければなりません。
例えば、あるサイトが IPv6-to-IPv4 変換として SIIT トランスレータを
使用しているとします。
このとき、
.Nm
はこの設定をサポートすることができません。