[openbsc] 01/01: Added content to bs11_config, ipaccess_find and ipaccess_config man pages
Ruben Undheim
rubund-guest at moszumanska.debian.org
Sat Feb 20 10:27:38 UTC 2016
This is an automated email from the git hooks/post-receive script.
rubund-guest pushed a commit to branch master
in repository openbsc.
commit 6f6d1cffad3a505e7f01b8b771238aee290ef3b0
Author: Ruben Undheim <ruben.undheim at gmail.com>
Date: Sat Feb 20 11:16:28 2016 +0100
Added content to bs11_config, ipaccess_find and ipaccess_config man pages
---
debian/man/bs11_config.txt | 46 ++++++++++++++++++++++++++++++++++++++----
debian/man/ipaccess-config.txt | 30 ++++++++++++++++++++++++---
debian/man/ipaccess-find.txt | 16 +++++++++------
3 files changed, 79 insertions(+), 13 deletions(-)
diff --git a/debian/man/bs11_config.txt b/debian/man/bs11_config.txt
index 7931252..4a3f237 100644
--- a/debian/man/bs11_config.txt
+++ b/debian/man/bs11_config.txt
@@ -1,14 +1,52 @@
NAME
- bs11_config - Osmocom BSC
+ bs11_config - Configuration of BS-11 BTS via RS232
SYNOPSIS
- bs11_config [options]
+ bs11_config [options] [command]
DESCRIPTION
- bs11_config is part of the OpenBSC base station controller from Osmocom.
+ bs11_config is a small commandline program that can be used to configure the BS-11? BTS using its RS232 link.
+
+ It can perform a subset of the functions that are typically performed using the Siemens LMT (Local Maintenance Terminal) software, such as
+
+ - querying some essential configuration values
+ - creating and deleting TRX1 objects
+ - download of SAFETY LOAD software
+ - download of BTS software
+ - creating an initial configuration (such as creating BBSIG,CCLK,PA,... objects)
+ - setting the Tx output power of the RF amplifier
+
+ It is part of the OpenBSC base station controller software from Osmocom.
OPTIONS
- -h help
+ -h,--help Print this help text
+ -p,--port </dev/ttyXXX> Specify serial port
+ -s,--software <file> Specify Software file
+ -S,--safety <file> Specify Safety Load file
+ -d,--delay <ms> Specify delay in milliseconds
+ -D,--disconnect Disconnect BTS from BSC
+ -w,--win-size <num> Specify Window Size
+ -f,--forced Force Software Load
+
+SUPPORTED COMMANDS
+ query Query the BS-11 about serial number and configuration
+ disconnect Disconnect A-bis link (go into administrative state)
+ resconnect Reconnect A-bis link (go into normal state)
+ restart Restart the BTS
+ software Download Software (only in administrative state)
+ create-trx1 Create objects for TRX1 (Danger: Your BS-11 might overheat)
+ delete-trx1 Delete objects for TRX1
+ pll-e1-locked Set the PLL to be locked to E1 clock
+ pll-standalone Set the PLL to be in standalone mode
+ pll-setvalue <value> Set the PLL set value
+ pll-workvalue <value> Set the PLL work value
+ oml-tei Set OML E1 TS and TEI
+ bport0-star Set BPORT0 line config to star
+ bport0-multidrop Set BPORT0 line config to multidrop
+ bport1-multidrop Set BPORT1 line config to multidrop
+ create-bport1 Create BPORT1 object
+ delete-bport1 Delete BPORT1 object
+
SEE ALSO
osmo-bsc(1)
diff --git a/debian/man/ipaccess-config.txt b/debian/man/ipaccess-config.txt
index f27a46b..15cd18e 100644
--- a/debian/man/ipaccess-config.txt
+++ b/debian/man/ipaccess-config.txt
@@ -2,13 +2,37 @@ NAME
ipaccess-config - Osmocom BSC
SYNOPSIS
- ipaccess-config [options]
+ ipaccess-config [options] <IP_OF_BTS>
DESCRIPTION
- ipaccess-config is part of the OpenBSC base station controller from Osmocom.
+ ipaccess-config is a small command line tool to configure an ip.access nanoBTS.
+
+ You can use this tool to perform basic operations such as setting NVRAM parameters or performing tests.
+
+ It is part of the OpenBSC base station controller from Osmocom.
OPTIONS
- -h help
+
+Commands for writing to the BTS:
+ -u --unit-id UNIT_ID Set the Unit ID of the BTS
+ -o --oml-ip IP Set primary OML IP (IP of your BSC)
+ -i --ip-address IP/MASK Set static IP address + netmask of BTS
+ -g --ip-gateway IP Set static IP gateway of BTS
+ -r --restart Restart the BTS (after other operations)
+ -n --nvram-flags FLAGS/MASK Set NVRAM attributes
+ -S --nvattr-set FLAG Set one additional NVRAM attribute
+ -U --nvattr-unset FLAG Set one additional NVRAM attribute
+ -l --listen TESTNR Perform specified test number
+ -L --Listen TEST_NAME Perform specified test
+ -s --stream-id ID Set the IPA Stream Identifier for OML
+ -d --software FIRMWARE Download firmware into BTS
+
+Miscellaneous commands:
+ -h --help this text
+ -H --HELP Print parameter details.
+ -f --firmware FIRMWARE Provide firmware information
+ -w --write-firmware This will dump the firmware parts to the filesystem. Use with -f.
+ -p --loop Loop the tests executed with the --listen command.
SEE ALSO
osmo-bsc(1)
diff --git a/debian/man/ipaccess-find.txt b/debian/man/ipaccess-find.txt
index 6946248..7c221e8 100644
--- a/debian/man/ipaccess-find.txt
+++ b/debian/man/ipaccess-find.txt
@@ -1,17 +1,21 @@
NAME
- ipaccess-find - Osmocom BSC
+ ipaccess-find - Tool to discover nanoBTS devices in your network
SYNOPSIS
- ipaccess-find [options]
+ ipaccess-find
DESCRIPTION
- ipaccess-find is part of the OpenBSC base station controller from Osmocom.
+ ipaccess-find is a small command line tool to search and find nanoBTS devices in your network.
+
+ It uses broadcast packets of the UDP variant of the Abis-IP protocol on port 3006. and thus will find any BTS that can be reached by the all-network broadcast address 255.255.255.255
+
+ It is part of the OpenBSC base station controller from Osmocom.
+
+ Simply run the program as root without any arguments.
-OPTIONS
- -h help
SEE ALSO
- osmo-bsc(1)
+ ipaccess-config(1)
AUTHOR
This manual page was written by Ruben Undheim <ruben.undheim at gmail.com> for the Debian project (and may be used by others).
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/openbsc.git
More information about the debian-science-commits
mailing list