summaryrefslogtreecommitdiff
path: root/docs/users_guide
diff options
context:
space:
mode:
authorJan Stolarek <jan.stolarek@p.lodz.pl>2013-06-07 09:15:32 +0200
committerIan Lynagh <ian@well-typed.com>2013-06-13 20:49:37 +0100
commit2280f9651ea4f08d8d7c29affbb134d6769e42e0 (patch)
tree20a0760afa6b410b0474992249eebc9098347b5f /docs/users_guide
parenta532f40f8575eaa384ed569d7584165503f6e9d4 (diff)
downloadhaskell-2280f9651ea4f08d8d7c29affbb134d6769e42e0.tar.gz
--show-options lists all flags. Add user documentation for #7843
Diffstat (limited to 'docs/users_guide')
-rw-r--r--docs/users_guide/flags.xml6
-rw-r--r--docs/users_guide/using.xml12
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/users_guide/flags.xml b/docs/users_guide/flags.xml
index 5366360f37..e034cd7311 100644
--- a/docs/users_guide/flags.xml
+++ b/docs/users_guide/flags.xml
@@ -60,6 +60,12 @@
<entry>-</entry>
</row>
<row>
+ <entry><option>&ndash;&ndash;show-options</option></entry>
+ <entry>display the supported command line options</entry>
+ <entry>mode</entry>
+ <entry>-</entry>
+ </row>
+ <row>
<entry><option>&ndash;&ndash;info</option></entry>
<entry>display information about the compiler</entry>
<entry>mode</entry>
diff --git a/docs/users_guide/using.xml b/docs/users_guide/using.xml
index 9c6fbf714a..1453e73087 100644
--- a/docs/users_guide/using.xml
+++ b/docs/users_guide/using.xml
@@ -473,6 +473,18 @@ module X where
<varlistentry>
<term>
<cmdsynopsis>
+ <command>ghc --show-options</command>
+ </cmdsynopsis>
+ <indexterm><primary><option>&ndash;&ndash;show-options</option></primary></indexterm>
+ </term>
+ <listitem>
+ <para>Print the supported command line options. This flag can be used for autocompletion in a shell.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <cmdsynopsis>
<command>ghc --info</command>
</cmdsynopsis>
<indexterm><primary><option>&ndash;&ndash;info</option></primary></indexterm>