Modulecmdargs-0.10.22Haskell2010

System.Console.CmdArgs.Helper

Module for implementing CmdArgs helpers. A CmdArgs helper is an external program, that helps a user construct the command line arguments. To use a helper set the environment variable $CMDARGS_HELPER (or $CMDARGS_HELPER_YOURPROGRAM) to one of:

echo foo will cause foo to be used as the command arguments.
cmdargs-browser will cause a web browser to appear to help entering the arguments. For this command to work, you will need to install the cmdargs-browser package: http://hackage.haskell.org/package/cmdargs-browser

Contents

Called by the main program
Called by the helper program

Synopsis

value execute
newtype Unknown
value receive
value reply
value comment

Packagecmdargs-0.10.22
Exports5
LanguageHaskell2010
LicenceBSD-3-Clause
SourceHelper.hs

Called by the main program

valueexecute

:: String
Name of the command to run, e.g. echo argument, cmdargs-browser
-> Mode a
Mode to run remotely
-> [String]
Initial set of command line flags (not supported by all helpers)
-> IO (Either String [String])
Either an error message, or a list of flags to use

Source#

Run a remote command line entry.

Called by the helper program

newtypenewtype Unknown

Source#

Unknown value, representing the values stored within the Mode structure. While the values are not observable, they behave identically to the original values.

valuereceive :: IO (Mode Unknown)

Source#

Receive information about the mode to display.

valuereply :: Either String [String] -> IO ()

Source#

Send a reply with either an error, or a list of flags to use. This function exits the helper program.

valuecomment :: String -> IO ()

Source#

Send a comment which will be displayed on the calling console, mainly useful for debugging.