--- Makefile.am | 2 +- doc/connman-vpn.8 | 2 +- doc/connman-vpn.conf.5 | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 52 insertions(+), 2 deletions(-) create mode 100644 doc/connman-vpn.conf.5
diff --git a/Makefile.am b/Makefile.am index 9193231..31cab05 100644 --- a/Makefile.am +++ b/Makefile.am @@ -154,7 +154,7 @@ vpn_connman_vpnd_LDADD = gdbus/libgdbus-internal.la $(builtin_vpn_libadd) \ vpn_connman_vpnd_LDFLAGS = -Wl,--export-dynamic \ -Wl,--version-script=$(srcdir)/vpn/vpn.ver -MANUAL_PAGES += doc/connman-vpn.8 +MANUAL_PAGES += doc/connman-vpn.conf.5 doc/connman-vpn.8 endif BUILT_SOURCES = $(local_headers) src/builtin.h $(service_files) scripts/connman diff --git a/doc/connman-vpn.8 b/doc/connman-vpn.8 index 889faff..e595890 100644 --- a/doc/connman-vpn.8 +++ b/doc/connman-vpn.8 @@ -59,4 +59,4 @@ the controlling terminal in addition to syslog. .BR \-r ", " \-\-routes Manage VPN routes instead of telling \fBconnmand\fP(8) to do it. .SH SEE ALSO -.BR connmanctl (1), \ connmand (8) +.BR connmanctl (1), \ connman-vpn.conf (5), \ connmand (8) diff --git a/doc/connman-vpn.conf.5 b/doc/connman-vpn.conf.5 new file mode 100644 index 0000000..5216aa9 --- /dev/null +++ b/doc/connman-vpn.conf.5 @@ -0,0 +1,50 @@ +.\" connman-vpn.conf(5) manual page +.\" +.\" Copyright (C) 2015 Intel Corporation +.\" +.TH "connman-vpn.conf" "5" "2015-10-15" "" +.SH NAME +connman-vpn.conf \- ConnMan-VPN configuration file +.SH SYNOPSIS +.B /etc/connman/connman-vpn.conf +.br +or +.br +\fI<SYSCONFDIR>\fB/connman/connman-vpn.conf +.br +.RI where\ <SYSCONFDIR> " depends on your distribution or build." +.SH DESCRIPTION +.P +.B connman-vpn.conf +is a configuration file for ConnMan-VPN. The configuration file is +optional but it can be used to set up various aspects of ConnMan-VPN's +behavior. The location of the file may be changed through use of +the \fB\-\-config= \fRargument for \fBconnman-vpn\fP(8). +.SH "FILE FORMAT" +.P +The configuration file format is key file format. +It consists of sections (groups) of key-value pairs. +Lines beginning with a '#' and blank lines are considered comments. +Sections are started by a header line containing the section enclosed +in '[' and ']', and ended implicitly by the start of the next section +or the end of the file. Each key-value pair must be contained in a section. +.P +Description of sections and available keys follows: +.SS [General] +This section is the only mandatory section of the configuration file. +.TP +.BI InputRequestTimeout= secs +Set input request timeout. Default is 300 seconds +The request for inputs like passphrase will timeout +after certain amount of time. Use this setting to +increase the value in case of different user +interface designs. +.SH "EXAMPLE" +The following example configuration sets InputRequestTimeout to 10 minutes. +.PP +.nf +[General] +InputRequestTimeout = 600 +.fi +.SH "SEE ALSO" +.BR connman (8), \ connman-vpn (8) -- 2.6.1 _______________________________________________ connman mailing list connman@connman.net https://lists.connman.net/mailman/listinfo/connman