diff options
| author | James Rayner <james@archlinux.org> | 2009-11-07 01:58:44 +0100 |
|---|---|---|
| committer | James Rayner <james@archlinux.org> | 2009-11-07 01:58:44 +0100 |
| commit | ecd51d8dc54e1a5c81f2c7d229b60ad089fa9de0 (patch) | |
| tree | 0efaa1ecc395f0bdc0c548b896f7aef8c2986fba /docs | |
| parent | 77a2e3798ce3197146315754e813e2b902f3f0b5 (diff) | |
| download | netctl-ecd51d8dc54e1a5c81f2c7d229b60ad089fa9de0.tar.gz netctl-ecd51d8dc54e1a5c81f2c7d229b60ad089fa9de0.tar.xz | |
Tweak docs, add website generation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ethernet | 1 | ||||
| -rw-r--r-- | docs/index | 57 | ||||
| -rwxr-xr-x | docs/make.sh | 2 | ||||
| -rwxr-xr-x | docs/makewebsite.sh | 7 | ||||
| -rw-r--r-- | docs/website/footer.html | 9 | ||||
| -rw-r--r-- | docs/website/header.html | 54 | ||||
| -rw-r--r-- | docs/wireless | 2 |
7 files changed, 130 insertions, 2 deletions
diff --git a/docs/ethernet b/docs/ethernet index 1781a03..a128697 100644 --- a/docs/ethernet +++ b/docs/ethernet @@ -2,6 +2,7 @@ % Arch Linux % +# Ethernet options reference ## Description This connection method uses the iproute suite of tools and dhcpcd to gain an IP address. diff --git a/docs/index b/docs/index new file mode 100644 index 0000000..de2bfb9 --- /dev/null +++ b/docs/index @@ -0,0 +1,57 @@ +% netcfg - Profile based network connection tool +% James Rayner +% + +# netcfg + +## About + +netcfg is profile based network connection tool. It can connect to wireless, wired and PPP connections and is easily expanded 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 + +## Download + +The latest version is 2.5.0rc1 + +Arch users can install netcfg via pacman, it is located in the [core] repository. Testing versions can often be found in the [testing] repository. + + pacman -S netcfg + +The source for netcfg can be found on the [Arch Linux ftp](ftp://ftp.archlinux.org/other/netcfg/), or [mirrored here](http://rayner.id.au/netcfg/source/) + +[Download latest source (2.5.0rc1)](ftp://ftp.archlinux.org/other/netcfg/netcfg-2.5.0rc1.tar.gz) + +### Optional dependencies + +* wpa_actiond: Wireless Roaming/autoconnect +* ifplugd: Wired link detection +* dialog: Menu support + + +## Documentation + +* [Quick Start Guide](http://wiki.archlinux.org/index.php/Network_Profiles) +* [Features](features.html) +* [Wireless options reference](wireless.html) +* [Ethernet options reference](ethernet.html) + +## Contact + +To report bugs or issues with netcfg, please use the [Arch Linux Bug Tracker](http://bugs.archlinux.org) + +To seek help using netcfg, please post on the [Arch Linux Forums](http://bbs.archlinux.org) + +To contact James regarding netcfg, please [email](mailto:james@archlinux.org) + + + diff --git a/docs/make.sh b/docs/make.sh index b101117..544d1f3 100755 --- a/docs/make.sh +++ b/docs/make.sh @@ -1,5 +1,5 @@ #! /bin/bash -PAGES=(index ethernet features wireless) +PAGES=(ethernet features wireless) for page in ${PAGES[@]}; do rm ${page}.html diff --git a/docs/makewebsite.sh b/docs/makewebsite.sh new file mode 100755 index 0000000..06d8f6d --- /dev/null +++ b/docs/makewebsite.sh @@ -0,0 +1,7 @@ +#! /bin/bash +PAGES=(index ethernet features wireless) + +for page in ${PAGES[@]}; do + rm ${page}.html + pandoc --toc -w html --email-obfuscation=javascript -B website/header.html -A website/footer.html -o ${page}.html $page +done diff --git a/docs/website/footer.html b/docs/website/footer.html new file mode 100644 index 0000000..c933e4a --- /dev/null +++ b/docs/website/footer.html @@ -0,0 +1,9 @@ + </div> + <div class="foot"> + Arch Linux copyright © 2002-2009 <a href="mailto:jvinet@zeroflux.org" title="contact Judd Vinet">Judd Vinet</a> and <a href="mailto:aaron@archlinux.org" title="contact Aaron Griffin">Aaron Griffin</a>.<br /> + The Arch Linux name and logo are recognized trademarks. Some rights + reserved.<br /> + The registered trademark Linux® is used pursuant to a sublicense from LMI, the exclusive licensee of Linus Torvalds, owner of the mark on a world-wide basis. + </div> + </body> +</html> diff --git a/docs/website/header.html b/docs/website/header.html new file mode 100644 index 0000000..f10db1c --- /dev/null +++ b/docs/website/header.html @@ -0,0 +1,54 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <title>Arch Linux</title> + <meta http-equiv="content-type" content="text/html; charset=utf-8" /> + <link rel="stylesheet" href="http://archlinux.org/media/arch.css" /> + <link rel="icon" href="/media/favicon.ico" type="image/x-icon" /> + <link rel="shortcut icon" href="/media/favicon.ico" type="image/x-icon" /> + +<link rel="alternate" type="application/rss+xml" title="Arch Linux News Updates" href="/feeds/news/" /> +<link rel="alternate" type="application/rss+xml" title="Arch Linux Package Updates" href="/feeds/packages/" /> +<style type="text/css"> + dt +{ +font-weight: bold; +} +dd +{ + margin-left: 2em; +} +h3 +{ + margin-top: 10px; +} +pre +{ + padding-bottom: 10px; +} +h1 a, h2 a, h3 a { + color: #000000; +} +* ul { padding: 10px 20px; } + </style> + </head> + <body> + <div id="head_container"> + <div id="title"> + <div id="logo"><h1 id="archtitle"><a href="http://archlinux.org/" title="Arch Linux (Home)">Arch Linux</a></h1></div> + </div> + <div id="main_nav"> + <ul> + <li><a href="http://aur.archlinux.org">AUR</a></li> + <li><a href="http://bugs.archlinux.org">Bugs</a></li> + <li><a href="http://wiki.archlinux.org/index.php/Network_Profiles">Wiki</a></li> + <li><a href="http://bbs.archlinux.org">Forums</a></li> + <li class="selected"><a href="/netcfg">netcfg</a></li> + <li><a href="http://archlinux.org">Home</a></li> + </ul> + </div> + </div> + <div id="content"> + + + diff --git a/docs/wireless b/docs/wireless index 30d9b28..785b552 100644 --- a/docs/wireless +++ b/docs/wireless @@ -2,7 +2,7 @@ % Arch Linux % -# 'wireless' Connection manual +# Wireless options reference ## Description This connection method uses wpa_supplicant to configure a wireless network connection. This connection uses the 'ethernet' connection after successful association and thus supports all of it's options. |