日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
SFTP(1) FreeBSD 一般コマンドマニュアル SFTP(1)
名称
sftp -- 安全なファイル転送プログラム
書式
sftp [-1246aCfpqrv] [-B buffer_size] [-b batchfile] [-c cipher]
[-D sftp_server_path] [-F ssh_config] [-i identity_file] [-l limit]
[-o ssh_option] [-P port] [-R num_requests] [-S program]
[-s subsystem | sftp_server] host
sftp [user@]host[:file ...]
sftp [user@]host[:dir[/]]
sftp -b batchfile [user@]host
解説
sftp は、暗号化された ssh(1) 通信路を通して、すべての操作を実行する、
ftp(1) に似た、対話型のファイル転送プログラムです。また、それは、公開鍵認
証と圧縮のように、ssh の多くの機能を使用します。sftp は、指定された host
に接続して、ログインし、次に、対話型のコマンドモードに入ります。
2 番目の使用法の形式は、対話型でない認証方法が使用されるなら、自動的に
ファイルを検索して、取り出します。そうでなければ、それは、成功した対話型
認証の後にファイルを検索して、取り出します。
3 番目の使用法の形式によって、sftp は、リモートのディレクトリで開始するこ
とができます。
最終の使用法の形式は、-b オプションを使用して、自動化されたセッションを可
能にします。そのような場合には、接続時にパスワードを入力する必要性を取り
除くために非対話式の認証を設定することが必要です (詳細については sshd(8)
と ssh-keygen(1) を参照してください)。
いくつかの使用形式は、パス名からのホスト名を区切るためにコロン文字を使用
するので、IPv6 アドレスは、曖昧さを避けるために角括弧で囲まれなければなり
ません。
オプションは、次の通りです:
-1 プロトコルバージョン 1 の使用を指定します。
-2 プロトコルバージョン 2 の使用を指定します。
-4 sftp が、IPv4 アドレスのみを使用すること強制します。
-6 sftp が、IPv6 アドレスのみを使用すること強制します。
-a ファイルの既存の部分的または完全なコピーに上書きするのではなく、
割り込まれた転送を継続することを試みます。部分的な内容が、転送さ
れているそれらと異なるなら、結果のファイルは、壊れていると思われ
ます。
-B buffer_size
sftp がファイル転送をおこなうさいのバッファサイズを指定します。
バッファを大きくすると、往復 (round trip) が少なくなりますが、そ
のぶんメモリは余計に消費します。デフォルトの値は、32768 バイトで
す。
-b batchfile
バッチモードは、stdin の代わりに入力 batchfile から一連のコマンド
を読み込みます。それは、ユーザの相互作用を欠くので、対話型でない
認証とともに使用されるべきです。`-' の batchfile は、標準入力を示
すために使用されます。sftp は、次のコマンドのいずれかが失敗するな
ら、異常終了します: get, put, reget, reput, rename, ln, rm,
mkdir, chdir, ls, lchdir, chmod, chown, chgrp, lpwd, df, symlink
と lmkdir。`-' 文字をコマンドの前に付けることによって、コマンドご
とのエラーでの終了を抑制することができます (例えば、-rm
/tmp/blah*)。
-C (ssh の -C フラグによって) 圧縮を有効にします。
-c cipher
データ転送を暗号化するために使用する方式 (cipher) を選択します。
このオプションは、直接 ssh(1) に渡されます。
-D sftp_server_path
(ssh(1) を経由するのではなく) 直接ローカル sftp サーバに接続しま
す。このオプションは、クライアントとサーバをデバッグする際に役に
立ちます。
-F ssh_config
ssh(1) のための代わりのユーザ毎の設定ファイルを指定します。このオ
プションは、直接 ssh(1) に渡されます。
-f 転送の直後にディスクにフラッシュされるファイルを要求します。ファ
イルをアップロードするとき、この機能は、サーバが
"fsync@openssh.com" 拡張を実装する場合のみ、有効にされます。
-i identity_file
公開鍵の認証のための identity (秘密鍵) が読み込まれるファイルを選
択します。このオプションは、直接 ssh(1) に渡されます。
-l limit
使用される帯域幅を制限します、Kbit/s で指定されます。
-o ssh_option
ssh_config(5) で使用される形式で ssh に渡すオプションを使用するこ
とができます。これは、個別の sftp コマンド行フラグがない、オプ
ションを指定するために役に立ちます。例えば、代わりのポートを使用
するためには、次のように指定します: sftp -oPort=24。以下にリスト
されたオプションのすべての詳細とそれらの指定できる値については、
ssh_config(5) を参照してください。
AddressFamily
BatchMode
BindAddress
CanonicalDomains
CanonicalizeFallbackLocal
CanonicalizeHostname
CanonicalizeMaxDots
CanonicalizePermittedCNAMEs
CertificateFile
ChallengeResponseAuthentication
CheckHostIP
Cipher
Ciphers
Compression
CompressionLevel
ConnectionAttempts
ConnectTimeout
ControlMaster
ControlPath
ControlPersist
GlobalKnownHostsFile
GSSAPIAuthentication
GSSAPIDelegateCredentials
HashKnownHosts
Host
HostbasedAuthentication
HostbasedKeyTypes
HostKeyAlgorithms
HostKeyAlias
HostName
IdentitiesOnly
IdentityAgent
IdentityFile
IPQoS
KbdInteractiveAuthentication
KbdInteractiveDevices
KexAlgorithms
LogLevel
MACs
NoHostAuthenticationForLocalhost
NumberOfPasswordPrompts
PasswordAuthentication
PKCS11Provider
Port
PreferredAuthentications
Protocol
ProxyCommand
ProxyJump
PubkeyAuthentication
RekeyLimit
RhostsRSAAuthentication
RSAAuthentication
SendEnv
ServerAliveInterval
ServerAliveCountMax
StrictHostKeyChecking
TCPKeepAlive
UpdateHostKeys
UsePrivilegedPort
User
UserKnownHostsFile
VerifyHostKeyDNS
-P port
リモートホストで接続するポートを指定します。
-p 元のファイルの更新時刻、アクセス時刻とモードを保持します。
-q 静かなモード: ssh(1) からの警告と診断メッセージと同様に進捗状況
メータを無効にします。
-R num_requests
どれだけの要求がどの時点においても未解決であるかを指定します。こ
れを増加させることは、ファイル転送速度をわずかに改善しますが、メ
モリ使用量を増加させます。デフォルトは、64 の未解決の要求です。
-r アップロードとダウンロードしているとき、すべてのディレクトリを再
帰的にコピーします。sftp は、ツリーの走査で遭遇するシンボリックリ
ンクをたどらないことに注意してください。
-S program
暗号化された接続のために使用する program の名前。プログラムは、
ssh(1) のオプションを理解しなければなりません。
-s subsystem | sftp_server
SSH2 サブシステムまたはリモートホストの sftp サーバのためのパスを
指定します。パスは、プロトコルバージョン 1 で sftp を使用するか、
またはリモートの sshd(8) が sftp サブシステムの設定を行っていない
とき、役に立ちます。
-v ログ記録するレベルを上げます。また、このオプションは、ssh に渡さ
れます。
対話型コマンド
対話型のモードで、sftp は、ftp(1) のものに似ている 1 組のコマンドを理解し
ます。コマンドは、大文字小文字を区別しません。空白を含んでいるパス名は、
引用符で囲まれなければなりません。glob(3) によって認識されるパス名内に含
まれているあらゆる特殊文字は、バックスラッシュ (`\') でエスケープされなけ
ればなりません。
bye sftp を終了します。
cd path
リモートディレクトリを path に変更します。
chgrp grp path
ファイル path のグループを grp に変更します。path は、glob(3) 文
字を含み、複数のファイルと一致します。grp は、数値の GID でなけれ
ばなりません。
chmod mode path
ファイル path のパーミッションを mode に変更します。path は、
glob(3) 文字を含み、複数のファイルと一致します。
chown own path
ファイル path の所有者を own に変更します。path は、glob(3) 文字
を含み、複数のファイルと一致します。own は、数値の UID でなければ
なりません。
df [-hi] [path]
カレントディレクトリ (または、指定された path) を保持しているファ
イルシステムのための使用情報を表示します。-h フラグが指定されるな
ら、容量情報は、"人間に読み込み可能な" 接尾辞を使用して表示されま
す。-i フラグは、容量情報に加えて i ノード情報の表示を要求しま
す。このコマンドは、``statvfs@openssh.com'' 拡張を実装するサーバ
でのみサポートされます。
exit sftp を終了します。
get [-afPpr] remote-path [local-path]
remote-path (リモートパス) を検索して、取り出し、ローカルマシン
で、それを格納します。ローカルのパス名が指定されないなら、それが
リモートマシンにあるのと同じ名前を与えられます。remote-path (リ
モートパス) は、glob(3) 文字を含み、複数のファイルと一致します。
それが行われ、local-path が指定されるなら、local-path (ローカルパ
ス) は、ディレクトリを指定しなければなりません。
-a フラグが指定されるなら、既存のファイルの部分的な転送を再開する
ことを試みます。再開は、ローカルファイルのあらゆる部分的なコピー
とリモートのコピーと一致すると仮定されることに注意してください。
リモートファイルの内容が部分的なローカルコピーと異なるなら、結果
のファイルは、壊れていると思われます。
-f フラグが指定されるなら、ディスクにファイルをフラッシュするため
にファイル転送が完了した後に、fsync(2) が呼び出されます。
-P または -p フラグのいずれかが指定されるなら、すべてのファイルの
パーミッションとアクセス時刻もまたコピーされます。
-r フラグが指定されるなら、ディレクトリは、再帰的にコピーされま
す。sftp は、再帰的な転送を実行するとき、シンボリックリンクをたど
らないことに注意してください。
help ヘルプテキストを表示します。
lcd path
パスへの変更のローカルディレクトリを path に変更します。
lls [ls-options [path]]
path または path が指定されないなら、カレントディレクトリのいずれ
かのローカルディレクトリのリストを表示します。ls-options は、ロー
カルシステムの ls(1) コマンドによってサポートされる、あらゆるフラ
グを含んでいます。path は、glob(3) 文字を含み、複数のファイルと一
致します。
lmkdir path
path によって指定されたローカルディレクトリを作成します。
ln [-s] oldpath newpath
oldpath (古いパス) から newpath (新しいパス) へのリンクを作成しま
す。-s フラグが指定されるなら、作成されるリンクは、シンボリックリ
ンクで、そうでなければ、ハードリンクです。
lpwd ローカルの作業ディレクトリを印刷 (表示) します。
ls [-1afhlnrSt] [path]
path または path が指定されないなら、カレントディレクトリのいずれ
かのリモートディレクトリのリストを表示します。path は、glob(3) 文
字を含み、複数のファイルと一致します。
次のフラグが、認識され、次に応じて ls の振る舞いを変更します:
-1 単一のカラム状の出力を生成します。
-a ドット (`.') で始まるファイルをリストします。
-f ソートしないでリストします。デフォルトのソートの順序は、
辞書編集順です。
-h ロング形式のオプションで使用されると、次の単位接尾辞を使
用します: サイズに対して 2 のべき乗を使用して 4 以下に桁
数を縮小する順序で (Byte, Kilobyte, Megabyte, Gigabyte,
Terabyte, Petabyte, Exabyte) バイト、キロバイト、メガバイ
ト、ギガバイト、テラバイト、ペタバイトとエクサバイト
(K=1024, M=1048576, など) です。
-l パーミッションと所有者の情報を含む追加の詳細を表示しま
す。
-n 数値的に表されるユーザとグループの情報で長いリストを生成
します。
-r リストのソート順を逆にします。
-S ファイルのサイズによってリストをソートします。
-t 最後の更新時刻によってリストをソートします。
lumask umask
ローカルの umask を umask に設定します。
mkdir path
path によって指定されたリモートのディレクトリを作成します。
progress
進行状況のメータの表示を切り替えます。
put [-afPpr] local-path [remote-path]
local-path (ローカルパス) をアップロードして、リモートマシンにそ
れを格納します。リモートパス名が指定されてないなら、ローカルマシ
ンの名前と同じ名前が与えられます。local-path (ローカルパス) は、
glob(3) 文字を含むことができ、複数のファイルとマッチすることがで
きます。複数のファイルが指定され、remote-path (リモートパス) が指
定されるなら、remote-path (リモートパス) は、ディレクトリを指定し
なければなりません。
-a フラグが指定されるなら、既存のファイルの部分的な転送を再開する
ことを試みます。再開は、リモートのファイルの任意の部分的なコピー
とローカルなコピーと一致していると仮定することに注意してくださ
い。ローカルなファイルの内容がリモートのローカルなコピーと異なる
なら、結果のファイルは、壊れていると思われます。
-f フラグが指定されるなら、ファイルが転送された後に、fsync(2) を
呼び出すために、要求がサーバに送信されます。これは、
"fsync@openssh.com" 拡張を実装しているサーバによってのみサポート
されることに注意してください。
-P または -p フラグのいずれかが指定されるなら、すべてのファイルの
パーミッションとアクセス時刻もまたコピーされます。
-r フラグが指定されるなら、ディレクトリは、再帰的にコピーされま
す。sftp は、再帰的な転送を実行するとき、シンボリックリンクをたど
らないことに注意してください。
pwd リモートのワーキングディレクトリを表示します。
quit sftp を終了します。
reget [-Ppr] remote-path [local-path]
remote-path (リモートパス) のダウンロードを再開します。-a フラグ
の設定がある get と同等です。
reput [-Ppr] [local-path] remote-path
[local-path] のアップロードを再開します。-a フラグが設定された
put と同等です。
rename oldpath newpath
リモートファイルの oldpath (古いパス) を newpath (新しいパス) に
名前を変更します。
rm path
path によって指定されるリモートファイルを削除します。
rmdir path
path によって指定されるリモートディレクトを削除します。
symlink oldpath newpath
oldpath (古いパス) から newpath (新しいパス) へのシンボリックリン
クを作成します。
version
sftp のプロトコルのバージョンを表示します。
!command
ローカルのシェルで、command (コマンド) を実行します。
! ローカルのシェルにエスケープします。
? help と同義語です。
関連項目
ftp(1), ls(1), scp(1), ssh(1), ssh-add(1), ssh-keygen(1), glob(3),
ssh_config(5), sftp-server(8), sshd(8)
T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh
filexfer-00.txt, January 2001, work in progress material.
FreeBSD 11.2 July 16, 2016 FreeBSD 11.2