1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-14 17:13:50 +01:00

doc/guides: migrate terminal config

Co-authored-by: crasbe <crasbe@gmail.com>
This commit is contained in:
AnnsAnn 2025-09-17 17:47:35 +02:00
parent bca37a7b39
commit 8cfb09ab43
2 changed files with 58 additions and 53 deletions

View File

@ -1,55 +1,5 @@
Terminal programs configuration {#terminal-programs}
Terminal programs configuration (Deprecated) {#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.
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`
picocom {#picocom}
=======
- Generic method:
- Start with `--imap lfcrlf` parameter.
- Via RIOT build system:
- `RIOT_TERMINAL=picocom make term`
putty {#putty}
=====
- Graphical method:
- Go to configuration tree and choose `Terminal` branch.
- Enable option `Implicit CR in every LF`.
@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/misc/terminal_config/).
This page will be removed after release 2026.04.

View File

@ -0,0 +1,55 @@
---
title: Terminal programs configuration
description: How to configure popular terminal programs for correct display of newlines
---
## 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 (0x0D, 0x0A). See https://en.wikipedia.org/wiki/Newline for background.
This page tries to collect the necessary settings for common terminal programs
that will make them correctly display newlines.
## 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
- Interactive method:
- Press ***Ctrl+A u***.
- Manual method:
- Edit the configuration file (`~/.minirc.dfl` per default).
- Add the following line:
`pu addcarreturn Yes`
## miniterm
- Generic method:
- Start with `--eol CR` parameter.
- Via RIOT build system:
- `RIOT_TERMINAL=miniterm make term`
## picocom
- Generic method:
- Start with `--imap lfcrlf` parameter.
- Via RIOT build system:
- `RIOT_TERMINAL=picocom make term`
## putty
- Graphical method:
- Go to configuration tree and choose `Terminal` branch.
- Enable option `Implicit CR in every LF`.