glirc-2.37: Console IRC client

Copyright(c) Eric Mertens 2016
LicenseISC
Maintaineremertens@gmail.com
Safe HaskellNone
LanguageHaskell2010

Client.Configuration

Contents

Description

This module defines the top-level configuration information for the client.

Synopsis

Configuration type

data Configuration Source #

Top-level client configuration information. When connecting to a server configuration from _configServers is used where possible, otherwise _configDefaults is used.

Constructors

Configuration 

Fields

data ConfigurationFailure Source #

Failure cases when loading a configuration file.

Constructors

ConfigurationReadFailed String

Error message from reading configuration file

ConfigurationParseFailed FilePath String

Error message from parser or lexer

ConfigurationMalformed FilePath String

Error message from loading parsed configuration

data LayoutMode Source #

Constructors

OneColumn

Vertically stack all windows in a single column

TwoColumn

Vertically stack extra windows in a second column

Instances
Show LayoutMode Source # 
Instance details

Defined in Client.Configuration

data PaddingMode Source #

Setting for how to pad the message prefix.

Constructors

LeftPadding !Int

Whitespace add to the left side of chat prefix

RightPadding !Int

Whitespace add to the right side of chat prefix

NoPadding

No whitespace added

Instances
Show PaddingMode Source # 
Instance details

Defined in Client.Configuration

data ExtensionConfiguration Source #

Configuration information for run-time loaded dynamic library extensions.

Constructors

ExtensionConfiguration 

Fields

Lenses

Loading configuration

loadConfiguration Source #

Arguments

:: Maybe FilePath

path to configuration file

-> IO (Either ConfigurationFailure (FilePath, Configuration)) 

Load the configuration file defaulting to ~.glircconfig.

Given configuration path is optional and actual path used will be returns on success

Resolving paths

getConfigPath :: IO FilePath Source #

Uses getXdgDirectory XdgConfig to find ~.configglirc/config

Specification

FilePath resolution

newFilePathContext Source #

Arguments

:: FilePath

configuration file path

-> IO FilePathContext