From: Simon Glass <sjg@chromium.org> Add a note about the pager to the console documentation. Signed-off-by: Simon Glass <sjg@chromium.org> --- doc/usage/console.rst | 16 ++++++++++++++++ doc/usage/environment.rst | 5 +++++ 2 files changed, 21 insertions(+) diff --git a/doc/usage/console.rst b/doc/usage/console.rst index d7d41bca187..95424c43ee9 100644 --- a/doc/usage/console.rst +++ b/doc/usage/console.rst @@ -60,3 +60,19 @@ file ('stdin', 'stdout' or 'stderr') Remember that FILE-related functions CANNOT be used before U-Boot relocation, which is done in `board_init_r()`. + +Pager +----- + +U-Boot has a simple pager feature, enabled with `CONFIG_CONSOLE_PAGER`. It is +only available if both `CONFIG_CONSOLE_MUX` is enabled. + +When activated, the pager pauses at the end of each 'page' (screenful) of +output, shows a prompt and lets the user read the output. To continue, press +SPACE. + +The number of lines before the pager kicks in is configurable using the `pager` +environment variable, which should contain a decimal value. Set it to 0 (or +leave it unset) to disable the pager. If the variable is not present then the +number of lines in the video console is used. If there is no video console, then +`CONSOLE_PAGER_LINES` sets the number of lines. diff --git a/doc/usage/environment.rst b/doc/usage/environment.rst index 6235d7276f0..696acbfd6a5 100644 --- a/doc/usage/environment.rst +++ b/doc/usage/environment.rst @@ -336,7 +336,12 @@ netretry themselves. pager +<<<<<<< HEAD Decimal number of visible lines on the display, or serial console. +======= + Decimal number of visible lines on the display, or serial console. See + :doc:`/usage/console`. +>>>>>>> 949c148e39e (pager: doc: Add mention of the pager feature) rng_seed_size Size of random value added to device-tree node /chosen/rng-seed. -- 2.43.0