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


-- | Haskell tldr client
--   
--   Haskell tldr client with support for viewing tldr pages. Has offline
--   cache for accessing pages. Visit <a>https://tldr.sh</a> for more
--   details.
@package tldr
@version 0.9.2

module Tldr.App.Constant
tldrDirName :: String
pagesUrl :: String
checkDirs :: [String]
platformDirs :: [String]

module Tldr.Parser

-- | Parses '{{foo}}' blocks in CommonMark Code, such that:
--   
--   <ul>
--   <li>`ls {{foo}} bar` -&gt; `[Left "ls ", Right "foo", Left "
--   bar"]`</li>
--   </ul>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly codeParser ""
--   Right []
--   
--   &gt;&gt;&gt; parseOnly codeParser "tar"
--   Right [Left "tar"]
--   
--   &gt;&gt;&gt; parseOnly codeParser "tar{"
--   Right [Left "tar{"]
--   
--   &gt;&gt;&gt; parseOnly codeParser "tar{{"
--   Right [Left "tar{{"]
--   
--   &gt;&gt;&gt; parseOnly codeParser "tar{{{"
--   Right [Left "tar{{{"]
--   
--   &gt;&gt;&gt; parseOnly codeParser "tar}"
--   Right [Left "tar}"]
--   
--   &gt;&gt;&gt; parseOnly codeParser "tar{{{b}"
--   Right [Left "tar{{{b}"]
--   
--   &gt;&gt;&gt; parseOnly codeParser "tar{{{b}}"
--   Right [Left "tar",Right "{b"]
--   
--   &gt;&gt;&gt; parseOnly codeParser "tar{{b}}}"
--   Right [Left "tar",Right "b}"]
--   
--   &gt;&gt;&gt; parseOnly codeParser "tar xf {{source.tar[.gz|.bz2|.xz]}} --directory={{directory}}"
--   Right [Left "tar xf ",Right "source.tar[.gz|.bz2|.xz]",Left " --directory=",Right "directory"]
--   </pre>
codeParser :: Parser [Either Text Text]

-- | Collect both Lefts and Rights, mappending them to zore or one item per
--   connected sublist.
--   
--   <pre>
--   &gt;&gt;&gt; collectEither []
--   []
--   
--   &gt;&gt;&gt; collectEither [Right "abc", Right "def", Left "x", Left "z", Right "end"]
--   [Right "abcdef",Left "xz",Right "end"]
--   
--   &gt;&gt;&gt; collectEither [Right "", Right "def", Left "x", Left "", Right ""]
--   [Right "def",Left "x"]
--   </pre>
collectEither :: (Eq a, Eq b, Monoid a, Monoid b) => [Either a b] -> [Either a b]

-- | Peek 2 characters, not consuming any input.
peek2Chars :: Parser (Maybe Char, Maybe Char)

module Tldr.Types
data Locale
English :: Locale
Missing :: Locale
Other :: String -> Locale
Unknown :: String -> Locale
data ColorSetting
NoColor :: ColorSetting
UseColor :: ColorSetting
data ConsoleSetting
ConsoleSetting :: Bool -> Underlining -> BlinkSpeed -> ColorIntensity -> Color -> ColorIntensity -> ConsoleIntensity -> ConsoleSetting
[italic] :: ConsoleSetting -> Bool
[underline] :: ConsoleSetting -> Underlining
[blink] :: ConsoleSetting -> BlinkSpeed
[fgIntensity] :: ConsoleSetting -> ColorIntensity
[fgColor] :: ConsoleSetting -> Color
[bgIntensity] :: ConsoleSetting -> ColorIntensity
[consoleIntensity] :: ConsoleSetting -> ConsoleIntensity
data TldrOpts
TldrOpts :: TldrCommand -> Maybe Int -> Maybe ColorSetting -> TldrOpts
[tldrAction] :: TldrOpts -> TldrCommand
[autoUpdateInterval] :: TldrOpts -> Maybe Int
[colorSetting] :: TldrOpts -> Maybe ColorSetting
data TldrCommand
UpdateIndex :: TldrCommand
ViewPage :: ViewOptions -> [String] -> TldrCommand
About :: TldrCommand
data ViewOptions
ViewOptions :: Maybe String -> Maybe String -> ViewOptions
[platformOption] :: ViewOptions -> Maybe String
[languageOption] :: ViewOptions -> Maybe String
instance GHC.Enum.Bounded Tldr.Types.ColorSetting
instance GHC.Enum.Enum Tldr.Types.ColorSetting
instance GHC.Classes.Ord Tldr.Types.ColorSetting
instance GHC.Show.Show Tldr.Types.ColorSetting
instance GHC.Classes.Eq Tldr.Types.ColorSetting
instance GHC.Classes.Ord Tldr.Types.ViewOptions
instance GHC.Classes.Eq Tldr.Types.ViewOptions
instance GHC.Show.Show Tldr.Types.ViewOptions
instance GHC.Classes.Ord Tldr.Types.TldrCommand
instance GHC.Classes.Eq Tldr.Types.TldrCommand
instance GHC.Show.Show Tldr.Types.TldrCommand
instance GHC.Show.Show Tldr.Types.TldrOpts

module Tldr
parsePage :: FilePath -> IO Node
renderPage :: FilePath -> Handle -> ColorSetting -> IO ()
data ConsoleSetting
ConsoleSetting :: Bool -> Underlining -> BlinkSpeed -> ColorIntensity -> Color -> ColorIntensity -> ConsoleIntensity -> ConsoleSetting
[italic] :: ConsoleSetting -> Bool
[underline] :: ConsoleSetting -> Underlining
[blink] :: ConsoleSetting -> BlinkSpeed
[fgIntensity] :: ConsoleSetting -> ColorIntensity
[fgColor] :: ConsoleSetting -> Color
[bgIntensity] :: ConsoleSetting -> ColorIntensity
[consoleIntensity] :: ConsoleSetting -> ConsoleIntensity
defConsoleSetting :: ConsoleSetting
headingSetting :: ConsoleSetting
toSGR :: ColorSetting -> ConsoleSetting -> [SGR]
renderNode :: NodeType -> ColorSetting -> Handle -> IO ()
changeConsoleSetting :: ColorSetting -> NodeType -> IO ()

module Tldr.App.Handler
handleAboutFlag :: IO ()
retriveLocale :: IO Locale
checkLocale :: Locale -> Bool
englishViewOptions :: ViewOptions -> ViewOptions
getCheckDirs :: ViewOptions -> [String]
pageExists :: FilePath -> IO (Maybe FilePath)
getPagePath :: Locale -> String -> [String] -> IO (Maybe FilePath)
updateTldrPages :: IO ()
handleTldrOpts :: TldrOpts -> IO ()

module Tldr.App
appMain :: IO ()
