From 9af2c372b91f151a09b087b45bec078068e2eb2b Mon Sep 17 00:00:00 2001 From: Ugo Pattacini Date: Wed, 8 Jan 2025 14:17:06 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=92=A1=20Tips=20and=20tricks=20section=20?= =?UTF-8?q?(#387)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/tips_tricks/index.md | 5 +++++ docs/tips_tricks/tmux/infinite_scroll.md | 19 +++++++++++++++++++ mkdocs.yml | 9 ++++++--- 3 files changed, 30 insertions(+), 3 deletions(-) create mode 100644 docs/tips_tricks/index.md create mode 100644 docs/tips_tricks/tmux/infinite_scroll.md diff --git a/docs/tips_tricks/index.md b/docs/tips_tricks/index.md new file mode 100644 index 000000000..2e89f662c --- /dev/null +++ b/docs/tips_tricks/index.md @@ -0,0 +1,5 @@ +# :bulb:{.blink} Tips & Tricks + +A list of useful and multi-purpose tips and tricks that can help you in your daily work. + +- [Setup `tmux` infinite scroll](./tmux/infinite_scroll.md) diff --git a/docs/tips_tricks/tmux/infinite_scroll.md b/docs/tips_tricks/tmux/infinite_scroll.md new file mode 100644 index 000000000..cb2126095 --- /dev/null +++ b/docs/tips_tricks/tmux/infinite_scroll.md @@ -0,0 +1,19 @@ +# Setup `tmux` infinite scroll + +Sometimes it is useful to run the `yarprobotinterface` directly from the terminal. By using `tmux`, you can detach from the SSH session. However, by default, the scrollback is not infinite, and not all messages are streamed to the logger. + +To overcome this limitation: + +1. Install xclip with: + ```console + sudo apt install xclip + ``` +2. Create a configuration file with: + ```console + touch ~/.tmux.conf + ``` +3. Set the following content in the configuration file: + ``` + set -g mouse on + set -g history-limit 100000 + ``` diff --git a/mkdocs.yml b/mkdocs.yml index 113bcd4c7..9df137632 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -216,7 +216,7 @@ nav: - ergocub-head: - Jetpack installation: icub_operating_systems/icubos/jetpack.md - Post-flashing operations: - - Install CUDA libraries : icub_operating_systems/icubos/install-cuda-libraries.md + - Install CUDA libraries: icub_operating_systems/icubos/install-cuda-libraries.md - Install librealsense: icub_operating_systems/icubos/install-librealsense.md - Install jtop: icub_operating_systems/icubos/install-jtop.md - Install CMake (only for Ubuntu 20.04): icub_operating_systems/icubos/install-cmake.md @@ -254,12 +254,11 @@ nav: - iCub Setup startup procedure: icub_operating_systems/startup-procedure.md - NVIDIA JetPack installation: icub_operating_systems/icubos/jetpack.md - Post-flashing operations: - - Install CUDA libraries : icub_operating_systems/icubos/install-cuda-libraries.md + - Install CUDA libraries: icub_operating_systems/icubos/install-cuda-libraries.md - Install librealsense: icub_operating_systems/icubos/install-librealsense.md - Install jtop: icub_operating_systems/icubos/install-jtop.md - Install CMake (only for Ubuntu 20.04): icub_operating_systems/icubos/install-cmake.md - Setup for FRAMOS-IMX415 (only for iCub head v2.10): icub_operating_systems/icubos/setup-framos-imx415.md - - iCub Setup Multiple Robots: - Summary: icub_setup_multiple_robots/index.md - How to use two iCub robots in gazebo simulation: icub_setup_multiple_robots/two_robots_simulation.md @@ -322,3 +321,7 @@ nav: - Overview of Temperature Sensors: temperature_sensors/general/overview.md - Motor Temperature Data Flow: temperature_sensors/software/dataflow.md - Reading Motor Temperature Data: temperature_sensors/software/reading_data.md + + - 💡 Tips and Tricks: + - Summary: tips_tricks/index.md + - Setup tmux infinite scroll: tips_tricks/tmux/infinite_scroll.md