From 8cfb09ab43e43f97a01bbcc6776f065fcc5335c1 Mon Sep 17 00:00:00 2001 From: AnnsAnn Date: Wed, 17 Sep 2025 17:47:35 +0200 Subject: [PATCH] doc/guides: migrate terminal config Co-authored-by: crasbe --- doc/doxygen/src/terminal-programs.md | 56 ++-------------------------- doc/guides/misc/terminal_config.md | 55 +++++++++++++++++++++++++++ 2 files changed, 58 insertions(+), 53 deletions(-) create mode 100644 doc/guides/misc/terminal_config.md diff --git a/doc/doxygen/src/terminal-programs.md b/doc/doxygen/src/terminal-programs.md index b2446b8bce..d4e65c2b57 100644 --- a/doc/doxygen/src/terminal-programs.md +++ b/doc/doxygen/src/terminal-programs.md @@ -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. diff --git a/doc/guides/misc/terminal_config.md b/doc/guides/misc/terminal_config.md new file mode 100644 index 0000000000..1ef71f58df --- /dev/null +++ b/doc/guides/misc/terminal_config.md @@ -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`.