doc: does not acquire the tty

Signed-off-by: Mattias Andrée <maandree@member.fsf.org>

3 files changed, 44 insertions, 6 deletions

diff --git a/README b/README
index 57fd0c6..b80b92d 100644
--- a/README
+++ b/README
@@ -20,6 +20,15 @@ EXAMPLE
 
 	/sbin/sleeping-getty 20 /sbin/agetty -8 -s 38400 tty20 linux
 
+NOTES
+	sleeping-getty does not acquire the TTY. That would be a waste
+	of CPU cycles. This means, if naïvely used, that if you start
+	your computer, log in on tty1, and start X, and have startx
+	configured to start X on the next available VT. X will start
+	on VT 2. This is probably not want you want. Instead you
+	should edit startx to ensure that a VT lower than a preferred
+	number (customarily 7) will not be used.
+
 RATIONALE
 	It is nice to have a score or two of TTY:s available. However,
 	starting them, can require some unnecessary CPU time and will
diff --git a/doc/info/chap/invoking.texinfo b/doc/info/chap/invoking.texinfo
index f0a51ec..008c883 100644
--- a/doc/info/chap/invoking.texinfo
+++ b/doc/info/chap/invoking.texinfo
@@ -37,7 +37,17 @@ 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.
+Note that @command{sleeping-getty} works on
+VT:s, not TTY:s. It cannot wait for a serial
+console to become, active, only virtual terminals.
+
+Also note, @command{sleeping-getty} does not acquire
+the TTY. That would be a waste of CPU cycles. This
+means, if naïvely used, that if you start your
+computer, log in on @file{tty1}, and start @command{X},
+and have @command{startx} configured to start @command{X}
+on the next available VT. @command{X} will start on
+VT@tie{}2. This is probably not want you want. Instead
+you should edit startx to ensure that a VT lower than
+a preferred number (customarily 7) will not be used.
 
diff --git a/doc/man/sleeping-getty.8 b/doc/man/sleeping-getty.8
index a40772c..f20ed92 100644
--- a/doc/man/sleeping-getty.8
+++ b/doc/man/sleeping-getty.8
@@ -24,10 +24,29 @@ works on VT:s, not TTY:s. It cannot wait for a serial console to
 become, active, only virtual terminals.
 .SH EXAMPLE
 .nf
-/sbin/\fBsleeping-getty\fP \fI15\fP /sbin/got tty\fI15\fP TERM=linux
-/sbin/\fBsleeping-getty\fP \fI16\fP /sbin/got tty\fI16\fP TERM=linux
-/sbin/\fBsleeping-getty\fP \fI20\fP /sbin/agetty -8 -s 38400 tty\fI20\fP linux
+/sbin/\fBsleeping\-getty\fP \fI15\fP /sbin/got tty\fI15\fP TERM=linux
+/sbin/\fBsleeping\-getty\fP \fI16\fP /sbin/got tty\fI16\fP TERM=linux
+/sbin/\fBsleeping\-getty\fP \fI20\fP /sbin/agetty -8 -s 38400 tty\fI20\fP linux
 .fi
+.SH NOTES
+.B sleeping\-getty
+does not acquire the TTY. That would be a waste of CPU cycles.
+This means, if naïvely used, that if you start your computer,
+log in on
+.BR tty1 ,
+and start
+.BR X ,
+and have
+.B startx
+configured to start
+.B X
+on the next available VT.
+.B X
+will start on VT\ 2. This is probably not want you want.
+Instead you should edit
+.B startx
+to ensure that a VT lower than a preferred number
+(customarily 7) will not be used.
 .SH RATIONALE
 It is nice to have a score or two of TTY:s available. However,
 starting them, can require some unnecessary CPU time and will