irc-ctcp: A CTCP encoding and decoding library for IRC clients.

[ library, mit, network ] [ Propose Tags ]

CTCP (Client To Client Protocol) is a way of sending arbitrary data over an IRC network, which may include bytes not allowed in standard IRC messages. CTCPs are sent as a PRIVMSG or NOTICE, where the first and last characters as \001 (SOH), and special bytes are escaped by encoding them into a two-byte sequence beginning with \020 (DLE). CTCPs consist of command name (typically in upper-case) followed by list of space-separated arguments, which may be empty.

One use of CTCPs supported by the vast majority of IRC clients today is the ACTION command, typically invoked with /me. For example, if the user foo in the channel #bar were to issue

/me dances

everyone in the channel would receive the message

:foo PRIVMSG #bar :\001ACTION dances\001

Other common uses of CTCP include requesting the name and version of a user's IRC client, their local time, determining ping times, and initiating file transfers (DCC).

Characters are escaped as follows:

\000 (NUL)
\020 \060 ("0")
\012 (NL)
\020 \156 ("n")
\015 (CR)
\020 \162 ("r")
\020 (DLE)
\020 \020

All other appearences of the escape character are errors, and are dropped.

See for more details.

Versions [faq],,,,
Change log
Dependencies base (>=4.7 && <5), bytestring (>=0.10), text (>=1.1) [details]
License LicenseRef-OtherLicense
Author Michael Walker
Revised Revision 1 made by barrucadu at 2014-09-04T16:56:49Z
Category Network
Home page
Uploaded by barrucadu at 2014-09-01T21:14:52Z
Distributions LTSHaskell:, NixOS:, Stackage:
Downloads 4372 total (9 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]




Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees