update man pages

more correct behavior to --daemon option (renamed to --detached)
This commit is contained in:
arcan1s
2014-08-19 11:26:03 +04:00
parent 8b58f6d383
commit 47dc016da2
12 changed files with 140 additions and 35 deletions

View File

@ -17,12 +17,16 @@ set (HEADERS "")
add_subdirectory (${SUBPROJECT_SOURCE_DIR})
# build man
file (GLOB SUBPROJECT_MAN_IN *.1)
file (GLOB SUBPROJECT_MAN5_IN *.5)
file (RELATIVE_PATH SUBPROJECT_MAN ${CMAKE_SOURCE_DIR} ${SUBPROJECT_MAN_IN})
file (RELATIVE_PATH SUBPROJECT_MAN5 ${CMAKE_SOURCE_DIR} ${SUBPROJECT_MAN5_IN})
configure_file (${SUBPROJECT_MAN_IN} ${CMAKE_CURRENT_BINARY_DIR}/${SUBPROJECT_MAN})
configure_file (${SUBPROJECT_MAN5_IN} ${CMAKE_CURRENT_BINARY_DIR}/${SUBPROJECT_MAN5})
install (FILES org.netctlgui.helper.conf DESTINATION ${DBUS_SYSTEMCONF_PATH})
install (FILES netctlgui-helper.conf DESTINATION /etc)
install (FILES netctlgui-helper.service DESTINATION ${SYSTEMD_SERVICE_PATH})
install (FILES ${CMAKE_CURRENT_BINARY_DIR}/${SUBPROJECT_MAN} DESTINATION share/man/man1/)
install (FILES ${CMAKE_CURRENT_BINARY_DIR}/${SUBPROJECT_MAN5} DESTINATION share/man/man5/)
install (FILES bash-completions DESTINATION share/bash-completion/completions/ RENAME ${SUBPROJECT})
install (FILES zsh-completions DESTINATION share/zsh/site-functions/ RENAME _${SUBPROJECT})

View File

@ -1,4 +1,4 @@
.TH netctlgui-helper 1 "@CURRENT_DATE@" "version @PROJECT_VERSION@" "USER COMMANDS"
.TH netctlgui-helper 1 "@CURRENT_DATE@" "version @PROJECT_VERSION@" "General Commands Manual"
.SH NAME
netctlgui-helper is a helper daemon for netctl-gui
.SH SYNOPSIS
@ -14,6 +14,7 @@ without any additional permissions. To have access to DBus interface user should
.IP "-c, --config FILE"
read configuration from file
.I FILE
instead of default user configuration
.IP "-d, --debug"
print debug information
.IP "--nodaemon"
@ -32,8 +33,10 @@ show build information and exit
show this help and exit
.SH FILES
.I $HOME/.config/netctl-gui.conf
,
.I /etc/netctlgui-helper.conf
.RS
Configuration file
Configuration files
.RE
.I /usr/lib/systemd/system/netctlgui-helper.service
.RS
@ -61,6 +64,7 @@ By the way it is highly recommended to copy source service file before to
and edit copied file to avoid upgrade problems.
.SH SEE ALSO
.BR netctl-gui (1)
.BR netctlgui-helper.conf (5)
.SH STANDARDS
See
.B @CMAKE_INSTALL_PREFIX@/share/doc/netctl-gui/netctl-gui-dbus-api.html

View File

@ -0,0 +1,104 @@
.TH netctlgui-helper.conf 5 "@CURRENT_DATE@" "version @PROJECT_VERSION@" "File Formats Manual"
.SH NAME
netctlgui-helper.conf is a configuration file of Netctl GUI project
.SH SYNOPSIS
.B /etc/netctlgui-helper.conf
for system-wide configuration or
.B $HOME/.config/netctl-gui.conf
for user one
.SH DESCRIPTION
.B netctlgui-helper.conf
is a file which contains parameters for
.BR netctlgui-helper (1)
and may be used as template for
.BR netctl-gui (1)
configuration also.
.SH OPTIONS
.IP "CLOSE_HELPER=false"
close helper after GUI application quit. This option is not recognized by
.BR netctlgui-helper (1)
.IP "CLOSETOTRAY=true"
hide application to tray on exit if tray is available. This option is not recognized by
.BR netctlgui-helper (1)
.IP "CTRL_DIR=/run/wpa_supplicant_netctl-gui"
path to control directory which is required by
.BR wpa_supplicant (8)
.IP "CTRL_GROUP=users"
group which is owner of
.B CTRL_DIR
.IP "FORCE_SUDO=false"
force use
.B SUDO_PATH
for helper instead of using
.BR setuid (3)
to child processes
.IP "HELPER_PATH=/usr/bin/netctlgui-helper"
path to
.BR netctlgui-helper (1)
This option is not recognized by
.BR netctlgui-helper (1)
.IP "HELPER_SERVICE=netctlgui-helper.service"
.BR netctlgui-helper (1)
service name. This option is not recognized by
.BR netctlgui-helper (1)
.IP "IFACE_DIR=/sys/class/net/"
path to directory which contains interface information
.IP "LANGUAGE=en"
application language
.IP "NETCTL_PATH=/usr/bin/netctl"
path to
.BR netctl (1)
.IP "NETCTLAUTO_PATH=/usr/bin/netctl-auto"
path to
.BR netctl-auto (1)
.IP "NETCTLAUTO_SERVICE=netctl-auto"
.BR netctl-auto (1)
service name without
.I .service
suffix
.IP "PID_FILE=/run/wpa_supplicant_netctl-gui.pid"
.BR wpa_supplicant (8)
PID file
.IP "PREFERED_IFACE="
prefered wireless interface
.IP "PROFILE_DIR=/etc/netctl/"
path to
.BR netctl (1)
profile directory
.IP "RFKILL_DIR=/sys/class/rfkill/"
path to directory with
.BR rfkill (8)
devices. This option is not recognized by
.BR netctlgui-helper (1)
.IP "STARTTOTRAY=false"
start
.BR netctl-gui (1)
minimized to tray if it is available. This option is not recognized by
.BR netctlgui-helper (1)
.IP "SUDO_PATH=/usr/bin/kdesu"
path to
.BR sudo (8)
frontend
.IP "SYSTEMCTL_PATH=/usr/bin/systemctl"
path to
.BR systemctl (1)
.IP "SYSTRAY=true"
create system tray icon. This option is not recognized by
.BR netctlgui-helper (1)
.IP "USE_HELPER=true"
use
.BR netctlgui-helper (1)
if it is available. This option is not recognized by
.BR netctlgui-helper (1)
.IP "WPACLI_PATH=/usr/bin/wpa_cli"
path to
.BR wpa_cli (8)
.IP "WPASUP_PATH=/usr/bin/wpa_supplicant"
path to
.BR wpa_supplicant (8)
.IP "WPA_DRIVERS=nl80211,wext"
.BR wpa_supplicant (8)
drivers for wireless interface comma separated
.SH SEE ALSO
.BR netctl-gui (1)
.BR netctlgui-helper (1)