netctl-gui/sources/helper/netctlgui-helper.1
2014-08-25 10:54:18 +04:00

80 lines
2.1 KiB
Groff

.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
.B netctlgui-helper
[ options ]
.SH DESCRIPTION
.B netctlgui-helper
is a Qt based helper daemon which provides a DBus interface for interaction with
.B netctl
without any additional permissions. To have access to DBus interface user should have group
.B network
.SH OPTIONS
.IP "-c, --config FILE"
read configuration from file
.I FILE
instead of default user configuration
.IP "-d, --debug"
print debug information
.IP "--nodaemon"
do not run as daemon
.IP "--replace"
force replace the existing session
.IP "--restore"
force restore the existing session
.IP "--system"
do not read user configuration
.IP "-v, --version"
show version and exit
.IP "-i, --info"
show build information and exit
.IP "-h, --help"
show this help and exit
.SH FILES
.I $HOME/.config/netctl-gui.conf
,
.I /etc/netctlgui-helper.conf
.RS
Configuration files
.RE
.I /usr/lib/systemd/system/netctlgui-helper.service
.RS
Systemd service file
.RE
.I /etc/dbus-1/system.d/org.netctlgui.helper.conf
.RS
DBus policy configuration file
.RE
.SH USAGE WITH SYSTEMD
It is a recommended way to use this daemon. To start helper as systemd daemon type:
.nf
# systemctl start netctlgui-helper
.fi
If you want to setup non-standard configuration file edit source service file and replace the following line:
.nf
ExecStart=/usr/bin/netctlgui-helper
.fi
to
.nf
ExecStart=/usr/bin/netctlgui-helper -c /path/to/your/file
.fi
By the way it is highly recommended to copy source service file before to
.B /etc/systemd/system
and edit copied file to avoid upgrade problems.
.SH SEE ALSO
.BR netctl-gui (1)
.BR netctl-gui.conf (5)
.SH STANDARDS
See
.B @CMAKE_INSTALL_PREFIX@/share/doc/netctl-gui/netctl-gui-dbus-api.html
for more details.
.SH SECURITY CONSIDERATIONS
See
.B @CMAKE_INSTALL_PREFIX@/share/doc/netctl-gui/netctl-gui-security-notes.html
for more details.
.SH AUTHOR
@PROJECT_AUTHOR@ <\fI@PROJECT_CONTACT@\fR>
.SH LICENSE
This software is licensed under @PROJECT_LICENSE@