stupidcomputer
/
sx
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
sx/sx.1

111 lines
2.0 KiB
Groff
Raw Normal View History

doc: update sx version and date Regroup SEE ALSO section manuals by their section number.
2021-07-06 17:30:41 -05:00
.TH SX 1 "6 July 2021" 2.1.7
introduce sx
2017-12-01 14:14:54 -06:00
.SH NAME
doc: mention XDG_CONFIG_HOME environments
2017-12-08 11:18:15 -06:00
sx \- start an xorg server
introduce sx
2017-12-01 14:14:54 -06:00
.SH SYNOPSIS
.B sx
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-08-11 08:47:09 -05:00
.RI [ "command " [ "arguments " ...]]
introduce sx
2017-12-01 14:14:54 -06:00
.SH DESCRIPTION
.B sx
can be used to replace both
.BR xinit (1)
and
.BR startx (1)
sx: further tuning the signal situation This commit removes the complication of trying to handle client PIDs as doing so didn't provide any noticable gain. The main issue was that both `wait' commands didn't wait on their respective PIDs while the final cleanup wasn't called with both client and server PIDs and so the server remained running due to -noreset. The exit status of `sx' should again reflect that of the Xorg's which may be useful for scripts. Also slightly improves the comments on how Xorg handles USR1 signals. Fixes https://github.com/Earnestly/sx/issues/19
2020-10-06 12:51:39 -05:00
for starting an
.BR Xorg (1)
server with an initial client. By default
introduce sx
2017-12-01 14:14:54 -06:00
.B sx
doc: grammatical correction and clarification This emphasises that the command need not have arguments. Additionally include a reference to Xwrapper.config(5) as mentioned in the NOTE.
2018-10-21 11:14:48 -05:00
will attempt to execute
doc: include examples and clarify usage Sometimes people encode logic into files such as Xinitrc which absorbs command-line arguments that typically control which window manager or desktop environment to start. These examples demonstrate how they might do this with sxrc and other suggestions for reusing ~/.Xinitrc
2019-02-06 12:54:34 -06:00
.I \%XDG_CONFIG_HOME/sx/sxrc
introduce sx
2017-12-01 14:14:54 -06:00
unless a
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-08-11 08:47:09 -05:00
.I command
doc: grammatical correction and clarification This emphasises that the command need not have arguments. Additionally include a reference to Xwrapper.config(5) as mentioned in the NOTE.
2018-10-21 11:14:48 -05:00
is provided. The
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-08-11 08:47:09 -05:00
.I command
doc: grammatical correction and clarification This emphasises that the command need not have arguments. Additionally include a reference to Xwrapper.config(5) as mentioned in the NOTE.
2018-10-21 11:14:48 -05:00
may have additional
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-08-11 08:47:09 -05:00
.IR arguments .
sx: further tuning the signal situation This commit removes the complication of trying to handle client PIDs as doing so didn't provide any noticable gain. The main issue was that both `wait' commands didn't wait on their respective PIDs while the final cleanup wasn't called with both client and server PIDs and so the server remained running due to -noreset. The exit status of `sx' should again reflect that of the Xorg's which may be useful for scripts. Also slightly improves the comments on how Xorg handles USR1 signals. Fixes https://github.com/Earnestly/sx/issues/19
2020-10-06 12:51:39 -05:00
.SH EXIT STATUS
.B sx
will attempt to inherit the exit status from the
.BR Xorg (1)
server. Otherwise it is 0.
introduce sx
2017-12-01 14:14:54 -06:00
.SH ENVIRONMENT
.TP
.B XAUTHORITY
doc: clarify how XAUTHORITY is used
2017-12-04 05:58:00 -06:00
This environment references a file which stores authorisation entries
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-01 20:22:29 -06:00
used to secure
introduce sx
2017-12-01 14:14:54 -06:00
.BR Xorg (1) .
If this environment is not set then
.B sx
will create and use
sx: use XDG_DATA_HOME for the authority The authority file should not really be considered configuration data especially in the context of backups which might want to exclude such content.
2018-07-19 08:14:54 -05:00
.B \%XDG_DATA_HOME/sx/xauthority
doc: clarify how XAUTHORITY is used
2017-12-04 05:58:00 -06:00
instead while also exporting this value to
.BR XAUTHORITY .
doc: mention XDG_CONFIG_HOME environments
2017-12-08 11:18:15 -06:00
.TP
.B XDG_CONFIG_HOME
The directory used when searching for
sx: use XDG_DATA_HOME for the authority The authority file should not really be considered configuration data especially in the context of backups which might want to exclude such content.
2018-07-19 08:14:54 -05:00
.IR sxrc .
doc: mention XDG_CONFIG_HOME environments
2017-12-08 11:18:15 -06:00
.B \%HOME/.config
sx: use XDG_DATA_HOME for the authority The authority file should not really be considered configuration data especially in the context of backups which might want to exclude such content.
2018-07-19 08:14:54 -05:00
will be used if not set.
.TP
.B XDG_DATA_HOME
The directory used for storing the
.I xauthority
file.
.B \%HOME/.local/share
will be used if not set.
introduce sx
2017-12-01 14:14:54 -06:00
.SH FILES
.TP
doc: mention XDG_CONFIG_HOME environments
2017-12-08 11:18:15 -06:00
.B XDG_CONFIG_HOME/sx/sxrc
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-08-11 08:47:09 -05:00
The default command started by
introduce sx
2017-12-01 14:14:54 -06:00
.BR sx .
This file must be executable.
.TP
sx: use XDG_DATA_HOME for the authority The authority file should not really be considered configuration data especially in the context of backups which might want to exclude such content.
2018-07-19 08:14:54 -05:00
.B XDG_DATA_HOME/sx/xauthority
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-01 20:22:29 -06:00
The default authority used by
.B sx
if an alternative file is not provided with
doc: mention XDG_CONFIG_HOME environments
2017-12-08 11:18:15 -06:00
.BR XAUTHORITY .
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-08-11 08:47:09 -05:00
.SH NOTES
doc: hopefully more clarity on need for xwrapper
2022-07-20 14:15:07 -05:00
With the addition of
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-08-11 08:47:09 -05:00
.BR Xorg.wrap (1)
it may be necessary to set
.I allowed_users
to
.I anybody
in
doc: hopefully more clarity on need for xwrapper
2022-07-20 14:15:07 -05:00
.B \%/etc/X11/Xwrapper.config
if
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-08-11 08:47:09 -05:00
.B sx
doc: hopefully more clarity on need for xwrapper
2022-07-20 14:15:07 -05:00
is used in a pipeline or its standard output and standard error is redirected
to a file as it will not be considered a console user.
doc: include examples and clarify usage Sometimes people encode logic into files such as Xinitrc which absorbs command-line arguments that typically control which window manager or desktop environment to start. These examples demonstrate how they might do this with sxrc and other suggestions for reusing ~/.Xinitrc
2019-02-06 12:54:34 -06:00
.SH EXAMPLES
Use an existing
.I .Xinitrc
by specifying an appropriate interpreter such as
.BR sh (1)
sx: further tuning the signal situation This commit removes the complication of trying to handle client PIDs as doing so didn't provide any noticable gain. The main issue was that both `wait' commands didn't wait on their respective PIDs while the final cleanup wasn't called with both client and server PIDs and so the server remained running due to -noreset. The exit status of `sx' should again reflect that of the Xorg's which may be useful for scripts. Also slightly improves the comments on how Xorg handles USR1 signals. Fixes https://github.com/Earnestly/sx/issues/19
2020-10-06 12:51:39 -05:00
or making it executable with a correct interpreter line:
doc: include examples and clarify usage Sometimes people encode logic into files such as Xinitrc which absorbs command-line arguments that typically control which window manager or desktop environment to start. These examples demonstrate how they might do this with sxrc and other suggestions for reusing ~/.Xinitrc
2019-02-06 12:54:34 -06:00
.IP
.EX
.B sx sh ~/.Xinitrc
.EE
.PP
Pass arguments to the standard
.I sxrc
by presenting it to
.B sx
as a
.IR command :
.IP
.EX
.B sx ~/.config/sx/sxrc arg1 arg2
.EE
introduce sx
2017-12-01 14:14:54 -06:00
.SH SOURCE
.UR https://github.com/Earnestly/sx
.UE
.SH SEE ALSO
.BR startx (1),
doc: grammatical correction and clarification This emphasises that the command need not have arguments. Additionally include a reference to Xwrapper.config(5) as mentioned in the NOTE.
2018-10-21 11:14:48 -05:00
.BR xinit (1),
.BR Xorg (1),
doc: update sx version and date Regroup SEE ALSO section manuals by their section number.
2021-07-06 17:30:41 -05:00
.BR X (7),
doc: clarify how XAUTHORITY is used
2017-12-04 05:58:00 -06:00
.BR Xsecurity (7),
doc: grammatical correction and clarification This emphasises that the command need not have arguments. Additionally include a reference to Xwrapper.config(5) as mentioned in the NOTE.
2018-10-21 11:14:48 -05:00
.BR Xwrapper.config (5)