basis/tools/hexdump/hexdump-docs.factor

   1 ! Copyright (C) 2008 Doug Coleman.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax kernel sequences byte-arrays
   4 strings ;
   5 IN: tools.hexdump
   6
   7 HELP: hexdump.
   8 { $values { "byte-array" byte-array } }
   9 { $description "Converts a sequence to its hexadecimal and ASCII representation sixteen characters at a time and writes it to standard out." } ;
  10
  11 HELP: hexdump
  12 { $values { "byte-array" byte-array } { "str" string } }
  13 { $description "Converts a sequence to its hexadecimal and ASCII representation sixteen characters at a time.  Lines are separated by a newline character." }
  14 { $see-also hexdump. } ;
  15
  16 ARTICLE: "tools.hexdump" "Hexdump"
  17 "The " { $vocab-link "tools.hexdump" } " vocabulary provides a traditional hexdump view of a sequence." $nl
  18 "Write hexdump to string:"
  19 { $subsection hexdump }
  20 "Write the hexdump to the output stream:"
  21 { $subsection hexdump. } ;
  22
  23 ABOUT: "tools.hexdump"