[PATCH weston] screen-share: Add screen-share command to weston.ini man page

[Andrew Wedgbury]

Hi Pekka,

On Thu, 21 Aug 2014, Pekka Paalanen wrote:

> On Thu, 26 Jun 2014 16:31:43 +0100
> Andrew Wedgbury <andrew.wedgbury at realvnc.com> wrote:
>
>> This adds a description of the screen-share command configuration key to the
>> weston.ini man page.
>>
>> Signed-off-by: Andrew Wedgbury <andrew.wedgbury at realvnc.com>
>> ---
>>  man/weston.ini.man | 10 ++++++++++
>>  1 file changed, 10 insertions(+)
>>
>> diff --git a/man/weston.ini.man b/man/weston.ini.man
>> index 667f70a..86f7e37 100644
>> --- a/man/weston.ini.man
>> +++ b/man/weston.ini.man
>> @@ -78,6 +78,7 @@ The section headers are:
>>  .BR "keyboard       " "Keyboard layouts"
>>  .BR "terminal       " "Terminal application options"
>>  .BR "xwayland       " "XWayland options"
>> +.BR "screen-share   " "Screen sharing options"
>>  .fi
>>  .RE
>>  .PP
>> @@ -115,6 +116,7 @@ directory are:
>>  .nf
>>  .BR xwayland.so
>>  .BR cms-colord.so
>> +.BR screen-share.so
>>  .fi
>>  .RE
>>  .TP 7
>> @@ -421,6 +423,14 @@ The terminal shell (string). Sets the $TERM variable.
>>  sets the path to the xserver to run (string).
>>  .RE
>>  .RE
>> +.SH "SCREEN-SHARE SECTION"
>> +.TP 7
>> +.BI "command=" "/usr/bin/weston --backend=rdp-backend.so \
>> +--shell=fullscreen-shell.so --no-clients-resize"
>> +sets the command to start a fullscreen-shell server for screen sharing (string).
>> +The default value starts weston with the RDP backend.
>> +.RE
>> +.RE
>>  .SH "SEE ALSO"
>>  .BR weston (1),
>>  .BR weston-launch (1),
>
> Hi,
>
> pushed, but I removed the sentence about the default value. You have a
> value set in weston.ini.in which is the example .ini file, yes, but
> that is not the default. The default is set on the line:
>
> 	weston_config_section_get_string(section, "command", &ss->command, "");
>
> and so the default is the empty string. I also think the default won't
> run at all.
>
> I don't think we even install the example weston.ini anywhere, even
> though we do generate it.
>

Yes, I had assumed that most people would be using the generated 
weston.ini file, so that would be a better place to put this value. It 
just seems like quite a specific value to hard code, and given that people 
might want to tweak it, having a 'default' value in the ini file would 
be more useful and informative.

>
> Thanks,
> pq
>

---
Andrew Wedgbury <andrew.wedgbury at realvnc.com>