doc: vty: Update trx_vty_reference.xml
Change-Id: I2587cd47ee48e979de447f7a0f4d79bb5fac0592
diff --git a/doc/manuals/vty/trx_vty_reference.xml b/doc/manuals/vty/trx_vty_reference.xml
index ffc642a..d6cd15d 100644
--- a/doc/manuals/vty/trx_vty_reference.xml
+++ b/doc/manuals/vty/trx_vty_reference.xml
@@ -85,12 +85,6 @@
<param name='length' doc='Set number of lines on a screen' />
</params>
</command>
- <command id='echo .MESSAGE'>
- <params>
- <param name='echo' doc='Echo a message back to the vty' />
- <param name='.MESSAGE' doc='The message to echo' />
- </params>
- </command>
<command id='who'>
<params>
<param name='who' doc='Display who is on vty' />
@@ -181,7 +175,7 @@
<param name='1' doc='Prefix each log message with the log level name' />
</params>
</command>
- <command id='logging print file (0|1|basename)'>
+ <command id='logging print file (0|1|basename) [last]'>
<params>
<param name='logging' doc='Configure logging' />
<param name='print' doc='Log output settings' />
@@ -189,6 +183,7 @@
<param name='0' doc='Don't prefix each log message' />
<param name='1' doc='Prefix each log message with the source file and line' />
<param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' />
+ <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
</params>
</command>
<command id='logging set-log-mask MASK'>
@@ -198,21 +193,14 @@
<param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' />
</params>
</command>
- <command id='logging set log mask MASK'>
- <params>
- <param name='logging' doc='Configure logging' />
- <param name='set' doc='Decide which categories to output.' />
- <param name='log' doc='Log commands' />
- <param name='mask' doc='Mask commands' />
- <param name='MASK' doc=''set log mask' is deprecated, please refer to the docs of 'set-log-mask' instead' />
- </params>
- </command>
- <command id='logging level (all|main|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (everything|debug|info|notice|error|fatal)'>
+ <command id='logging level (main|trxctrl|dev|lms|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
<params>
<param name='logging' doc='Configure logging' />
<param name='level' doc='Set the log level for a specified category' />
- <param name='all' doc='Global setting for all subsystems' />
<param name='main' doc='Main generic category' />
+ <param name='trxctrl' doc='TRX CTRL interface' />
+ <param name='dev' doc='Device/Driver specific code' />
+ <param name='lms' doc='Logging from within LimeSuite itself' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -231,7 +219,7 @@
<param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
<param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
<param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
- <param name='everything' doc='Don't use. It doesn't log anything' />
+ <param name='lrspro' doc='Remote SIM protocol' />
<param name='debug' doc='Log debug messages and higher levels' />
<param name='info' doc='Log informational messages and higher levels' />
<param name='notice' doc='Log noticeable messages and higher levels' />
@@ -239,6 +227,38 @@
<param name='fatal' doc='Log only fatal messages' />
</params>
</command>
+ <command id='logging level set-all (debug|info|notice|error|fatal)'>
+ <params>
+ <param name='logging' doc='Configure logging' />
+ <param name='level' doc='Set the log level for a specified category' />
+ <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
+ <param name='debug' doc='Log debug messages and higher levels' />
+ <param name='info' doc='Log informational messages and higher levels' />
+ <param name='notice' doc='Log noticeable messages and higher levels' />
+ <param name='error' doc='Log error messages and higher levels' />
+ <param name='fatal' doc='Log only fatal messages' />
+ </params>
+ </command>
+ <command id='logging level force-all (debug|info|notice|error|fatal)'>
+ <params>
+ <param name='logging' doc='Configure logging' />
+ <param name='level' doc='Set the log level for a specified category' />
+ <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the 'no logging level force-all' command. Note: any 'logging level <category> <level>' commands will have no visible effect after this, until the forced level is released.' />
+ <param name='debug' doc='Log debug messages and higher levels' />
+ <param name='info' doc='Log informational messages and higher levels' />
+ <param name='notice' doc='Log noticeable messages and higher levels' />
+ <param name='error' doc='Log error messages and higher levels' />
+ <param name='fatal' doc='Log only fatal messages' />
+ </params>
+ </command>
+ <command id='no logging level force-all'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='logging' doc='Configure logging' />
+ <param name='level' doc='Set the log level for a specified category' />
+ <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' />
+ </params>
+ </command>
<command id='show logging vty'>
<params>
<param name='show' doc='Show running system information' />
@@ -312,6 +332,12 @@
<param name='counters' doc='Generate table of all registered counters' />
</params>
</command>
+ <command id='show rate-counters'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='rate-counters' doc='Show all rate counters' />
+ </params>
+ </command>
</node>
<node id='enable'>
<name>enable</name>
@@ -365,12 +391,6 @@
<param name='length' doc='Set number of lines on a screen' />
</params>
</command>
- <command id='echo .MESSAGE'>
- <params>
- <param name='echo' doc='Echo a message back to the vty' />
- <param name='.MESSAGE' doc='The message to echo' />
- </params>
- </command>
<command id='who'>
<params>
<param name='who' doc='Display who is on vty' />
@@ -474,7 +494,7 @@
<param name='1' doc='Prefix each log message with the log level name' />
</params>
</command>
- <command id='logging print file (0|1|basename)'>
+ <command id='logging print file (0|1|basename) [last]'>
<params>
<param name='logging' doc='Configure logging' />
<param name='print' doc='Log output settings' />
@@ -482,6 +502,7 @@
<param name='0' doc='Don't prefix each log message' />
<param name='1' doc='Prefix each log message with the source file and line' />
<param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' />
+ <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
</params>
</command>
<command id='logging set-log-mask MASK'>
@@ -491,21 +512,14 @@
<param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' />
</params>
</command>
- <command id='logging set log mask MASK'>
- <params>
- <param name='logging' doc='Configure logging' />
- <param name='set' doc='Decide which categories to output.' />
- <param name='log' doc='Log commands' />
- <param name='mask' doc='Mask commands' />
- <param name='MASK' doc=''set log mask' is deprecated, please refer to the docs of 'set-log-mask' instead' />
- </params>
- </command>
- <command id='logging level (all|main|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (everything|debug|info|notice|error|fatal)'>
+ <command id='logging level (main|trxctrl|dev|lms|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
<params>
<param name='logging' doc='Configure logging' />
<param name='level' doc='Set the log level for a specified category' />
- <param name='all' doc='Global setting for all subsystems' />
<param name='main' doc='Main generic category' />
+ <param name='trxctrl' doc='TRX CTRL interface' />
+ <param name='dev' doc='Device/Driver specific code' />
+ <param name='lms' doc='Logging from within LimeSuite itself' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -524,7 +538,7 @@
<param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
<param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
<param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
- <param name='everything' doc='Don't use. It doesn't log anything' />
+ <param name='lrspro' doc='Remote SIM protocol' />
<param name='debug' doc='Log debug messages and higher levels' />
<param name='info' doc='Log informational messages and higher levels' />
<param name='notice' doc='Log noticeable messages and higher levels' />
@@ -532,6 +546,38 @@
<param name='fatal' doc='Log only fatal messages' />
</params>
</command>
+ <command id='logging level set-all (debug|info|notice|error|fatal)'>
+ <params>
+ <param name='logging' doc='Configure logging' />
+ <param name='level' doc='Set the log level for a specified category' />
+ <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
+ <param name='debug' doc='Log debug messages and higher levels' />
+ <param name='info' doc='Log informational messages and higher levels' />
+ <param name='notice' doc='Log noticeable messages and higher levels' />
+ <param name='error' doc='Log error messages and higher levels' />
+ <param name='fatal' doc='Log only fatal messages' />
+ </params>
+ </command>
+ <command id='logging level force-all (debug|info|notice|error|fatal)'>
+ <params>
+ <param name='logging' doc='Configure logging' />
+ <param name='level' doc='Set the log level for a specified category' />
+ <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the 'no logging level force-all' command. Note: any 'logging level <category> <level>' commands will have no visible effect after this, until the forced level is released.' />
+ <param name='debug' doc='Log debug messages and higher levels' />
+ <param name='info' doc='Log informational messages and higher levels' />
+ <param name='notice' doc='Log noticeable messages and higher levels' />
+ <param name='error' doc='Log error messages and higher levels' />
+ <param name='fatal' doc='Log only fatal messages' />
+ </params>
+ </command>
+ <command id='no logging level force-all'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='logging' doc='Configure logging' />
+ <param name='level' doc='Set the log level for a specified category' />
+ <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' />
+ </params>
+ </command>
<command id='show logging vty'>
<params>
<param name='show' doc='Show running system information' />
@@ -605,6 +651,12 @@
<param name='counters' doc='Generate table of all registered counters' />
</params>
</command>
+ <command id='show rate-counters'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='rate-counters' doc='Show all rate counters' />
+ </params>
+ </command>
</node>
<node id='config'>
<name>config</name>
@@ -910,7 +962,7 @@
<param name='1' doc='Prefix each log message with the log level name' />
</params>
</command>
- <command id='logging print file (0|1|basename)'>
+ <command id='logging print file (0|1|basename) [last]'>
<params>
<param name='logging' doc='Configure logging' />
<param name='print' doc='Log output settings' />
@@ -918,14 +970,17 @@
<param name='0' doc='Don't prefix each log message' />
<param name='1' doc='Prefix each log message with the source file and line' />
<param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' />
+ <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
</params>
</command>
- <command id='logging level (all|main|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (everything|debug|info|notice|error|fatal)'>
+ <command id='logging level (main|trxctrl|dev|lms|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
<params>
<param name='logging' doc='Configure logging' />
<param name='level' doc='Set the log level for a specified category' />
- <param name='all' doc='Global setting for all subsystems' />
<param name='main' doc='Main generic category' />
+ <param name='trxctrl' doc='TRX CTRL interface' />
+ <param name='dev' doc='Device/Driver specific code' />
+ <param name='lms' doc='Logging from within LimeSuite itself' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -944,7 +999,7 @@
<param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
<param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
<param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
- <param name='everything' doc='Don't use. It doesn't log anything' />
+ <param name='lrspro' doc='Remote SIM protocol' />
<param name='debug' doc='Log debug messages and higher levels' />
<param name='info' doc='Log informational messages and higher levels' />
<param name='notice' doc='Log noticeable messages and higher levels' />
@@ -952,6 +1007,38 @@
<param name='fatal' doc='Log only fatal messages' />
</params>
</command>
+ <command id='logging level set-all (debug|info|notice|error|fatal)'>
+ <params>
+ <param name='logging' doc='Configure logging' />
+ <param name='level' doc='Set the log level for a specified category' />
+ <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
+ <param name='debug' doc='Log debug messages and higher levels' />
+ <param name='info' doc='Log informational messages and higher levels' />
+ <param name='notice' doc='Log noticeable messages and higher levels' />
+ <param name='error' doc='Log error messages and higher levels' />
+ <param name='fatal' doc='Log only fatal messages' />
+ </params>
+ </command>
+ <command id='logging level force-all (debug|info|notice|error|fatal)'>
+ <params>
+ <param name='logging' doc='Configure logging' />
+ <param name='level' doc='Set the log level for a specified category' />
+ <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the 'no logging level force-all' command. Note: any 'logging level <category> <level>' commands will have no visible effect after this, until the forced level is released.' />
+ <param name='debug' doc='Log debug messages and higher levels' />
+ <param name='info' doc='Log informational messages and higher levels' />
+ <param name='notice' doc='Log noticeable messages and higher levels' />
+ <param name='error' doc='Log error messages and higher levels' />
+ <param name='fatal' doc='Log only fatal messages' />
+ </params>
+ </command>
+ <command id='no logging level force-all'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='logging' doc='Configure logging' />
+ <param name='level' doc='Set the log level for a specified category' />
+ <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' />
+ </params>
+ </command>
</node>
<node id='config-stats'>
<name>config-stats</name>
@@ -1035,10 +1122,11 @@
<param name='login' doc='Enable password checking' />
</params>
</command>
- <command id='bind A.B.C.D'>
+ <command id='bind A.B.C.D [<0-65535>]'>
<params>
<param name='bind' doc='Accept VTY telnet connections on local interface' />
<param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
+ <param name='[<0-65535>]' doc='Local TCP port number' />
</params>
</command>
</node>
@@ -1146,6 +1234,13 @@
<param name='enable' doc='(null)' />
</params>
</command>
+ <command id='ext-rach (disable|enable)'>
+ <params>
+ <param name='ext-rach' doc='Enable extended (11-bit) RACH (default=disable)' />
+ <param name='disable' doc='(null)' />
+ <param name='enable' doc='(null)' />
+ </params>
+ </command>
<command id='rt-prio <1-32>'>
<params>
<param name='rt-prio' doc='Set the SCHED_RR real-time priority' />