diff --git a/common/vty_additions.xml b/common/vty_additions.xml index d32cea2..ef442f5 100644 --- a/common/vty_additions.xml +++ b/common/vty_additions.xml @@ -5,31 +5,30 @@ - - Show Node for introspection - This is the default node when connecting to the + + The view node is the default node when connecting to the VTY interface. This node does not require any additional permission and allows to introspect the application. - - Enable Node for admin commands - This is a privileged node allowing to make changes - to the configuration and allow to access more commands. Everything - available on the show node should be available here. + + The enable node is a privileged node, allowing to make changes + to the configuration and to access further commands like 'configure'. + All commands seen on the view node are also available here. - - Configuration Node for configuration - This is the base node for all configuration nodes. It - allows to enter BTS and logging node to configure them. + + The config node is the root for all configuration commands, + which are identical to the config file format. Changes made on the telnet + VTY can be made persistent with the 'write file' command. - - - Logging Node for logging configuration - This is the node is a child of the configuration node and - is responsible for configuring the logging framework including the - log targets and log levels. + + + The log node is commonly available in all Osmocom programs and + allows configuring logging to stderr and/or log files, including logging + category and level filtering as well as output formatting options. + Note that the 'logging enable' command is required to make logging commands + available on the telnet VTY. @@ -39,10 +38,21 @@ + + This command is required to make logging commands available + on the telnet VTY. + - The logging framework has the concept of filters. This can - be used to only show log messages that apply to a given timeslot or - subscriber. The all filter allows all messages to pass unfiltered. + Disable/enable general log output on a given target. + Typically, 'logging filter all 1' allows to see the usual log output on a + given target. Setting to '0' can be useful when logging to the telnet VTY + console: mute all log output to allow typing VTY commands on the telnet + prompt without interference from log output; 'logging filter all 1' then + re-enables logging in the same log output configuration as before. + + Some applications provide more specific filters, e.g. to log a given IMSI + only. To employ such filters, set 'logging filter all 0' to disable + general logging, and then enable a more specific filter instead.