summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorTomas Volf <~@wolfsden.cz>2024-05-11 15:26:23 +0200
committerArun Isaac <arunisaac@systemreboot.net>2024-05-30 18:23:34 +0100
commit9948816819e0af23587d75701ba81d797ef7ea29 (patch)
tree7c42e4917dddc65d0a75eba6d12dec5fe9876afc /doc
parent4fdbf78a0fd8c3fb5169f4182154bd7ae3cc01dc (diff)
downloadguix-9948816819e0af23587d75701ba81d797ef7ea29.tar.gz
services: xorg: Add xorg-start-command-xinit procedure.
When the user does not use any desktop environment, the typical sequence is to
log in and then type `startx' into the tty to get a window manager running.
Most distributions do provide a startx by default, but Guix has only an
xorg-start-command that is not suitable for this.

This commit adds a second procedure, xorg-start-command-xinit, that correctly
picks a virtual terminal to use, sets up XAUTHORITY and starts xinit with the
correct arguments.  That should make running Guix without a desktop
environment more approachable.

* gnu/services/xorg.scm (xorg-start-command-xinit): New public procedure.
* doc/guix.texi (X Window): Document it.

Change-Id: I17cb16093d16a5c6550b1766754700d4fe014ae9
Signed-off-by: Arun Isaac <arunisaac@systemreboot.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index c1ff049f03..e59827d2bb 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -123,7 +123,7 @@ Copyright @copyright{} 2023 Foundation Devices, Inc.@*
 Copyright @copyright{} 2023 Thomas Ieong@*
 Copyright @copyright{} 2023 Saku Laesvuori@*
 Copyright @copyright{} 2023 Graham James Addis@*
-Copyright @copyright{} 2023 Tomas Volf@*
+Copyright @copyright{} 2023, 2024 Tomas Volf@*
 Copyright @copyright{} 2024 Herman Rimm@*
 Copyright @copyright{} 2024 Matthew Trzcinski@*
 Copyright @copyright{} 2024 Richard Sent@*
@@ -23623,6 +23623,15 @@ in @var{config}, are available.  The result should be used in place of
 Usually the X server is started by a login manager.
 @end deffn
 
+@deffn {Procedure} xorg-start-command-xinit [config]
+Return a @code{startx} script in which the modules, fonts,
+etc. specified in @var{config} are available.  The result should be used
+in place of @code{startx} and should be invoked by the user from a tty
+after login.  Unlike @code{xorg-start-command}, this script calls
+xinit. Therefore it works well when executed from a tty.  If you are
+using a desktop environment, you are unlikely to need this procedure.
+@end deffn
+
 
 @defvar screen-locker-service-type
 Type for a service that adds a package for a screen locker or screen