Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add terminal program configuration #20493

Merged
merged 1 commit into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/doxygen/riot.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -767,6 +767,7 @@ INPUT = ../../doc.txt \
src/driver-guide.md \
src/getting-started.md \
src/flashing.md \
src/terminal-programs.md \
src/build-in-docker.md \
../../tests/README.md \
src/build-system-basics.md \
Expand Down
49 changes: 49 additions & 0 deletions doc/doxygen/src/terminal-programs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Terminal programs configuration {#terminal-programs}
===========================================================

[TOC]

Background {#background}
==========
This page explains how to configure some popular terminal programs for correct
display of newlines when using the serial interface of a RIOT powered device.
When printing something using *stdio* (e.g., `printf("Hello World!\n");`, RIOT
sends a line feed character (`0xA`) as `\n` (newline).

Some terminals need more, for example, a carriage return and a line feed
character (0xD, 0xA). See https://en.wikipedia.org/wiki/Newline for background.

This page tries to collect needed settings for common terminal programs that
will make them correctly display newlines.

picocom {#picocom}
=======
- Generic method:
- Start with `--imap lfcrlf` parameter.
- Via RIOT build system:
- `RIOT_TERMINAL=picocom make term`

gtkterm {#gtkterm}
======
- Graphical method:
- Open the configuration menu.
- Click on ***CR LF auto***.
- Manual method:
- Edit the file `~/.gtktermrc`.
- Change value of ***crlfauto*** option to `True`.

minicom {#minicom}
=======
- Interactive method:
- Press ***Ctrl+A u***.
- Manual method:
- Edit the configuration file (`~/.minirc.dfl` per default).
- Add the following line:
pu addcarreturn Yes

miniterm {#miniterm}
========
- Generic method:
- Start with `--eol CR`parameter.
- Via RIOT build system:
- `RIOT_TERMINAL=miniterm make term`
Loading