blob: 8a8d54b0215c36e7e20236ec2048da4e3d35aa2c [file] [log] [blame]
Bram Moolenaara3fe8fe2013-07-13 15:33:20 +02001.TH XXD 1 "August 1996" "Manual page for xxd"
2.\"
3.\" 21st May 1996
4.\" Man page author:
5.\" Tony Nugent <tony@sctnugen.ppp.gu.edu.au> <T.Nugent@sct.gu.edu.au>
6.\" Changes by Bram Moolenaar <Bram@vim.org>
7.SH 名前
8.I xxd
9\- 16 進ダンプを作成したり、元に戻したり。
10.SH 書式
11.B xxd
12\-h[elp]
13.br
14.B xxd
15[options] [infile [outfile]]
16.br
17.B xxd
18\-r[evert] [options] [infile [outfile]]
19.SH 説明
20ファイルや標準入力から 16 進ダンプを作成します。
2116 進ダンプから元のバイナリに戻すこともできます。
22.BR uuencode (1)
23
24.BR uudecode (1)
25のように、バイナリデータを、メールに貼り付け可能な ASCII 形式に変換できた
26り、標準出力に出力することもできます。
27さらに、バイナリファイルにパッチを当てるという使い方もできます。
28.SH オプション
29.I infile
30を指定しなかった場合は、標準入力が読み込まれます。
31.I infile
32
33.RB \` \- '
34を指定した場合も、標準入力から読み込まれます。
35.I outfile
36を指定しなかった (または
37.RB \` \- '
38を指定した) 場合は、標準出力に出力されます。
39.PP
40引数の解釈処理は適当なので注意してください。パラメータを取らない引数は
41最初の一文字だけチェックされます。
42引数の文字とパラメータの間のスペースは省略可能です。
43パラメータは 10 進数、16 進数、8 進数で指定できます。
44.BR \-c8
45
46.BR "\-c 8"
47
48.B \-c 010
49
50.B \-cols 8
51はすべて同じ意味です。
52.PP
53.TP
54.IR \-a " | " \-autoskip
55オートスキップ: 連続した nul 行を一つの '*' で置き換える。
56.TP
57.IR \-b " | " \-bits
58ビット (2進数) ダンプ。
591 オクテットが "1" "0" 8 文字で出力されます。
60各行の行頭には 16 進数の行番号が表示されます。
61行末には ascii (または ebcdic) で表した場合の文字が表示されます。
62このモードでは \-r\-p\-i は機能しません。
63.TP
64.IR "\-c cols " | " \-cols cols"
65一行
66.RI < cols >
67オクテットで出力する。標準設定は 16 (\-i: 12, \-ps: 30, \-b: 6)。最大 256
68.TP
69.IR \-E " | " \-EBCDIC
70右端に出力される文字のエンコーディングを ASCII から EBCDIC に変更する。
7116 進ダンプの出力形式は変更されません。
72\-r\-p\-i が同時に指定された場合は何の効果もありません。
73.TP
74.IR "\-g bytes " | " \-groupsize bytes"
75出力を
76.RI < bytes >
77バイト (2 文字の 16 進数、または 8 文字の 2 進数) ごとにスペースで区切りま
78す。
79区切らずに出力するには
80.I \-g 0
81を指定してください。
82.RI < Bytes >
83の標準設定は \fI2\fP です。2 進ダンプの場合は \fI1\fP です。
84ポストスクリプト形式やインクルード形式で出力するときは、このオプションは使わ
85れません。
86.TP
87.IR \-h " | " \-help
88コマンドの説明を出力して終了する。変換は実行されません。
89.TP
90.IR \-i " | " \-include
91C インクルードファイル形式で出力します。入力ファイルの名前が付けられた静的配
92列の定義が出力されます。標準入力の場合は定義の中身だけ出力されます。
93.TP
94.IR "\-l len " | " \-len len"
95.RI < len >
96オクテットだけ出力する。
97.TP
98.IR \-p " | " \-ps " | " \-postscript " | " \-plain
99ポストスクリプト形式の 16 進ダンプを出力する。別名 プレーン 16 進ダンプ。
100.TP
101.IR \-r " | " \-revert
102元に戻す: 16 進ダンプからバイナリ形式に変換 (またはパッチ) します。
103ファイルへ出力する場合、出力先のファイルは切り詰めされません。
104行番号や特定の書式がないプレーン 16 進ダンプを読み込む場合は、
105.I \-r \-p
106を指定してください。空白と改行は無視されます。
107.TP
108.I \-seek offset
109.IR \-r
110の後で使われた場合: 16 進ダンプを出力するファイルの位置に
111.RI < offset >
112を加える。
113.TP
114.I \-s [+][\-]seek
115infile
116.RI < seek >
117バイト目 (絶対位置、または相対位置) から開始する。
118\fI+ \fRは、現在の標準入力の位置から相対的な位置を示します
119(標準入力から読み込むときのみ意味があります)。\fI\- \fRは、入力の終わりから
120の文字数を示します (\fI+\fR と同時に指定した場合は、現在の標準入力の位置から
121手前の位置を示します)。
122\-s 引数を指定しなかった場合は、現在のファイル位置から開始されます。
123.TP
124.I \-u
12516 進数の表記に大文字を使います。指定がない場合は小文字で出力されます。
126.TP
127.IR \-v " | " \-version
128バージョンを表示します。
129.SH 警告
130.PP
131.I xxd \-r
132では行番号の評価に関しての暗黙のルールがいくつかあります。
133出力ファイルがシーク可能なら、各行の行番号が順番通りに並んでなくても構いませ
134ん。位置が飛んでいても重なっていても大丈夫です。その場合、次の位置に移動する
135ために lseek(2) が使われます。
136出力ファイルがシーク不可なら、「隙間」だけが処理可能です。隙間は null バイト
137で埋められます。
138.PP
139.I xxd \-r
140は不正な入力をエラーにしません。ゴミは静かに読み飛ばされます。
141.PP
14216 進ダンプを編集するときは注意が必要です。
143.I xxd \-r
144は必要な桁 (\-c 引数参照) だけ 16 進データを読み込んで、行の残りを無視しま
145す。つまり、ascii (または ebcdic) を示している列への変更は無視されます。
146xxd \-r \-p でプレーン形式 (ポストスクリプト形式) 16 進ダンプを元に戻す場
147合は、列の数は影響しません。
1482 桁の 16 進数と認識できるものはすべて変換されます。
149.PP
150\fI% xxd \-i file\fR
151.br
152
153.br
154\fI% xxd \-i < file\fR
155.br
156の結果は違います。注意してください。
157.PP
158.I xxd \-s +seek
159
160.IR "xxd \-s seek" ,
161の違いは、lseek(2) を使って入力を "巻き戻す" かどうかです。'+' が意味を持つ
162のは、入力が標準入力で、xxd が起動されたときに標準入力のファイル位置がファイ
163ルの先頭ではなかった場合です。
164以下の例が分かりやすいかもしれません (もっと混乱するかも!)...
165.PP
166`cat' が既に標準入力を終わりまで読んでいるので、読む前に標準入力を巻き戻す必
167要がある。
168.br
169\fI% sh \-c "cat > plain_copy; xxd \-s 0 > hex_copy" < file\fR
170.PP
171ファイル位置 0x480 (=1024+128) 前方から 16 進ダンプする。
172`+' は 「現在地からの相対位置」を意味するので、dd が 1k 処理した後から、さら
173に `128' 進めます。
174.br
175\fI% sh \-c "dd of=plain_snippet bs=1k count=1; xxd \-s +128 > hex_snippet" < file\fR
176.PP
177ファイル位置 0x100 ( = 1024\-768) から 16 進ダンプする。
178.br
179\fI% sh \-c "dd of=plain_snippet bs=1k count=1; xxd \-s +\-768 > hex_snippet" < file\fR
180.PP
181このような使い方はあまりしませんし、`+' を使うこともほとんどないでしょう。
182\-s を使うときはいつでも、strace(1) や truss(1) を使って、xxd の働きをチェッ
183クすることをお勧めします。
184.SH 例
185.PP
186.br
187.BR ファイル
188の最初の三行 (16 進数で 0x30 バイト) 以降を出力する。
189.br
190\fI% xxd \-s 0x30 file\fR
191.PP
192.br
193.BR ファイル
194の最後から三行 (16 進数で 0x30 バイト) を出力する。
195.br
196\fI% xxd \-s \-0x30 file\fR
197.PP
198.br
199120 バイトを、平文 16 進ダンプ形式で一行に 20 オクテットずつ出力する。
200.br
201\fI% xxd \-l 120 \-ps \-c 20 xxd.1\fR
202.br
2032e54482058584420312022417567757374203139
204.br
20539362220224d616e75616c207061676520666f72
206.br
20720787864220a2e5c220a2e5c222032317374204d
208.br
209617920313939360a2e5c22204d616e2070616765
210.br
21120617574686f723a0a2e5c2220202020546f6e79
212.br
213204e7567656e74203c746f6e79407363746e7567
214.br
215
216.br
217この man ページの先頭から 120 バイトを一行に 12 オクテットずつ 16 進ダンプす
218る。
219.br
220\fI% xxd \-l 120 \-c 12 xxd.1\fR
221.br
2220000000: 2e54 4820 5858 4420 3120 2241 .TH XXD 1 "A
223.br
224000000c: 7567 7573 7420 3139 3936 2220 ugust 1996"
225.br
2260000018: 224d 616e 7561 6c20 7061 6765 "Manual page
227.br
2280000024: 2066 6f72 2078 7864 220a 2e5c for xxd"..\\
229.br
2300000030: 220a 2e5c 2220 3231 7374 204d "..\\" 21st M
231.br
232000003c: 6179 2031 3939 360a 2e5c 2220 ay 1996..\\"
233.br
2340000048: 4d61 6e20 7061 6765 2061 7574 Man page aut
235.br
2360000054: 686f 723a 0a2e 5c22 2020 2020 hor:..\\"
237.br
2380000060: 546f 6e79 204e 7567 656e 7420 Tony Nugent
239.br
240000006c: 3c74 6f6e 7940 7363 746e 7567 <tony@sctnug
241.PP
242.br
243xxd.1 の日付部分だけを出力する。
244.br
245\fI% xxd \-s 0x36 \-l 13 \-c 13 xxd.1\fR
246.br
2470000036: 3231 7374 204d 6179 2031 3939 36 21st May 1996
248.PP
249.br
250.B input_file
251
252.B output_file
253にコピーし、先頭に 0x00 を 100 バイト分付け加える。
254.br
255\fI% xxd input_file | xxd \-r \-s 100 > output_file\fR
256.br
257
258.br
259xxd.1 の日付を修正する。
260.br
261\fI% echo "0000037: 3574 68" | xxd \-r \- xxd.1\fR
262.br
263\fI% xxd \-s 0x36 \-l 13 \-c 13 xxd.1\fR
264.br
2650000036: 3235 7468 204d 6179 2031 3939 36 25th May 1996
266.PP
267.br
268中身がすべて 0x00 の 65537 バイトのファイルを作成する。
269ただし、最後のバイトだけは 'A' (hex 0x41)。
270.br
271\fI% echo "010000: 41" | xxd \-r > file\fR
272.PP
273.br
274作成したファイルをオートスキップを使って 16 進ダンプする。
275.br
276\fI% xxd \-a \-c 12 file\fR
277.br
2780000000: 0000 0000 0000 0000 0000 0000 ............
279.br
280*
281.br
282000fffc: 0000 0000 40 ....A
283.PP
284一文字の 'A' からなる 1 バイトのファイルを作成する。
285 '\-r \-s' の後に指定した数値がファイル中の行番号に加算され、結果、余計なバ
286イトが飛ばされる。
287.br
288\fI% echo "010000: 41" | xxd \-r \-s \-0x10000 > file\fR
289.PP
290.B vim(1)
291の中から xxd をフィルタとして実行し、
292マークされた `a' から `z' までの領域を 16 進ダンプする。
293.br
294\fI:'a,'z!xxd\fR
295.PP
296.B vim(1)
297の中から xxd をフィルタとして実行し、
298マークされた `a' から `z' までの領域をバイナリに戻す。
299.br
300\fI:'a,'z!xxd \-r\fR
301.PP
302.B vim(1)
303の中から xxd をフィルタとして実行し、
30416 進ダンプされた行を元に戻す。戻したい行にカーソルを移動して:
305.br
306\fI!!xxd \-r\fR
307.PP
308シリアル行から一文字読み込む
309.br
310\fI% xxd \-c1 < /dev/term/b &\fR
311.br
312\fI% stty < /dev/term/b \-echo \-opost \-isig \-icanon min 1\fR
313.br
314\fI% echo \-n foo > /dev/term/b\fR
315.PP
316.SH 返り値
317以下のエラー値が返ります:
318.TP
3190
320エラーなし。
321.TP
322\-1
323操作がサポートされていない (
324.I xxd \-r \-i
325はまだ不可です)。
326.TP
3271
328引数の解釈に関するエラー。
329.TP
3302
331入力ファイルに関する問題。
332.TP
3333
334出力ファイルに関する問題。
335.TP
3364,5
337指定された位置へシークできなかった。
338.SH 関連項目
339uuencode(1), uudecode(1), patch(1)
340.br
341.SH 警告
342この奇妙なツールは作者が使いやすいように作られています。
343自己責任で使ってください。ファイルをコピーし、それを調べ、ウィザードたれ。
344.br
345.SH バージョン
346このマニュアルは xxd バージョン 1.7 について説明しています。
347.SH 著者
348.br
349(c) 1990-1997 by Juergen Weigert
350.br
351<jnweiger@informatik.uni\-erlangen.de>
352.LP
353私の功績として自由に配布してください。
354.br
355儲かったら教えてください。
356.br
357損しても知りません。
358.PP
359マニュアルは Tony Nugent
360.br
361<tony@sctnugen.ppp.gu.edu.au> <T.Nugent@sct.gu.edu.au>
362.br
363によって書かれ、
364Bram Moolenaar が少し変更を加え、
365Juergen Weigert が編集しました。
366.PP