netctl.1.txt 3.19 KB
Newer Older
1
NETCTL(1)
Jouke Witteveen's avatar
Jouke Witteveen committed
2
3
4
5
=========

NAME
----
6
netctl - Control the netctl network profile manager
Jouke Witteveen's avatar
Jouke Witteveen committed
7
8
9
10


SYNOPSIS
--------
11
*netctl* {*COMMAND*} [+PROFILE+]
Jouke Witteveen's avatar
Jouke Witteveen committed
12

13
*netctl* [--help | --version]
Jouke Witteveen's avatar
Jouke Witteveen committed
14
15
16
17


DESCRIPTION
-----------
18
19
*netctl* may be used to introspect and control the state of the systemd
services for the network profile manager.
Jouke Witteveen's avatar
Jouke Witteveen committed
20
21
22
23


OPTIONS
-------
24
25
26
The following commands are understood:

*list*::
27
28
    List all available profiles. Online profiles will be marked with a
    `*', otherwise active profiles will be marked with a `+'.
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

*store*::
    Saves which profiles are currently active.

*restore*::
    Loads the profiles that were active during the last invocation of
    `*store*'.

*stop-all*::
    Stops all active network profiles.

*start [+PROFILE+]*::
    Start the network profile specified on the command line.

*stop [+PROFILE+]*::
    Stop the network profile specified on the command line.

*restart [+PROFILE+]*::
    Restart the network profile specified on the command line. If it is
    not started yet, it will be started.

*switch-to [+PROFILE+]*::
    Starts the network profile specified on the command line after
    stopping all profiles that refer to the same interface.

54
55
56
57
*is-active [+PROFILE+]*::
    Check whether the network profile specified on the command line is
    active. Prints the current state.

58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
*status [+PROFILE+]*::
    Show terse runtime status information about a profile, followed by
    its most recent log data from the journal.

*enable [+PROFILE+]*::
    Enable the systemd unit for the profile specified. This will create
    a unit configuration file. If the file already exists, the command
    fails. No other profiles than the one specified will be enabled.
    Changes to the general options in a profile specification will not
    propagate to the unit configuration file automatically. After such
    changes, it is necessary to `*reenable*' the profile.

*disable [+PROFILE+]*::
    Disable the systemd unit for the profile specified. This will remove
    the file created by `*enable*' even if it was customized, so be
73
    careful.
74

75
76
77
78
*reenable [+PROFILE+]*::
    Reenable the systemd unit for the profile specified. This is
    effectively a combination of `*disable*' and `*enable*'.

79
80
81
82
*is-enabled [+PROFILE+]*::
    Check whether the systemd unit for the specified profile is enabled.
    Prints the current enable status.

83
84
*edit [+PROFILE+]*::
    Open the file of the specified profile in an editor. This does not
85
86
87
88
89
    reenable, restart, or verify any profiles.

*verify [+PROFILE+]*::
    Check the file of the specified profile for syntax errors. If no
    errors are found, no output is produced.
90

91
92
93
94
*wait-online [+PROFILE+]*::
    Wait until the interface of the profile has a routable IP address of
    some kind.

95
96
97
98
99
100
101
102
103

EXIT STATUS
-----------
On success 0 is returned, a non-zero failure code otherwise.


ENVIRONMENT
-----------
'$NETCTL_DEBUG'::
Jouke Witteveen's avatar
Jouke Witteveen committed
104
105
106
    If set to +"yes"+, debugging output is generated. +
    The value of this variable is independent of the value of the
    variable with the same name in profiles.
107
108
109
'$NETCTL_STATE_FILE'::
    The location of the state file. Defaults to
    '/var/lib/netctl/netctl.state'.
Jouke Witteveen's avatar
Jouke Witteveen committed
110
111
112
113


SEE ALSO
--------
114
*netctl-auto*(1), *netctl.profile*(5), *netctl.special*(7), *systemctl*(1)