prefix ethtool attributes with "link-" to be compatible with

[mirror_ifupdown2.git] / man.rst / ifquery.8.rst

diff --git a/man.rst/ifquery.8.rst b/man.rst/ifquery.8.rst
index 8a09838be0d1dcb12379ce0c1cda7e44947a9a3d..1ed793969330fb89e0770fd0b93a47212a1ed83e 100644 (file)
--- a/man.rst/ifquery.8.rst
+++ b/man.rst/ifquery.8.rst
@@ -6,16 +6,12 @@ ifquery
 query network interface configuration
 -------------------------------------
 
-:Author: roopa@cumulusnetworks.com
+:Author: Roopa Prabhu <roopa@cumulusnetworks.com>
 :Date:   2014-02-05
 :Copyright: Copyright 2014 Cumulus Networks, Inc.  All rights reserved.
 :Version: 0.1
 :Manual section: 8
 
-NAME
-====
-    **ifquery** - query interface configuration
-
 SYNOPSIS
 ========
 
@@ -36,7 +32,8 @@ DESCRIPTION
     in **/etc/network/interfaces** file.
 
     **ifquery** always works on the current **interfaces(5)** file
-    **/etc/network/interfaces**.
+    **/etc/network/interfaces** unless an alternate interfaces file is
+    provided with the **-i** option.
 
 OPTIONS
 =======
@@ -65,13 +62,24 @@ OPTIONS
                           Exclude interfaces from the list of interfaces to
                           operate on. Can be specified multiple times
 
+    -i INTERFACESFILE, --interfaces INTERFACESFILE
+                          Use interfaces file instead of default
+                          /etc/network/interfaces
+
     -r, --running         print raw interfaces file entries
 
     -c, --check           check interface file contents against running state
                           of an interface. Returns exit code 0 on success and
                           1 on error
 
-    -p, --print-dependency {list,dot} print iface dependency in list or dot format
+    -x, --raw             print raw config file entries
+
+
+    -o {native,json}, --format {native,json}
+                          interface display format
+
+    -p, --print-dependency {list,dot}
+                          print iface dependency in list or dot format
 
     -s, --syntax-help     print supported interface config syntax. Scans all
                           addon modules and dumps supported syntax from them
@@ -126,6 +134,12 @@ EXAMPLES
 
         (The above command only works on a system with dot installed)
 
+KNOWN_ISSUES
+============
+    **ifquery --check** is currently experimental
+
+    **ifquery --check** cannot validate usercommands given under pre-up, post-up etc
+    There is currently no support to check/validate ethtool iface attributes
 
 SEE ALSO
 ========