summaryrefslogtreecommitdiffstats
path: root/src/lib/connections/README
blob: 6d8db9b481f12a561bb86b349c8af096943adb8e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
Support for connection types is implemented by connection files in

  /usr/lib/network/connections/

The file name determines the name of the connection type, so support
for the aviancarrier connection type will be provided by the file:

  /usr/lib/network/connections/aviancarrier

Files that implement support for a connection type should NOT be
executable. Such files should contain valid Bash code, among which two
functions, namely <connection_type>_up and <connection_type>_down. For
the aviancarrier file this would be:

  aviancarrier_up
  aviancarrier_down

These functions are responsible for bringing the network up and down,
respectively. When the functions are called, three bash files are
already sourced, so all functions and variables in those files are
available. The readily sourced files are:

  /usr/lib/network/network
  /usr/lib/network/globals
  /etc/netctl/<profile>

Here, <profile> is the profile file specifying the desired network
configuration.

A simple example of a connection file is that of the dummy connection
type.