"These options control client features that affect the appearance or the keyboard.")
group.add_option("--no-windows", action="store_false",
dest="windows_enabled", default=True,
help="Tells the server not to send any window data, only notifications and bell events will be forwarded - if enabled.")
group.add_option("--session-name", action="store",
dest="session_name", default=None,
help="The name of this session, which may be used in notifications, menus, etc. Default: Xpra")
group.add_option("--title", action="store",
dest="title", default="@title@ on @client-machine@",
help="Text which is shown as window title, may use remote metadata variables (default: '@title@ on @client-machine@')")
group.add_option("--window-icon", action="store",
dest="window_icon", default=None,
help="Path to the default image which will be used for all windows (the application may override this)")
# let the platform specific code add its own options:
# adds "--no-tray" for platforms that support it
add_client_options(group)
group.add_option("--tray-icon", action="store",
dest="tray_icon", default=None,
help="Path to the image which will be used as icon for the system-tray or dock")
group.add_option("--key-shortcut", action="append",
dest="key_shortcuts", type="str", default=[],
help="Define key shortcuts that will trigger specific actions."
+ " Defaults to 'Meta+Shift+F4:quit' if no shortcuts are defined.")
group.add_option("--no-keyboard-sync", action="store_false",
dest="keyboard_sync", default=bool_default("keyboard-sync", True),
help="Disable keyboard state synchronization, prevents keys from repeating on high latency links but also may disrupt applications which access the keyboard directly")
parser.add_option_group(group)
group = OptionGroup(parser, "Advanced Options",
"These options apply to both client and server. Please refer to the man page for details.")
group.add_option("--password-file", action="store",
def main(script_file, cmdline):
#################################################################
## NOTE NOTE NOTE
##
## If you modify anything here, then remember to update the man page
## (xpra.1) as well!
##
## NOTE NOTE NOTE
#################################################################
if XPRA_LOCAL_SERVERS_SUPPORTED:
start_str = "\t%prog start DISPLAY\n"
list_str = "\t%prog list\n"
upgrade_str = "\t%prog upgrade DISPLAY"
note_str = ""
stop_str = "\t%prog stop [DISPLAY]\n"
else:
start_str = ""
list_str = ""
upgrade_str = ""
note_str = "(This xpra installation does not support starting local servers.)"
stop_str = ""
parser = OptionParser(version="xpra v%s" % xpra.__version__,
usage="".join(["\n",
start_str,
"\t%prog attach [DISPLAY]\n",
"\t%prog detach [DISPLAY]\n",
"\t%prog screenshot filename [DISPLAY]\n",
"\t%prog version [DISPLAY]\n",
stop_str,
list_str,
upgrade_str,
note_str]))
if XPRA_LOCAL_SERVERS_SUPPORTED:
parser.add_option("--start-child", action="append",
dest="children", metavar="CMD",
help="program to spawn in new server (may be repeated)")
parser.add_option("--exit-with-children", action="store_true",
dest="exit_with_children", default=False,
help="Terminate server when --start-child command(s) exit")
parser.add_option("--no-daemon", action="store_false",
dest="daemon", default=True,
help="Don't daemonize when running as a server")
parser.add_option("--use-display", action="store_true",
dest="use_display", default=False,
help="Use an existing display rather than starting one with xvfb")
parser.add_option("--xvfb", action="store",
dest="xvfb", default="Xvfb +extension Composite -screen 0 3840x2560x24+32 -nolisten tcp -noreset -auth $XAUTHORITY", metavar="CMD",
help="How to run the headless X server (default: '%default')")
parser.add_option("--no-randr", action="store_false",
dest="randr", default=True,
help="Disables X11 randr support, xrandr allows the virtual display to be resized to match the client's dimensions (if supported by Xvfb)")
parser.add_option("--bind-tcp", action="store",
dest="bind_tcp", default=None,
metavar="[HOST]:PORT",
help="Listen for connections over TCP (insecure)")
parser.add_option("--no-clipboard", action="store_false",
dest="clipboard", default=True,
help="Disable clipboard support")
parser.add_option("--no-pulseaudio", action="store_false",
dest="pulseaudio", default=True,
help="Disable pulseaudio support via X11 root window properties")
parser.add_option("--no-keyboard-sync", action="store_false",
dest="keyboard_sync", default=True,
help="Disable keyboard state synchronization, prevents keys from repeating on high latency links but also may disrupt applications which access the keyboard directly")
# let the platform specific code add its own options:
# adds "--no-tray" for platforms that support it
add_client_options(parser)
parser.add_option("--no-mmap", action="store_false",
dest="mmap", default=True,
help="Disable memory mapped transfers for local connections")
parser.add_option("--password-file", action="store",
dest="password_file", default=None,
help="The file containing the password required to connect (useful to secure TCP mode)")
parser.add_option("--session-name", action="store",
dest="session_name", default=None,
help="The name of this session, which may be used in notifications, menus, etc. Default: Xpra")
parser.add_option("--title-suffix", action="store",
dest="title_suffix", default=None,
help="Text which is appended to the window's title (deprecated - use --title instead)")
parser.add_option("--title", action="store",
dest="title", default="@title@ on @client-machine@",
help="Text which is shown as window title, may use remote metadata variables (default: '@title@ on @client-machine@')")
parser.add_option("--window-icon", action="store",
dest="window_icon", default=None,
help="Path to the default image which will be used for all windows (the application may override this)")
parser.add_option("--tray-icon", action="store",
dest="tray_icon", default=None,
help="Path to the image which will be used as icon for the system-tray or dock")
parser.add_option("--encoding", action="store",
metavar="ENCODING",
dest="encoding", type="str",
help="What image compression algorithm to use: %s. Default: %s" % (", ".join(ENCODINGS), DEFAULT_ENCODING))
if "jpeg" in ENCODINGS:
parser.add_option("--jpeg-quality", action="store",
metavar="LEVEL",
dest="jpegquality", type="int", default="80",
help="Use jpeg compression with given quality (1-100). Default: 80")
parser.add_option("-b", "--max-bandwidth", action="store",
dest="max_bandwidth", type="float", default=0.0, metavar="BANDWIDTH (kB/s)",
help="Specify the link's maximal receive speed to auto-adjust JPEG quality, 0.0 disables. (default: disabled)")
parser.add_option("--auto-refresh-delay", action="store",
dest="auto_refresh_delay", type="float", default=0.0,
metavar="DELAY",
help="Idle delay in seconds before doing automatic lossless refresh."
+ " 0.0 to disable."
+ " Default: %default.")
parser.add_option("--key-shortcut", action="append",
dest="key_shortcuts", type="str", default=[],
help="Define key shortcuts that will trigger specific actions."
+ " Defaults to Meta+Shift+F4:quit if no shortcuts are defined.")
parser.add_option("--readonly", action="store_true",
dest="readonly", default=False,
help="Ignore all keyboard input and mouse events from client")
parser.add_option("-z", "--compress", action="store",
dest="compression_level", type="int", default=3,
metavar="LEVEL",
help="How hard to work on compressing data."
+ " 0 to disable compression,"
+ " 9 for maximal (slowest) compression. Default: %default.")
parser.add_option("--ssh", action="store",
dest="ssh", default=DEFAULT_SSH_CMD, metavar="CMD",
help="How to run ssh (default: '%default')")
parser.add_option("--socket-dir", action="store",
dest="sockdir", default="~/.xpra",
help="Directory to place the socket file in (default: '%default')")
parser.add_option("--mmap-group", action="store_true",
dest="mmap_group", default=False,
help="When creating the mmap file with the client, set the group permission on the mmap file to the same value as the owner of the server socket file we connect to (default: '%default')")
parser.add_option("--remote-xpra", action="store",
dest="remote_xpra", default=".xpra/run-xpra",
metavar="CMD",
help="How to run xpra on the remote host (default: '%default')")
parser.add_option("-d", "--debug", action="store",
dest="debug", default=None, metavar="FILTER1,FILTER2,...",
help="List of categories to enable debugging for (or \"all\")")
(options, args) = parser.parse_args(cmdline[1:])
if "jpeg" not in ENCODINGS:
#ensure the default values are set even though
#the option is not shown to the user as it is not available
options.jpegquality = 80
options.max_bandwidth = 0
if not args:
parser.error("need a mode")
if options.encoding and options.encoding not in ENCODINGS:
parser.error("encoding %s is not supported, try: %s" % (options.encoding, ", ".join(ENCODINGS)))
def toggle_logging(level):
if not options.debug:
logging.root.setLevel(level)
return
categories = options.debug.split(",")
for cat in categories:
if cat.startswith("-"):
logging.getLogger(cat[1:]).setLevel(logging.INFO)
if cat == "all":
logger = logging.root
else:
logger = logging.getLogger(cat)
logger.setLevel(level)
def dump_frames(*arsg):
import traceback
frames = sys._current_frames()
print("")
print("found %s frames:" % len(frames))
for fid,frame in frames.items():
print("%s - %s:" % (fid, frame))
traceback.print_stack(frame)
print("")
if options.debug is not None:
toggle_logging(logging.DEBUG)
else:
toggle_logging(logging.INFO)
logging.root.addHandler(logging.StreamHandler(sys.stderr))
if os.name=="posix":
def sigusr1(*args):
dump_frames()
toggle_logging(logging.DEBUG)
def sigusr2(*args):
toggle_logging(logging.INFO)
signal.signal(signal.SIGUSR1, sigusr1)
signal.signal(signal.SIGUSR2, sigusr2)
mode = args.pop(0)
if mode in ("start", "upgrade") and XPRA_LOCAL_SERVERS_SUPPORTED:
nox()
from xpra.scripts.server import run_server
run_server(parser, options, mode, script_file, args)
elif mode in ("attach", "detach", "screenshot", "version"):
run_client(parser, options, args, mode)
elif mode == "stop" and XPRA_LOCAL_SERVERS_SUPPORTED:
nox()
run_stop(parser, options, args)
elif mode == "list" and XPRA_LOCAL_SERVERS_SUPPORTED:
run_list(parser, options, args)
elif mode == "_proxy" and XPRA_LOCAL_SERVERS_SUPPORTED:
nox()
run_proxy(parser, options, args)
else:
parser.error("invalid mode '%s'" % mode)
def main(script_file, cmdline):
#################################################################
## NOTE NOTE NOTE
##
## If you modify anything here, then remember to update the man page
## (xpra.1) as well!
##
## NOTE NOTE NOTE
#################################################################
defaults = read_xpra_defaults()
def bool_default(varname, default_value):
v = defaults.get(varname)
if not v:
return default_value
if type(v)==str:
v = v.lower()
if v in ["yes", "true", "1"]:
return True
if v in ["no", "false", "0"]:
return False
print("invalid value for '%s': %s, using default value %s instead" % (varname, v, default_value))
return default_value
def int_default(varname, default_value):
v = defaults.get(varname)
if not v:
return default_value
try:
return int(v)
except:
return default_value
if XPRA_LOCAL_SERVERS_SUPPORTED:
start_str = "\t%prog start DISPLAY\n"
list_str = "\t%prog list\n"
upgrade_str = "\t%prog upgrade DISPLAY"
note_str = ""
stop_str = "\t%prog stop [DISPLAY]\n"
else:
start_str = ""
list_str = ""
upgrade_str = ""
note_str = "(This xpra installation does not support starting local servers.)"
stop_str = ""
parser = OptionParser(version="xpra v%s" % xpra.__version__,
usage="".join(["\n",
start_str,
"\t%prog attach [DISPLAY]\n",
"\t%prog detach [DISPLAY]\n",
"\t%prog screenshot filename [DISPLAY]\n",
"\t%prog info [DISPLAY]\n",
"\t%prog version [DISPLAY]\n",
stop_str,
list_str,
upgrade_str,
note_str]))
if XPRA_LOCAL_SERVERS_SUPPORTED:
group = OptionGroup(parser, "Server Options",
"These options are only relevant on the server when using the 'start' or 'upgrade' mode.")
group.add_option("--start-child", action="append",
dest="children", metavar="CMD",
help="program to spawn in new server (may be repeated)")
group.add_option("--exit-with-children", action="store_true",
dest="exit_with_children", default=False,
help="Terminate server when --start-child command(s) exit")
group.add_option("--no-daemon", action="store_false",
dest="daemon", default=True,
help="Don't daemonize when running as a server")
group.add_option("--use-display", action="store_true",
dest="use_display", default=False,
help="Use an existing display rather than starting one with xvfb")
DEFAULT_XVFB = "Xvfb -dpi 96 +extension Composite -screen 0 3840x2560x24+32 -nolisten tcp -noreset -auth $XAUTHORITY"
group.add_option("--xvfb", action="store",
dest="xvfb",
default=defaults.get("xvfb", DEFAULT_XVFB),
metavar="CMD",
help="How to run the headless X server (default: '%default')")
group.add_option("--bind-tcp", action="store",
dest="bind_tcp", default=None,
metavar="[HOST]:PORT",
help="Listen for connections over TCP (insecure)")
parser.add_option_group(group)
group = OptionGroup(parser, "Server Controlled Features",
"These options can be used to turn on or off certain features, "
"they can be specified on the client or on the server, "
"but the client cannot enable them if they are disabled on the server.")
group.add_option("--no-clipboard", action="store_false",
dest="clipboard", default=bool_default("clipboard", True),
help="Disable clipboard support")
group.add_option("--no-pulseaudio", action="store_false",
dest="pulseaudio", default=bool_default("pulseaudio", True),
help="Disable pulseaudio support via X11 root window properties")
group.add_option("--no-notifications", action="store_false",
dest="notifications", default=bool_default("notifications", True),
help="Disable forwarding of system notifications")
group.add_option("--no-cursors", action="store_false",
dest="cursors", default=bool_default("cursors", True),
help="Disable forwarding of custom application mouse cursors")
group.add_option("--no-bell", action="store_false",
dest="bell", default=bool_default("bell", True),
help="Disable forwarding of the system bell")
group.add_option("--no-mmap", action="store_false",
dest="mmap", default=bool_default("mmap", True),
help="Disable memory mapped transfers for local connections")
group.add_option("--readonly", action="store_true",
dest="readonly", default=bool_default("readonly", False),
help="Ignore all keyboard input and mouse events from the clients")
group.add_option("--enable-sharing", action="store_true",
dest="sharing", default=bool_default("sharing", False),
help="Allow more than one client to connect to the same session")
parser.add_option_group(group)
group = OptionGroup(parser, "Client Picture Encoding and Compression Options",
"These options are used by the client to specify the desired picture and network data compression.")
default_encoding = defaults.get("encoding", ENCODINGS[0])
group.add_option("--encoding", action="store",
metavar="ENCODING", default=default_encoding,
dest="encoding", type="str",
help="What image compression algorithm to use: %s. Default: %s" % (", ".join(ENCODINGS), default_encoding))
if "jpeg" in ENCODINGS:
group.add_option("--jpeg-quality", action="store",
metavar="LEVEL",
dest="jpegquality", type="int", default="80",
help="Use jpeg compression with given quality (1-100). Default: 80")
group.add_option("-b", "--max-bandwidth", action="store",
dest="max_bandwidth", type="float", default=0.0, metavar="BANDWIDTH (kB/s)",
help="Specify the link's maximal receive speed to auto-adjust JPEG quality, 0.0 disables. (default: disabled)")
group.add_option("--auto-refresh-delay", action="store",
dest="auto_refresh_delay", type="float", default=1.0,
metavar="DELAY",
help="Idle delay in seconds before doing automatic lossless refresh."
+ " 0.0 to disable."
+ " Default: %default.")
DEFAULT_COMPRESS = 1
compress_str = defaults.get("compress", str(DEFAULT_COMPRESS))
try:
compress = int(compress_str)
except:
print("WARNING: invalid default value for 'compress' option, using default: %s" % DEFAULT_COMPRESS)
compress = DEFAULT_COMPRESS
group.add_option("-z", "--compress", action="store",
dest="compression_level", type="int", default=compress,
metavar="LEVEL",
help="How hard to work on compressing data."
+ " You generally do not need to use this option,"
+ " the default value should be adequate."
+ " 0 to disable compression,"
+ " 9 for maximal (slowest) compression. Default: %default.")
parser.add_option_group(group)
group = OptionGroup(parser, "Client Features Options",
"These options control client features that affect the appearance or the keyboard.")
group.add_option("--session-name", action="store",
dest="session_name", default=None,
help="The name of this session, which may be used in notifications, menus, etc. Default: Xpra")
group.add_option("--title", action="store",
dest="title", default="@title@ on @client-machine@",
help="Text which is shown as window title, may use remote metadata variables (default: '@title@ on @client-machine@')")
group.add_option("--window-icon", action="store",
dest="window_icon", default=None,
help="Path to the default image which will be used for all windows (the application may override this)")
# let the platform specific code add its own options:
# adds "--no-tray" for platforms that support it
add_client_options(group)
group.add_option("--tray-icon", action="store",
dest="tray_icon", default=None,
help="Path to the image which will be used as icon for the system-tray or dock")
group.add_option("--key-shortcut", action="append",
dest="key_shortcuts", type="str", default=[],
help="Define key shortcuts that will trigger specific actions."
+ " Defaults to 'Meta+Shift+F4:quit' if no shortcuts are defined.")
group.add_option("--no-keyboard-sync", action="store_false",
dest="keyboard_sync", default=bool_default("keyboard-sync", True),
help="Disable keyboard state synchronization, prevents keys from repeating on high latency links but also may disrupt applications which access the keyboard directly")
parser.add_option_group(group)
group = OptionGroup(parser, "Advanced Options",
"These options apply to both client and server. Please refer to the man page for details.")
group.add_option("--password-file", action="store",
dest="password_file", default=None,
help="The file containing the password required to connect (useful to secure TCP mode)")
group.add_option("--dpi", action="store",
dest="dpi", default=int_default("dpi", 96),
help="The 'dots per inch' value that client applications should try to honour (default: %s)")
default_socket_dir = defaults.get("socket-dir")
default_socket_dir_str = default_socket_dir or "$XPRA_SOCKET_DIR or '~/.xpra'"
group.add_option("--socket-dir", action="store",
dest="sockdir", default=default_socket_dir,
help="Directory to place/look for the socket files in (default: %s)" % default_socket_dir_str)
debug_default = None
if bool_default("debug", False):
debug_default = "all"
group.add_option("-d", "--debug", action="store",
dest="debug", default=debug_default, metavar="FILTER1,FILTER2,...",
help="List of categories to enable debugging for (or \"all\")")
parser.add_option_group(group)
group = OptionGroup(parser, "Advanced Client Options",
"Please refer to the man page for details.")
group.add_option("--ssh", action="store",
dest="ssh", default=defaults.get("ssh", DEFAULT_SSH_CMD), metavar="CMD",
help="How to run ssh (default: '%default')")
group.add_option("--mmap-group", action="store_true",
dest="mmap_group", default=bool_default("mmap-group", False),
help="When creating the mmap file with the client, set the group permission on the mmap file to the same value as the owner of the server socket file we connect to (default: '%default')")
group.add_option("--enable-pings", action="store_true",
dest="send_pings", default=bool_default("pings", False),
help="Send ping packets every second to gather latency statistics")
group.add_option("--remote-xpra", action="store",
dest="remote_xpra", default=".xpra/run-xpra",
metavar="CMD",
help="How to run xpra on the remote host (default: '%default')")
parser.add_option_group(group)
(options, args) = parser.parse_args(cmdline[1:])
if "jpeg" not in ENCODINGS:
#ensure the default values are set even though
#the option is not shown to the user as it is not available
options.jpegquality = 80
options.max_bandwidth = 0
try:
int(options.dpi)
except Exception, e:
parser.error("invalid dpi: %s" % e)
def main(script_file, cmdline):
platform_init()
if os.name=="posix" and os.getuid()==0:
warn("\nWarning: running as root")
try:
import glib
glib.set_prgname("Xpra")
except:
pass
#################################################################
## NOTE NOTE NOTE
##
## If you modify anything here, then remember to update the man page
## (xpra.1) as well!
##
## NOTE NOTE NOTE
#################################################################
supports_shadow = XPRA_SHADOW_SUPPORTED
supports_server = XPRA_LOCAL_SERVERS_SUPPORTED
if supports_server:
try:
from xpra.wait_for_x_server import wait_for_x_server #@UnresolvedImport @UnusedImport
except:
supports_server = False
command_options = [
"\t%prog attach [DISPLAY]\n",
"\t%prog detach [DISPLAY]\n",
"\t%prog screenshot filename [DISPLAY]\n",
"\t%prog info [DISPLAY]\n",
"\t%prog version [DISPLAY]\n"
]
if supports_server:
command_options = ["\t%prog start DISPLAY\n",
"\t%prog stop [DISPLAY]\n",
"\t%prog list\n",
"\t%prog upgrade DISPLAY\n",
] + command_options
if supports_shadow:
command_options.append("\t%prog shadow DISPLAY\n")
if not supports_server:
command_options.append("(This xpra installation does not support starting local servers.)")
hidden_options = {}
parser = OptionParser(version="xpra v%s" % xpra.__version__,
usage="\n" + "".join(command_options))
defaults = make_defaults_struct()
if supports_server or supports_shadow:
group = OptionGroup(parser, "Server Options",
"These options are only relevant on the server when using the 'start', 'upgrade' or 'shadow' mode.")
parser.add_option_group(group)
if supports_server:
group.add_option("--start-child", action="append",
dest="start_child", metavar="CMD", default=defaults.start_child,
help="program to spawn in new server (may be repeated) (default: %default)")
group.add_option("--exit-with-children", action="store_true",
dest="exit_with_children", default=defaults.exit_with_children,
help="Terminate server when --start-child command(s) exit")
else:
hidden_options["start_child"] = None
hidden_options["exit_with_children"] = False
if supports_server or supports_shadow:
group.add_option("--no-daemon", action="store_false",
dest="daemon", default=True,
help="Don't daemonize when running as a server")
group.add_option("--log-file", action="store",
dest="log_file", default=defaults.log_file,
help="When daemonizing, this is where the log messages will go (default: %s)."
+ " If a relative filename is specified the it is relative to --socket-dir,"
+ " the value of '$DISPLAY' will be substituted with the actual display used"
)
else:
hidden_options["daemon"] = False
hidden_options["log_file"] = defaults.log_file
if supports_server:
group.add_option("--use-display", action="store_true",
dest="use_display", default=defaults.use_display,
help="Use an existing display rather than starting one with xvfb")
group.add_option("--xvfb", action="store",
dest="xvfb",
default=defaults.xvfb,
metavar="CMD",
help="How to run the headless X server (default: '%default')")
else:
hidden_options["use_display"] = False
hidden_options["xvfb"] = ''
if supports_server or supports_shadow:
group.add_option("--bind-tcp", action="append",
dest="bind_tcp", default=defaults.bind_tcp,
metavar="[HOST]:PORT",
help="Listen for connections over TCP (use --password-file to secure it)."
+ " You may specify this option multiple times with different host and port combinations")
else:
hidden_options["bind_tcp"] = []
if supports_server:
group.add_option("--no-pulseaudio", action="store_false",
dest="pulseaudio", default=defaults.pulseaudio,
help="Disable starting of a pulseaudio server for the session")
group.add_option("--pulseaudio-command", action="store",
dest="pulseaudio_command", default=defaults.pulseaudio_command,
help="The command used to start the pulseaudio server (default: '%default')")
else:
hidden_options["pulseaudio"] = False
hidden_options["pulseaudio_command"] = ""
group = OptionGroup(parser, "Server Controlled Features",
"These options can be used to turn certain features on or off, "
"they can be specified on the client or on the server, "
"but the client cannot enable them if they are disabled on the server.")
parser.add_option_group(group)
group.add_option("--no-clipboard", action="store_false",
dest="clipboard", default=defaults.clipboard,
help="Disable clipboard support")
group.add_option("--no-notifications", action="store_false",
dest="notifications", default=defaults.notifications,
help="Disable forwarding of system notifications")
group.add_option("--no-system-tray", action="store_false",
dest="system_tray", default=defaults.system_tray,
help="Disable forwarding of system tray icons")
group.add_option("--no-cursors", action="store_false",
dest="cursors", default=defaults.cursors,
help="Disable forwarding of custom application mouse cursors")
group.add_option("--no-bell", action="store_false",
dest="bell", default=defaults.bell,
help="Disable forwarding of the system bell")
group.add_option("--no-mmap", action="store_false",
dest="mmap", default=defaults.mmap,
help="Disable memory mapped transfers for local connections")
group.add_option("--readonly", action="store_true",
dest="readonly", default=defaults.readonly,
help="Ignore all keyboard input and mouse events from the clients")
group.add_option("--enable-sharing", action="store_true",
dest="sharing", default=defaults.sharing,
help="Allow more than one client to connect to the same session")
group.add_option("--no-speaker", action="store_false",
dest="speaker", default=defaults.speaker,
help="Disable forwarding of sound output to the client(s)")
group.add_option("--speaker-codec", action="append",
dest="speaker_codec", default=defaults.speaker_codec,
help="The audio codec to use for forwarding the speaker sound output "
"(you may specify more than one to define the preferred order, use 'help' to get a list of options, "
"when unspecified all available codecs are allowed and the first one is used)")
group.add_option("--no-microphone", action="store_false",
dest="microphone", default=defaults.microphone,
help="Disable forwarding of sound input to the server")
group.add_option("--microphone-codec", action="append",
dest="microphone_codec", default=defaults.microphone_codec,
help="The audio codec to use for forwaring the microphone sound input "
"(you may specify more than one to define the preferred order, use 'help' to get a list of options, "
"when unspecified all available codecs are allowed and the first one is used)")
group = OptionGroup(parser, "Client Picture Encoding and Compression Options",
"These options are used by the client to specify the desired picture and network data compression."
"They may also be specified on the server as default values for those clients that do not set them.")
parser.add_option_group(group)
group.add_option("--encoding", action="store",
metavar="ENCODING", default=defaults.encoding,
dest="encoding", type="str",
help="What image compression algorithm to use: %s." % (", ".join(ENCODINGS)) +
" Default: %default."
)
if "jpeg" in ENCODINGS:
group.add_option("-b", "--max-bandwidth", action="store",
dest="max_bandwidth", type="float", default=defaults.max_bandwidth, metavar="BANDWIDTH (kB/s)",
help="Specify the link's maximal receive speed to auto-adjust JPEG quality, 0.0 disables. (default: %default)")
else:
hidden_options["max_bandwidth"] = 0
if len(set(("jpeg", "webp", "x264")).intersection(set(ENCODINGS)))>0:
group.add_option("--min-quality", action="store",
metavar="MIN-LEVEL",
dest="min_quality", type="int", default=defaults.min_quality,
help="Sets the minimum x264 encoding quality allowed in automatic quality setting (from 1 to 100, 0 to leave unset). Default: %default.")
group.add_option("--quality", action="store",
metavar="LEVEL",
dest="quality", type="int", default=defaults.quality,
help="Use a fixed image compression quality - only relevant to lossy encodings (1-100, 0 to use automatic setting). Default: %default.")
else:
hidden_options["min_quality"] = defaults.min_quality
hidden_options["quality"] = defaults.quality
if "x264" in ENCODINGS:
group.add_option("--min-speed", action="store",
metavar="SPEED",
dest="min_speed", type="int", default=defaults.min_speed,
help="Sets the minimum x264 encoding speed allowed in automatic speed setting (1-100, 0 to leave unset). Default: %default.")
group.add_option("--speed", action="store",
metavar="SPEED",
dest="speed", type="int", default=defaults.speed,
help="Use x264 image compression with the given encoding speed (1-100, 0 to use automatic setting). Default: %default.")
else:
hidden_options["min_speed"] = defaults.min_speed
hidden_options["speed"] = defaults.speed
group.add_option("--auto-refresh-delay", action="store",
dest="auto_refresh_delay", type="float", default=defaults.auto_refresh_delay,
metavar="DELAY",
help="Idle delay in seconds before doing an automatic lossless refresh."
+ " 0.0 to disable."
+ " Default: %default.")
group.add_option("-z", "--compress", action="store",
dest="compression_level", type="int", default=defaults.compression_level,
metavar="LEVEL",
help="How hard to work on compressing data."
+ " You generally do not need to use this option,"
+ " the default value should be adequate,"
+ " picture data is compressed separately (see --encoding)."
+ " 0 to disable compression,"
+ " 9 for maximal (slowest) compression. Default: %default.")
group = OptionGroup(parser, "Client Features Options",
"These options control client features that affect the appearance or the keyboard.")
parser.add_option_group(group)
group.add_option("--opengl", action="store",
dest="opengl", default=defaults.opengl,
help="Use OpenGL accelerated rendering, options: yes,no,auto. Default: %default.")
group.add_option("--no-windows", action="store_false",
dest="windows", default=defaults.windows,
help="Tells the server not to send any window data, only notifications and bell events will be forwarded (if enabled).")
group.add_option("--session-name", action="store",
dest="session_name", default=defaults.session_name,
help="The name of this session, which may be used in notifications, menus, etc. Default: Xpra")
group.add_option("--title", action="store",
dest="title", default=defaults.title,
help="Text which is shown as window title, may use remote metadata variables (default: '%default')")
group.add_option("--window-icon", action="store",
dest="window_icon", default=defaults.window_icon,
help="Path to the default image which will be used for all windows (the application may override this)")
# let the platform specific code add its own options:
# adds "--no-tray" for platforms that support it
add_client_options(group)
group.add_option("--tray-icon", action="store",
dest="tray_icon", default=defaults.tray_icon,
help="Path to the image which will be used as icon for the system-tray or dock")
group.add_option("--key-shortcut", action="append",
dest="key_shortcut", type="str", default=defaults.key_shortcut,
help="Define key shortcuts that will trigger specific actions."
+ " Defaults to 'Meta+Shift+F4:quit' if no shortcuts are defined.")
group.add_option("--no-keyboard-sync", action="store_false",
dest="keyboard_sync", default=defaults.keyboard_sync,
help="Disable keyboard state synchronization, prevents keys from repeating on high latency links but also may disrupt applications which access the keyboard directly")
parser.add_option_group(group)
group = OptionGroup(parser, "Advanced Options",
"These options apply to both client and server. Please refer to the man page for details.")
parser.add_option_group(group)
group.add_option("--password-file", action="store",
dest="password_file", default=defaults.password_file,
help="The file containing the password required to connect (useful to secure TCP mode)")
group.add_option("--dpi", action="store",
dest="dpi", default=defaults.dpi,
help="The 'dots per inch' value that client applications should try to honour (default: %default)")
default_socket_dir_str = defaults.socket_dir or "$XPRA_SOCKET_DIR or '~/.xpra'"
group.add_option("--socket-dir", action="store",
dest="socket_dir", default=defaults.socket_dir,
help="Directory to place/look for the socket files in (default: %s)" % default_socket_dir_str)
debug_default = ""
if defaults.debug:
debug_default = "all"
group.add_option("-d", "--debug", action="store",
dest="debug", default=debug_default, metavar="FILTER1,FILTER2,...",
help="List of categories to enable debugging for (or \"all\")")
group.add_option("--ssh", action="store",
dest="ssh", default=defaults.ssh, metavar="CMD",
help="How to run ssh (default: '%default')")
group.add_option("--mmap-group", action="store_true",
dest="mmap_group", default=defaults.mmap_group,
help="When creating the mmap file with the client, set the group permission on the mmap file to the same value as the owner of the server socket file we connect to (default: '%default')")
group.add_option("--enable-pings", action="store_true",
dest="pings", default=defaults.pings,
help="Send ping packets every second to gather latency statistics")
group.add_option("--clipboard-filter-file", action="store",
dest="clipboard_filter_file", default=defaults.clipboard_filter_file,
help="Name of a file containing regular expressions of clipboard contents that must be filtered out")
group.add_option("--remote-xpra", action="store",
dest="remote_xpra", default=defaults.remote_xpra,
metavar="CMD",
help="How to run xpra on the remote host (default: '%default')")
if len(ENCRYPTION_CIPHERS)>0:
group.add_option("--encryption", action="store",
dest="encryption", default=defaults.encryption,
metavar="ALGO",
help="Specifies the encryption cipher to use, only %s is currently supported. (default: None)" % (", ".join(ENCRYPTION_CIPHERS)))
else:
hidden_options["encryption"] = ''
options, args = parser.parse_args(cmdline[1:])
if not args:
parser.error("need a mode")
#ensure all the option fields are set even though
#some options are not shown to the user:
for k,v in hidden_options.items():
setattr(options, k, v)
try:
int(options.dpi)
except Exception, e:
parser.error("invalid dpi: %s" % e)
"These options control client features that affect the appearance or the keyboard.")
group.add_option("--no-windows", action="store_false",
dest="windows_enabled", default=True,
help="Tells the server not to send any window data, only notifications and bell events will be forwarded - if enabled.")
group.add_option("--session-name", action="store",
dest="session_name", default=None,
help="The name of this session, which may be used in notifications, menus, etc. Default: Xpra")
group.add_option("--title", action="store",
dest="title", default="@title@ on @client-machine@",
help="Text which is shown as window title, may use remote metadata variables (default: '@title@ on @client-machine@')")
group.add_option("--window-icon", action="store",
dest="window_icon", default=None,
help="Path to the default image which will be used for all windows (the application may override this)")
# let the platform specific code add its own options:
# adds "--no-tray" for platforms that support it
add_client_options(group)
group.add_option("--tray-icon", action="store",
dest="tray_icon", default=None,
help="Path to the image which will be used as icon for the system-tray or dock")
group.add_option("--key-shortcut", action="append",
dest="key_shortcuts", type="str", default=[],
help="Define key shortcuts that will trigger specific actions."
+ " Defaults to 'Meta+Shift+F4:quit' if no shortcuts are defined.")
group.add_option("--no-keyboard-sync", action="store_false",
dest="keyboard_sync", default=bool_default("keyboard-sync", True),
help="Disable keyboard state synchronization, prevents keys from repeating on high latency links but also may disrupt applications which access the keyboard directly")
parser.add_option_group(group)
group = OptionGroup(parser, "Advanced Options",
"These options apply to both client and server. Please refer to the man page for details.")
group.add_option("--password-file", action="store",
def main(script_file, cmdline):
#################################################################
## NOTE NOTE NOTE
##
## If you modify anything here, then remember to update the man page
## (xpra.1) as well!
##
## NOTE NOTE NOTE
#################################################################
if XPRA_LOCAL_SERVERS_SUPPORTED:
start_str = "\t%prog start DISPLAY\n"
list_str = "\t%prog list\n"
upgrade_str = "\t%prog upgrade DISPLAY"
note_str = ""
stop_str = "\t%prog stop [DISPLAY]\n"
else:
start_str = ""
list_str = ""
upgrade_str = ""
note_str = "(This xpra installation does not support starting local servers.)"
stop_str = ""
parser = OptionParser(version="xpra v%s" % xpra.__version__,
usage="".join([
"\n", start_str, "\t%prog attach [DISPLAY]\n",
"\t%prog detach [DISPLAY]\n",
"\t%prog screenshot filename [DISPLAY]\n",
"\t%prog version [DISPLAY]\n", stop_str,
list_str, upgrade_str, note_str
]))
if XPRA_LOCAL_SERVERS_SUPPORTED:
parser.add_option(
"--start-child",
action="append",
dest="children",
metavar="CMD",
help="program to spawn in new server (may be repeated)")
parser.add_option(
"--exit-with-children",
action="store_true",
dest="exit_with_children",
default=False,
help="Terminate server when --start-child command(s) exit")
parser.add_option("--no-daemon",
action="store_false",
dest="daemon",
default=True,
help="Don't daemonize when running as a server")
parser.add_option(
"--use-display",
action="store_true",
dest="use_display",
default=False,
help="Use an existing display rather than starting one with xvfb")
parser.add_option(
"--xvfb",
action="store",
dest="xvfb",
default=
"Xvfb +extension Composite -screen 0 3840x2560x24+32 -noreset -auth $XAUTHORITY",
metavar="CMD",
help="How to run the headless X server (default: '%default')")
parser.add_option(
"--no-randr",
action="store_false",
dest="randr",
default=True,
help=
"Disables X11 randr support, xrandr allows the virtual display to be resized to match the client's dimensions (if supported by Xvfb)"
)
parser.add_option("--bind-tcp",
action="store",
dest="bind_tcp",
default=None,
metavar="[HOST]:PORT",
help="Listen for connections over TCP (insecure)")
parser.add_option("--no-clipboard",
action="store_false",
dest="clipboard",
default=True,
help="Disable clipboard support")
parser.add_option(
"--no-pulseaudio",
action="store_false",
dest="pulseaudio",
default=True,
help="Disable pulseaudio support via X11 root window properties")
parser.add_option(
"--no-keyboard-sync",
action="store_false",
dest="keyboard_sync",
default=True,
help=
"Disable keyboard state synchronization, prevents keys from repeating on high latency links but also may disrupt applications which access the keyboard directly"
)
# let the platform specific code add its own options:
# adds "--no-tray" for platforms that support it
add_client_options(parser)
parser.add_option(
"--no-mmap",
action="store_false",
dest="mmap",
default=True,
help="Disable memory mapped transfers for local connections")
parser.add_option(
"--password-file",
action="store",
dest="password_file",
default=None,
help=
"The file containing the password required to connect (useful to secure TCP mode)"
)
parser.add_option(
"--session-name",
action="store",
dest="session_name",
default=None,
help=
"The name of this session, which may be used in notifications, menus, etc. Default: Xpra"
)
parser.add_option(
"--title-suffix",
action="store",
dest="title_suffix",
default=None,
help=
"Text which is appended to the window's title (deprecated - use --title instead)"
)
parser.add_option(
"--title",
action="store",
dest="title",
default="@title@ on @client-machine@",
help=
"Text which is shown as window title, may use remote metadata variables (default: '@title@ on @client-machine@')"
)
parser.add_option(
"--window-icon",
action="store",
dest="window_icon",
default=None,
help=
"Path to the default image which will be used for all windows (the application may override this)"
)
parser.add_option(
"--tray-icon",
action="store",
dest="tray_icon",
default=None,
help=
"Path to the image which will be used as icon for the system-tray or dock"
)
parser.add_option(
"--encoding",
action="store",
metavar="ENCODING",
dest="encoding",
type="str",
help="What image compression algorithm to use: %s. Default: rgb24" %
(", ".join(ENCODINGS)))
if "jpeg" in ENCODINGS:
parser.add_option(
"--jpeg-quality",
action="store",
metavar="LEVEL",
dest="jpegquality",
type="int",
default="80",
help="Use jpeg compression with given quality (1-100). Default: 80"
)
parser.add_option(
"-b",
"--max-bandwidth",
action="store",
dest="max_bandwidth",
type="float",
default=0.0,
metavar="BANDWIDTH (kB/s)",
help=
"Specify the link's maximal receive speed to auto-adjust JPEG quality, 0.0 disables. (default: disabled)"
)
parser.add_option(
"--auto-refresh-delay",
action="store",
dest="auto_refresh_delay",
type="float",
default=0.0,
metavar="DELAY",
help="Idle delay in seconds before doing automatic lossless refresh." +
" 0.0 to disable." + " Default: %default.")
parser.add_option(
"--key-shortcut",
action="append",
dest="key_shortcuts",
type="str",
default=[],
help="Define key shortcuts that will trigger specific actions." +
" Defaults to Meta+Shift+F4:quit if no shortcuts are defined.")
parser.add_option(
"--readonly",
action="store_true",
dest="readonly",
default=False,
help="Ignore all keyboard input and mouse events from client")
parser.add_option(
"-z",
"--compress",
action="store",
dest="compression_level",
type="int",
default=3,
metavar="LEVEL",
help="How hard to work on compressing data." +
" 0 to disable compression," +
" 9 for maximal (slowest) compression. Default: %default.")
parser.add_option("--ssh",
action="store",
dest="ssh",
default=DEFAULT_SSH_CMD,
metavar="CMD",
help="How to run ssh (default: '%default')")
parser.add_option(
"--socket-dir",
action="store",
dest="sockdir",
default="~/.xpra",
help="Directory to place the socket file in (default: '%default')")
parser.add_option(
"--mmap-group",
action="store_true",
dest="mmap_group",
default=False,
help=
"When creating the mmap file with the client, set the group permission on the mmap file to the same value as the owner of the server socket file we connect to (default: '%default')"
)
parser.add_option(
"--remote-xpra",
action="store",
dest="remote_xpra",
default=".xpra/run-xpra",
metavar="CMD",
help="How to run xpra on the remote host (default: '%default')")
parser.add_option(
"-d",
"--debug",
action="store",
dest="debug",
default=None,
metavar="FILTER1,FILTER2,...",
help="List of categories to enable debugging for (or \"all\")")
(options, args) = parser.parse_args(cmdline[1:])
if "jpeg" not in ENCODINGS:
#ensure the default values are set even though
#the option is not shown to the user as it is not available
options.jpegquality = 80
options.max_bandwidth = 0
if not args:
parser.error("need a mode")
if options.encoding and options.encoding not in ENCODINGS:
parser.error("illegal encoding")
def toggle_logging(level):
if not options.debug:
logging.root.setLevel(level)
return
categories = options.debug.split(",")
for cat in categories:
if cat.startswith("-"):
logging.getLogger(cat[1:]).setLevel(logging.INFO)
if cat == "all":
logger = logging.root
else:
logger = logging.getLogger(cat)
logger.setLevel(level)
def dump_frames(*arsg):
import traceback
frames = sys._current_frames()
print("")
print("found %s frames:" % len(frames))
for fid, frame in frames.items():
print("%s - %s:" % (fid, frame))
traceback.print_stack(frame)
print("")
if options.debug is not None:
toggle_logging(logging.DEBUG)
else:
toggle_logging(logging.INFO)
logging.root.addHandler(logging.StreamHandler(sys.stderr))
if os.name == "posix":
def sigusr1(*args):
dump_frames()
toggle_logging(logging.DEBUG)
def sigusr2(*args):
toggle_logging(logging.INFO)
signal.signal(signal.SIGUSR1, sigusr1)
signal.signal(signal.SIGUSR2, sigusr2)
mode = args.pop(0)
if mode in ("start", "upgrade") and XPRA_LOCAL_SERVERS_SUPPORTED:
nox()
from xpra.scripts.server import run_server
run_server(parser, options, mode, script_file, args)
elif mode in ("attach", "detach", "screenshot", "version"):
run_client(parser, options, args, mode)
elif mode == "stop" and XPRA_LOCAL_SERVERS_SUPPORTED:
nox()
run_stop(parser, options, args)
elif mode == "list" and XPRA_LOCAL_SERVERS_SUPPORTED:
run_list(parser, options, args)
elif mode == "_proxy" and XPRA_LOCAL_SERVERS_SUPPORTED:
nox()
run_proxy(parser, options, args)
else:
parser.error("invalid mode '%s'" % mode)
