add man page #469

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 Project website: https://github.com/mviereck/x11docker
 
 ## [Unreleased]
+### Added
+ - `man` page for x11docker.
+ [(469)](https://github.com/mviereck/x11docker/issues/469)
 ### Fixed
  - `--tty` failed with `--xc`. Fix: disable `--xc`.
  [(464)](https://github.com/mviereck/x11docker/issues/464)

TODO.md

@@ -2,6 +2,9 @@
 x11docker ToDo notes
 
 ## Work in progress
+ - bug: ssh: --hostdisplay fails
+ - bug: setting XAUTHORITY with systemctl
+
  - kata: add new runtime for nerdctl io.containerd.kata.v2 
 
  - --kwin in weston segfaults
@@ -12,35 +15,17 @@ x11docker ToDo notes
  - --build=nvidia?
  - x11docker/nvidia-base: use tags with version number?
 
- - --clipboard: improve Wayland clipboard support
-
  - further centralize argument checks
- - change global "no" to ""
-
  - --pulseaudio=host: check possible tcp setup
- - --interactive fails now with old systemd versions. (wontfix, not important enough)
-
- - --interactive --init=runit|openrc|sysvinit: no job control in shell
- - --init=openrc|runit: elogind fails
- - check elogind with cgroupv2. maybe drop --sharecgroup and set up in container only
 
  - sommelier
- - --backend=systemd-nspawn|lxc|lxd|runc
- - check empty XDG_RUNTIME_DIR e.g. with --user, --hostuser
- - --weston2-xwayland?
-
- - --backend=proot
- - --name
- - --init except systemd possible?
- - clean /tmp
- - how to disable old binds? issue e.g. with/without --home, --share
-
+ - check empty XDG_RUNTIME_DIR e.g. with --user, --hostuser 
 
 ## Issues to fix
  - --build: download files for COPY/ADD (x11docker/check, x11docker/xserver)
  - `--remove`: give note about not removed files in `~./config/x11docker` and `/etc/x11docker`
  - `--update`: Check if installs not into `/usr/bin` or `/usr/local/bin`. Do not install other files then.
-  Maybe change to $1 mode without `--`
+ - --clipboard: improve Wayland clipboard support
 
 ## Checks
  - check all `--init=` in all backends rootful and rootless.
@@ -55,6 +40,10 @@ x11docker ToDo notes
  - `--backend=podman` rootless: disallow `--home` for different `--user`.
 
 ## Old issues to fix
+ - --interactive --init=runit|openrc|sysvinit: no job control in shell
+ - --interactive fails now with old systemd versions. (wontfix, not important enough)
+ - --init=openrc|runit: elogind fails
+ - check elogind with cgroupv2. maybe drop --sharecgroup and set up in container only
  - `--kwin-xwayland`: broken? Xwayland says: "missing wl_shell protocol". Deprecated yet.
  - docker-for-win: DOS newline mess in `error()` #219.
  - docker-for-win: Double entries in log.

x11docker

@@ -11,7 +11,7 @@
 # Run 'x11docker --help' or scroll down to read usage information.
 # More documentation at: https://github.com/mviereck/x11docker
 
-Version="7.5.0-beta-1"
+Version="7.5.0-beta-2"
 Packagedversion="no" # Set to "yes" if you want to package x11docker. This disables installation options.
 
 # --enforce-i: Enforce running in interactive mode to allow commands tty and weston-launch in special setups. (deprecated)
@@ -26,7 +26,6 @@ x11docker: Run GUI applications and desktop environments in containers.
  Supports docker, podman, and (experimental) nerdctl.
  Can run X servers from host or in containers of x11docker/xserver.
  Can also provide X servers to host applications.
-
 Usage:
 To run a container on a new X server:
  x11docker IMAGE
@@ -160,8 +159,6 @@ X server options:
  notably by options --desktop, --gpu, --wayland, --wm.
  -h, --hostdisplay Share host display :0. Quite bad container isolation!
  Least overhead of all X server options.
- Some apps may fail due to restricted untrusted cookies.
- Remove restrictions with option --clipboard.
  -a, --xpra Nested X server supporting seamless and --desktop mode.
  --xpra2 Like --xpra --xc, but runs xpra client on host.
  -A, --xpra-xwayland Like --xpra, but supports option --gpu.
@@ -366,7 +363,7 @@ Verbosity options:
  -v, --verbose Be verbose. Output of x11docker.log on stderr.
  -V Be verbose with colored output.
 
-Cleanup options (need root permissions):
+Cleanup options (might need root permissions):
  --cleanup Clean up orphaned containers and cache files. Those
  can remain if x11docker still runs on system shutdown.
  Terminates currently running x11docker containers, too.
@@ -1820,6 +1817,11 @@ $(diff -u -s -Z $Binpath/x11docker $(pwd)/x11docker 2>&1 | sed "s/^+.*/${Colgree
  cp LICENSE.txt /usr/share/doc/x11docker/
  } || note "Error while creating /usr/share/doc/x11docker"
 
+ note "Storing man page in /usr/share/man/man1/x11docker.1.gz"
+ command -v gzip >/dev/null && {
+ gzip -c x11docker.man > /usr/share/man/man1/x11docker.1.gz
+ } || note "Error storing man page."
+
  note "Installed x11docker version $Newversion"
  ;;
  --remove)