summaryrefslogtreecommitdiff
path: root/dev-haskell/options/metadata.xml
diff options
context:
space:
mode:
Diffstat (limited to 'dev-haskell/options/metadata.xml')
-rw-r--r--dev-haskell/options/metadata.xml55
1 files changed, 0 insertions, 55 deletions
diff --git a/dev-haskell/options/metadata.xml b/dev-haskell/options/metadata.xml
index e04b15e7a127..3d015d9cde4c 100644
--- a/dev-haskell/options/metadata.xml
+++ b/dev-haskell/options/metadata.xml
@@ -5,61 +5,6 @@
<email>haskell@gentoo.org</email>
<name>Gentoo Haskell</name>
</maintainer>
- <longdescription>
- The @options@ package lets library and application developers easily work
- with command-line options.
-
- The following example is a full program that can accept two options,
- @--message@ and @--quiet@:
-
- @
- import Control.Applicative
- import Options
-
- data MainOptions = MainOptions
- &amp;#x20; &amp;#x7b; optMessage :: String
- &amp;#x20; , optQuiet :: Bool
- &amp;#x20; &amp;#x7d;
-
- instance 'Options' MainOptions where
- &amp;#x20; defineOptions = pure MainOptions
- &amp;#x20; \&lt;*\&gt; simpleOption \"message\" \"Hello world!\"
- &amp;#x20; \"A message to show the user.\"
- &amp;#x20; \&lt;*\&gt; simpleOption \"quiet\" False
- &amp;#x20; \"Whether to be quiet.\"
-
- main :: IO ()
- main = runCommand $ \\opts args -&gt; do
- &amp;#x20; if optQuiet opts
- &amp;#x20; then return ()
- &amp;#x20; else putStrLn (optMessage opts)
- @
-
- &gt;$ ./hello
- &gt;Hello world!
- &gt;$ ./hello --message='ciao mondo'
- &gt;ciao mondo
- &gt;$ ./hello --quiet
- &gt;$
-
- In addition, this library will automatically create documentation options
- such as @--help@ and @--help-all@:
-
- &gt;$ ./hello --help
- &gt;Help Options:
- &gt; -h, --help
- &gt; Show option summary.
- &gt; --help-all
- &gt; Show all help options.
- &gt;
- &gt;Application Options:
- &gt; --message :: text
- &gt; A message to show the user.
- &gt; default: "Hello world!"
- &gt; --quiet :: bool
- &gt; Whether to be quiet.
- &gt; default: false
- </longdescription>
<origin>gentoo-staging</origin>
</pkgmetadata> \ No newline at end of file