From dff1ffd8cca0cf454a084336ef51cbd80139f65e Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@member.fsf.org>
Date: Sat, 19 Dec 2015 01:50:38 +0100
Subject: info: overview and invoking
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@member.fsf.org>
---
 doc/info/chap/invoking.texinfo | 40 +++++++++++++++++++++++++++++++++++++++-
 doc/info/chap/overview.texinfo | 12 +++++++++++-
 2 files changed, 50 insertions(+), 2 deletions(-)

(limited to 'doc/info')

diff --git a/doc/info/chap/invoking.texinfo b/doc/info/chap/invoking.texinfo
index ebd7910..f0a51ec 100644
--- a/doc/info/chap/invoking.texinfo
+++ b/doc/info/chap/invoking.texinfo
@@ -1,5 +1,43 @@
 @node Invoking
 @chapter Invoking
 
-@command{sleeping-getty}
+Example usages:
+@example
+/sbin/sleeping-getty 15 /sbin/got tty15 TERM=linux
+
+/sbin/sleeping-getty 16 /sbin/got tty16 TERM=linux
+
+/sbin/sleeping-getty 20 /sbin/agetty -8 -s 38400 tty20 linux
+@end example
+
+The first argument shall be the number of the
+virtual terminal the process waits for to be
+be brought to the foreground.
+
+The second argument shall be pathname of the
+getty program that shall be started once the
+virtual terminal is in the foreground. Note
+that @env{PATH} is probably not set up, and
+a full pathname is required.
+
+The rest of the arguments shall be those that
+are passed to the getty program.
+
+For example,
+@example
+/sbin/sleeping-getty 15 /sbin/got tty15 TERM=linux
+@end example
+@noindent
+shall wait for virtual terminal number 15
+(on which you will find @file{/dev/tty15})
+to become active. Then the processes is
+switch to, without forking,
+@command{/sbin/got tty15 TERM=linux},
+which is Gates of Tartaros on @file{/dev/tty15}
+with the environment variable @env{TERM} set
+to @command{linux}.
+
+Note that sleeping-getty works on VT:s, not TTY:s.
+It cannot wait for a serial console to become,
+active, only virtual terminals.
 
diff --git a/doc/info/chap/overview.texinfo b/doc/info/chap/overview.texinfo
index 85d90c9..17a8f86 100644
--- a/doc/info/chap/overview.texinfo
+++ b/doc/info/chap/overview.texinfo
@@ -1,5 +1,15 @@
 @node Overview
 @chapter Overview
 
-@command{sleeping-getty}
+@command{sleeping-getty} waits until a selected
+virtual terminal is brought to the foreground.
+Then, or if the process started with this
+virtual terminal in the foreground, the process
+changes image to a getty program.
+
+This is used to save CPU cycles during boot
+to get a smoother boot, which is important if
+your getty program does a lot of things, or if
+your computer is not too powerful. It also
+reduces the memory footprint.
 
-- 
cgit v1.2.3-70-g09d2