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


-- | A Haskell library to make self-extracting executables
--   
--   A Haskell library to make self-extracting executables.
@package self-extract
@version 0.2.1


-- | Defines utilities for creating/extracting TAR archives.
--   
--   These functions shell out to the <a>tar</a> process because Haskell
--   packages that implement Tar would need some C header files, which we
--   don't want to require on the user end.
module Codec.SelfExtract.Tar

-- | Zip the given directory into the given archive.
tar :: Path b0 Dir -> Path b1 File -> IO ()

-- | Extract the given archive to the given directory.
untar :: Path b0 File -> Path b1 Dir -> IO ()


-- | Defines functions that should be used in the <tt>Setup.hs</tt> file.
module Codec.SelfExtract.Distribution

-- | Bundle the given directory into the executable with the given name.
--   
--   For example, to bundle the <tt>static/</tt> directory in the
--   executable named <tt>install-files</tt>:
--   
--   <pre>
--   main = defaultMainWithHooks simpleUserHooks
--     { postCopy = args cf pd lbi -&gt; do
--         postCopy simpleUserHooks args cf pd lbi
--         bundle "install-files" "./static/" lbi
--     }
--   </pre>
bundle :: String -> FilePath -> LocalBuildInfo -> IO ()

-- | Same as <a>bundle</a>, except using the <a>Path</a> library.
--   
--   <pre>
--   main = defaultMainWithHooks simpleUserHooks
--     { postCopy = args cf pd lbi -&gt; do
--         postCopy simpleUserHooks args cf pd lbi
--         bundle' "install-files" [reldir|./static/|] lbi
--     }
--   </pre>
bundle' :: String -> Path b Dir -> LocalBuildInfo -> IO ()


-- | Defines functions that should be used in a self-extractable
--   executable.
module Codec.SelfExtract

-- | Extract the self-bundled executable to the given path.
--   
--   <pre>
--   extractTo "dir"  -- will extract to $CWD/dir
--   extractTo "/usr/local/lib"
--   </pre>
extractTo :: FilePath -> IO ()

-- | Extract the self-bundled executable to a temporary path.
--   
--   <pre>
--   withExtractToTemp $ tmp -&gt; do
--     ...
--   </pre>
withExtractToTemp :: (FilePath -> IO ()) -> IO ()

-- | Same as <a>extractTo</a>, except using the <a>Path</a> library.
--   
--   <pre>
--   extractTo' [reldir|dir|]  -- will extract to $CWD/dir
--   extractTo' [absdir|/usr/local/lib|]
--   </pre>
extractTo' :: Path b Dir -> IO ()

-- | Same as <a>withExtractToTemp</a>, except using the <a>Path</a>
--   library.
withExtractToTemp' :: (Path Abs Dir -> IO ()) -> IO ()