git.gag.com Git - debian/splat/blob - utils/README

   1 Utilities for use with SPLAT! software are found under the
   2 splat-1.1.0/utils directory.  They include the following:
   3
   4 citydecoder
   5 ===========
   6 This utility reads U.S. Census Bureau files of Incorporated Places/Census
   7 Designated Places, and generates city/site data files for use with SPLAT!
   8 software.  Files for use with this utility are available for download
   9 free of charge from:
  10
  11         http://www.census.gov/geo/www/cob/bdy_files.html.
  12
  13 Please select the ARC/INFO Ungenerate (ASCII) Metadata Cartographic Boundary
  14 Files from this site and unzip them prior to importing them to citydecoder.
  15 U.S. Census files are cataloged by the two digit FIPS code for the region
  16 (state) they represent.  citydecoder takes as an argument the two-letter
  17 file prefix plus the FIPS code of the region or state being processed.
  18 For example:
  19
  20         citydecoder pl34
  21
  22 reads files "pl34_d00.dat" and "pl34_d00a.dat" that are extracted after
  23 the downloaded file has been unzipped, and generates a list of city names
  24 and geographical coordinates for the state of New Jersey (FIPS code 34).
  25 This data may be sorted and written to a file (cities.nj.dat) in the
  26 following manner:
  27
  28         citydecoder pl34 | sort > cities.nj.dat
  29
  30 A list of FIPS codes (fips.txt) is included under splat/utils for your
  31 convenience.
  32
  33
  34 usgs2sdf
  35 ========
  36 The usgs2sdf utility takes as an argument the name of an uncompressed
  37 and record delimited Digital Elevation Model Data (DEM) downloaded from
  38 the US Geological Survey, and generates a SPLAT Data File (SDF) compatible
  39 with SPLAT! Software.  usgs2sdf may be invoked manually, or via the
  40 postdownload script.
  41
  42
  43 postdownload
  44 ============
  45 postdownload is a front-end to the usgs2sdf utility.  postdownload
  46 takes as an argument the name of the gzipped Digital Elevation Model
  47 (DEM) downloaded from the US Geological Survey (ie: wilmington-w.gz).
  48 postdownload uncompresses the DEM file, adds necessary record delimiters,
  49 and invokes usgs2sdf to produce a SPLAT Data File (SDF).
  50
  51 Digital Elevation Models may be downloaded from:
  52
  53      http://edcsgs9.cr.usgs.gov/glis/hyper/guide/1_dgr_demfig/index1m.html
  54
  55 Invoke postdownload with the name of each DEM file downloaded to
  56 produce a database of SPLAT Data Files.
  57
  58
  59 fontdata
  60 ========
  61 The fontdata utility reads Slackware gzipped console font data
  62 to create the fontdata.h file required for compilation of SPLAT!.
  63 Font data of the type needed by this utility may be found under
  64 /usr/lib/kbd/consolefonts (Slackware < 8), or under
  65 /usr/share/kbd/consolefonts (Slackware >= 8.0).
  66
  67 A default fontdata.h file is already included in with SPLAT!, and is
  68 a derivative of the s.fnt console font type available under Slackware.
  69 fontdata takes as an argument the name of the file containing the
  70 gzipped compressed console fonts:
  71
  72         fontdata s.fnt.gz
  73
  74
  75 Building The Utilities
  76 ======================
  77 Normally, these utilities are built and installed along with SPLAT!
  78 when SPLAT!'s ./configure script is invoked.  However, if you modify
  79 them and/or wish to build and install them separately, here is how it's
  80 done.  First, invoke the "build" script to compile each or all utilities
  81 in this directory by name.  For example:
  82
  83         ./build citydecoder
  84
  85 compiles citydecoder only, while
  86
  87         ./build all
  88
  89 compiles all utilities.
  90
  91
  92 Installing The Utilities
  93 ========================
  94 Invoke the "install" script to install each or all utilities in this
  95 directory by name.  For example:
  96
  97         ./install citydecoder
  98
  99 installs citydecoder only, while
 100
 101         ./install all
 102
 103 installs all utilities.
 104
 105 You need to be 'root' to install any or all of these utilities.
 106
 107 ---
 108 John A. Magliacane, KD2BD
 109 January 2004
 110