File: xpra.conf.in

package info (click to toggle)
xpra 0.17.6+dfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 7,168 kB
  • ctags: 10,958
  • sloc: python: 68,278; ansic: 618; sh: 89; xml: 50; makefile: 28
file content (521 lines) | stat: -rw-r--r-- 12,552 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
#
# This is the default configuration file for Xpra
#
# You can provide default values for most command line
# options here.
# Each user can also define its own options in the file
# ~/xpra/xpra.conf which will take precedence over this file.
# Most options can also be overriden on the xpra command line.
# See "xpra -h" or the man page for details.
#
# Syntax:
# - Options which can be turned on or off will accept
#   the following values: 1, 0, true, false, yes, no
# - Options which can accept multiple values
#   may just be specified multiple times.
# - You may break a long line into multiple lines
#   by ending each line with a backslash '\'.


################################################################################
# General Options

# Enable clipboard forwarding:
#clipboard = yes
#clipboard = no
# Can also be used to specify a different keyboard implementation:
#clipboard = GDK
#clipboard = translated
#clipboard = default
#clipboard = auto
clipboard = yes

# Forward notifications:
notifications = yes

# Show Xpra's tray menu
tray = yes

# Forward system tray icons:
system-tray = yes

# Forward sound output to clients:
speaker = off
#speaker = disabled
#speaker = on

# Forward sound input to server:
# microphone = disabled
# microphone = on
# microphone = on: Built-in Audio Analog Stereo
# microphone = off: Built-in Audio Analog Stereo
microphone = off

# Debugging:
#debug =
#debug = keyboard,clipboard,tray

# Send ping packets more regularly (every second):
pings = no

# Allow the client to forward its log output to the server:
#remote-logging = yes
remote-logging = %(remote_logging)s


################################################################################
# File transfers

# Receive files
file-transfer = yes

# Location where files are received:
#download-path = ~/Downloads
#download-path = ~/Desktop
#download-path = /tmp

# File size limit in MB
file-size-limit = 10

# How to open files:
#open-command = xdg-open

# Open files
open-files = no


################################################################################
# Printer forwarding

# Print support:
printing = %(printing)s

# To manage printers:
#lpadmin = lpadmin
#lpadmin = sudo lpadmin
lpadmin = /usr/sbin/lpadmin

# To query printer definitions:
#lpinfo = lpinfo
#lpinfo = sudo lpinfo
lpinfo = /usr/sbin/lpinfo

# To save startup time, use pre-defined printers:
# Postscript:
# postscript-printer = drv:///sample.drv/generic.ppd
postscript-printer = %(postscript_printer)s
# pdf-printer = /usr/share/ppd/cupsfilters/Generic-PDF_Printer-PDF.ppd
pdf-printer = %(pdf_printer)s


################################################################################
# Picture Encoding

# Encodings allowed:
# (not all encodings may be available in your environment):
#encodings = h264, vp8, png, png/P, png/L, webp, rgb, jpeg, h265, vp9
#encodings = all
#encodings = rgb
encodings = all

# Default encoding
# (not all encodings may be available in your environment):
#encoding = h264
#encoding = vp8
#encoding = png
#encoding = jpeg
#encoding = rgb
#encoding = webp

# Used by the server to encode video:
# video-encoders = x264, vpx, nvenc
# video-encoders = none
# video-encoders = all
video-encoders = all

# Used by both the client and server for colourspace conversion:
# csc-modules = swscale, cython, opencl
# csc-modules = none
# csc-modules = all
csc-modules = all

# Used by the client for decoding:
# video-decoders = avcodec2, vpx
# video-decoders = avcodec, vpx
# video-decoders = none
# video-decoders = all
video-decoders = all

# Automatic video downscaling:
# video-scaling = 0		#same as off
# video-scaling = off
# video-scaling = on
# video-scaling = 10		#mild automatic downscaling
# video-scaling = 100		#very aggressive downscaling
video-scaling = on

# Use fixed quality
# (value is a percentage or "auto"):
#quality = 80
quality = auto

# For auto quality only:
#min-quality = 50
min-quality = 30

# Use fixed speed
# (value is a percentage or "auto"):
#speed = 90
speed = auto

# For auto speed only:
#min-speed = 0
min-speed = 30

# Idle delay in seconds before doing an automatic lossless refresh:
auto-refresh-delay = 0.15

# Use a fixed DPI:
#dpi = 96
#automatic (which is the default):
#dpi = 0

# Video encoders loaded by the server
# (all of them unless specified)
# examples:
#video-encoders=x264,vpx,nvenc
#video-encoders=x264

# Colourspace conversion modules loaded by the server
# (all of them unless specified)
# examples:
#csc-modules=swscale,cython,opencl
#csc-modules=swscale


################################################################################
# Sound Encoding

# Sound plugin to use for capturing sound:
#sound-source = pulse
#sound-source = alsa
#sound-source = auto

# Codec(s) to use for forwarding speaker sound:
#speaker-codec = mp3
#speaker-codec = flac
#speaker-codec = wav
#speaker-codec = wavpack
#speaker-codec = speex
#speaker-codec = opus

# Codec(s) to use for forwarding microphone sound:
#microphone-codec = mp3
#microphone-codec = flac
#microphone-codec = wav
#microphone-codec = wavpack
#microphone-codec = speex
#microphone-codec = opus

# Try to synchronize audio and video:
#av-sync = off
av-sync = on


################################################################################
# Webcam forwarding
# webcam = auto
# webcam = no
# webcam = /dev/video0
webcam = %(webcam)s


################################################################################
# Network Connection

# Enable shared memory transfers:
mmap = %(mmap)s

# Use server group ownership for mmap file:
mmap-group = no

# The file permissions set on the server's unix domain socket
# (ignored when mmap-group is enabled)
#socket-permissions = 660
socket-permissions = 600

# Share session with other users:
sharing = no

# Compressors:
#compressors = all
#compressors = none
#compressors = zlib
compressors = lz4, lzo, zlib

# Default compression (0 to 9):
compression_level = 1

# Packet encoders (at least one is required):
#packet-encoders = bencode
#packet-encoders = all
packet-encoders = rencode, bencode, yaml

# Socket directories (may be specified more than once):
#socket-dirs = /tmp
#socket-dirs = ~/.xpra
#socket-dirs = /var/run/xpra
%(socket_dirs)s

# Where to create new sockets
# (otherwise the first "socket-dirs" is used)
#socket-dir = /tmp
#socket-dir = ~/.xpra

# Session idle timeout in seconds:
#idle-timeout = 120
idle-timeout = 0

# Server idle timeout in seconds:
#server-idle-timeout = 600
server-idle-timeout = 0


################################################################################
# Client Options

# OpenGL accelerated rendering:
#opengl = yes
#opengl = no
opengl = auto

# Client window title:
title = @title@ on @client-machine@

# Icon used by the system tray:
#tray-icon = /path/to/icon.png

# Keyboard synchronization:
keyboard-sync = yes

# Client ssh command:
#ssh = "C:\Program Files\Plink.exe" -ssh -noagent
#ssh = /usr/bin/ssh
#ssh = ssh -o ControlMaster=no -o ConnectTimeout=20
#ssh = ssh -x
ssh = %(ssh_command)s

# Key Shortcuts:
%(key_shortcuts)s

# Border:
#border=auto:off,5
#border=auto,5
#border=red,1
#border=no

# What to do when the user closes the window:
# - forward the action to the server:
# window-close = forward
# window-close = ignore
# window-close = disconnect
# window-close = ask
window-close = auto

# Desktop Scaling:
# - double the size of all windows:
#desktop-scaling = 2
# - increase the size by 50%%:
#desktop-scaling = 1.5
#desktop-scaling = 3/2
# - disable all desktop scaling:
#desktop-scaling = off
#desktop-scaling = 0
# - enable desktop scaling and automatically select
#   a scaling value if the client display is large:
#desktop-scaling = auto
# - enable desktop scaling, but start with no scaling activated:
#desktop-scaling = 1
#desktop-scaling = on
desktop-scaling = auto

# Make shadow servers show up in fullscreen mode:
#shadow-fullscreen = yes
shadow-fullscreen = no


########################################################################
# Server Options:

# Directory for server log files:
#log-dir = ~/.xpra
#log-dir = /tmp
log-dir = %(log_dir)s

# Log file:
log-file = $DISPLAY.log

# Commands to start by default
#  (may be specified more than once):
# examples:
#start-child = /usr/bin/xterm
#start-child = /usr/bin/xeyes
#start=/bin/true
#
# Xsession can take care of initializing dbus, keyring-daemon,
# gpg-agent or whatever else might be usually started together with X
start = /etc/X11/Xsession true

# Or you can specify individual actions:
#xrdb -merge /etc/X11/Xresources
#xrdb -merge ~/.Xresources
#
# The difference between start and start-child is only relevant
# when using exit-with-children.
# This causes the server to terminate when the last child has exited:
exit-with-children = no

# Commands to start immediately after the first client has connected:
# (see above for the start vs start-child distinction)
#start-after-connect = touch ~/.xpra/connect
#start-child-after-connect = xterm

# Commands to every time a client connects:
# (see above for the start vs start-child distinction)
#start-on-connect = touch ~/.xpra/login
#start-child-on-connect = xterm

# Start a dbus-daemon:
# dbus-launch =
# dbus-launch = /usr/bin/dbus-launch --close-stderr
dbus-launch = dbus-launch --close-stderr

# Start a dbus server which can be used to interact with the server process:
#dbus-control = no
dbus-control = %(dbus_control)s

# Forward client dbus rpc requests:
# (requires client configuration)
#dbus-proxy = no
dbus-proxy = %(dbus_proxy)s

# A wrapper for executing all sub-commands:
# exec-wrapper = vglrun --
# exec-wrapper = vglrun -d :1 --

# Allows clients to start new commands in the server context:
#start-new-commands = yes
start-new-commands = no

########################################################################
# Server Connection Options:

# Where to create local sockets:
# bind=none
# bind=auto
# bind=~/.xpra/
# bind=FILENAME
# bind=/path/to/socketfilename
# bind=/run/user/$UID/xpra/
bind = %(bind)s

# Authentication module to use for local sockets:
#auth=fail
#auth=reject
#auth=allow
#auth=file
#auth=multifile
#auth=sys
#auth=none

# To listen on TCP sockets:
# bind-tcp=:10000
# bind-tcp=0.0.0.0:10000
# bind-tcp=192.168.0.1:10000

# Authentication module to use for TCP sockets:
#tcp-auth=none

# To listen on AF_VSOCK sockets:
# bind-vsock=auto:2000
# bind-vsock=2:2000

# Authentication to use for VSOCK:
#vsock-auth=none

# Where to send non xpra clients:
# (can be used to share the port with a web server)
#tcp-proxy = 127.0.0.1:80

# Start an html proxy server (requires bind-tcp):
#html = no
#html = yes
#html = :20000
#html = 127.0.0.1:20000

# Publish sessions:
#mdns = no
mdns = %(mdns)s

########################################################################
# Server Environment:

# Set the _NET_WM_NAME,
# used by some application that make too many assumptions (ie: Java)
# To workaround JDK6 window positioning issues, use:
#wm-name = Sawfish
wm-name = Xpra

# Input methods
# To disable input method completely:
#input-method=none
# To keep the environment unchanged:
#input-method=keep
# Other possible options:
#input-method=IBus
#input-method=SCIM
#input-method=uim
input-method=none

# Environment variables for children started
# with 'start-child' or 'start':
# (can be specified multiple times)
#env = HOME=/home/alt
#env = GDK_DEBUG=dnd
%(env)s

# Start a pulseaudio server with each session:
pulseaudio = %(pulseaudio)s

# pulseaudio server start command:
pulseaudio-command = %(pulseaudio_command)s

# commands used to configure the pulseaudio server:
# pactl set-source-volume SomeSource 20%%
%(pulseaudio_configure_commands)s

# Paint the windows on the xvfb so that
# screen grabs and screen recorders will work
# (repaint delay in milliseconds, 0 to disable)
# sync-xvfb = 200
# sync-xvfb = 50
sync-xvfb = 0

# Virtual display command:
# - Old Xvfb option (required on Ubuntu where Xorg is broken):
# xvfb = Xvfb +extension Composite -nolisten tcp -noreset \
#        -auth $XAUTHORITY \
#        -screen 0 5760x2560x24+32
# - With Xorg 1.12 or newer and the dummy driver:
# xvfb = /usr/bin/Xorg -noreset -nolisten tcp \
#        +extension GLX +extension RANDR +extension RENDER \
#        -auth $XAUTHORITY \
#        -logfile %(log_dir)s/Xorg.${DISPLAY}.log \
#        -configdir ${HOME}/.xpra/xorg.conf.d
#        -config %(conf_dir)s/xorg.conf
#
# Selecting virtual X server:
xvfb = %(xvfb_command)s

# Does the xvfb command support the "-displayfd" argument?
displayfd = %(has_displayfd)s