Browse Source

microcom: Fix various review comments

 - Expand the description to prevent confusion
 - Use 'baud rate' instead of baudrate
 - Replace '-' chars in example parameter values with '_'
 - Remove the telnet RFC number
Jeroen Meulemeester 7 years ago
parent
commit
94e2496c29
1 changed files with 4 additions and 4 deletions
  1. 4 4
      pages/linux/microcom.md

+ 4 - 4
pages/linux/microcom.md

@@ -1,11 +1,11 @@
 # microcom
 
-> A minimalistic terminal program.
+> A minimalistic terminal program, used to access remote devices via a serial, CAN or telnet connection from the console.
 
-- Open a serial port using the specified baudrate:
+- Open a serial port using the specified baud rate:
 
-`microcom --port {{path/to/serial-port}} --speed {{baudrate}}`
+`microcom --port {{path/to/serial_port}} --speed {{baud_rate}}`
 
-- Establish a telnet connection (rfc2217) to the specified host:
+- Establish a telnet connection to the specified host:
 
 `microcom --telnet {{hostname}}:{{port}}`