Skip to content

Commit

Permalink
Update README.md to match new command line flags.
Browse files Browse the repository at this point in the history
  • Loading branch information
bemasher committed Aug 3, 2014
1 parent a77fc80 commit 33e0ed6
Showing 1 changed file with 40 additions and 7 deletions.
47 changes: 40 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,26 +58,41 @@ Available command-line flags are as follows:

```
Usage of rtlamr:
-centerfreq=920299072: center frequency to receive on
-duration=0: time to run for, 0 for infinite
-filterid=0: display only messages matching given id
-filtertype=0: display only messages matching given type
-format="plain": format to write log messages in: plain, csv, json, xml or gob
-gobunsafe=false: allow gob output to stdout
-h=false: print short help
-help=false: print long help
-logfile="/dev/stdout": log statement dump file
-quiet=false: suppress printing state information at startup
-samplefile="NUL": raw signal dump file
-server="127.0.0.1:1234": address or hostname of rtl_tcp instance
-single=false: one shot execution
-symbollength=73: symbol length in samples, see -help for valid lengths
rtltcp specific:
-agcmode=false: enable/disable rtl agc
-centerfreq=920299072: center frequency to receive on
-directsampling=false: enable/disable direct sampling
-freqcorrection=0: frequency correction in ppm
-gainbyindex=0: set gain by index
-h=false: print short help
-help=false: print long help
-offsettuning=false: enable/disable offset tuning
-rtlxtalfreq=0: set rtl xtal frequency
-samplerate=2400000: sample rate
-server="127.0.0.1:1234": address or hostname of rtl_tcp instance
-testmode=false: enable/disable test mode
-tunergain=0: set tuner gain in dB
-tunergainmode=true: enable/disable tuner gain
-tunerxtalfreq=0: set tuner xtal frequency
```

Long Help via `-help`:
```
Usage of rtlamr:
-centerfreq=920299072: Sets the center frequency of the rtl_tcp server. Defaults to 920.29MHz.
Usage of c:\Users\bemasher\Desktop\Dropbox\Public\Source\GoLang\bin\rtlamr.exe:
-duration=0: Sets time to receive for, 0 for infinite. Defaults to infinite.
If the time limit expires during processing of a block (which is quite
likely) it will exit on the next pass through the receive loop. Exiting
Expand All @@ -103,7 +118,9 @@ Usage of rtlamr:
Doing so would normally break a terminal, so we disable it unless
explicitly enabled.
-help=false: Print this help.
-h=false: Print short help.
-help=false: Print long help.
-logfile="/dev/stdout": Sets file to dump log messages to. Defaults to os.DevNull and prints to stderr.
Log messages have the following structure:
Expand Down Expand Up @@ -157,8 +174,6 @@ Usage of rtlamr:
enables offset and length fields in plain text log messages. Only samples
for correctly received messages are dumped.
-server="127.0.0.1:1234": Sets rtl_tcp server address or hostname and port to connect to. Defaults to 127.0.0.1:1234.
-single=false: Provides one shot execution. Defaults to false.
Receiver listens until exactly one message is received before exiting.
Expand Down Expand Up @@ -207,6 +222,24 @@ Usage of rtlamr:
89: 2.916352 MHz, 90: 2.949120 MHz, 91: 2.981888 MHz,
92: 3.014656 MHz, 93: 3.047424 MHz, 94: 3.080192 MHz,
95: 3.112960 MHz, 96: 3.145728 MHz, 97: 3.178496 MHz
rtltcp specific:
-agcmode=false: enable/disable rtl agc
-centerfreq=920299072: center frequency to receive on
-directsampling=false: enable/disable direct sampling
-freqcorrection=0: frequency correction in ppm
-gainbyindex=0: set gain by index
-h=false: print short help
-help=false: print long help
-offsettuning=false: enable/disable offset tuning
-rtlxtalfreq=0: set rtl xtal frequency
-samplerate=2400000: sample rate
-server="127.0.0.1:1234": address or hostname of rtl_tcp instance
-testmode=false: enable/disable test mode
-tunergain=0: set tuner gain in dB
-tunergainmode=true: enable/disable tuner gain
-tunerxtalfreq=0: set tuner xtal frequency
```

Running the receiver is as simple as starting an `rtl_tcp` instance and then starting the receiver:
Expand Down

0 comments on commit 33e0ed6

Please sign in to comment.