home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / vim53os2.zip / vim-5.3 / doc / xxd.man < prev   
Text File  |  1998-08-30  |  11KB  |  331 lines
  1.  
  2.  
  3.  
  4. XXD(1)                                                     XXD(1)
  5.  
  6.  
  7. NAME
  8.        xxd - make a hexdump or do the reverse.
  9.  
  10. SYNOPSIS
  11.        xxd -h[elp]
  12.        xxd [options] [infile [outfile]]
  13.        xxd -r[evert] [options] [infile [outfile]]
  14.  
  15. DESCRIPTION
  16.        xxd  creates a hex dump of a given file or standard input.
  17.        It can also convert a hex dump back to its original binary
  18.        form.   Like  uuencode(1)  and  uudecode(1)  it allows the
  19.        transmission of binary data in a `mail-safe' ASCII  repre-
  20.        sentation,  but  has the advantage of decoding to standard
  21.        output.  Moreover, it can be used to perform  binary  file
  22.        patching.
  23.  
  24. OPTIONS
  25.        If  no infile is given, standard input is read.  If infile
  26.        is specified as a `-' character, then input is taken  from
  27.        standard  input.  If no outfile is given (or a `-' charac-
  28.        ter is in its place), results are sent to standard output.
  29.  
  30.        Note that a "lazy" parser is used which does not check for
  31.        more than the first option letter, unless  the  option  is
  32.        followed  by  a parameter.  Spaces between a single option
  33.        letter and its  parameter  are  optional.   Parameters  to
  34.        options  can be specified in decimal, hexadecimal or octal
  35.        notation.  Thus-c8, -c 8, -c  010  and  -cols  8  are  all
  36.        equivalent.
  37.  
  38.  
  39.        -a | -autoskip
  40.               toggle  autoskip:  A single '*' replaces nul-lines.
  41.               Default off.
  42.  
  43.        -c cols | -cols cols
  44.               format <cols> octets per line. Default 16 (-i:  12,
  45.               -ps: 30). Max 256.
  46.  
  47.        -E | -EBCDIC
  48.               Change the character encoding in the righthand col-
  49.               umn from ASCII to EBCDIC.  This does not change the
  50.               hexadecimal  representation. The option is meaning-
  51.               less in combinations with -r, -p or -i.
  52.  
  53.        -g bytes | -groupsize bytes
  54.               seperate the output of every <bytes> bytes (two hex
  55.               characters  each) by a whitespace.  Specify -g 0 to
  56.               suppress grouping.  <Bytes> defaults to 2.   Group-
  57.               ing  does not apply to postscript or include style.
  58.  
  59.        -h | -help
  60.               print a summary of available commands and exit.  No
  61.  
  62.  
  63.  
  64. Manual page for xxd        August 1996                          1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XXD(1)                                                     XXD(1)
  71.  
  72.  
  73.               hex dumping is performed.
  74.  
  75.        -i | -include
  76.               output  in  C include file style. A complete static
  77.               array definition is written (named after the  input
  78.               file), unless xxd reads from stdin.
  79.  
  80.        -l len | -len len
  81.               stop after writing <len> octets.
  82.  
  83.        -p | -ps | -postscript
  84.               output in postscript continuous hexdump style.
  85.  
  86.        -r | -revert
  87.               reverse  operation: convert (or patch) hexdump into
  88.               binary.  If not writing to stdout, xxd  writes  its
  89.               output file without truncating it.
  90.  
  91.        -seek offset
  92.               When  used after -r : revert with <offset> added to
  93.               file positions found in hexdump.
  94.  
  95.        -s [+][-]seek
  96.               start at <seek> bytes abs. (or rel.) infile offset.
  97.               +  indicates  that the seek is relative to the cur-
  98.               rent stdin  file  position  (meaningless  when  not
  99.               reading  from  stdin).   -  indicates that the seek
  100.               should be that many characters from the end of  the
  101.               input (or if combined with
  102.                +  :  before  the  current  stdin  file position).
  103.               Without -s option, xxd starts at the  current  file
  104.               position.
  105.  
  106.        -u     use  upper case hex letters. Default is lower case.
  107.  
  108.        -v | -version
  109.               show version string.
  110.  
  111. CAVEATS
  112.        xxd -r has some builtin magic while evaluating line number
  113.        information.   If  the  ouput  file  is seekable, then the
  114.        linenumbers at the start of each hexdump line may  be  out
  115.        of  order,  lines may be missing, or overlapping. In these
  116.        cases xxd will lseek(2) to the next position. If the  out-
  117.        put  file  is  not  seekable, only gaps are allowed, which
  118.        will be filled by null-bytes.
  119.  
  120.        xxd -r never generates parse errors. Garbage  is  silently
  121.        skipped.
  122.  
  123.        When  editing  hexdumps,  please  note  that  xxd -r skips
  124.        everything on the input line after reading enough  columns
  125.        of hexadecimal data (see option -c). This also means, that
  126.        changes to the printable ascii  (or  ebcdic)  columns  are
  127.  
  128.  
  129.  
  130. Manual page for xxd        August 1996                          2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XXD(1)                                                     XXD(1)
  137.  
  138.  
  139.        always ignored.
  140.  
  141.        Note the difference between
  142.        % xxd -i file
  143.        and
  144.        % xxd -i < file
  145.  
  146.        xxd  -s  +seek  may  be  different  from  xxd -s seek , as
  147.        lseek(2) is used to "rewind" input.  A '+' makes a differ-
  148.        ence  if  the  input  source is stdin, and if stdin's file
  149.        position is not at the start of the file by the  time  xxd
  150.        is  started  and  given its input.  The following examples
  151.        may help to clarify (or further confuse!)...
  152.  
  153.        Rewind stdin before reading; needed because the `cat'  has
  154.        already read to the end of stdin.
  155.        % sh -c 'cat > plain_copy; xxd -s 0 > hex_copy' < file
  156.  
  157.        Hexdump from file position 0x480 (=1024+128) onwards.  The
  158.        `+' sign means "relative to the  current  position",  thus
  159.        the `128' adds to the 1k where dd left off.
  160.        %  sh -c 'dd of=plain_snippet bs=1k count=1; xxd -s +128 >
  161.        hex_snippet' < file
  162.  
  163.        Hexdump from file position 0x100 ( = 1024-768) on.
  164.        % sh -c 'dd of=plain_snippet bs=1k count=1; xxd -s +-768 >
  165.        hex_snippet' < file
  166.  
  167.        However,  this  is  a rare situation and the use of `+' is
  168.        rarely needed.  the author prefers to monitor  the  effect
  169.        of xxd with strace(1) or truss(1), whenever -s is used.
  170.  
  171. EXAMPLES
  172.        Print  everything  but  the  first  three  lines (hex 0x30
  173.        bytes) of file
  174.        % xxd -s 0x30 file
  175.  
  176.        Print 3 lines (hex 0x30 bytes) from the end of file
  177.        % xxd -s -0x30 file
  178.  
  179.        Print 120 bytes as continuous hexdump with 40  octets  per
  180.        line.
  181.        % xxd -l 120 -ps -c 20 xxd.1
  182.        2e544820585844203120224d616e75616c207061
  183.        676520666f7220787864220a2e5c220a2e5c2220
  184.        32317374204d617920313939360a2e5c22204d61
  185.        6e207061676520617574686f723a0a2e5c222020
  186.        2020546f6e79204e7567656e74203c746f6e7940
  187.        7363746e7567656e2e7070702e67752e6564752e
  188.  
  189.        Hexdump  the  first  120  bytes  of  this man page with 12
  190.        octets per line.
  191.        % xxd -l 120 -c 12 xxd.1
  192.        0000000: 2e54 4820 5858 4420 3120 224d  .TH XXD 1 "M
  193.  
  194.  
  195.  
  196. Manual page for xxd        August 1996                          3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XXD(1)                                                     XXD(1)
  203.  
  204.  
  205.        000000c: 616e 7561 6c20 7061 6765 2066  anual page f
  206.        0000018: 6f72 2078 7864 220a 2e5c 220a  or xxd"..\".
  207.        0000024: 2e5c 2220 3231 7374 204d 6179  .\" 21st May
  208.        0000030: 2031 3939 360a 2e5c 2220 4d61   1996..\" Ma
  209.        000003c: 6e20 7061 6765 2061 7574 686f  n page autho
  210.        0000048: 723a 0a2e 5c22 2020 2020 546f  r:..\"    To
  211.        0000054: 6e79 204e 7567 656e 7420 3c74  ny Nugent <t
  212.        0000060: 6f6e 7940 7363 746e 7567 656e  ony@sctnugen
  213.        000006c: 2e70 7070 2e67 752e 6564 752e  .ppp.gu.edu.
  214.  
  215.        Display just the date from the file xxd.1
  216.        % xxd -s 0x28 -l 12 -c 12 xxd.1
  217.        0000028: 3231 7374 204d 6179 2031 3939  21st May 199
  218.  
  219.        Copy input_file to output_file and prepend  100  bytes  of
  220.        value 0x00.
  221.        % xxd input_file | xxd -r -s 100 > output_file
  222.  
  223.        Patch the date in the file xxd.1
  224.        % echo '0000029: 3574 68' | xxd -r - xxd.1
  225.        % xxd -s 0x28 -l 12 -c 12 xxd.1
  226.        0000028: 3235 7468 204d 6179 2031 3939  25th May 199
  227.  
  228.        Create  a  65537 byte file with all bytes 0x00, except for
  229.        the last one which is 'A' (hex 0x41).
  230.        % echo '010000: 41' | xxd -r > file
  231.  
  232.        Hexdump this file with autoskip.
  233.        % xxd -a -c 12 file
  234.        0000000: 0000 0000 0000 0000 0000 0000  ............
  235.        *
  236.        000fffc: 0000 0000 40                   ....A
  237.  
  238.        Create a 1 byte file containing a  single  'A'  character.
  239.        The  number after '-r -s' adds to the linenumbers found in
  240.        the file; in effect, the leading bytes are suppressed.
  241.        % echo '010000: 41' | xxd -r -s -0x10000 > file
  242.  
  243.        Use xxd as a filter within an editor  such  as  vim(1)  to
  244.        hexdump a region marked between `a' and `z'.
  245.        :'a,'z!xxd
  246.  
  247.        Use  xxd  as  a  filter within an editor such as vim(1) to
  248.        recover a binary hexdump marked between `a' and `z'.
  249.        :'a,'z!xxd -r
  250.  
  251.        Use xxd as a filter within an editor  such  as  vim(1)  to
  252.        recover  one  line of a hexdump.  Move the cursor over the
  253.        line and type:
  254.        !!xxd -r
  255.  
  256.        Read single characters from a serial line
  257.        % xxd -c1 < /dev/term/b &
  258.        % stty < /dev/term/b -echo -opost -isig -icanon min 1
  259.  
  260.  
  261.  
  262. Manual page for xxd        August 1996                          4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. XXD(1)                                                     XXD(1)
  269.  
  270.  
  271.        % echo -n foo > /dev/term/b
  272.  
  273.  
  274. RETURN VALUES
  275.        The following error values are returned:
  276.  
  277.        0      no errors encountered.
  278.  
  279.        -1     operation not supported ( xxd -r -i still  impossi-
  280.               ble).
  281.  
  282.        1      error while parsing options.
  283.  
  284.        2      problems with input file.
  285.  
  286.        3      problems with output file.
  287.  
  288.        4,5    desired seek position is unreachable.
  289.  
  290. SEE ALSO
  291.        uuencode(1), uudecode(1), patch(1)
  292.  
  293. WARNINGS
  294.        The  tools  weirdness  matches  its  creators  brain.  Use
  295.        entirely at your own risk. Copy files. Trace it. Become  a
  296.        wizard.
  297.  
  298. VERSION
  299.        This manual page documents xxd version 1.7
  300.  
  301. AUTHOR
  302.        (c) 1990-1997 by Juergen Weigert
  303.        <jnweiger@informatik.uni-erlangen.de>
  304.  
  305.        Distribute freely and credit me,
  306.        make money and share with me,
  307.        lose money and don't ask me.
  308.  
  309.        Manual page started by Tony Nugent
  310.        <tony@sctnugen.ppp.gu.edu.au> <T.Nugent@sct.gu.edu.au>
  311.        Small  changes  by  Bram  Moolenaar.   Edited  by  Juergen
  312.        Weigert.
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328. Manual page for xxd        August 1996                          5
  329.  
  330.  
  331.