diff options
author | Jouke Witteveen <j.witteveen@gmail.com> | 2013-07-25 00:08:09 +0200 |
---|---|---|
committer | Jouke Witteveen <j.witteveen@gmail.com> | 2013-07-25 00:08:09 +0200 |
commit | 906c6daa8a1ab95b3e169b09a925816ebce4831c (patch) | |
tree | 3074e2aefcd98a15f6cf322646a270a8d44c0300 /docs/netctl-auto.1.txt | |
parent | 20c66d6499f22adad6c1dae854a627f061c5fbcb (diff) | |
parent | 7d081a227528201ed65b8bab9ec07ccd8dfc1162 (diff) | |
download | netctl-906c6daa8a1ab95b3e169b09a925816ebce4831c.tar.gz netctl-906c6daa8a1ab95b3e169b09a925816ebce4831c.tar.xz |
Merge branch 'master' of git://github.com/gandro/netctl into gandro-master
Diffstat (limited to 'docs/netctl-auto.1.txt')
-rw-r--r-- | docs/netctl-auto.1.txt | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/docs/netctl-auto.1.txt b/docs/netctl-auto.1.txt new file mode 100644 index 0000000..1fa17d8 --- /dev/null +++ b/docs/netctl-auto.1.txt @@ -0,0 +1,90 @@ +NETCTL-AUTO(1) +============== + +NAME +---- +netctl-auto - Control automatic selection of wireless netctl profiles + + +SYNOPSIS +-------- +*netctl-auto* {*COMMAND*} ... + +*netctl-auto* [--help | --version] + + +DESCRIPTION +----------- +*netctl-auto* may be used to control the automatic network profile selection +offered by the 'netctl-auto@.service' file. See *netctl.special*(7) for +details about the service file. + + +OPTIONS +------- +The following commands are understood: + +*list*:: + List all profiles which are currently available for automatic selection. + Active profiles will be marked with a '*', disabled profiles will be + marked with a '!'. + +*current*:: + Report currently active profiles. + +*switch-to [+PROFILE+]*:: + Switch to the network profile specified on the command line. The + specified profile will be enabled if necessary, the state of all other + profiles is not changed. This command does not force *netctl-auto* to use + the specified profile. If a disconnect occurs, *netctl-auto* may select + an alternative profile. + +*enable [+PROFILE+]*:: + Enable a previously disabled network profile for automatic selection. + Every time the *netctl-auto* service is started, all available profiles + are enabled by default. + +*disable [+PROFILE+]*:: + Disable the specified profile for automatic selection. This will only + take effect until the *netctl-auto* service is stopped. + To permanently exclude a profile from automatic selection, use the + 'ExcludeAuto=yes' option in the profile. + +*enable-all*:: + Enable all profiles for automatic selection. + +*disable-all*:: + Disable all profiles for automatic selection. + +*start [+INTERFACE+]*:: + Start automatic profile selection on the specified interface. + + This command should not be invoked directly, use the following command + instead: +--------------------------------------------- + systemctl start netctl-auto@<interface> +--------------------------------------------- + +*stop [+INTERFACE+]*:: + Stop automatic profile selection on the specified interface. This will + disconnect the currently active profile on the interface. + + This command should not be invoked directly, use the following command + instead: +-------------------------------------------- + systemctl stop netctl-auto@<interface> +-------------------------------------------- + + +EXIT STATUS +----------- +On success 0 is returned, a non-zero failure code otherwise. + + +ENVIRONMENT +----------- +'$NETCTL_DEBUG':: + If set to +"yes"+, debugging output is generated. + + +SEE ALSO +-------- +*netctl*(1), *netctl.profile*(5), *netctl.special*(7) |