X11SPICE(1)

📦 version 2019-08, in nixos 26.05, nixpkgs unstable

💅 x11spice — the manual page, but make it make sense

okay so bestie, welcome to the X11SPICE(1) page — that's section 1 of the User Commands manual, bestie, we're in the big leagues now 🎀. Anyway. Let's get into it.

✨ NAME ✨

x11spice — share an Xorg server via Spice. that's it. that's the whole thing. your X session, but remote, but make it Spice protocol 💅

🦋 SYNOPSIS 🦋

x11spice [OPTION] [<listen-spec>]

literally just options and maybe a listen spec. slay.

👑 DESCRIPTION 👑

so x11spice will allow a user to share an X11 session using libspice-server. yup, that's the whole vibe.

this right here provides a remote desktop access feature, using the Spice protocol. remote desktop!! iconic!! 🖥️✨

if supplied, the first and only command line parameter will provide a specification for how the Spice server should listen for connections. note that: first and only, bestie. don't get cute with a second one.

the <listen-spec> is of the form:

[[host]:[port][-end-port]

where host specifies the address to listen on (default: localhost), and port specifies the port to listen to (default: 5900). and end-port, if given, will cause x11spice to scan from port to end-port checking for an open port, and using the first one available. it's giving "find me literally any open door" 🚪💀

by default, x11spice will display a simple dialog box which will show connection status and provide a mechanism to disconnect a remote viewer or exit the program altogether. a lil baby UI. we love her 🫶

🌸 OPTIONS 🌸

  • --config[=FILENAME] — this will read configuration settings from FILENAME, ignoring all settings in normal XDG locations. no cap, ignoring. if not provided, x11spice will first read settings from /etc/xdg/x11spice/x11spice.conf, then overwrite them with any settings read from ~/.config/x11spice/x11spice.conf. so: system settings first, then your settings stomp all over them 💅
  • --display=DISPLAY — DISPLAY will use an alternate Xorg server. the string should be in the standard format used by X for the DISPLAY environment variable; e.g. :1. classic. iykyk.
  • --generate-password[=LEN] — when this option is selected, x11spice will generate a password randomly and use that for the connection; the password will be printed to the standard output for use. if the optional LEN is given, the password will have that length. random password generator, we stan 🔥
  • --hide — this will prevent the x11spice user interface from appearing at all. gone. poof. invisible main character energy 🙈
  • --minimize — if given, the x11spice user interface will start minimized. she's shy but she's there 🎀
  • --password=PASSWORD — if given, x11spice will directly use PASSWORD as an option. Note: this is not recommended. this will expose the password in the process list, which is a security concern. fr fr, don't do this one, bestie 😭
  • --password-file={-|PASSWORD} — if specified, x11spice will read the password from the given file, or stdin in the case of a file named -. yes, that's a literal single dash meaning stdin. she's quirky like that 🌈
  • --ssl[=spec] — this will turn on SSL mode. at a minimum, SSL mode requires a server cert, private key, and a CA certificate. you can also optionally provide a key password, a dh_key_file, and a ciphersuite. secure!! encrypted!! we love a protected connection 🔒✨

the optional spec, if given, is a comma delimited list of file names. the first file name will be the CA cert .pem file, the second one the server cert file, the third the private key. the optional fourth parameter is the key password, then the dh_key_file, and finally the ciphersuite. you can skip one of the options by providing a blank entry (e.g. --ssl=ca-cert.pem,,private-key.pem). yes, that double comma is on purpose, don't panic 💀

  • --timeout[=SECONDS] — if a timeout is specificed, if no connection is made within the given number of seconds, x11spice will exit. (also yes, the original says "specificed" — i'm not fixing her spelling, that's lore 🫶). no connection? she's leaving. periodt.
  • --allow-control — this will enable a remote viewer to inject mouse or keyboard commands. so they can actually drive your session. powerful. use responsibly 👑

⭐ EXIT STATUS ⭐

x11spice will return a status of 0 if it is able to start a Spice session. it will return non zero in the event of an error. zero means slay, anything else means something went wrong 😭

💖 EXAMPLE 💖

x11spice --generate-password

that's it. that's the example. generate a password and go 🎀

Copyright (C) 2016 Jeremy White <jwhite@codeweavers.com>. All rights reserved.

x11spice 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, either version 3 of the License, or (at your option) any later version.

x11spice 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. (yes, the all-caps is real, that's just how legalese yells 📣)

you should have received a copy of the GNU General Public License along with x11spice. If not, see <http://www.gnu.org/licenses/>.

and that's the whole page, bestie 💜 — this was the x11spice page from the User Commands manual, dated July 2016, and it's out. mwah 🌸

📦 where this page comes from