From 656abb12401525eb000a2d430de36d3c4689450a Mon Sep 17 00:00:00 2001 From: rebortg Date: Sun, 26 Jun 2022 20:40:00 +0200 Subject: console-server: fix command syntax --- docs/configuration/service/console-server.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) (limited to 'docs/configuration/service') diff --git a/docs/configuration/service/console-server.rst b/docs/configuration/service/console-server.rst index dd2f5032..f3c304c8 100644 --- a/docs/configuration/service/console-server.rst +++ b/docs/configuration/service/console-server.rst @@ -26,25 +26,25 @@ times are used to send a single character, and so dividing the signalling bit-rate by ten results in the overall transmission speed in characters per second. This is also the default setting if none of those options are defined. -.. cfgcmd:: set service console-server data-bits [7 | 8] +.. cfgcmd:: set service console-server device data-bits [7 | 8] Configure either seven or eight data bits. This defaults to eight data bits if left unconfigured. -.. cfgcmd:: set service console-server description +.. cfgcmd:: set service console-server device description A user friendly description identifying the connected peripheral. -.. cfgcmd:: set service console-server parity [even | odd | none] +.. cfgcmd:: set service console-server device parity [even | odd | none] Set the parity option for the console. If unset this will default to none. -.. cfgcmd:: set service console-server stop-bits [1 | 2] +.. cfgcmd:: set service console-server device stop-bits [1 | 2] Configure either one or two stop bits. This defaults to one stop bits if left unconfigured. -.. cfgcmd:: set service console-server speed +.. cfgcmd:: set service console-server device speed [ 300 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200 ] .. note:: USB to serial converters will handle most of their work in software @@ -58,7 +58,7 @@ Each individual configured console-server device can be directly exposed to the outside world. A user can directly connect via SSH to the configured port. -.. cfgcmd:: set service console-server ssh port +.. cfgcmd:: set service console-server device ssh port Accept SSH connections for the given `` on TCP port ``. After successfull authentication the user will be directly dropped to @@ -106,3 +106,7 @@ Operation .. hint:: The sequence ``^Ec?`` translates to: ``Ctrl+E c ?``. To quit the session use: ``Ctrl+E c .`` + +.. opcmd:: show log console-server + + Show the console server log. -- cgit v1.2.3