diff options
Diffstat (limited to 'docs/netcfg.txt')
-rw-r--r-- | docs/netcfg.txt | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/docs/netcfg.txt b/docs/netcfg.txt new file mode 100644 index 0000000..18394ff --- /dev/null +++ b/docs/netcfg.txt @@ -0,0 +1,96 @@ +% NETCFG(8) netcfg 2.6.4 | Arch Linux +% Rémy Oudompheng <remy@archlinux.org> + James Rayner <james@archlinux.org> +% July 2011 + +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 + +`-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. |