From 7a25ba554ac032d39b4f90f6e9fc9de194b97cdf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 23 Oct 2019 10:13:30 +0200 Subject: man: reorder description of nspawn --console The default value was described at the end of two long paragraphs. Make the first para self contained, and move the description of --console=pipe into the second para. --- man/systemd-nspawn.xml | 48 +++++++++++++++++++++++++----------------------- 1 file changed, 25 insertions(+), 23 deletions(-) diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index db3f10c3a2..c0427aa42f 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -1296,30 +1296,32 @@ MODE - Configures how to set up standard input, output and error output for the container payload, as - well as the /dev/console device for the container. Takes one of - , , or . If - a pseudo-TTY is allocated and made available as /dev/console - in the container. It is then bi-directionally connected to the standard input and output passed to - systemd-nspawn. is similar but only the output of the container - is propagated and no input from the caller is read. In mode a pseudo TTY is allocated, - but it is not connected anywhere. Finally, in mode no pseudo TTY is allocated, but the - passed standard input, output and error output file descriptors are passed on — as they are — to the container - payload. In this mode /dev/console will not exist in the container. Note that in this mode - the container payload generally cannot be a full init system as init systems tend to require - /dev/console to be available. On the other hand, in this mode container invocations can be - used within shell pipelines. This is because intermediary pseudo TTYs do not permit independent bidirectional - propagation of the end-of-file (EOF) condition, which is necessary for shell pipelines to work - correctly. - - Note that the mode should be used carefully, as passing arbitrary file descriptors - to less trusted container payloads might open up unwanted interfaces for access by the container payload. For - example, if a passed file descriptor refers to a TTY of some form, APIs such as TIOCSTI - may be used to synthesize input that might be used for escaping the container. Hence mode - should only be used if the payload is sufficiently trusted or when the standard input/output/error output file - descriptors are known safe, for example pipes. Defaults to if + Configures how to set up standard input, output and error output for the container + payload, as well as the /dev/console device for the container. Takes one of + , , , or + . If , a pseudo-TTY is allocated and made available + as /dev/console in the container. It is then bi-directionally connected to the + standard input and output passed to systemd-nspawn. is + similar but only the output of the container is propagated and no input from the caller is read. If + , a pseudo TTY is allocated, but it is not connected anywhere. Finally, in + mode no pseudo TTY is allocated, but the standard input, output and error + output file descriptors passed to systemd-nspawn are passed on — as they are — to + the container payload, see the following paragraph. Defaults to if systemd-nspawn is invoked from a terminal, and - otherwise. + otherwise. + + In mode, /dev/console will not exist in the + container. This means that the container payload generally cannot be a full init system as init + systems tend to require /dev/console to be available. On the other hand, in this + mode container invocations can be used within shell pipelines. This is because intermediary pseudo + TTYs do not permit independent bidirectional propagation of the end-of-file (EOF) condition, which is + necessary for shell pipelines to work correctly. Note that the mode + should be used carefully, as passing arbitrary file descriptors to less trusted container + payloads might open up unwanted interfaces for access by the container payload. For example, if a + passed file descriptor refers to a TTY of some form, APIs such as TIOCSTI may be + used to synthesize input that might be used for escaping the container. Hence + mode should only be used if the payload is sufficiently trusted or when the standard + input/output/error output file descriptors are known safe, for example pipes. -- cgit v1.2.1