Document output/scale configuration option in the weston.ini man page.

v2: Different, hopefully better, wording. This patch entirely replaces
the previous similar patch I sent.

v3: Now including the correct patch. Please disregard the "v2" mail.

Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>

diff --git a/man/weston.ini.man b/man/weston.ini.man
index 25da2b1..ccd7185 100644 (file)
--- a/man/weston.ini.man
+++ b/man/weston.ini.man
@@ -374,6 +374,18 @@ be one of the following 8 strings:
 .fi
 .RE
 .TP 7
+.BI "scale=" factor
+An integer, 1 by default, typically configured as 2 when needed, denoting
+the scale factor of the output. Applications that support it render at the
+appropriate scale. For other applications, weston will scale their output
+by this factor.
+.RE
+.RS
+.PP
+Use a value of 2 for outputs with high resolution. Such displays are often
+called "HiDPI" or "retina" displays.
+.RE
+.TP 7
 .BI "seat=" name
 The logical seat name that that this output should be associated with. If this
 is set then the seat's input will be confined to the output that has the seat