summaryrefslogtreecommitdiffstats
path: root/docs/index.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.txt')
-rw-r--r--docs/index.txt57
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/index.txt b/docs/index.txt
new file mode 100644
index 0000000..4fb4e4a
--- /dev/null
+++ b/docs/index.txt
@@ -0,0 +1,57 @@
+netcfg {version}
+----------------
+
+About
+~~~~~
+netcfg is profile based network connection tool. It can connect to a
+variety of connections (including wired, wireless and PPP) and is easily
+extended to support other connection types.
+
+
+Features
+~~~~~~~~
+
+* Easy configuration
+* Wireless, wired and ppp connections
+* Wireless roaming and automatic connection (using wpa_actiond/wpa_supplicant)
+* Radio kill switch (rfkill) awareness
+* pm-utils suspend/resume support
+* Execution of commands before/after up/down
+* Wired link detection (using ifplugd)
+* Modern iproute and wpa_supplicant based connectivity
+
+
+Optional dependencies
+~~~~~~~~~~~~~~~~~~~~~
+
+* wpa_supplicant: for wireless networking
+* wpa_actiond: Wireless Roaming/autoconnect
+* ifplugd: Wired link detection
+* dialog: Menu support
+* bridge-utils: To set up bridge connections
+
+
+Documentation
+~~~~~~~~~~~~~
+
+* http://wiki.archlinux.org/index.php/Netcfg[Arch Linux Wiki page]
+* link:features.html[Feature documentation]
+* link:netcfg.8.html[netcfg man page]
+* link:netcfg-profiles.5.html[netcfg-profiles man page]
+
+
+Contact
+~~~~~~~
+
+To report bugs or issues with netcfg, please use the
+http://bugs.archlinux.org[Arch Linux Bug Tracker]
+
+To seek help using netcfg, please post on the
+http://bbs.archlinux.org[Arch Linux Forums]
+
+
+Copyright
+~~~~~~~~~
+netcfg is Copyright (C) 2011-2012, Netcfg Development Team
+and Copyright (C) 2007-2010 James Rayner <james@archlinux.org>
+and is licensed through the Modified BSD License.