diff options
author | Jouke Witteveen <j.witteveen@gmail.com> | 2012-03-12 16:01:43 +0100 |
---|---|---|
committer | Jouke Witteveen <j.witteveen@gmail.com> | 2012-03-12 16:01:43 +0100 |
commit | 94ae8b1ccd08b7d0b2408db5b2054dee53413166 (patch) | |
tree | 534008d264f6c2b15b2431d5d20ca56f0e4b8c07 /docs | |
parent | 1a6cc347550cfde03be9f3155240b8d0e60e3e39 (diff) | |
download | netctl-94ae8b1ccd08b7d0b2408db5b2054dee53413166.tar.gz netctl-94ae8b1ccd08b7d0b2408db5b2054dee53413166.tar.xz |
Rename -i parameter to -D
-i is not a very cool parameter for downing an interface. Change it to -D so that it mirrors -R in the sense that a capital is used for interface-based actions.
The old behaviour is kept (undocumented) for backward compatibility.
Also a typo (iface-recont should have been iface-recon) is fixed.
Lastly some restrictions on profile naming are included in the documentation. The "should not start with '@'" is only for usage with net-profiles.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/netcfg-profiles.5.txt | 4 | ||||
-rw-r--r-- | docs/netcfg.8.txt | 2 |
2 files changed, 4 insertions, 2 deletions
diff --git a/docs/netcfg-profiles.5.txt b/docs/netcfg-profiles.5.txt index 7c33500..e39209f 100644 --- a/docs/netcfg-profiles.5.txt +++ b/docs/netcfg-profiles.5.txt @@ -12,7 +12,9 @@ The *netcfg*(8) profiles are plain text files that defines variables for netcfg behaviour. They must be compliant with *bash*(1) shell syntax and usually do not execute any code. -They are named '/etc/network.d/$\{profile_name}'. +They are named '/etc/network.d/$\{profile_name}', where ++$\{profile_name\}+ must not contain a newline character and should not +start with the `@'-sign. OVERVIEW diff --git a/docs/netcfg.8.txt b/docs/netcfg.8.txt index a878ba3..1d20234 100644 --- a/docs/netcfg.8.txt +++ b/docs/netcfg.8.txt @@ -45,7 +45,7 @@ OPTIONS Reconnect profile active on specified interface *-d, down* _profile_:: Stop the specified profile -*-i, iface-down* _interface_:: +*-D, iface-down* _interface_:: Stop the profile up on the specified interface. *-a, all-down*:: Stop all connected profiles |