doc/dump3d.sgml

   1 <refmeta>
   2 <refentrytitle>dump3d</refentrytitle>
   3 <manvolnum>1</manvolnum>
   4 </refmeta>
   5
   6 <refnamediv>
   7 <refname>dump3d</refname>
   8 <refpurpose>dump <filename>.3d</filename> file contents in textual format
   9 </refpurpose>
  10 </refnamediv>
  11
  12 <refsynopsisdiv>
  13 <cmdsynopsis>
  14 <command>dump3d</command>
  15 <arg choice="opt">--survey=SURVEY</arg>
  16 <arg choice="opt">--rewind</arg>
  17 <arg choice="opt">--show-dates</arg>
  18 <arg choice="req">PROCESSED_SURVEY_DATA_FILE</arg>
  19 </cmdsynopsis>
  20 </refsynopsisdiv>
  21
  22 <refsect1><title>Description</title>
  23
  24 <Para>
  25 Dump out the entries in a processed survey data file - useful for debugging,
  26 and also provides a textual format which is fairly easy to parse if you want
  27 to write a simple script to pull out information from a file.
  28 </Para>
  29
  30 <Para>
  31 Note that this tool can actually be used to dump any format the "img" library
  32 can read, not just Survex <filename>.3d</filename> files.
  33 </Para>
  34 </refsect1>