NAME

x11spice - Share an Xorg server via Spice

SYNOPSIS

x11spice [OPTION] [<listen-spec>]

DESCRIPTION

x11spice will allow a user to share an X11 session using libspice-server.

This provides a remote desktop access feature, using the Spice protocol.

If supplied, the first and only command line parameter will provide a specification for how the Spice server should listen for connections.

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). 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.

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.

OPTIONS

--config[=FILENAME]

This will read configuration settings from FILENAME, ignoring all settings in normal XDG locations. 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.

--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.

--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.

--hide

This will prevent the x11spice user interface from appearing at all.

--minimize

If given, the x11spice user interface will start minimized.

--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.

--password-file={-|PASSWORD}

If specified, x11spice will read the password from the given file, or stdin in the case of a file named -.

--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.

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).

--timeout[=SECONDS]

If a timeout is specificed, if no connection is made within the given number of seconds, x11spice will exit.

--allow-control

This will enable a remote viewer to inject mouse or keyboard commands.

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.

EXAMPLE

x11spice --generate-password

COPYRIGHT

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.

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