Created
December 11, 2023 07:57
-
-
Save polypoyo/30c3a7125c13a4699cc9ce0cf8597ada to your computer and use it in GitHub Desktop.
Modified version of xvfb-run to allow usage of other servers
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/usr/bin/env bash | |
# --- T2-COPYRIGHT-NOTE-BEGIN --- | |
# This copyright note is auto-generated by ./scripts/Create-CopyPatch. | |
# | |
# T2 SDE: package/.../xorg-server/xvfb-run.sh | |
# Copyright (C) 2005 The T2 SDE Project | |
# Copyright (C) XXXX - 2005 Debian | |
# | |
# More information can be found in the files COPYING and README. | |
# | |
# This program is free software; you can redistribute it and/or modify | |
# it under the terms of the GNU General Public License as published by | |
# the Free Software Foundation; version 2 of the License. A copy of the | |
# GNU General Public License can be found in the file COPYING. | |
# --- T2-COPYRIGHT-NOTE-END --- | |
# | |
# from: http://necrotic.deadbeast.net/xsf/XFree86/trunk/debian/local/xvfb-run | |
# This script starts an instance of $XSERVER, the "fake" X server, runs a command | |
# with that server available, and kills the X server when done. The return | |
# value of the command becomes the return value of this script. | |
# | |
# If anyone is using this to build a Debian package, make sure the package | |
# Build-Depends on xvfb, xbase-clients, and xfonts-base. | |
set -e | |
PROGNAME=x-run | |
XSERVER=${XSERVER:-Xwayland} # under x11, use Xnest (or Xephyr). on a headless machine, you wouldn't use this script, but instead xvfb-run | |
WINDOW_MANAGER=${WINDOW_MANAGER:-xmonad} # xmonad's default config works great for our purposes | |
SERVERNUM=99 | |
AUTHFILE= | |
ERRORFILE=/tmp/xerror | |
STARTWAIT=0.05 # may need to increase this on older systems. the original value from xvfb-run was 3.0 | |
XVFBARGS="-retro" | |
LISTENTCP="-nolisten tcp" | |
XAUTHPROTO=. | |
# Query the terminal to establish a default number of columns to use for | |
# displaying messages to the user. This is used only as a fallback in the event | |
# the COLUMNS variable is not set. ($COLUMNS can react to SIGWINCH while the | |
# script is running, and this cannot, only being calculated once.) | |
DEFCOLUMNS=$(stty size 2>/dev/null | awk '{print $2}') || true | |
if ! expr "$DEFCOLUMNS" : "[[:digit:]]\+$" >/dev/null 2>&1; then | |
DEFCOLUMNS=80 | |
fi | |
# Display a message, wrapping lines at the terminal width. | |
message () { | |
echo "$PROGNAME: $*" | fmt -t -w ${COLUMNS:-$DEFCOLUMNS} | |
} | |
# Display an error message. | |
error () { | |
message "error: $*" >&2 | |
} | |
# Display a usage message. | |
usage () { | |
if [ -n "$*" ]; then | |
message "usage error: $*" | |
fi | |
cat <<EOF | |
Usage: $PROGNAME [OPTION ...] COMMAND | |
Run COMMAND (usually an X client) in a virtual X server environment. | |
Options: | |
-a --auto-servernum try to get a free server number, starting at | |
--server-num (deprecated, use --auto-display | |
instead) | |
-d --auto-display use the X server to find a display number | |
automatically | |
-e FILE --error-file=FILE file used to store xauth errors and $XSERVER | |
output (default: $ERRORFILE) | |
-f FILE --auth-file=FILE file used to store auth cookie | |
(default: ./.Xauthority) | |
-h --help display this usage message and exit | |
-n NUM --server-num=NUM server number to use (default: $SERVERNUM) | |
-l --listen-tcp enable TCP port listening in the X server | |
-p PROTO --xauth-protocol=PROTO X authority protocol name to use | |
(default: xauth command's default) | |
-s ARGS --server-args=ARGS arguments (other than server number and | |
"-nolisten tcp") to pass to the $XSERVER server | |
(default: "$XVFBARGS") | |
-w DELAY --wait=DELAY delay in seconds to wait for $XSERVER to start | |
before running COMMAND (default: $STARTWAIT) | |
EOF | |
} | |
# Find a free server number by looking at .X*-lock files in /tmp. | |
find_free_servernum() { | |
# Sadly, the "local" keyword is not POSIX. Leave the next line commented in | |
# the hope Debian Policy eventually changes to allow it in /bin/sh scripts | |
# anyway. | |
local i | |
i=$SERVERNUM | |
while [ -f /tmp/.X$i-lock ]; do | |
i=$(($i + 1)) | |
done | |
echo $i | |
} | |
# Parse the command line. | |
ARGS=$(getopt --options +ade:f:hn:lp:s:w: \ | |
--long auto-servernum,auto-display,error-file:,auth-file:,help,server-num:,listen-tcp,xauth-protocol:,server-args:,wait: \ | |
--name "$PROGNAME" -- "$@") | |
GETOPT_STATUS=$? | |
if [ $GETOPT_STATUS -ne 0 ]; then | |
error "internal error; getopt exited with status $GETOPT_STATUS" | |
exit 6 | |
fi | |
eval set -- "$ARGS" | |
while :; do | |
case "$1" in | |
-a|--auto-servernum) SERVERNUM=$(find_free_servernum) ;; | |
-d|--auto-display) AUTO_DISPLAY=1 ;; | |
-e|--error-file) ERRORFILE="$2"; shift ;; | |
-f|--auth-file) AUTHFILE="$2"; shift ;; | |
-h|--help) SHOWHELP="yes" ;; | |
-n|--server-num) SERVERNUM="$2"; shift ;; | |
-l|--listen-tcp) LISTENTCP="" ;; | |
-p|--xauth-protocol) XAUTHPROTO="$2"; shift ;; | |
-s|--server-args) XVFBARGS="$2"; shift ;; | |
-w|--wait) STARTWAIT="$2"; shift ;; | |
--) shift; break ;; | |
*) error "internal error; getopt permitted \"$1\" unexpectedly" | |
exit 6 | |
;; | |
esac | |
shift | |
done | |
if [ "$SHOWHELP" ]; then | |
usage | |
exit 0 | |
fi | |
if [ -z "$*" ]; then | |
usage "need a command to run" >&2 | |
exit 2 | |
fi | |
if ! type xauth >/dev/null; then | |
error "xauth command not found" | |
exit 3 | |
fi | |
# Set up the temp dir for the pid and X authorization file | |
XVFB_RUN_TMPDIR="$(mktemp --directory --tmpdir $PROGNAME.XXXXXX)" | |
# If the user did not specify an X authorization file to use, set up a temporary | |
# directory to house one. | |
if [ -z "$AUTHFILE" ]; then | |
AUTHFILE=$(mktemp -p "$XVFB_RUN_TMPDIR" Xauthority.XXXXXX) | |
fi | |
# Start $XSERVER. | |
MCOOKIE=$(mcookie) | |
if [ -z "$AUTO_DISPLAY" ]; then | |
# Old style using a pre-computed SERVERNUM | |
XAUTHORITY=$AUTHFILE $XSERVER ":$SERVERNUM" $XVFBARGS $LISTENTCP >>"$ERRORFILE" \ | |
2>&1 & | |
XVFBPID=$! | |
else | |
# New style using $XSERVER to provide a free display | |
PIDFILE=$(mktemp -p "$XVFB_RUN_TMPDIR" pid.XXXXXX) | |
SERVERNUM=$(XAUTHORITY=$AUTHFILE $XSERVER -displayfd 1 $XVFBARGS $LISTENTCP \ | |
2>"$ERRORFILE" & echo $! > $PIDFILE) | |
XVFBPID=$(cat $PIDFILE) | |
fi | |
sleep "$STARTWAIT" | |
XAUTHORITY=$AUTHFILE xauth source - << EOF >>"$ERRORFILE" 2>&1 | |
add :$SERVERNUM $XAUTHPROTO $MCOOKIE | |
EOF | |
# Start the command and save its exit status. | |
set +e | |
env -u WAYLAND_DISPLAY DISPLAY=:$SERVERNUM XAUTHORITY=$AUTHFILE $WINDOW_MANAGER & | |
window_manager_pid=$! | |
env -u WAYLAND_DISPLAY DISPLAY=:$SERVERNUM XAUTHORITY=$AUTHFILE "$@" | |
RETVAL=$? | |
set -e | |
# Kill Window manager now that the command has exited | |
kill -INT $window_manager_pid | |
# Kill X Server now that the command has exited. | |
kill $XVFBPID | |
# Clean up. | |
XAUTHORITY=$AUTHFILE xauth remove ":$SERVERNUM" >"$ERRORFILE" 2>&1 | |
if [ -n "$XVFB_RUN_TMPDIR" ]; then | |
if ! rm -r "$XVFB_RUN_TMPDIR"; then | |
error "problem while cleaning up temporary directory" | |
exit 5 | |
fi | |
fi | |
# Return the executed command's exit status. | |
exit $RETVAL | |
# vim:set ai et sts=4 sw=4 tw=80: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment