Skip to content

Commit 90a548b

Browse files
committed
Minor help improvements
1 parent dd6cb5d commit 90a548b

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -527,13 +527,12 @@ There are various options to `mbed sterm`:
527527
You can also set default port, baudrate and echo mode using the `TERM_PORT`, `TERM_BAUDRATE` and `TERM_ECHO` Mbed CLI configuration options.
528528

529529
The following shortcuts are available within the serial terminal:
530-
- Quit: `CTRL+C` or `CTRL+J`
531-
- Reset: `CTRL+B` or `CTRL+R`
532-
- Echo toggle: `CTRL+E`
533-
- Terminal information: `TAB` or `CTRL+I`
534-
- Help: `CTRL+H`
535-
- Menu: `CTRL+T`
536-
- Change baud rate: `CTRL+T+B`
530+
- CTRL+B - Send Break (reset target)
531+
- CTRL+C - Exit terminal
532+
- CTRL+E - Toggle local echo
533+
- CTRL+H - Help
534+
- CTRL+T - Menu escape key
535+
- _Even more shortcuts are available through the Menu shortcut. Check the help within the serial terminal (CTRL+H).__
537536

538537
To automate things, you can also add the `--sterm` option to `mbed compile -f` to compile a new program, flash the program/firmware image to the connected target and then open serial terminal to it's COM port:
539538

mbed/mbed.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2390,7 +2390,7 @@ def status_(ignore=False):
23902390
dict(name='--build', help='Build directory. Default: build/'),
23912391
dict(name=['-c', '--clean'], action='store_true', help='Clean the build directory before compiling'),
23922392
dict(name=['-f', '--flash'], action='store_true', help='Flash the built firmware onto a connected target.'),
2393-
dict(name=['-s', '--sterm'], action='store_true', help='Open serial terminal after compiling. Can be chained with --flash'),
2393+
dict(name=['--sterm'], action='store_true', help='Open serial terminal after compiling. Can be chained with --flash'),
23942394
dict(name=['-N', '--artifact-name'], help='Name of the built program or library'),
23952395
dict(name=['-S', '--supported'], dest='supported', const=True, choices=["matrix", "toolchains", "targets"], nargs="?", help='Shows supported matrix of targets and toolchains'),
23962396
dict(name='--app-config', dest="app_config", help="Path of an app configuration file (Default is to look for 'mbed_app.json')"),

0 commit comments

Comments
 (0)