Date: Tuesday, February 8, 2022 @ 13:34:03 Author: lcarlier Revision: 436566
archrelease: copy trunk to testing-x86_64 Added: xorg-server/repos/testing-x86_64/ xorg-server/repos/testing-x86_64/0001-xkb-fix-XkbSetMap-when-changing-a-keysym-without-cha.patch (from rev 436565, xorg-server/trunk/0001-xkb-fix-XkbSetMap-when-changing-a-keysym-without-cha.patch) xorg-server/repos/testing-x86_64/PKGBUILD (from rev 436565, xorg-server/trunk/PKGBUILD) xorg-server/repos/testing-x86_64/xorg-server.install (from rev 436565, xorg-server/trunk/xorg-server.install) xorg-server/repos/testing-x86_64/xvfb-run (from rev 436565, xorg-server/trunk/xvfb-run) xorg-server/repos/testing-x86_64/xvfb-run.1 (from rev 436565, xorg-server/trunk/xvfb-run.1) -----------------------------------------------------------------+ 0001-xkb-fix-XkbSetMap-when-changing-a-keysym-without-cha.patch | 87 +++ PKGBUILD | 174 ++++++ xorg-server.install | 18 xvfb-run | 200 +++++++ xvfb-run.1 | 282 ++++++++++ 5 files changed, 761 insertions(+) Copied: xorg-server/repos/testing-x86_64/0001-xkb-fix-XkbSetMap-when-changing-a-keysym-without-cha.patch (from rev 436565, xorg-server/trunk/0001-xkb-fix-XkbSetMap-when-changing-a-keysym-without-cha.patch) =================================================================== --- testing-x86_64/0001-xkb-fix-XkbSetMap-when-changing-a-keysym-without-cha.patch (rev 0) +++ testing-x86_64/0001-xkb-fix-XkbSetMap-when-changing-a-keysym-without-cha.patch 2022-02-08 13:34:03 UTC (rev 436566) @@ -0,0 +1,87 @@ +From 0217cc6e0cf5013366105a90f5f91ccc4bab5425 Mon Sep 17 00:00:00 2001 +From: Samuel Thibault <samuel.thiba...@ens-lyon.org> +Date: Wed, 26 Jan 2022 00:05:55 +0100 +Subject: [PATCH] xkb: fix XkbSetMap when changing a keysym without changing a + keytype + +As the comment says: + +"symsPerKey/mapWidths must be filled regardless of client-side flags" + +so we always have to call CheckKeyTypes which will notably fill mapWidths +and nTypes. That is needed for CheckKeySyms to work since it checks the +width. Without it, any request with XkbKeySymsMask but not +XkbKeyTypesMask will fail because of the missing width information, for +instance this: + + XkbDescPtr xkb; + if (!(xkb = XkbGetMap (dpy, XkbKeyTypesMask|XkbKeySymsMask, XkbUseCoreKbd))) { + fprintf (stderr, "ERROR getting map\n"); + exit(1); + } + XFlush (dpy); + XSync (dpy, False); + + XkbMapChangesRec changes = { .changed = 0 }; + int oneGroupType[XkbNumKbdGroups] = { XkbOneLevelIndex }; + + if (XkbChangeTypesOfKey(xkb, keycode, 1, XkbGroup1Mask, oneGroupType, &changes)) { + fprintf(stderr, "ERROR changing type of key\n"); + exit(1); + } + XkbKeySymEntry(xkb,keycode,0,0) = keysym; + + if (!XkbChangeMap(dpy,xkb,&changes)) { + fprintf(stderr, "ERROR changing map\n"); + exit(1); + } + + XkbFreeKeyboard (xkb, 0, TRUE); + XFlush (dpy); + XSync (dpy, False); + +This had being going under the radar since about ever until commit +de940e06f8733d87bbb857aef85d830053442cfe ("xkb: fix key type index check +in _XkbSetMapChecks") fixed checking the values of kt_index, which was +previously erroneously ignoring errors and ignoring all other checks, just +because nTypes was not set, precisely because CheckKeyTypes was not called. + +Note: yes, CheckKeyTypes is meant to be callable without XkbKeyTypesMask, it +does properly check for that and just fills nTypes and mapWidths in that +case. + +Signed-off-by: Samuel Thibault <samuel.thiba...@ens-lyon.org> +Signed-off-by: Laurent Carlier <lordhea...@gmail.com> +--- + xkb/xkb.c | 11 +++++------ + 1 file changed, 5 insertions(+), 6 deletions(-) + +diff --git a/xkb/xkb.c b/xkb/xkb.c +index bfc21de00..820cd7166 100644 +--- a/xkb/xkb.c ++++ b/xkb/xkb.c +@@ -2511,16 +2511,15 @@ _XkbSetMapChecks(ClientPtr client, DeviceIntPtr dev, xkbSetMapReq * req, + } + } + +- if (!(req->present & XkbKeyTypesMask)) { +- nTypes = xkb->map->num_types; +- } +- else if (!CheckKeyTypes(client, xkb, req, (xkbKeyTypeWireDesc **) &values, +- &nTypes, mapWidths, doswap)) { ++ /* nTypes/mapWidths/symsPerKey must be filled for further tests below, ++ * regardless of client-side flags */ ++ ++ if (!CheckKeyTypes(client, xkb, req, (xkbKeyTypeWireDesc **) &values, ++ &nTypes, mapWidths, doswap)) { + client->errorValue = nTypes; + return BadValue; + } + +- /* symsPerKey/mapWidths must be filled regardless of client-side flags */ + map = &xkb->map->key_sym_map[xkb->min_key_code]; + for (i = xkb->min_key_code; i < xkb->max_key_code; i++, map++) { + register int g, ng, w; +-- +2.35.1 + Copied: xorg-server/repos/testing-x86_64/PKGBUILD (from rev 436565, xorg-server/trunk/PKGBUILD) =================================================================== --- testing-x86_64/PKGBUILD (rev 0) +++ testing-x86_64/PKGBUILD 2022-02-08 13:34:03 UTC (rev 436566) @@ -0,0 +1,174 @@ +# Maintainer: AndyRTR <andy...@archlinux.org> +# Maintainer: Jan de Groot <j...@archlinux.org> + +pkgbase=xorg-server +pkgname=('xorg-server' 'xorg-server-xephyr' 'xorg-server-xvfb' 'xorg-server-xnest' + 'xorg-server-common' 'xorg-server-devel') +pkgver=21.1.3 +pkgrel=2 +arch=('x86_64') +license=('custom') +groups=('xorg') +url="https://xorg.freedesktop.org" +makedepends=('xorgproto' 'pixman' 'libx11' 'mesa' 'mesa-libgl' 'xtrans' + 'libxkbfile' 'libxfont2' 'libpciaccess' 'libxv' 'libxcvt' + 'libxmu' 'libxrender' 'libxi' 'libxaw' 'libxtst' 'libxres' + 'xorg-xkbcomp' 'xorg-util-macros' 'xorg-font-util' 'libepoxy' + 'xcb-util' 'xcb-util-image' 'xcb-util-renderutil' 'xcb-util-wm' 'xcb-util-keysyms' + 'libxshmfence' 'libunwind' 'systemd' 'meson' 'git') +#source=(${pkgbase}-${pkgver}::git+https://gitlab.freedesktop.org/xorg/xserver.git#commit=27a0ee32ccef8d621aaa758c804fc9a5ceeb5a56 +source=(https://xorg.freedesktop.org/releases/individual/xserver/${pkgbase}-${pkgver}.tar.xz{,.sig} + xvfb-run # with updates from FC master + xvfb-run.1 + 0001-xkb-fix-XkbSetMap-when-changing-a-keysym-without-cha.patch) +validpgpkeys=('FD0004A26EADFE43A4C3F249C6F7AE200374452D') # Povilas Kanapickas <povi...@radix.lt> +sha512sums=('cf5fed023eadda62ae732f8c4d427c272ebe005188341290f3d03147042c103b00cbb94d86a0256da815fb9b9a3da315c21a05ee0c926c1a2ff0c54ab0c0638b' + 'SKIP' + '4154dd55702b98083b26077bf70c60aa957b4795dbf831bcc4c78b3cb44efe214f0cf8e3c140729c829b5f24e7466a24615ab8dbcce0ac6ebee3229531091514' + 'de5e2cb3c6825e6cf1f07ca0d52423e17f34d70ec7935e9dd24be5fb9883bf1e03b50ff584931bd3b41095c510ab2aa44d2573fd5feaebdcb59363b65607ff22' + 'bc3b955072f320ae72a771bebecbcf56637cd0448c3afa28149fcd9e0de3700e9fba1fec21fe283be77e1236e317e385f6970eb59df54d3181324c229c8309d7') + +prepare() { + cd ${pkgbase}-$pkgver + + # merged in main + patch -Np1 -i ../0001-xkb-fix-XkbSetMap-when-changing-a-keysym-without-cha.patch +} + +build() { + # Since pacman 5.0.2-2, hardened flags are now enabled in makepkg.conf + # With them, module fail to load with undefined symbol. + # See https://bugs.archlinux.org/task/55102 / https://bugs.archlinux.org/task/54845 + export CFLAGS=${CFLAGS/-fno-plt} + export CXXFLAGS=${CXXFLAGS/-fno-plt} + export LDFLAGS=${LDFLAGS/,-z,now} + + arch-meson ${pkgbase}-$pkgver build \ + -D ipv6=true \ + -D xvfb=true \ + -D xnest=true \ + -D xcsecurity=true \ + -D xorg=true \ + -D xephyr=true \ + -D glamor=true \ + -D udev=true \ + -D dtrace=false \ + -D systemd_logind=true \ + -D suid_wrapper=true \ + -D xkb_dir=/usr/share/X11/xkb \ + -D xkb_output_dir=/var/lib/xkb + + # Print config + meson configure build + ninja -C build + + # fake installation to be seperated into packages + DESTDIR="${srcdir}/fakeinstall" ninja -C build install +} + +_install() { + local src f dir + for src; do + f="${src#fakeinstall/}" + dir="${pkgdir}/${f%/*}" + install -m755 -d "${dir}" + # use copy so a new file is created and fakeroot can track properties such as setuid + cp -av "${src}" "${dir}/" + rm -rf "${src}" + done +} + +package_xorg-server-common() { + pkgdesc="Xorg server common files" + depends=(xkeyboard-config xorg-xkbcomp xorg-setxkbmap) + + _install fakeinstall/usr/lib/xorg/protocol.txt + _install fakeinstall/usr/share/man/man1/Xserver.1 + + install -m644 -Dt "${pkgdir}/var/lib/xkb/" "${pkgbase}-${pkgver}"/xkb/README.compiled + # license + install -m644 -Dt "${pkgdir}/usr/share/licenses/${pkgname}" "${pkgbase}-${pkgver}"/COPYING +} + +package_xorg-server() { + pkgdesc="Xorg X server" + depends=(libepoxy libxfont2 pixman xorg-server-common libunwind + dbus libgl xf86-input-libinput nettle + libpciaccess libdrm libxshmfence libxcvt) # FS#52949 + # see xorg-server-*/hw/xfree86/common/xf86Module.h for ABI versions - we provide major numbers that drivers can depend on + # and /usr/lib/pkgconfig/xorg-server.pc in xorg-server-devel pkg + provides=('X-ABI-VIDEODRV_VERSION=25.2' 'X-ABI-XINPUT_VERSION=24.4' 'X-ABI-EXTENSION_VERSION=10.0' 'x-server') + conflicts=('nvidia-utils<=331.20' 'glamor-egl' 'xf86-video-modesetting') + replaces=('glamor-egl' 'xf86-video-modesetting') + install=xorg-server.install + + _install fakeinstall/usr/bin/{X,Xorg,gtf} + _install fakeinstall/usr/lib/Xorg{,.wrap} + _install fakeinstall/usr/lib/xorg/modules/* + _install fakeinstall/usr/share/X11/xorg.conf.d/10-quirks.conf + _install fakeinstall/usr/share/man/man1/{Xorg,Xorg.wrap,gtf}.1 + _install fakeinstall/usr/share/man/man4/{exa,fbdevhw,inputtestdrv,modesetting}.4 + _install fakeinstall/usr/share/man/man5/{Xwrapper.config,xorg.conf,xorg.conf.d}.5 + + # distro specific files must be installed in /usr/share/X11/xorg.conf.d + install -m755 -d "${pkgdir}/etc/X11/xorg.conf.d" + + # license + install -m644 -Dt "${pkgdir}/usr/share/licenses/${pkgname}" "${pkgbase}-${pkgver}"/COPYING +} + +package_xorg-server-xephyr() { + pkgdesc="A nested X server that runs as an X application" + depends=(libxfont2 libgl libepoxy libunwind systemd-libs libxv pixman xorg-server-common + xcb-util-image xcb-util-renderutil xcb-util-wm xcb-util-keysyms + nettle libtirpc) + + _install fakeinstall/usr/bin/Xephyr + _install fakeinstall/usr/share/man/man1/Xephyr.1 + + # license + install -m644 -Dt "${pkgdir}/usr/share/licenses/${pkgname}" "${pkgbase}-${pkgver}"/COPYING +} + +package_xorg-server-xvfb() { + pkgdesc="Virtual framebuffer X server" + depends=(libxfont2 libunwind pixman xorg-server-common xorg-xauth + libgl nettle libtirpc systemd-libs) + + _install fakeinstall/usr/bin/Xvfb + _install fakeinstall/usr/share/man/man1/Xvfb.1 + + install -m755 "${srcdir}/xvfb-run" "${pkgdir}/usr/bin/" + install -m644 "${srcdir}/xvfb-run.1" "${pkgdir}/usr/share/man/man1/" # outda + + # license + install -m644 -Dt "${pkgdir}/usr/share/licenses/${pkgname}" "${pkgbase}-${pkgver}"/COPYING +} + +package_xorg-server-xnest() { + pkgdesc="A nested X server that runs as an X application" + depends=(libxfont2 libxext pixman xorg-server-common nettle libtirpc systemd-libs) + + _install fakeinstall/usr/bin/Xnest + _install fakeinstall/usr/share/man/man1/Xnest.1 + + # license + install -m644 -Dt "${pkgdir}/usr/share/licenses/${pkgname}" "${pkgbase}-${pkgver}"/COPYING +} + +package_xorg-server-devel() { + pkgdesc="Development files for the X.Org X server" + depends=('xorgproto' 'mesa' 'libpciaccess' + # not technically required but almost every Xorg pkg needs it to build + 'xorg-util-macros') + + _install fakeinstall/usr/include/xorg/* + _install fakeinstall/usr/lib/pkgconfig/xorg-server.pc + _install fakeinstall/usr/share/aclocal/xorg-server.m4 + + # license + install -m644 -Dt "${pkgdir}/usr/share/licenses/${pkgname}" "${pkgbase}-${pkgver}"/COPYING + + # make sure there are no files left to install + find fakeinstall -depth -print0 | xargs -0 rmdir +} Copied: xorg-server/repos/testing-x86_64/xorg-server.install (from rev 436565, xorg-server/trunk/xorg-server.install) =================================================================== --- testing-x86_64/xorg-server.install (rev 0) +++ testing-x86_64/xorg-server.install 2022-02-08 13:34:03 UTC (rev 436566) @@ -0,0 +1,18 @@ +post_upgrade() { + if (( $(vercmp $2 1.16.0-3) < 0 )); then + post_install + fi +} + +post_install() { + cat <<MSG +>>> xorg-server has now the ability to run without root rights with + the help of systemd-logind. xserver will fail to run if not launched + from the same virtual terminal as was used to log in. + Without root rights, log files will be in ~/.local/share/xorg/ directory. + + Old behavior can be restored through Xorg.wrap config file. + See Xorg.wrap man page (man xorg.wrap). +MSG +} + Copied: xorg-server/repos/testing-x86_64/xvfb-run (from rev 436565, xorg-server/trunk/xvfb-run) =================================================================== --- testing-x86_64/xvfb-run (rev 0) +++ testing-x86_64/xvfb-run 2022-02-08 13:34:03 UTC (rev 436566) @@ -0,0 +1,200 @@ +#!/bin/sh +# --- 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 --- + +# $Id$ +# from: http://necrotic.deadbeast.net/xsf/XFree86/trunk/debian/local/xvfb-run + +# This script starts an instance of Xvfb, 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=xvfb-run +SERVERNUM=99 +AUTHFILE= +ERRORFILE=/dev/null +STARTWAIT=3 +XVFBARGS="-screen 0 640x480x24" +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 Xvfb + 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 Xvfb server + (default: "$XVFBARGS") +-w DELAY --wait=DELAY delay in seconds to wait for Xvfb 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 Xvfb. +MCOOKIE=$(mcookie) + +if [ -z "$AUTO_DISPLAY" ]; then + # Old style using a pre-computed SERVERNUM + XAUTHORITY=$AUTHFILE Xvfb ":$SERVERNUM" $XVFBARGS $LISTENTCP >>"$ERRORFILE" \ + 2>&1 & + XVFBPID=$! +else + # New style using Xvfb to provide a free display + PIDFILE=$(mktemp -p "$XVFB_RUN_TMPDIR" pid.XXXXXX) + SERVERNUM=$(XAUTHORITY=$AUTHFILE Xvfb -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 +DISPLAY=:$SERVERNUM XAUTHORITY=$AUTHFILE "$@" +RETVAL=$? +set -e + +# Kill Xvfb 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: Copied: xorg-server/repos/testing-x86_64/xvfb-run.1 (from rev 436565, xorg-server/trunk/xvfb-run.1) =================================================================== --- testing-x86_64/xvfb-run.1 (rev 0) +++ testing-x86_64/xvfb-run.1 2022-02-08 13:34:03 UTC (rev 436566) @@ -0,0 +1,282 @@ +.\" $Id: xvfb-run.1 2138 2005-01-17 23:40:27Z branden $ +.\" +.\" Copyright 1998-2004 Branden Robinson <bran...@debian.org>. +.\" +.\" This is free software; you may redistribute it and/or modify +.\" it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2, +.\" or (at your option) any later version. +.\" +.\" This is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License with +.\" the Debian operating system, in /usr/share/common-licenses/GPL; if +.\" not, write to the Free Software Foundation, Inc., 59 Temple Place, +.\" Suite 330, Boston, MA 02111-1307 USA +.\" +.\" We need the URL macro from groff's www macro package, but also want +.\" things to work all right for people who don't have it. So we define +.\" our own URL macro and let the www macro package override it if it's +.\" available. +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.TH xvfb\-run 1 "2004\-11\-12" "Debian Project" +.SH NAME +xvfb\-run \- run specified X client or command in a virtual X server environment +.SH SYNOPSIS +.B xvfb\-run +[ +.I options +] +.I command +.SH DESCRIPTION +.B xvfb\-run +is a wrapper for the +.BR Xvfb (1x) +command which simplifies the task of running commands (typically an X +client, or a script containing a list of clients to be run) within a virtual +X server environment. +.PP +.B xvfb\-run +sets up an X authority file (or uses an existing user\-specified one), +writes a cookie to it (see +.BR xauth (1x)) +and then starts the +.B Xvfb +X server as a background process. +The process ID of +.B Xvfb +is stored for later use. +The specified +.I command +is then run using the X display corresponding to the +.B Xvfb +server +just started and the X authority file created earlier. +.PP +When the +.I command +exits, its status is saved, the +.B Xvfb +server is killed (using the process ID stored earlier), the X authority +cookie removed, and the authority file deleted (if the user did not specify +one to use). +.B xvfb\-run +then exits with the exit status of +.IR command . +.PP +.B xvfb\-run +requires the +.B xauth +command to function. +.SH OPTIONS +.TP +.B \-a\fR,\fB \-\-auto\-servernum +Try to get a free server number, starting at 99, or the argument to +.BR \-\-server\-num . +.TP +.BI \-e\ file \fR,\fB\ \-\-error\-file= file +Store output from +.B xauth +and +.B Xvfb +in +.IR file . +The default is +.IR /dev/null . +.TP +.BI \-f\ file \fR,\fB\ \-\-auth\-file= file +Store X authentication data in +.IR file . +By default, a temporary directory called +.IR xvfb\-run. PID +(where PID is the process ID of +.B xvfb\-run +itself) is created in the directory specified by the environment variable +.B TMPDIR +(or +.I /tmp +if that variable is null or unset), and the +.BR tempfile (1) +command is used to create a file in that temporary directory called +.IR Xauthority . +.TP +.B \-h\fR,\fB \-\-help +Display a usage message and exit. +.TP +.BI \-n\ servernumber \fR,\fB\ \-\-server\-num= servernumber +Use +.I servernumber +as the server number (but see the +.B \-a\fR,\fB \-\-auto\-servernum +option above). +The default is 99. +.TP +.B \-l\fR,\fB \-\-listen\-tcp +Enable TCP port listening in the X server. +For security reasons (to avoid denial\-of\-service attacks or exploits), +TCP port listening is disabled by default. +.TP +.BI \-p\ protocolname \fR,\fB\ \-\-xauth\-protocol= protocolname +Use +.I protocolname +as the X authority protocol to use. +The default is \(oq.\(cq, which +.B xauth +interprets as its own default protocol, which is MIT\-MAGIC\-COOKIE\-1. +.TP +.BI \-s\ arguments \fR,\fB\ \-\-server\-args= arguments +Pass +.I arguments +to the +.B Xvfb +server. +Be careful to quote any whitespace characters that may occur within +.I arguments +to prevent them from regarded as separators for +.BR xvfb\-run 's +own arguments. +Also, note that specification of \(oq\-nolisten tcp\(cq in +.I arguments +may override the function of +.BR xvfb\-run 's +own +.B \-l\fR,\fB \-\-listen\-tcp +option, and that specification of the server number (e.g., \(oq:1\(cq) may +be ignored because of the way the X server parses its argument list. +Use the +.B xvfb\-run +option +.BI \-n\ servernumber \fR,\fB\ \-\-server\-num= servernumber +to achieve the latter function. +The default is \(oq\-screen 0 640x480x8\(cq. +.TP +.BI \-w\ delay \fR,\fB\ \-\-wait= delay +Wait +.I delay +seconds after launching +.B Xvfb +before attempting to start the specified command. +The default is 3. +.SH ENVIRONMENT +.TP +.B COLUMNS +indicates the width of the terminal device in character cells. +This value is used for formatting diagnostic messages. +If not set, the terminal is queried using +.BR stty (1) +to determine its width. +If that fails, a value of \(oq80\(cq is assumed. +.TP +.B TMPDIR +specifies the directory in which to place +.BR xvfb\-run 's +temporary directory for storage of the X authority file; only used if the +.B \-f +or +.B \-\-auth\-file +options are not specified. +.SH "OUTPUT FILES" +.PP +Unless the +.B \-f +or +.B \-\-auth\-file +options are specified, a temporary +directory and file within it are created (and deleted) to store the X +authority cookies used by the +.B Xvfb +server and client(s) run under it. +See +.BR tempfile (1). +If \-f or \-\-auth\-file are used, then the specified X authority file is +only written to, not created or deleted (though +.B xauth +creates an authority file itself if told to use use that does not already +exist). +.PP +An error file with a user\-specified name is also created if the +.B \-e +or +.B \-\-error\-file +options are specifed; see above. +.SH "EXIT STATUS" +.B xvfb\-run +uses its exit status as well as output to standard error to communicate +diagnostics. +The exit status of \(oq1\(cq is not used, and should be interpreted as failure +of the specified command. +.TP +0 +.B xvfb\-run +only uses this exit status if the +.B \-h\fR,\fB \-\-help +option is given. +In all other situations, this may be interpreted as success of the specified +command. +.TP +2 +No command to run was specified. +.TP +3 +The +.B xauth +command is not available. +.TP +4 +The temporary directory that was going to be used already exists; since +.B xvfb\-run +produces a uniquely named directory, this may indicate an attempt by another +process on the system to exploit a temporary file race condition. +.TP +5 +A problem was encountered while cleaning up the temporary directory. +.TP +6 +A problem was encountered while using +.BR getopt (1) +to parse the command\-line arguments. +.SH EXAMPLES +.TP +.B xvfb\-run \-\-auto\-servernum \-\-server\-num=1 xlogo +runs the +.BR xlogo (1x) +demonstration client inside the +.B Xvfb +X server on the first available server number greater than or equal to 1. +.TP +.B xvfb\-run \-\-server\-args="\-screen 0 1024x768x24" ico \-faces +runs the +.BR ico (1x) +demonstration client (and passes it the +.B \-faces +argument) inside the +.B Xvfb +X server, configured with a root window of 1024 by 768 pixels and a color +depth of 24 bits. +.PP +Note that the demo X clients used in the above examples will not exit on +their own, so they will have to be killed before +.B xvfb\-run +will exit. +.SH BUGS +See +.URL "http://bugs.debian.org/xvfb" "the Debian Bug Tracking System" . +If you wish to report a bug in +.BR xvfb\-run , +please use the +.BR reportbug (1) +command. +.SH AUTHOR +.B xfvb\-run +was written by Branden Robinson and Jeff Licquia with sponsorship from +Progeny Linux Systems. +.SH "SEE ALSO" +.BR Xvfb (1x), +.BR xauth (1x) +.\" vim:set et tw=80: