summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRuben Undheim <ruben.undheim@gmail.com>2018-07-24 23:31:29 +0200
committerRuben Undheim <ruben.undheim@gmail.com>2018-07-24 23:31:29 +0200
commitc498005ff2b91a281f7695e832b0d5b004019747 (patch)
tree8e13736fb8ac7af8762b932cca062345e7e3da4a
parentf74a40adcd76adb55e3b1dd0087be01b2c0c566e (diff)
Updated man page
-rw-r--r--debian/osmo-trx-uhd.142
1 files changed, 10 insertions, 32 deletions
diff --git a/debian/osmo-trx-uhd.1 b/debian/osmo-trx-uhd.1
index 0f43940..92d1a0d 100644
--- a/debian/osmo-trx-uhd.1
+++ b/debian/osmo-trx-uhd.1
@@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
-.TH OSMO-TRX-UHD 1 "Februray 07, 2015"
+.TH OSMO-TRX-UHD 1 "July 24, 2018"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@@ -27,6 +27,12 @@ command.
.PP
\fBosmo-trx-uhd\fP is a software-defined radio transceiver that implements the Layer 1
physical layer of a BTS comprising the following 3GPP specifications:
+.PP
+For quickly getting started with a default configuration, run:
+.TP
+.RS
+.B osmo-trx-uhd -C /usr/share/doc/osmo-trx/examples/osmo-trx.cfg
+.RE
.
.PP
.br
@@ -46,40 +52,12 @@ between different telecommunication associations for developing new
generations of mobile phone networks. (post-2G/GSM)
.SH OPTIONS
-Usually it works well to start osmo-trx-uhd without any options.
.TP
.B \-h
-This text
-.TP
-.B \-a <args>
-UHD device args
-.TP
-.B \-l <logging level>
-Logging level (EMERG, ALERT, CRT, ERR, WARNING, NOTICE, INFO, DEBUG)
-.TP
-.B \-i <ip>
-IP address of GSM core
-.TP
-.B \-p <port>
-Base port number
-.TP
-.B \-d
-Enable dual channel diversity receiver
-.TP
-.B \-x
-Enable external 10 MHz reference
-.TP
-.B \-s <sps>
-Samples-per-symbol (1 or 4)
-.TP
-.B \-c <channel>
-Number of ARFCN channels (default=1)
-.TP
-.B \-f
-Enable C0 filler table
+Show command line options
.TP
-.B \-o <freq>
-Set baseband frequency offset (default=auto)
+.B \-C <config>
+Alternative config file. If not specified it looks for osm-trx.cfg in the current directory
.SH AUTHOR
This manual page was written by Ruben Undheim <ruben.undheim@gmail.com>,