sx/README
Earnestly 069d745d44 doc: move notes to manual and clarify the synopsis
Since the README is not intended to be installed to the system it makes
sense to provide the NOTES section in the manual itself which is.

This also expands the SYNOPSIS section to indicate that the usage of sx
should work as a typical chain command.
2018-10-14 11:25:17 +01:00

46 lines
1.6 KiB
Plaintext

sx <https://github.com/Earnestly/sx>
INTRODUCTION
sx is a simple alternative to both xinit(1) and startx(1) for starting
an Xorg server.
It started life as a proof of concept while attempting to learn how both
xinit and startx worked.
It is not a direct replacement however as it provides a different, more
limited, interface.
Some of these major differences are listed here:
* The server's command-line is hard coded and not exposed to the user.
* The server doesn't listen on anything except unix domain sockets.
* The server starts on the same tty the user logged in on.
* The first DISPLAY is 1 instead of 0 contrary to what X(7) suggests
as it is coupled to the tty number.
* xauth entries are overwritten if the displayname is identical.
* Corresponding xauth entries are unconditionally removed when the
server exits.
* The server uses the -noreset flag.
* While XAUTHORITY is still honoured, $XDG_DATA_HOME/sx/xauthfile is
used by default instead of $HOME/.Xauthority
* Very little proxy error checking is used preferring instead to let
each tool speak for itself.
* None of the typical /etc/X11/xinit infrastructure is directly used.
* Neither XINITRC is honoured nor .xinitrc used.
* The XDG_CONFIG_HOME/sx/sxrc file is used instead of .xinitrc and is
required to be executable.
For a rationale on why this exists, the author invites the reader to
look over the source code for both xinit and startx.
REQUIRES
* Xorg
* xauth
* /dev/urandom
INSTALL
make PREFIX=/usr DESTDIR=staged install