sx/README
Earnestly e08bc130c0 sx: use the default logfile
There's not a lot of point in absorbing the xserver's log file when it
will just be less intuitive for those looking for it in the standard
location.  Since the log is generated by Xorg and not sx, it only seems
reasonable.

This commit also renames xauthfile to xauthority for a little more
consistency with documentation and prior art.
2017-12-02 02:22:29 +00:00

46 lines
1.7 KiB
Plaintext

sx <https://github.com/Earnestly/sx>
INTRODUCTION
sx is a simple alternative to both xinit(1) and startx(1).
It started life as a proof of concept while attempting to learn how both
xinit(1) and startx(1) worked.
It is not a direct replacement however as it provides a different, more
limited, interface.
Some of these differences are as follows:
* The Xorg server's command-line is hard coded and not exposed to the
user.
* The first DISPLAY is 1 instead of 0 contrary to what X(7) suggests.
* xauth entries are overwritten if the displayname is identical.
* Corresponding xauth entries are unconditionally removed when the Xorg
server is terminated.
* The Xorg server uses the -noreset flag.
* /usr/lib/xorg-server/Xorg is used directly, bypassing Xorg.wrap.
* While XAUTHORITY is still honoured, $XDG_CONFIG_HOME/sx/xauthfile is
used 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 rational on why this exists, the author invites the reader to look
over the source code for both xinit(1) and startx(1).
REQUIRES
Notable requirements are for GNU timeout and GNU tail which is used for the
--pid option. Beyond these the usual set of POSIX command-line tools along
with Xorg and xauth are required.
BUILD
As there's nothing to build, simply install using a prefered PREFIX.
make DESTDIR=staged PREFIX=/usr install