Mercurial > vim
annotate runtime/doc/xxd.man @ 33299:4c975fa0a442 v9.0.1915
patch 9.0.1915: r_CTRL-C works differently in visual mode
Commit: https://github.com/vim/vim/commit/476733f3d06876c7ac105e064108c973a57984d3
Author: Christian Brabandt <cb@256bit.org>
Date: Tue Sep 19 20:41:51 2023 +0200
patch 9.0.1915: r_CTRL-C works differently in visual mode
Problem: r_CTRL-C works differently in visual mode
Solution: Make r_CTRL-C behave consistent in visual mode
in terminal and Windows GUI
in visual mode, r CTRL-C behaves strange in Unix like environments. It
seems to end visual mode, but still is waiting for few more chars,
however it never seems to replace it by any characters and eventually
just returns back into normal mode.
In contrast in Windows GUI mode, r_CTRL-C replaces in the selected area
all characters by a literal CTRL-C.
Not sure why it behaves like this. It seems in the Windows GUI, got_int
is not set and therefore behaves as if any other normal character has
been pressed.
So remove the special casing of what happens when got_int is set and
make it always behave like in Windows GUI mode. Add a test to verify it
always behaves like replacing in the selected area each selected
character by a literal CTRL-C.
closes: #13091
closes: #13112
Signed-off-by: Christian Brabandt <cb@256bit.org>
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Tue, 19 Sep 2023 21:00:03 +0200 |
| parents | 912224cab37f |
| children | 56d291e65044 |
| rev | line source |
|---|---|
| 6918 | 1 XXD(1) General Commands Manual XXD(1) |
| 7 | 2 |
| 3 | |
| 4 | |
| 5 NAME | |
| 6 xxd - make a hexdump or do the reverse. | |
| 7 | |
| 8 SYNOPSIS | |
| 9 xxd -h[elp] | |
| 10 xxd [options] [infile [outfile]] | |
| 11 xxd -r[evert] [options] [infile [outfile]] | |
| 12 | |
| 13 DESCRIPTION | |
| 36 | 14 xxd creates a hex dump of a given file or standard input. It can also |
| 15 convert a hex dump back to its original binary form. Like uuencode(1) | |
| 16 and uudecode(1) it allows the transmission of binary data in a `mail- | |
| 6918 | 17 safe' ASCII representation, but has the advantage of decoding to stan‐ |
| 36 | 18 dard output. Moreover, it can be used to perform binary file patching. |
| 7 | 19 |
| 20 OPTIONS | |
| 6918 | 21 If no infile is given, standard input is read. If infile is specified |
| 22 as a `-' character, then input is taken from standard input. If no | |
| 36 | 23 outfile is given (or a `-' character is in its place), results are sent |
| 24 to standard output. | |
| 7 | 25 |
| 6918 | 26 Note that a "lazy" parser is used which does not check for more than |
| 27 the first option letter, unless the option is followed by a parameter. | |
| 28 Spaces between a single option letter and its parameter are optional. | |
| 36 | 29 Parameters to options can be specified in decimal, hexadecimal or octal |
| 30 notation. Thus -c8, -c 8, -c 010 and -cols 8 are all equivalent. | |
| 7 | 31 |
| 32 -a | -autoskip | |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
33 Toggle autoskip: A single '*' replaces nul-lines. Default off. |
| 7 | 34 |
| 35 -b | -bits | |
| 36 | 36 Switch to bits (binary digits) dump, rather than hexdump. This |
| 37 option writes octets as eight digits "1"s and "0"s instead of a | |
| 38 normal hexadecimal dump. Each line is preceded by a line number | |
| 6918 | 39 in hexadecimal and followed by an ascii (or ebcdic) representa‐ |
| 36 | 40 tion. The command line switches -r, -p, -i do not work with this |
| 41 mode. | |
| 7 | 42 |
| 43 -c cols | -cols cols | |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
44 Format <cols> octets per line. Default 16 (-i: 12, -ps: 30, -b: |
|
27118
2f854597399f
patch 8.2.4088: xxd cannot output everything in one line
Bram Moolenaar <Bram@vim.org>
parents:
13571
diff
changeset
|
45 6). Max 256. No maxmimum for -ps. With -ps, 0 results in one |
|
2f854597399f
patch 8.2.4088: xxd cannot output everything in one line
Bram Moolenaar <Bram@vim.org>
parents:
13571
diff
changeset
|
46 long line of output. |
| 7 | 47 |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
48 -C | -capitalize |
| 29352 | 49 Capitalize variable names in C include file style, when using |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
50 -i. |
|
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
51 |
| 7 | 52 -E | -EBCDIC |
| 36 | 53 Change the character encoding in the righthand column from ASCII |
| 54 to EBCDIC. This does not change the hexadecimal representation. | |
| 55 The option is meaningless in combinations with -r, -p or -i. | |
| 7 | 56 |
| 6918 | 57 -e Switch to little-endian hexdump. This option treats byte groups |
| 58 as words in little-endian byte order. The default grouping of 4 | |
| 59 bytes may be changed using -g. This option only applies to hex‐ | |
| 29352 | 60 dump, leaving the ASCII (or EBCDIC) representation unchanged. |
| 6918 | 61 The command line switches -r, -p, -i do not work with this mode. |
| 62 | |
| 7 | 63 -g bytes | -groupsize bytes |
| 29352 | 64 Separate the output of every <bytes> bytes (two hex characters |
| 6918 | 65 or eight bit-digits each) by a whitespace. Specify -g 0 to sup‐ |
| 66 press grouping. <Bytes> defaults to 2 in normal mode, 4 in lit‐ | |
| 29352 | 67 tle-endian mode and 1 in bits mode. Grouping does not apply to |
| 6918 | 68 postscript or include style. |
| 7 | 69 |
| 70 -h | -help | |
| 29352 | 71 Print a summary of available commands and exit. No hex dumping |
| 36 | 72 is performed. |
| 7 | 73 |
| 74 -i | -include | |
| 29352 | 75 Output in C include file style. A complete static array defini‐ |
| 76 tion is written (named after the input file), unless xxd reads | |
| 36 | 77 from stdin. |
| 7 | 78 |
| 79 -l len | -len len | |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
80 Stop after writing <len> octets. |
| 7 | 81 |
| 29352 | 82 -n name | -name name |
| 83 Override the variable name output when -i is used. The array is | |
| 84 named name and the length is named name_len. | |
| 85 | |
| 6918 | 86 -o offset |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
87 Add <offset> to the displayed file position. |
| 6918 | 88 |
| 7 | 89 -p | -ps | -postscript | -plain |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
90 Output in postscript continuous hexdump style. Also known as |
| 36 | 91 plain hexdump style. |
| 7 | 92 |
| 93 -r | -revert | |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
94 Reverse operation: convert (or patch) hexdump into binary. If |
|
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
95 not writing to stdout, xxd writes into its output file without |
| 6918 | 96 truncating it. Use the combination -r -p to read plain hexadeci‐ |
| 97 mal dumps without line number information and without a particu‐ | |
| 29352 | 98 lar column layout. Additional Whitespace and line-breaks are al‐ |
| 99 lowed anywhere. | |
| 7 | 100 |
| 101 -seek offset | |
| 218 | 102 When used after -r: revert with <offset> added to file positions |
| 103 found in hexdump. | |
| 7 | 104 |
| 105 -s [+][-]seek | |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
106 Start at <seek> bytes abs. (or rel.) infile offset. + indicates |
|
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
107 that the seek is relative to the current stdin file position |
| 1126 | 108 (meaningless when not reading from stdin). - indicates that the |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
109 seek should be that many characters from the end of the input |
| 1126 | 110 (or if combined with +: before the current stdin file position). |
| 111 Without -s option, xxd starts at the current file position. | |
| 7 | 112 |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
113 -u Use upper case hex letters. Default is lower case. |
| 7 | 114 |
| 115 -v | -version | |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
116 Show version string. |
| 7 | 117 |
| 36 | 118 CAVEATS |
| 119 xxd -r has some builtin magic while evaluating line number information. | |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
120 If the output file is seekable, then the linenumbers at the start of |
|
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
121 each hexdump line may be out of order, lines may be missing, or over‐ |
|
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
122 lapping. In these cases xxd will lseek(2) to the next position. If the |
|
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
123 output file is not seekable, only gaps are allowed, which will be |
| 36 | 124 filled by null-bytes. |
| 7 | 125 |
| 36 | 126 xxd -r never generates parse errors. Garbage is silently skipped. |
| 7 | 127 |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
128 When editing hexdumps, please note that xxd -r skips everything on the |
| 36 | 129 input line after reading enough columns of hexadecimal data (see option |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
130 -c). This also means, that changes to the printable ascii (or ebcdic) |
|
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
131 columns are always ignored. Reverting a plain (or postscript) style |
|
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
132 hexdump with xxd -r -p does not depend on the correct number of col‐ |
|
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
133 umns. Here anything that looks like a pair of hex-digits is inter‐ |
| 36 | 134 preted. |
| 7 | 135 |
| 136 Note the difference between | |
| 137 % xxd -i file | |
| 138 and | |
| 139 % xxd -i < file | |
| 140 | |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
141 xxd -s +seek may be different from xxd -s seek, as lseek(2) is used to |
| 36 | 142 "rewind" input. A '+' makes a difference if the input source is stdin, |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
143 and if stdin's file position is not at the start of the file by the |
|
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
144 time xxd is started and given its input. The following examples may |
| 36 | 145 help to clarify (or further confuse!)... |
| 7 | 146 |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
147 Rewind stdin before reading; needed because the `cat' has already read |
| 36 | 148 to the end of stdin. |
| 810 | 149 % sh -c "cat > plain_copy; xxd -s 0 > hex_copy" < file |
| 7 | 150 |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
151 Hexdump from file position 0x480 (=1024+128) onwards. The `+' sign |
| 36 | 152 means "relative to the current position", thus the `128' adds to the 1k |
| 153 where dd left off. | |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
154 % sh -c "dd of=plain_snippet bs=1k count=1; xxd -s +128 > hex_snippet" |
| 36 | 155 < file |
| 7 | 156 |
| 157 Hexdump from file position 0x100 ( = 1024-768) on. | |
| 810 | 158 % sh -c "dd of=plain_snippet bs=1k count=1; xxd -s +-768 > hex_snippet" |
| 36 | 159 < file |
| 7 | 160 |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
161 However, this is a rare situation and the use of `+' is rarely needed. |
|
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
162 The author prefers to monitor the effect of xxd with strace(1) or |
| 36 | 163 truss(1), whenever -s is used. |
| 7 | 164 |
| 165 EXAMPLES | |
| 810 | 166 Print everything but the first three lines (hex 0x30 bytes) of file. |
| 7 | 167 % xxd -s 0x30 file |
| 168 | |
| 810 | 169 Print 3 lines (hex 0x30 bytes) from the end of file. |
| 7 | 170 % xxd -s -0x30 file |
| 171 | |
| 1126 | 172 Print 120 bytes as continuous hexdump with 20 octets per line. |
| 7 | 173 % xxd -l 120 -ps -c 20 xxd.1 |
| 36 | 174 2e54482058584420312022417567757374203139 |
| 175 39362220224d616e75616c207061676520666f72 | |
| 176 20787864220a2e5c220a2e5c222032317374204d | |
| 177 617920313939360a2e5c22204d616e2070616765 | |
| 178 20617574686f723a0a2e5c2220202020546f6e79 | |
| 179 204e7567656e74203c746f6e79407363746e7567 | |
| 7 | 180 |
| 36 | 181 Hexdump the first 120 bytes of this man page with 12 octets per line. |
| 7 | 182 % xxd -l 120 -c 12 xxd.1 |
| 36 | 183 0000000: 2e54 4820 5858 4420 3120 2241 .TH XXD 1 "A |
| 184 000000c: 7567 7573 7420 3139 3936 2220 ugust 1996" | |
| 185 0000018: 224d 616e 7561 6c20 7061 6765 "Manual page | |
| 186 0000024: 2066 6f72 2078 7864 220a 2e5c for xxd"..\ | |
| 187 0000030: 220a 2e5c 2220 3231 7374 204d "..\" 21st M | |
| 188 000003c: 6179 2031 3939 360a 2e5c 2220 ay 1996..\" | |
| 189 0000048: 4d61 6e20 7061 6765 2061 7574 Man page aut | |
| 190 0000054: 686f 723a 0a2e 5c22 2020 2020 hor:..\" | |
| 191 0000060: 546f 6e79 204e 7567 656e 7420 Tony Nugent | |
| 192 000006c: 3c74 6f6e 7940 7363 746e 7567 <tony@sctnug | |
| 7 | 193 |
| 194 Display just the date from the file xxd.1 | |
| 36 | 195 % xxd -s 0x36 -l 13 -c 13 xxd.1 |
| 196 0000036: 3231 7374 204d 6179 2031 3939 36 21st May 1996 | |
| 7 | 197 |
| 36 | 198 Copy input_file to output_file and prepend 100 bytes of value 0x00. |
| 7 | 199 % xxd input_file | xxd -r -s 100 > output_file |
| 200 | |
| 201 Patch the date in the file xxd.1 | |
| 810 | 202 % echo "0000037: 3574 68" | xxd -r - xxd.1 |
| 36 | 203 % xxd -s 0x36 -l 13 -c 13 xxd.1 |
| 204 0000036: 3235 7468 204d 6179 2031 3939 36 25th May 1996 | |
| 7 | 205 |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
206 Create a 65537 byte file with all bytes 0x00, except for the last one |
| 36 | 207 which is 'A' (hex 0x41). |
| 810 | 208 % echo "010000: 41" | xxd -r > file |
| 7 | 209 |
| 210 Hexdump this file with autoskip. | |
| 211 % xxd -a -c 12 file | |
| 212 0000000: 0000 0000 0000 0000 0000 0000 ............ | |
| 213 * | |
| 214 000fffc: 0000 0000 40 ....A | |
| 215 | |
| 29352 | 216 Create a 1 byte file containing a single 'A' character. The number af‐ |
| 217 ter '-r -s' adds to the linenumbers found in the file; in effect, the | |
| 36 | 218 leading bytes are suppressed. |
| 810 | 219 % echo "010000: 41" | xxd -r -s -0x10000 > file |
| 7 | 220 |
| 36 | 221 Use xxd as a filter within an editor such as vim(1) to hexdump a region |
| 222 marked between `a' and `z'. | |
| 7 | 223 :'a,'z!xxd |
| 224 | |
| 36 | 225 Use xxd as a filter within an editor such as vim(1) to recover a binary |
| 226 hexdump marked between `a' and `z'. | |
| 7 | 227 :'a,'z!xxd -r |
| 228 | |
| 36 | 229 Use xxd as a filter within an editor such as vim(1) to recover one line |
| 230 of a hexdump. Move the cursor over the line and type: | |
| 7 | 231 !!xxd -r |
| 232 | |
| 233 Read single characters from a serial line | |
| 234 % xxd -c1 < /dev/term/b & | |
| 235 % stty < /dev/term/b -echo -opost -isig -icanon min 1 | |
| 236 % echo -n foo > /dev/term/b | |
| 237 | |
| 238 RETURN VALUES | |
| 239 The following error values are returned: | |
| 240 | |
| 241 0 no errors encountered. | |
| 242 | |
| 36 | 243 -1 operation not supported ( xxd -r -i still impossible). |
| 7 | 244 |
| 245 1 error while parsing options. | |
| 246 | |
| 247 2 problems with input file. | |
| 248 | |
| 249 3 problems with output file. | |
| 250 | |
| 251 4,5 desired seek position is unreachable. | |
| 252 | |
| 253 SEE ALSO | |
| 254 uuencode(1), uudecode(1), patch(1) | |
| 255 | |
| 256 WARNINGS | |
|
13571
362b27e3f702
patch 8.0.1658: capitalize argument not available in long form
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
257 The tools weirdness matches its creators brain. Use entirely at your |
| 36 | 258 own risk. Copy files. Trace it. Become a wizard. |
| 7 | 259 |
| 260 VERSION | |
| 261 This manual page documents xxd version 1.7 | |
| 262 | |
| 263 AUTHOR | |
| 264 (c) 1990-1997 by Juergen Weigert | |
| 265 <jnweiger@informatik.uni-erlangen.de> | |
| 266 | |
| 267 Distribute freely and credit me, | |
| 268 make money and share with me, | |
| 269 lose money and don't ask me. | |
| 270 | |
| 271 Manual page started by Tony Nugent | |
| 272 <tony@sctnugen.ppp.gu.edu.au> <T.Nugent@sct.gu.edu.au> | |
| 36 | 273 Small changes by Bram Moolenaar. Edited by Juergen Weigert. |
| 7 | 274 |
| 36 | 275 Manual page for xxd August 1996 XXD(1) |