-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | run a subprocess, combining stdout and stderr
--   
--   Execute a command, redirect stderr into stdout, and return the
--   combined result (optionally, with a timeout). Irritatingly difficult
--   to do using the "process" library.
@package plex
@version 0.2.0.0


-- | Generic versions of <a>cmd</a>, <a>cmdTimeout</a> etc
module System.Plex.Internal

-- | wrapped executeFile that reports error
executeFile' :: FilePath -> Bool -> [String] -> Maybe [(String, String)] -> IO ()

-- | <tt>readCommand command args</tt>: given a <i>command</i> to run in a
--   subprocess, and <i>args</i> to pass to it -- return the childPid of
--   the subprocess, and a function for reading its output.
--   
--   if it doesn't start with a forward-slash, the <i>command</i> is
--   searched for in the current path.
readCommand :: FilePath -> [String] -> IO (ProcessID, IO String)

-- | More general version of <a>readCommand_</a>. First arg is a function
--   to read from the combined stdout/stderr handle.
readCommand_ :: NFData a => (Handle -> IO a) -> FilePath -> [String] -> IO (ProcessID, IO a)

-- | <tt>cmd command args</tt>: execute <i>command</i> with <i>args</i>;
--   read combined stdout and stderr; return it as a string If there is an
--   error executing the command, it'll get caught and a Haskell error
--   message will get printed.
cmd :: FilePath -> [String] -> IO String

-- | more general version of <a>cmd</a>.
cmd_ :: NFData b => (Handle -> IO b) -> FilePath -> [String] -> IO b

-- | same as command, but with a timeout. Hard to get it do return nicely
--   with timeout &lt; about 10^5 microsecs
cmdTimeout :: FilePath -> [String] -> Int -> IO (Maybe String)

-- | more general version of <a>cmdTimeout</a>.
cmdTimeout_ :: NFData a => (Handle -> IO a) -> FilePath -> [String] -> Int -> IO (Maybe a)


-- | Execute a command, redirect stderr into stdout, and return the
--   combined result (optionally, with a timeout).
module System.Plex.ByteString

-- | <tt>readCommand command args</tt>: given a <i>command</i> to run in a
--   subprocess, and <i>args</i> to pass to it -- return the childPid of
--   the subprocess, and a function for reading its output.
--   
--   if it doesn't start with a forward-slash, the <i>command</i> is
--   searched for in the current path.
readCommand :: FilePath -> [String] -> IO (ProcessID, IO ByteString)

-- | <tt>cmd command args</tt>: execute <i>command</i> with <i>args</i>;
--   read combined stdout and stderr; return it as a string If there is an
--   error executing the command, it'll get caught and a Haskell error
--   message will get printed.
cmd :: FilePath -> [String] -> IO ByteString

-- | same as command, but with a timeout. Hard to get it do return nicely
--   with timeout &lt; about 10^5 microsecs
cmdTimeout :: FilePath -> [String] -> Int -> IO (Maybe ByteString)


-- | Execute a command, redirect stderr into stdout, and return the
--   combined result (optionally, with a timeout).
module System.Plex

-- | <tt>readCommand command args</tt>: given a <i>command</i> to run in a
--   subprocess, and <i>args</i> to pass to it -- return the childPid of
--   the subprocess, and a function for reading its output.
--   
--   if it doesn't start with a forward-slash, the <i>command</i> is
--   searched for in the current path.
readCommand :: FilePath -> [String] -> IO (ProcessID, IO String)

-- | <tt>cmd command args</tt>: execute <i>command</i> with <i>args</i>;
--   read combined stdout and stderr; return it as a string If there is an
--   error executing the command, it'll get caught and a Haskell error
--   message will get printed.
cmd :: FilePath -> [String] -> IO String

-- | same as command, but with a timeout. Hard to get it do return nicely
--   with timeout &lt; about 10^5 microsecs
cmdTimeout :: FilePath -> [String] -> Int -> IO (Maybe String)