From 4e76d52671df4be4b756edb8ea3949d29df942a4 Mon Sep 17 00:00:00 2001
From: arcan1s <esalexeev@gmail.com>
Date: Wed, 20 Aug 2014 08:32:14 +0400
Subject: [PATCH] update configuration file

---
 CHANGELOG                            |  2 +-
 README.md                            |  3 ++-
 sources/helper/netctlgui-helper.conf | 36 ++++++++++++++++++++++++++++
 3 files changed, 39 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG b/CHANGELOG
index 80950a1..25e297d 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -19,7 +19,7 @@ Ver.1.3.0
     + add support of openvswitch
     + add security notes and API descriptions
     + add ability to use helper
-    + add ability to start minimized/maximized/daemonized
+    + add ability to start minimized/maximized/detached
     + add ability to don't save profile from WiFi tab
     * more correct actions into SettingsWindow
     * update to library changes
diff --git a/README.md b/README.md
index 22e964d..fa16e3d 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,7 @@ Installation
   * `-DBUILD_HELPER:BOOL=0` - do not build helper daemon
   * `-DBUILD_LIBRARY:BOOL=0` - do not build library
   * `-DBUILD_PLASMOID:BOOL=0` - do not build Plasmoid
+  * `-DBUILD_TEST:BOOL=1` - build auto tests for the library and the helper
   * `-DUSE_QT5:BOOL=0` - use Qt4 instead of Qt5 for GUI
 
 Additional information
@@ -65,7 +66,7 @@ TODO (wish list)
 ----------------
 
 * remove suid bit from helper (polkit/logind/etc)
-* option descriptions to /etc/netctlgui-helper.conf
+* check/update documentation
 
 Links
 -----
diff --git a/sources/helper/netctlgui-helper.conf b/sources/helper/netctlgui-helper.conf
index ee902a2..35e13b6 100644
--- a/sources/helper/netctlgui-helper.conf
+++ b/sources/helper/netctlgui-helper.conf
@@ -1,24 +1,60 @@
+# Configuration file for Netctl GUI project
+# /etc/netctlgui-helper.conf - system-wide configuration
+# $HOME/.config/netctl-gui.conf - user configuration
+
+# close helper after GUI application quit.
+# This option is not recognized by netctlgui-helper
 CLOSETOTRAY=true
+# hide application to tray on exit if tray is available.
+# This option is not recognized by netctlgui-helper
 CLOSE_HELPER=false
+# path to control directory which is required by wpa_supplicant
 CTRL_DIR=/run/wpa_supplicant_netctl-gui
+# group which is owner of CTRL_DIR
 CTRL_GROUP=users
+# force use SUDO_PATH for helper instead of using setuid(3) to child processes
 FORCE_SUDO=false
+# path to netctlgui-helper.
+# This option is not recognized by netctlgui-helper
 HELPER_PATH=/usr/bin/netctlgui-helper
+# netctlgui-helper service name.
+# This option is not recognized by netctlgui-helper
 HELPER_SERVICE=netctlgui-helper.service
+# path to directory which contains interface information
 IFACE_DIR=/sys/class/net/
+# application language
 LANGUAGE=en
+# path to netctl-auto
 NETCTLAUTO_PATH=/usr/bin/netctl-auto
+# netctl-auto service name without .service suffix
 NETCTLAUTO_SERVICE=netctl-auto
+# path to netctl
 NETCTL_PATH=/usr/bin/netctl
+# wpa_supplicant PID file
 PID_FILE=/run/wpa_supplicant_netctl-gui.pid
+# prefered wireless interface
 PREFERED_IFACE=
+# path to netctl profile directory
 PROFILE_DIR=/etc/netctl/
+# path to directory with rfkill devices.
+# This option is not recognized by netctlgui-helper
 RFKILL_DIR=/sys/class/rfkill/
+# start netctl-gui minimized to tray if it is available.
+# This option is not recognized by netctlgui-helper
 STARTTOTRAY=false
+# path to sudo frontend
 SUDO_PATH=/usr/bin/sudo
+# path to systemctl
 SYSTEMCTL_PATH=/usr/bin/systemctl
+# create system tray icon.
+# This option is not recognized by netctlgui-helper
 SYSTRAY=true
+# use netctlgui-helper if it is available.
+# This option is not recognized by netctlgui-helper
 USE_HELPER=true
+# path to wpa_cli
 WPACLI_PATH=/usr/bin/wpa_cli
+# path to wpa_supplicant
 WPASUP_PATH=/usr/bin/wpa_supplicant
+# wpa_supplicant drivers for wireless interface comma separated
 WPA_DRIVERS=nl80211,wext