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


-- | Install Haskell software
--   
--   This is a tool for deploying software projects into directory
--   structures suitable for installation on a system. It builds upon the
--   `stack install` command and adds more features. It's also a tool for
--   easier AppImage creation.
@package hsinstall
@version 2.7


-- | Deployed file location support library for software deployed with the
--   hsinstall utility. Or, really, anything that roughly follows an
--   FHS-like deployment structure.
module HSInstall.Paths

-- | Get a path to the share directory relative to the binary location. The
--   argument passed here is expected to be the output of
--   <tt>getDataDir</tt> generated by Cabal at compile time in the
--   <tt>Paths_PROJECTNAME</tt> module.
--   
--   Usage:
--   
--   <pre>
--   import HSInstall.Paths ( getShareDir )
--   import Paths_PROJECTNAME ( getDataDir )
--   
--   shareDir &lt;- getShareDir getDataDir
--   
--   </pre>
--   
--   If your binary is at <tt>/foo/bar/usr/bin/BINARY</tt>, this library
--   will generate this path: <tt>/foo/bar/usr/share/PROJECTNAME</tt>
getShareDir :: IO FilePath -> IO FilePath