From 27c11787d7c58b02f12d7afd476ea66abfeecaaf Mon Sep 17 00:00:00 2001
From: Jouke Witteveen <j.witteveen@gmail.com>
Date: Fri, 28 Dec 2012 02:43:13 +0100
Subject: Forking netcfg to netctl (2/2)

This commit contains the refactoring and rewriting of code.
---
 docs/netctl.special.7.txt | 55 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 docs/netctl.special.7.txt

(limited to 'docs/netctl.special.7.txt')

diff --git a/docs/netctl.special.7.txt b/docs/netctl.special.7.txt
new file mode 100644
index 0000000..eabb4d3
--- /dev/null
+++ b/docs/netctl.special.7.txt
@@ -0,0 +1,55 @@
+NETCTL.SPECIAL(7)
+=================
+
+NAME
+----
+netctl.special - Special netctl systemd units
+
+
+SYNOPSIS
+--------
+netctl.service, netctl-auto.service, netctl-ifplugd.service
+
+
+DESCRIPTION
+-----------
+Bundled with netctl come a few systemd units that are not controlled
+through the netctl command. They can be used through the systemctl
+utility of systemd.
+
+
+SPECIAL UNITS
+-------------
+netctl.service::
+    When started, this unit tries to start the profiles that were
+    running when the unit was last stopped. In some cases, the interface
+    a profile binds to might not be available yet, when netctl.service
+    tries to bring a profile up. A simple, hackish, solution is to do:
+--------------------------------------------------------------------
+echo "[[ -t 0 ]] || sleep 3" > /etc/network.d/interfaces/<interface>
+chmod 755 /etc/network.d/interfaces/<interface>
+--------------------------------------------------------------------
+    A more concise solution is to first enable a profile through netctl
+    and then disable it again through systemctl:
+--------------------------------------------------------------------
+netctl enable <profile>
+systemctl disable netctl@<profile>
+--------------------------------------------------------------------
+    This way the unit configuration file for the profile remains in
+    existence, while the profile is not enabled.
+
+netctl-auto@<interface>.service::
+    This unit issues a scan on the interface it is used for and tries to
+    start a profile for a network it finds. It is targeted to wireless
+    interfaces.
+
+netctl-ifplugd@<interface>.service::
+    This unit starts ifplugd on the interface it is used for. It will
+    try to start a netctl profile whenever a cable is plugged into the
+    interface and stop the profile when the cable is unplugged. Note
+    that this unit does not provide network.target.
+
+
+SEE ALSO
+--------
+*netctl*(1), *netctl.profile*(5)
-- 
cgit v1.2.3-24-g4f1b