make maintainer-clean removes these, and we want a clean orig.tar.gz

[debian/gnuradio] / gr-noaa / README

diff --git a/gr-noaa/README b/gr-noaa/README
index d99c0d90a07a75f3218803cba696f6f054b771b9..f00d2d28deec0c0bf9b227aeee90a6d509417a8c 100644 (file)
--- a/gr-noaa/README
+++ b/gr-noaa/README
@@ -5,31 +5,48 @@ As the scripts are generated using GRC, GRC must be installed at runtime
 in order for them to operate.
 
 
-HRPT Operation
---------------
+HRPT OPERATION
 
 usrp_rx_hrpt.py
+---------------
 
 This GUI script will receive HRPT RF, demodulate, synchronize, and deframe
 HRPT minor frames into a file.  The file stores a series of 11090 word,
 16-bits per word corresponding to the HRPT minor frame format (only the
 lower 10-bits per word are significant.)
 
-The script file by default uses USRP side A, 1698 MHz, at decimation 16. A
-configuration file 'usrp_rx_hrpt.cfg' in the current working directory will
-allow changing this, as well as implementing persistent storage of GUI
+The script file by default uses USRP side A, 1698 MHz, at decimation 16. The
+gnuradio configuration file ~/.gnuradio/config.conf, section 'usrp_rx_hrpt.cfg',
+will allow changing this, as well as implementing persistent storage of GUI
 entered parameters from invocation to invocation.
 
 The present HRPT demodulator is only tested at decimation 16.  The only other
-valid decimation rates are 24 and 32, which may word but with more bit
+valid decimation rates are 24 and 32, which may work but with more bit
 errors.  No other decimation rates will work.
 
 
-demod_hrpt_file.py
+file_rx_hrpt.py
+---------------
+
+This GUI script operates like usrp_rx_hrpt.py, but reads from a pre-captured
+data file supplied by -F on the command line.
+
+
+usrp_rx_hrpt_nogui.py
+---------------------
+
+This non-GUI script operates without a display and requires that all parameters
+be set in the configuration file prior to running.  It has no command-line
+parameters, and works identically to the GUI scripts.
+
+
+hrpt_demod_file.py
+------------------
 
-This command-line only script will operate on a file generated with
+This non-GUI script will operate on a file generated with
 usrp_rx_cfile.py and output frames in the same format as above.  It does
-*not* use the configuration file above.
+*not* use the configuration file above; instead you must pass parameters to
+it on the command line.  To exit the program, press Enter.
 
 Usage: demod_hrpt_file.py: [options]
 
@@ -39,11 +56,11 @@ Options:
                         Set Decimation [default=16]
   -p PLL_ALPHA, --pll-alpha=PLL_ALPHA
                         Set pll_alpha [default=50m]
-  -s SYNC_ALPHA, --sync-alpha=SYNC_ALPHA
-                        Set sync_alpha [default=50m]
-  -F FILENAME, --filename=FILENAME
+  -s CLOCK_ALPHA, --clock-alpha=CLOCK_ALPHA
+                        Set clock_alpha [default=50m]
+  -F INPUT_FILENAME, --input-filename=INPUT_FILENAME
                         Set Filename [default=usrp.dat]
-  -o OUTPUT, --output=OUTPUT
+  -o OUTPUT_FILENAME, --output-filename=OUTPUT_FILENAME
                         Set Output [default=frames.dat]