summaryrefslogtreecommitdiff
path: root/doc/source/command-options.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/command-options.rst')
-rw-r--r--doc/source/command-options.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/source/command-options.rst b/doc/source/command-options.rst
index 5cb84684..6260ec32 100644
--- a/doc/source/command-options.rst
+++ b/doc/source/command-options.rst
@@ -14,6 +14,12 @@ for defining and using options in all situations. The alternative of only
using it when necessary leads to errors when copy-n-paste is used for a
new command without understanding why or why not that instance is correct.
+The :doc:`Human Interface Guide <humaninterfaceguide>`
+describes the guildelines for option names and usage. In short:
+ * All option names shall be GNU-style long names (two leading dashes).
+ * Some global options may have short nmaes, generally limited to those defined
+ in support libraries such as ``cliff``.
+
General Command Options
=======================