summaryrefslogtreecommitdiffstats
path: root/docs/netcfg.8.txt
blob: a878ba31cf4ab938bc4f5e500f07e16b95f40dca (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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
NETCFG(8)
=========

NAME
----
netcfg - start/stop/control network profiles


SYNOPSIS
--------
netcfg [_options_]

netcfg *profile*


DESCRIPTION
-----------
*netcfg* is used to configure and manage network connections via
profiles. It has pluggable support for a range of connection types, such
as wireless, ethernet, ppp. It is also capable of starting/stopping many
to one connections, that is, multiple connections within the same
profile, optionally with bonding.

It may be run at boot, by enabling the '/etc/rc.d/net-profiles' daemon
in '/etc/rc.conf' +DAEMONS+ line. After boot time, it may be used to
start profiles, simply by passing only the profile name.

When run without options, `netcfg profile` is equivalent to `netcfg -u
profile`.


OPTIONS
-------
*-l, list*::
  List all available profiles
*current*::
  Report currently running profiles
*-c, check-iface* _profile_::
  Start the specified profile, only if it's interface is not currently up.
*-u, up* _profile_::
  Start the specified profile
*-r, reconnect* _profile_::
  Disconnect and reconnect the specified profile
*-R, iface-recon* _interface_::
  Reconnect profile active on specified interface
*-d, down* _profile_::
  Stop the specified profile
*-i, iface-down* _interface_::
  Stop the profile up on the specified interface.
*-a, all-down*::
  Stop all connected profiles
*all-suspend*::
  Suspend and store the name of all active profiles.
*all-resume*::
  Reconnect any profiles that have been suspended.
*-v, --version*::
  Display version information and exit
*-h, --help*::
  Display help message and exit


CONFIGURATION FILES
-------------------
'/etc/conf.d/netcfg'::
  Parameters for startup.
'/etc/network.d/'::
  User-defined profiles.


FILES
-----
'/usr/lib/network/connections/'::
  Currently installed network profile types.
'/etc/network.d/examples/'::
  Example profiles.
'/usr/share/doc/netcfg/contrib/'::
  Inspirational scripts.


ENVIRONMENT VARIABLES
---------------------
+NETCFG_DEBUG+::
  Set to 1 to activate debug output.


SEE ALSO
--------
*netcfg-profiles*(5) on how to configure netcfg.

include::footer.txt[]