diff options
| author | Jouke Witteveen <j.witteveen@gmail.com> | 2012-03-04 00:34:18 +0100 |
|---|---|---|
| committer | Jouke Witteveen <j.witteveen@gmail.com> | 2012-03-04 00:34:18 +0100 |
| commit | 6b4c974d5a1a8d12831a6b0de72104368851b5a7 (patch) | |
| tree | c9f06ac8f70fbdc50bfa9215d9a2d0b93cc3dc57 /docs/index.txt | |
| parent | 4ed88705b8ea1dae9adc109b71ef35624a9faccd (diff) | |
| download | netctl-6b4c974d5a1a8d12831a6b0de72104368851b5a7.tar.gz netctl-6b4c974d5a1a8d12831a6b0de72104368851b5a7.tar.xz | |
Overhaul of documentation
- Documentation now uses asciidoc instead of pandoc.
- Documentation is updated.
- More documentation is installed.
- The Makefile has been revised.
- Autocompletion files must now be installed through the PKGBUILD.
- contrib/11netcfg has been deleted. It is unmaintained and duplicated in pm-utils. This closes FS#25587.
- contrib/common.hook has been deleted. It demonstrated a feature that the target audience is already familiar with and didn't work anyway. This closes FS#27496. Developers are free to write unwieldy scripts in the {PRE,POST}_{UP,DOWN} variables.
Diffstat (limited to 'docs/index.txt')
| -rw-r--r-- | docs/index.txt | 57 |
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. |