# Python X2Go (Client) API Documentation (v0.6.1.4)

## x2go.defaults module

Default variables and values for Python X2Go.

x2go.defaults.DEFAULT_PDFSAVE_LOCATION = 'PDF'

  Default location for saving PDF files (PDFSAVE print action).

x2go.defaults.DEFAULT_PDFVIEW_CMD = 'xdg-open'

  Default PDF viewer command for Linux systems (PDFVIEW print action).

x2go.defaults.DEFAULT_PRINTCMD_CMD = 'lpr'

  Default command for the PRINTCMD print action.

x2go.defaults.PUBAPP_MAX_NO_SUBMENUS = 10

  Less than ten applications will not get rendered into submenus.

x2go.defaults.RSAHostKey = <paramiko.rsakey.RSAKey object>

  An RSA host key for this client session. Python X2Go does not use the system’s host key but generates its own host key for each running application instance.

x2go.defaults.X2GO_DESKTOPSESSIONS = {'CINNAMON': 'cinnamon-session-cinnamon2d', 'GNOME': 'gnome-session', 'IceWM': 'icewm', 'KDE': 'startkde', 'LXDE': 'startlxde', 'LXQt': 'startlxqt', 'MATE': 'mate-session', 'TRINITY': 'starttrinity', 'UNITY': 'unity', 'XFCE': 'xfce4-session'}

  A dictionary with meta-commands for X2Go’s window manager sessions. Will be populated by the concatenation of `X2GO_DESKTOPSESSIONS_<BACKEND>_PREFERRED`.

x2go.defaults.X2GO_DESKTOPSESSIONS_KDRIVE_PREFERRED = {'CINNAMON': 'cinnamon-session-cinnamon2d', 'GNOME': 'gnome-session', 'UNITY': 'unity'}

  A dictionary with meta-commands for X2Go’s window manager sessions, usage of X2GoKDrive preferred.

x2go.defaults.X2GO_DESKTOPSESSIONS_NX3_PREFERRED = {'IceWM': 'icewm', 'KDE': 'startkde', 'LXDE': 'startlxde', 'LXQt': 'startlxqt', 'MATE': 'mate-session', 'TRINITY': 'starttrinity', 'XFCE': 'xfce4-session'}

  A dictionary with meta-commands for X2Go’s window manager sessions, usage of NXv3 preferred.

x2go.defaults.X2GO_GENERIC_APPLICATIONS = ['WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL']

  X2Go’s generic applications.

x2go.defaults.X2GO_MIMEBOX_ACTIONS = {'OPEN': 'X2GoMIMEboxActionOPEN', 'OPENWITH': 'X2GoMIMEboxActionOPENWITH', 'SAVEAS': 'X2GoMIMEboxActionSAVEAS'}

  Relating MIME box action names and classes.

x2go.defaults.X2GO_MIMEBOX_EXTENSIONS_BLACKLIST = ['LOCK', 'SYS', 'SWP', 'EXE', 'COM', 'CMD', 'PS1', 'PS2', 'BAT', 'JS', 'PY', 'PL', 'SH']

  Black-listed MIME box file extenstions.

x2go.defaults.X2GO_PRINT_ACTIONS = {'DIALOG': 'X2GoPrintActionDIALOG', 'PDFSAVE': 'X2GoPrintActionPDFSAVE', 'PDFVIEW': 'X2GoPrintActionPDFVIEW', 'PRINT': 'X2GoPrintActionPRINT', 'PRINTCMD': 'X2GoPrintActionPRINTCMD'}

  Relating print action names and classes.

x2go.defaults.X2GO_SESSIONPROFILE_DEFAULTS = {'applications': ['WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL'], 'autoconnect': False, 'autologin': True, 'autostart': False, 'clipboard': 'both', 'command': 'TERMINAL', 'defsndport': True, 'directrdp': False, 'directrdpsettings': '', 'display': 1, 'dpi': 96, 'export': {}, 'forwardsshagent': False, 'fstunnel': True, 'fullscreen': False, 'height': 600, 'host': ['server.mydomain'], 'icon': ':icons/128x128/x2gosession.png', 'iconvfrom': 'UTF-8', 'iconvto': 'UTF-8', 'kdrive': False, 'key': '', 'krblogin': False, 'layout': 'us', 'maxdim': False, 'mimeboxaction': 'OPEN', 'mimeboxextensions': '', 'multidisp': False, 'name': 'NEW_PROFILE', 'pack': '16m-jpeg', 'print': False, 'published': False, 'quality': 9, 'rdpclient': 'rdesktop', 'rdpoptions': '-u X2GO_USER -p X2GO_PASSWORD', 'rdpport': 3389, 'rdpserver': '', 'restoreexports': False, 'rootless': True, 'sessiontitle': '', 'setdpi': False, 'setsessiontitle': False, 'sndport': 4713, 'sound': False, 'soundsystem': 'pulse', 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyautologin': True, 'sshproxyhost': 'proxyhost.mydomain', 'sshproxykeyfile': '', 'sshproxyport': 22, 'sshproxysamepass': False, 'sshproxysameuser': False, 'sshproxytype': 'SSH', 'sshproxyuser': '', 'startsoundsystem': False, 'type': 'pc105/us', 'uniquehostkeyaliases': False, 'useexports': True, 'useiconv': False, 'usekbd': True, 'usemimebox': False, 'user': 'buildd', 'usesshproxy': False, 'variant': '', 'width': 800, 'xdmcpserver': 'localhost', 'xinerama': False}

  `x2go.backends.profiles.base.X2GoSessionProfiles` default values to fill a new session profile with.

x2go.defaults.X2GO_SHARE_FULLACCESS = 1

  Constant representing read-write (full) access to shared desktops.

x2go.defaults.X2GO_SHARE_VIEWONLY = 0

  Constant representing read-only access to shared desktops.

x2go.defaults.pack_methods_nx3_noqual = ['nopack', '8', '64', '256', '512', '4k', '32k', '64k', '256k', '2m', '16m', '256-rdp', '256-rdp-compressed', '32k-rdp', '32k-rdp-compressed', '64k-rdp', '64k-rdp-compressed', '16m-rdp', '16m-rdp-compressed', 'rfb-hextile', 'rfb-tight', 'rfb-tight-compressed', '8-tight', '64-tight', '256-tight', '512-tight', '4k-tight', '32k-tight', '64k-tight', '256k-tight', '2m-tight', '16m-tight', '8-jpeg-%', '64-jpeg', '256-jpeg', '512-jpeg', '4k-jpeg', '32k-jpeg', '64k-jpeg', '256k-jpeg', '2m-jpeg', '16m-jpeg-%', '8-png-jpeg-%', '64-png-jpeg', '256-png-jpeg', '512-png-jpeg', '4k-png-jpeg', '32k-png-jpeg', '64k-png-jpeg', '256k-png-jpeg', '2m-png-jpeg', '16m-png-jpeg-%', '8-png-%', '64-png', '256-png', '512-png', '4k-png', '32k-png', '64k-png', '256k-png', '2m-png', '16m-png-%', '16m-rgb-%', '16m-rle-%']

  Available NX3 compression methods.