diff options
author | Jouke Witteveen <j.witteveen@gmail.com> | 2012-12-28 02:38:58 +0100 |
---|---|---|
committer | Jouke Witteveen <j.witteveen@gmail.com> | 2012-12-28 02:38:58 +0100 |
commit | 4e457e0efd0e5fd5df24c7e9ed63b02d0196ea8d (patch) | |
tree | 09580c92ca78e8b9b54d7ed8d6b79d7fcd6fd9ff /docs | |
parent | 6737a37e5666837a8f51a2f74bdebdd756151394 (diff) | |
download | netctl-4e457e0efd0e5fd5df24c7e9ed63b02d0196ea8d.tar.gz netctl-4e457e0efd0e5fd5df24c7e9ed63b02d0196ea8d.tar.xz |
Forking netcfg to netctl (1/2)
This commit contains the moving of files.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile | 19 | ||||
-rw-r--r-- | docs/examples/openvpn | 5 | ||||
-rw-r--r-- | docs/examples/ppp | 4 | ||||
-rw-r--r-- | docs/features.txt | 147 | ||||
-rw-r--r-- | docs/footer.txt | 22 | ||||
-rw-r--r-- | docs/index.txt | 57 | ||||
-rw-r--r-- | docs/netctl.1.txt (renamed from docs/netcfg.8.txt) | 0 | ||||
-rw-r--r-- | docs/netctl.profile.5.txt (renamed from docs/netcfg-profiles.5.txt) | 0 |
8 files changed, 5 insertions, 249 deletions
diff --git a/docs/Makefile b/docs/Makefile index ef05303..879e5ac 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,21 +1,12 @@ -# Makefile for netcfg documentation +# Makefile for netctl documentation -MANPAGES = netcfg.8 netcfg-profiles.5 -WEBPAGES = index.html features.html $(MANPAGES:%=%.html) +MANPAGES = netctl.1 netctl.profile.5 netctl.special.7 -.PHONY: manpages website clean +.PHONY: manpages clean manpages: $(MANPAGES) -website: website.tar.xz - -$(MANPAGES): %: %.txt footer.txt +$(MANPAGES): %: %.txt a2x -d manpage -f manpage -a manversion=$(VERSION) $< -$(WEBPAGES): %.html: %.txt - asciidoc -a disable-javascript -a linkcss -a max-width=960px $< - -website.tar.xz: $(WEBPAGES) - tar --transform "s%^%netcfg/%" -cJf $@ $^ -C /etc/asciidoc/stylesheets asciidoc.css - clean: - -@rm -vf $(MANPAGES) $(WEBPAGES) website.tar.xz 2>/dev/null + -@rm -vf $(MANPAGES) 2>/dev/null diff --git a/docs/examples/openvpn b/docs/examples/openvpn deleted file mode 100644 index b6106aa..0000000 --- a/docs/examples/openvpn +++ /dev/null @@ -1,5 +0,0 @@ -CONNECTION="openvpn" -INTERFACE="ignore" -OVPN_CONFIG="/etc/openvpn/example/openvpn.conf" -OVPN_PID_FILE="/tmp/openvpn.example.pid" -OVPN_FLAGS="" diff --git a/docs/examples/ppp b/docs/examples/ppp deleted file mode 100644 index dfb6bc1..0000000 --- a/docs/examples/ppp +++ /dev/null @@ -1,4 +0,0 @@ -CONNECTION='ppp' -INTERFACE='ignore' -PEER='provider' -PPP_TIMEOUT=10 diff --git a/docs/features.txt b/docs/features.txt deleted file mode 100644 index 4cf7def..0000000 --- a/docs/features.txt +++ /dev/null @@ -1,147 +0,0 @@ -Netcfg Features ---------------- - -Network Profile management -~~~~~~~~~~~~~~~~~~~~~~~~~~ -netcfg is profile based. Each network has an individual profile. These -profiles can be individually connected/disconnected at any time. The -profile configuration varies depending on whether it's a wireless, -ethernet (wired) or other type of connection. The available options are -documented on the netcfg website and in the included examples. The -installed and available connection types can be seen at -'/usr/lib/network/connections/' - -To connect to a profile called `mynetwork' which would be located at -'/etc/network.d/mynetwork', you may run: - ----------------- -netcfg mynetwork ----------------- - -To disconnect from the same profile you could run one of: - ---------------------- -netcfg -d mynetwork -netcfg down mynetwork ---------------------- - -To reconnect: - -------------------- -netcfg -r mynetwork -------------------- - -For more options, see ''netcfg help'' - - -Start a specific list of profiles on boot -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -net-profiles allows you to start some profiles at boot time. Specify the -profiles you want netcfg to start (in the order you want them to be -started) in the +NETWORKS+ line in '/etc/conf.d/netcfg'. -Prefix a profile with a `@' to start it in the background. For example: - --------------------------------- -NETWORKS=(@adsl @mywireless lan) --------------------------------- - -Alternatively, you can have netcfg restart the profiles you had running -at the previous shutdown by specifying +NETWORKS=(last)+. - -Next, enable the `netcfg' systemd service or, on legacy systems, add -`net-profiles' to +DAEMONS+ in '/etc/rc.conf'. - - -Wireless automatic connection and roaming support -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Through the use of wpa_actiond which calls commands on a wpa_supplicant -event, netcfg now has automatic connection and roaming support. - -To use this: - -. Install core/wpa_actiond -. In '/etc/conf.d/netcfg' set +WIRELESS_INTERFACE+ to your wireless interface, eg: -+ ---------------------------- -WIRELESS_INTERFACE="wlan0" ---------------------------- -. Run `systemctl start net-auto-wireless` - -To run on boot, enable the `net-auto-wireless' systemd service. - - -Per interface configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Configuration that applies to all profiles using an interface can be set -at '/etc/network.d/interfaces/$INTERFACE'. For example: - ------------------------------- -/etc/network.d/interfaces/eth0 ------------------------------- - -This is useful for wpa_supplicant options, radio kill switch support, -pre/post up/down scripts and net-auto-wireless. It is loaded before a -profile is loaded so that any profile based options will take priority. - - -Execute commands before/after interface up/down -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If your interface requires special actions prior/after the -establishment/closure of a connection, you may use the +PRE_UP+, POST_UP, -+PRE_DOWN+, +POST_DOWN+ properties. For example, if you want to run a -script before connecting: - ------------------------- -PRE_UP="/path/to/script" ------------------------- - -Or if you want to manage resolv.conf through resolvconf, you could -remove any DNS related options and use the following, which will be run -after a successful connection: - ----------------------------------------------------------------- -POST_UP='echo "nameserver 8.8.8.8" | resolvconf -a "$INTERFACE"' ----------------------------------------------------------------- - -If the commands specified in these properties return anything other than -0 (success), netcfg aborts the current operation. If you command might -fail, create a separate bash script with an "exit 0;" at the end. -Alternatively you may add "|| true" to the end of the command that may -fail. - - -Output Hooks -~~~~~~~~~~~~ -netcfg has limited support to load hooks that handle output. By default -it loads the "arch" hook which provides the familiar output that you -see. A syslog logging hook is also included. These can be found at -'/usr/lib/network/hooks/' - - -Menu based profile selection -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You may select a profile to connect to from a menu. This requires the -'dialog' package installed. To display a menu, simply run `netcfg-menu`. -If you wish to have a menu on boot, set +NETWORKS=(menu)+ in your -'/etc/conf.d/netcfg' and ensure that `net-profiles' is in the +DAEMONS+ -array. A boot-time menu is not supported on systemd installations. - - -Menu based wireless network selection -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You can also connect to a wireless network using a menu. To display the -menu, run `wifi-menu [-o] [interface]`. The _interface_ defaults to the -+WIRELESS_INTERFACE+ from '/etc/conf.d/netcfg'. When `-o' is specified, -passwords are obscured (ie masked and saved in hexadecimal form). The -tool generates a profile file if no suitable profile was found. - - -Debugging -~~~~~~~~~ -To run netcfg with debugging output, set the NETCFG_DEBUG environment -variable to "yes", for example: - -------------------------------------- -NETCFG_DEBUG="yes" netcfg <arguments> -------------------------------------- - diff --git a/docs/footer.txt b/docs/footer.txt deleted file mode 100644 index c9efbad..0000000 --- a/docs/footer.txt +++ /dev/null @@ -1,22 +0,0 @@ -More information can be found at *<https://wiki.archlinux.org/index.php/Netcfg>*. - - -BUGS ----- -For bugtracking, *<https://bugs.archlinux.org/>* is used. - - -AUTHORS -------- -netcfg has many contributors. -For a list of contributors, use `git shortlog -s` on the netcfg.git repository. - -Current maintainer: - -* Jouke Witteveen <j.witteveen@gmail.com> - -Past maintainers: - -* Rémy Oudompheng <remy@archlinux.org> -* James Rayner <james@archlinux.org> - diff --git a/docs/index.txt b/docs/index.txt deleted file mode 100644 index 10ba380..0000000 --- a/docs/index.txt +++ /dev/null @@ -1,57 +0,0 @@ -netcfg home page ----------------- - -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 -~~~~~~~~~~~~~ - -* https://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 -https://bugs.archlinux.org[Arch Linux Bug Tracker] - -To seek help using netcfg, please post on the -https://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. diff --git a/docs/netcfg.8.txt b/docs/netctl.1.txt index 54fbd78..54fbd78 100644 --- a/docs/netcfg.8.txt +++ b/docs/netctl.1.txt diff --git a/docs/netcfg-profiles.5.txt b/docs/netctl.profile.5.txt index f929e47..f929e47 100644 --- a/docs/netcfg-profiles.5.txt +++ b/docs/netctl.profile.5.txt |