Imported Upstream version 1.37
[platform/upstream/connman.git] / doc / connman-vpn.conf.5.in
1 .\" connman-vpn.conf(5) manual page
2 .\"
3 .\" Copyright (C) 2015 Intel Corporation
4 .\"
5 .TH "connman-vpn.conf" "5" "2015-10-15" ""
6 .SH NAME
7 connman-vpn.conf \- ConnMan-VPN configuration file
8 .SH SYNOPSIS
9 .B @sysconfdir@/connman/connman-vpn.conf
10 .SH DESCRIPTION
11 .P
12 .B connman-vpn.conf
13 is a configuration file for ConnMan-VPN. The configuration file is
14 optional but it can be used to set up various aspects of ConnMan-VPN's
15 behavior. The location of the file may be changed through use of
16 the \fB\-\-config= \fRargument for \fBconnman-vpn\fP(8).
17 .SH "FILE FORMAT"
18 .P
19 The configuration file consists of sections (groups) of key-value pairs.
20 Lines beginning with a '#' and blank lines are considered comments.
21 Sections are started by a header line containing the section enclosed
22 in '[' and ']', and ended implicitly by the start of the next section
23 or the end of the file. Each key-value pair must be contained in a section.
24 .P
25 Description of sections and available keys follows:
26 .SS [General]
27 This section is the only mandatory section of the configuration file.
28 .TP
29 .BI InputRequestTimeout= secs
30 Set input request timeout. Default is 300 seconds. The request for inputs
31 like passphrase will timeout after certain amount of time. Use this setting
32 to increase the value in case of different user interface designs.
33 .SH "EXAMPLE"
34 The following example configuration sets InputRequestTimeout to 10 minutes.
35 .PP
36 .nf
37 [General]
38 InputRequestTimeout = 600
39 .fi
40 .SH "SEE ALSO"
41 .BR connman (8), \ connman-vpn (8)