summaryrefslogtreecommitdiffstats
path: root/docs/netcfg.txt
blob: 499219fe0083e026c8ec997f9e66c4776cf3449a (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
91
92
93
94
95
96
97
% NETCFG(8) netcfg 2.7 | Arch Linux
% Jouke Witteveen <j.witteveen@gmail.com>
  Rémy Oudompheng <remy@archlinux.org>
  James Rayner <james@archlinux.org>
% 2012-02-29

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, netxfg **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.
*/etc/network.d/hooks/*
:   See /usr/share/doc/netcfg/contrib for examples.

ENVIRONMENT VARIABLES
=====================

**NETCFG_DEBUG**
:   Set to 1 to activate debug output.

BUGS
====

None, hopefully, but if you do find one of these elusive things,
please submit at http://bugs.archlinux.org/ or email one of the authors
below.

SEE ALSO
========

**netcfg-profiles**(5) for how to configure netcfg.