aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPetter Reinholdtsen <pere@hungry.com>2017-08-21 20:15:38 +0000
committerPetter Reinholdtsen <pere@hungry.com>2017-08-21 20:15:38 +0000
commita3e9fbbfaa988eed2399b4f4053d00b5f9a230c6 (patch)
tree41b3997654f99340202951e6b34edc9913314ffb
parent6c4304da43346150d00b2bdc5a520746c2f45906 (diff)
Added simple draft manual page for grgsm_livemon in rst format.
-rw-r--r--docs/grgsm_livemon.rst61
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/grgsm_livemon.rst b/docs/grgsm_livemon.rst
new file mode 100644
index 0000000..4310ef1
--- /dev/null
+++ b/docs/grgsm_livemon.rst
@@ -0,0 +1,61 @@
+=============
+grgsm_livemon
+=============
+
+-------------------------------------------------------
+GSM C0 monitor forwarding packages to network interface
+-------------------------------------------------------
+
+:Author: Piotr Krysik - ptrkrysik@gmail.com
+:Date: 2017-08-21
+:Copyright: public domain
+:Version: 0.0
+:Manual section: 1
+:Manual group: User Commands
+
+SYNOPSIS
+========
+
+grgsm_livemon [options]
+
+DESCRIPTION
+===========
+
+Interactive monitor of a single C0 channel with analysis performed by
+Wireshark. Example command to run wireshark:
+
+ sudo wireshark -k -f udp -Y gsmtap -i lo
+
+
+OPTIONS
+=======
+
+-h, --help
+ show this help message and exit
+
+--args=ARGS
+ Set Device Arguments [default=]
+
+-g GAIN, --gain=GAIN
+ Set gain [default=30]
+
+--osr=OSR
+ Set OverSampling Ratio [default=4]
+
+-p PPM, --ppm=PPM
+ Set ppm [default=0]
+
+-s SAMP_RATE, --samp-rate=SAMP_RATE
+ Set samp_rate [default=2M]
+
+-o SHIFTOFF, --shiftoff=SHIFTOFF
+ Set Frequency Shiftoff [default=400k]
+
+-f FC, --fc=FC
+ Set GSM channel's central frequency [default=941.8M]
+
+SEE ALSO
+========
+
+* `<https://github.com/ptrkrysik/gr-gsm/>`__
+* ``grgsm_scanner(1)``