mirrors/FreeRDP
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[man] add manpage for global configuration

Browse Source
This commit is contained in:
Armin Novak 2024-10-02 16:48:48 +02:00 committed by akallabeth
parent 0146deb4c0
commit c86a78bef7
No known key found for this signature in database
GPG Key ID: A49454A3FC909FD5
7 changed files with 103 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
client/SDL/SDL2/man/CMakeLists.txt
View File

@ -3,6 +3,7 @@ set(DEPS
../../common/man/sdl-freerdp-config.1.xml
../../common/man/sdl-freerdp-examples.1.xml
../../common/man/sdl-freerdp-envvar.1.xml
)
../../../common/man/freerdp-global-config.1.xml
)
generate_and_install_freerdp_man_from_xml(${MODULE_NAME} "1" "${DEPS}")

3
client/SDL/SDL2/man/sdl2-freerdp.1.xml.in
View File

@ -5,6 +5,7 @@ PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
<!ENTITY syntax SYSTEM "freerdp-argument.1.xml">
<!ENTITY config SYSTEM "sdl-freerdp-config.1.xml">
<!ENTITY envvar SYSTEM "sdl-freerdp-envvar.1.xml">
<!ENTITY configuration SYSTEM "freerdp-global-config.1.xml">
<!ENTITY examples SYSTEM "sdl-freerdp-examples.1.xml">
]
>
@ -53,6 +54,8 @@ PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
&envvar;
&configuration;
&examples;
<refsect1>

3
client/SDL/SDL3/man/CMakeLists.txt
View File

@ -3,6 +3,7 @@ set(DEPS
../../common/man/sdl-freerdp-config.1.xml
../../common/man/sdl-freerdp-examples.1.xml
../../common/man/sdl-freerdp-envvar.1.xml
)
../../../common/man/freerdp-global-config.1.xml
)
generate_and_install_freerdp_man_from_xml(${MODULE_NAME} "1" "${DEPS}")

3
client/SDL/SDL3/man/sdl3-freerdp.1.xml.in
View File

@ -5,6 +5,7 @@ PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
<!ENTITY syntax SYSTEM "freerdp-argument.1.xml">
<!ENTITY config SYSTEM "sdl-freerdp-config.1.xml">
<!ENTITY envvar SYSTEM "sdl-freerdp-envvar.1.xml">
<!ENTITY configuration SYSTEM "freerdp-global-config.1.xml">
<!ENTITY examples SYSTEM "sdl-freerdp-examples.1.xml">
]
>
@ -53,6 +54,8 @@ PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
&envvar;
&configuration;
&examples;
<refsect1>

3
client/X11/man/CMakeLists.txt
View File

@ -3,6 +3,7 @@ set(DEPS
xfreerdp-examples.1.xml
xfreerdp-shortcuts.1.xml
xfreerdp-envvar.1.xml
)
../../common/man/freerdp-global-config.1.xml
)
generate_and_install_freerdp_man_from_xml(${MODULE_NAME} "1" "${DEPS}")

3
client/X11/man/xfreerdp.1.xml.in
View File

@ -6,6 +6,7 @@ PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
<!ENTITY shortcuts SYSTEM "xfreerdp-shortcuts.1.xml">
<!ENTITY channels SYSTEM "xfreerdp-channels.1.xml">
<!ENTITY envvar SYSTEM "xfreerdp-envvar.1.xml">
<!ENTITY configuration SYSTEM "freerdp-global-config.1.xml">
<!ENTITY examples SYSTEM "xfreerdp-examples.1.xml">
]
>
@ -56,6 +57,8 @@ PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
&envvar;
&configuration;
&examples;
<refsect1>

76
client/common/man/freerdp-global-config.1.xml.in Normal file
View File

@ -0,0 +1,76 @@
<refsect1>
<title>Global Configuration</title>
<variablelist>
<varlistentry>
<term>Format and Location:</term>
<listitem>
<para>The configuration file is stored in global system configuration.<sbr/>
The location is <replaceable>@CMAKE_INSTALL_FULL_SYSCONFDIR@/@VENDOR@/@PRODUCT@/certificates.json</replaceable><sbr/>
File format is JSON</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Supported options:</term>
<listitem>
<varlistentry>
<term><replaceable>deny</replaceable></term>
<listitem>
<varlistentry>
<listitem>
<para><replaceable>JSON boolean</replaceable><sbr/>
Deny the certificate if the check against system SSL store was not successful</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>ignore</replaceable></term>
<listitem>
<varlistentry>
<listitem>
<para><replaceable>JSON boolean</replaceable><sbr/>
Ignore certificate failures, just ignore the certificate</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>deny-userconfig</replaceable></term>
<listitem>
<varlistentry>
<listitem>
<para><replaceable>JSON boolean</replaceable><sbr/>
If the checks in the global configuration do not accept the certificate do not ask the user</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>certificate-db</replaceable></term>
<listitem>
<varlistentry>
<term><replaceable>JSON array</replaceable></term>
<listitem><para>An array of <replaceable>JSON objects</replaceable> with:</para>
<varlistentry>
<term><replaceable>type</replaceable></term>
<listitem>
<para><replaceable>JSON string</replaceable><sbr/>
a string identifying the hash algorithm used, e.g. <replaceable>sha256</replaceable> <sbr/></para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>hash</replaceable></term>
<listitem>
<para><replaceable>JSON string</replaceable><sbr/>
a string of hex integer values representing the certificate hash, e.g. <replaceable>0123456789abcdef</replaceable></para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
</variablelist>
</refsect1>