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

83 lines
1.5 KiB
Groff
Raw Normal View History

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
.TH SX 1 "21 October 2018"
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)
for starting an Xorg server. By default
.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
introduce sx
2017-12-01 14:14:54 -06:00
.I sxrc
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 .
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
Since the addition of
.BR Xorg.wrap (1)
it may be necessary to set
.I allowed_users
to
.I anybody
in
.BR \%/etc/X11/Xwrapper.config .
This is due to
.B sx
attempting to run commands from within a subshell and is thusly not considered
a console user.
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 X (7),
.BR xinit (1),
.BR Xorg (1),
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)