]> git.ipfire.org Git - thirdparty/iw.git/commitdiff
finish docs
authorJohannes Berg <johannes@sipsolutions.net>
Tue, 5 May 2009 13:24:39 +0000 (15:24 +0200)
committerJohannes Berg <johannes@sipsolutions.net>
Tue, 5 May 2009 13:24:39 +0000 (15:24 +0200)
mesh.c
mpath.c
reg.c
station.c

diff --git a/mesh.c b/mesh.c
index df43465429b5bd10acc6e28641e552067b10cd94..624ec379c3182d807d6f3dfd46431ef0d058444a 100644 (file)
--- a/mesh.c
+++ b/mesh.c
@@ -244,7 +244,8 @@ static int set_interface_meshparam(struct nl80211_state *state,
 }
 
 COMMAND(set, mesh_param, "<param> <value>",
-       NL80211_CMD_SET_MESH_PARAMS, 0, CIB_NETDEV, set_interface_meshparam, NULL);
+       NL80211_CMD_SET_MESH_PARAMS, 0, CIB_NETDEV, set_interface_meshparam,
+       "Set mesh parameter (run command without any to see available ones).");
 
 /* Getter */
 static int print_mesh_param_handler(struct nl_msg *msg, void *arg)
@@ -290,4 +291,5 @@ static int get_interface_meshparam(struct nl80211_state *state,
 }
 
 COMMAND(get, mesh_param, "<param>",
-       NL80211_CMD_GET_MESH_PARAMS, 0, CIB_NETDEV, get_interface_meshparam, NULL);
+       NL80211_CMD_GET_MESH_PARAMS, 0, CIB_NETDEV, get_interface_meshparam,
+       "Retrieve mesh parameter (run command without any to see available ones).");
diff --git a/mpath.c b/mpath.c
index 2a3dc0f1292ba639419ad75a3562a8766bd28afa..d590cfff52340665530af859e07c7c7b5bcb106a 100644 (file)
--- a/mpath.c
+++ b/mpath.c
@@ -123,9 +123,11 @@ static int handle_mpath_get(struct nl80211_state *state,
        return -ENOBUFS;
 }
 COMMAND(mpath, get, "<MAC address>",
-       NL80211_CMD_GET_MPATH, 0, CIB_NETDEV, handle_mpath_get, NULL);
+       NL80211_CMD_GET_MPATH, 0, CIB_NETDEV, handle_mpath_get,
+       "Get information on mesh path to the given node.");
 COMMAND(mpath, del, "<MAC address>",
-       NL80211_CMD_DEL_MPATH, 0, CIB_NETDEV, handle_mpath_get, NULL);
+       NL80211_CMD_DEL_MPATH, 0, CIB_NETDEV, handle_mpath_get,
+       "Remove the mesh path to the given node.");
 
 static int handle_mpath_set(struct nl80211_state *state,
                            struct nl_cb *cb,
@@ -169,9 +171,11 @@ static int handle_mpath_set(struct nl80211_state *state,
        return -ENOBUFS;
 }
 COMMAND(mpath, new, "<destination MAC address> next_hop <next hop MAC address>",
-       NL80211_CMD_NEW_MPATH, 0, CIB_NETDEV, handle_mpath_set, NULL);
+       NL80211_CMD_NEW_MPATH, 0, CIB_NETDEV, handle_mpath_set,
+       "Create a new mesh path (instead of relying on automatic discovery).");
 COMMAND(mpath, set, "<destination MAC address> next_hop <next hop MAC address>",
-       NL80211_CMD_SET_MPATH, 0, CIB_NETDEV, handle_mpath_set, NULL);
+       NL80211_CMD_SET_MPATH, 0, CIB_NETDEV, handle_mpath_set,
+       "Set an existing mesh path's next hop.");
 
 static int handle_mpath_dump(struct nl80211_state *state,
                             struct nl_cb *cb,
@@ -182,4 +186,5 @@ static int handle_mpath_dump(struct nl80211_state *state,
        return 0;
 }
 COMMAND(mpath, dump, NULL,
-       NL80211_CMD_GET_MPATH, NLM_F_DUMP, CIB_NETDEV, handle_mpath_dump, NULL);
+       NL80211_CMD_GET_MPATH, NLM_F_DUMP, CIB_NETDEV, handle_mpath_dump,
+       "List known mesh paths.");
diff --git a/reg.c b/reg.c
index b336471f42c0787fbd0f472ce4289aca6a7bf651..a6bd74c5502272d41500d032f89952bf9cff1c08 100644 (file)
--- a/reg.c
+++ b/reg.c
@@ -91,7 +91,8 @@ static int handle_reg_set(struct nl80211_state *state,
        return -ENOBUFS;
 }
 COMMAND(reg, set, "<ISO/IEC 3166-1 alpha2>",
-       NL80211_CMD_REQ_SET_REG, 0, CIB_NONE, handle_reg_set, NULL);
+       NL80211_CMD_REQ_SET_REG, 0, CIB_NONE, handle_reg_set,
+       "Notify the kernel about the current regulatory domain.");
 
 static int print_reg_handler(struct nl_msg *msg, void *arg)
 
@@ -184,4 +185,5 @@ static int handle_reg_get(struct nl80211_state *state,
        nl_cb_set(cb, NL_CB_VALID, NL_CB_CUSTOM, print_reg_handler, NULL);
        return 0;
 }
-COMMAND(reg, get, NULL, NL80211_CMD_GET_REG, 0, CIB_NONE, handle_reg_get, NULL);
+COMMAND(reg, get, NULL, NL80211_CMD_GET_REG, 0, CIB_NONE, handle_reg_get,
+       "Print out the kernel's current regulatory domain information.");
index f18f3ea1f95b8aefa14ce3518d147177330b1c46..b8e9c7916c358259174c7b2dca9996c6c755e665 100644 (file)
--- a/station.c
+++ b/station.c
@@ -188,9 +188,11 @@ static int handle_station_get(struct nl80211_state *state,
        return -ENOBUFS;
 }
 COMMAND(station, get, "<MAC address>",
-       NL80211_CMD_GET_STATION, 0, CIB_NETDEV, handle_station_get, NULL);
+       NL80211_CMD_GET_STATION, 0, CIB_NETDEV, handle_station_get,
+       "Get information for a specific station.");
 COMMAND(station, del, "<MAC address>",
-       NL80211_CMD_DEL_STATION, 0, CIB_NETDEV, handle_station_get, NULL);
+       NL80211_CMD_DEL_STATION, 0, CIB_NETDEV, handle_station_get,
+       "Remove the given station entry (use with caution!)");
 
 static int handle_station_set(struct nl80211_state *state,
                              struct nl_cb *cb,
@@ -237,7 +239,8 @@ static int handle_station_set(struct nl80211_state *state,
        return -ENOBUFS;
 }
 COMMAND(station, set, "<MAC address> plink_action <open|block>",
-       NL80211_CMD_SET_STATION, 0, CIB_NETDEV, handle_station_set, NULL);
+       NL80211_CMD_SET_STATION, 0, CIB_NETDEV, handle_station_set,
+       "Set mesh peer link action for this station (peer).");
 
 static int handle_station_dump(struct nl80211_state *state,
                               struct nl_cb *cb,
@@ -248,4 +251,5 @@ static int handle_station_dump(struct nl80211_state *state,
        return 0;
 }
 COMMAND(station, dump, NULL,
-       NL80211_CMD_GET_STATION, NLM_F_DUMP, CIB_NETDEV, handle_station_dump, NULL);
+       NL80211_CMD_GET_STATION, NLM_F_DUMP, CIB_NETDEV, handle_station_dump,
+       "List all stations known, e.g. the AP on managed interfaces");