User Tools

Site Tools


wiki:development:sessions-file

This is an old revision of the document!


X2Go Sessions File Format Specification

Generic Sessions File Format

[<unique-timestamp-for-session-1>]
<session1-option1>=<session1-value1>
<session1-option2>=<session1-value2>
...
<session1-optionN>=<session1-valueN>

[<unique-timestamp-for-session-2>]
<session2-option1>=<session2-value1>
<session2-option2>=<session2-value2>
...
<session2-optionN>=<session2-valueN>

...

[<unique-timestamp-for-session-M>]
<sessionM-option1>=<sessionM-value1>
<sessionM-option2>=<sessionM-value2>
...
<sessionM-optionN>=<sessionM-valueN>

==== Session Options en Detail ====

//... in alphabetical order.//

^ Option name ^ Data Type ^ Default value X2Go Client ^ Default value Python X2Go ^ Comment ^
| sound=true  | Boolean   | true | true | Enable sound |
| soundtunnel | Boolean   | true | true | Python X2Go always tunnels sound through SSH |
| defsndport  | Boolean   | true | true | |
| soundsystem | String    | pulse | pulse | Possible values: none, pulse, arts, esd |
| sndport     | Pos. Integer | //depends on soundsystem // | //depends on soundsystem // | pulse: 4713, esd: 16001 |
| startsoundsystem | Boolean | false | false | Start sound system's daemon for started sessions |
| krblogin    | Boolean   | false | //not supported// | |
| useiconv    | Boolean   | false | false | |
| iconvfrom   | String    | UTF-8 | UTF-8 | Encoding names as understood by the iconv tool |
| iconvto     | String    | UTF-8 | UTF-8 | Encoding names as understood by the iconv tool |
| width       | pos. Integer | 800 | 800 | Geometry of non-fullscreen window |
| height      | pos. Integer | 600 | 600 | Geometry of non-fullscreen window |
| dpi         | Integer | 96 | 96 | Use the dpi value to manipulate the font size in a session |
| pack        | String | jpeg-16m | jpeg-16m | NX compression method |
| quality     | [0..9] | 9        | 9        | NX compression quality |
| export      | String |          |          | Format: "<folder1>:[0|1];<folder2>:[0|1];" |
| speed       | [0..4] | 2        | 2        | 0=Modem, 1=ISDN, 2=ADSL, 3=WAN, 4=LAN |
| fullscreen  | Boolean | false   | false | |
| setsessiontitle | Boolean | //not supported // | false | If disabled, the server-side provided session title is used |
| sessiontitle | String | //not supported // |  | Store a customized session window title in the session profile config |
| usekbd      | Boolean | false | false | Do not send keyboard type and layout to server, use as is |
| layout      | String  | //i18n dependent// | //i18n dependent// | Keyboard Layout (en, de, ...) |
| useexports  | Boolean | true    | true     | |
| xdmcpserver | String  | localhost | localhost | Only used if ''command=XDMCP'' |
| rdpserver   | String  | | | FQDN Hostname or IP of Windows server, only used if ''command=RDP'' |
| rdpoptions  | String  |         | -u X2GO_USER -p X2GO_PASSWORD | RDP options for ''command=RDP'' |
| xinerama    | Boolean | false   | //not supported// | |
| autostart   | Boolean | false   | //not supported// | |
| autologin   | Boolean | false   | //not supported// | |
| print       | Boolean | true    | true              | |
| type        | String  | //i18n dependent// | //i18n dependent// | Keyboard type |
| usesshproxy | Boolean | //not supported// | false | Connect via a SSH proxy |
| sshproxyhost | String | //not supported// |  | Format: <hostname>[:<port>] |
| sshproxyuser | String | //not supported// |  | Username for connecting to SSH proxy server |
| sshproxykeyfile | Filename | //not supported |  | Filename of local SSH private key | 
| sshproxytunnel | String | //not supported// |  | localhost:<port-on-proxy>:<x2goserver-ip>:<x2goserver-port> |
| fstunnel    | Boolean | true    | true | On Python X2Go, file systems are always tunneled through SSH |
| applications | List   | WWWBROWSER, MAILCLIENT, OFFICE, TERMINAL | dito | |
| host | String | | | FQDN Hostname or IP Adress |
| mimeboxaction | String | //not supported// | OPEN | Possible values: OPEN, OPENWITH, SAVEAS |
| mimeboxextensions | List | //not supported// | | Comma-separated list of allowed file extensions |
| multidisp | Boolean | false | //not supported// | |
| key       | Filename | | | Filename to SSH private key file |
| icon | Filename | :icons/128x128/x2gosession.png | :icons/128x128/x2gosession.png | Icon for Desktop Session Windows |
| rootless | Boolean | //depends on session command// | //depends on session command// | |
| name | String | | | PyHoca-GUI feature: using ,,/" as a separator in the session name creates menus and submenus in the PyHoca-GUI applet |
| command | String | KDE | TERMINAL | Command to be launched on X2Go Server |
| published | Boolean | false | false | Enable ,,published applications" mode of X2Go |
wiki/development/sessions-file.1331375252.txt.gz · Last modified: 2013/03/08 13:31 (external edit)