XSPICE(1)

Okay bestie, this is the manual page for XSPICE(1) from the User Commands section πŸŽ€βœ¨ Let's get into it!

✨ NAME ✨

Xspice is the X server and SPICE server, all in one πŸ’–

πŸ’… DESCRIPTION πŸ’…

The usage vibe is:

usage: Xspice [Xspice and Xorg options intermixed]

So Xspice is an X server AND a SPICE server, and you can toss Xspice and Xorg options together in any order πŸ¦‹ Here's a little example you can copy:

Xspice --port 5900 --disable-ticketing :1.0

πŸŽ€ optional arguments πŸŽ€

Here's the full options lineup, bestie πŸ’œ

  • -h, --help β€” pulls up the help message and then bounces πŸ‘‹
  • --xorg XORG β€” the manual doesn't spill any tea on this one πŸ™ˆ
  • --auto β€” automatically whips up a temporary xorg.conf and starts the X server, no effort needed ✨
  • --xsession XSESSION β€” if you give this, it runs after Xorg launches. It should be a program like x-session-manager 🫢
  • --config CONFIG β€” the manual is silent on this one πŸ™ˆ
  • --port PORT β€” the standard spice port 🌸
  • --exit-on-disconnect β€” the X server yeets itself when any client disconnects πŸ’€
  • --deferred-fps DEFERRED_FPS β€” if you give this, it renders to a buffer and only sends updates this many times per second 🎬
  • --tls-port TLS_PORT β€” the spice TLS port πŸ”
  • --disable-ticketing β€” no client password required, zero drama πŸ”“
  • --sasl β€” enables SASL 🧚
  • --x509-dir X509_DIR β€” the x509 directory for TLS πŸ“
  • --cacert-file CACERT_FILE β€” the CA certificate file for TLS πŸ“œ
  • --x509-cert-file X509_CERT_FILE β€” the server certificate file for TLS 🎟️
  • --x509-key-file X509_KEY_FILE β€” the server key file for TLS πŸ—οΈ
  • --x509-key-password X509_KEY_PASSWORD β€” the password for the key file, used for TLS πŸ”‘
  • --tls-ciphers TLS_CIPHERS β€” the manual doesn't say anything about this one πŸ™ˆ
  • --dh-file DH_FILE β€” same mystery energy, no details given πŸ™ˆ
  • --password PASSWORD β€” sets the password you need to connect to the server πŸ“
  • --image-compression {off,auto_glz,auto_lz,quic,glz,lz} β€” default is auto_glz 🌈
  • --jpeg-wan-compression {auto,never,always} β€” default is auto πŸ“Έ
  • --zlib-glz-wan-compression {auto,never,always} β€” default is auto πŸ—œοΈ
  • --streaming-video {off,all,filter} β€” default is filter πŸŽ₯
  • --ipv4-only β€” the manual gives no description, but the name says it's IPv4 only 🌐
  • --ipv6-only β€” the manual gives no description, but the name says it's IPv6 only 🌐
  • --vdagent β€” launches vdagent & vdagentd, which provide clipboard & resolution automation πŸ“‹πŸ–₯️
  • --vdagent-virtio-path VDAGENT_VIRTIO_PATH β€” the virtio socket path used by vdagentd 🧦
  • --vdagent-uinput-path VDAGENT_UINPUT_PATH β€” the uinput socket path used by vdagent 🎹
  • --vdagentd-exec VDAGENTD_EXEC β€” the path to spice-vdagentd (used with --vdagent) πŸ›€οΈ
  • --vdagent-exec VDAGENT_EXEC β€” the path to spice-vdagent (used with --vdagent) πŸ›€οΈ
  • --vdagent-no-launch β€” does not launch vdagent & vdagentd. It's for debugging, or for when some external script wants to handle that part itself πŸ™…β€β™€οΈ
  • --vdagent-uid VDAGENT_UID β€” sets the vdagent user id. Changing it only makes sense together with --vdagent-no-launch πŸ‘‘
  • --vdagent-gid VDAGENT_GID β€” sets the vdagent group id. Same deal: it only makes sense alongside --vdagent-no-launch πŸ‘‘
  • --audio-fifo-dir AUDIO_FIFO_DIR β€” sets the fifo directory for playback audio, designed to work with PulseAudio's module-pipe-sink 🎧
Any options Xspice doesn't parse get passed straight through to Xorg as-is πŸ¦‹

And that's the tea, bestie πŸ’– Brought to you by Xspice, last touched in May 2015 🌸 Stay iconic. 🧚