summary refs log tree commit diff
path: root/src/libnm-core-impl/nm-setting-proxy.c
diff options
context:
space:
mode:
authorMichael Biebl <biebl@debian.org>2022-05-04 15:35:24 +0200
committerMichael Biebl <biebl@debian.org>2022-05-04 15:35:24 +0200
commit9959fdb2e8ddd06f2161798ca0a39c77d67c652d (patch)
tree2ce24a336d2b1c5fd5dec3090db312eded6c78ba /src/libnm-core-impl/nm-setting-proxy.c
parent8c623dddbdebe354cb94bfc559a5371a14865317 (diff)
New upstream version 1.37.92 upstream/1.37.92
Diffstat (limited to 'src/libnm-core-impl/nm-setting-proxy.c')
-rw-r--r--src/libnm-core-impl/nm-setting-proxy.c18
1 files changed, 14 insertions, 4 deletions
diff --git a/src/libnm-core-impl/nm-setting-proxy.c b/src/libnm-core-impl/nm-setting-proxy.c
index 4b9a2970..8b91210b 100644
--- a/src/libnm-core-impl/nm-setting-proxy.c
+++ b/src/libnm-core-impl/nm-setting-proxy.c
@@ -114,7 +114,7 @@ nm_setting_proxy_get_pac_url(NMSettingProxy *setting)
  * nm_setting_proxy_get_pac_script:
  * @setting: the #NMSettingProxy
  *
- * Returns: the PAC script
+ * Returns: the PAC script.
  *
  * Since: 1.6
  **/
@@ -315,15 +315,25 @@ nm_setting_proxy_class_init(NMSettingProxyClass *klass)
     /**
      * NMSettingProxy:pac-script:
      *
-     * PAC script for the connection.
+     * PAC script for the connection. This is an UTF-8 encoded javascript code
+     * that defines a FindProxyForURL() function.
      *
      * Since: 1.6
      **/
+    /* ---nmcli---
+     * property: pac-script
+     * description: The PAC script. In the profile this must be an UTF-8 encoded javascript code that defines
+     *   a FindProxyForURL() function.
+     *   When setting the property in nmcli, a filename is accepted too. In that case,
+     *   nmcli will read the content of the file and set the script. The prefixes "file://" and "js://" are
+     *   supported to explicitly differentiate between the two.
+     * ---end---
+     */
     /* ---ifcfg-rh---
      * property: pac-script
      * variable: PAC_SCRIPT(+)
-     * description: Path of the PAC script.
-     * example: PAC_SCRIPT=/home/joe/proxy.pac
+     * description: The PAC script. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.
+     * example: PAC_SCRIPT="function FindProxyForURL (url, host) { return 'PROXY proxy.example.com:8080; DIRECT'; }"
      * ---end---
      */
     _nm_setting_property_define_direct_string(properties_override,