hii

 1.Dd $Mdocdate: March 15 2019 $
 2.Dt HII 5
 3.Os
 4.Sh NAME
 5.Nm hii
 6.Nd Output file format of the hii IRC client
 7.Sh DESCRIPTION
 8The
 9.Pa out
10files created by
11.Xr hii 1
12consist of newline separated records for IRC events, record fields are
13separated by an ASCII space character.
14The first field is a timestamp from Unix epoch at which the event was
15received.
16All other fields are essentially user controlled and differ for
17different kinds of IRC events.
18.Pp
19ASCII format codes as well as non-printable characters are removed from
20all IRC events.
21However,
22.Nm
23itself adds non-printable characters suffixes as the last character of a
24record to identify special classes of IRC events.
25The following ASCII suffixes are currently supported:
26.Bl -tag -width acknowledge-(0x06) -offset 2m
27.It acknowledge (0x06)
28The event is a
29.Em PRIVMSG
30or
31.Em NOTICE
32send by the own client.
33.It bell (0x07)
34The event is a
35.Em PRIVMSG
36either containing the user's nick or send directly to the user.
37.El
38.Pp
39The
40.Pa log
41file created by
42.Nm
43uses a similar format.
44In contrast to
45.Pa out
46files each record represents a
47.Em PRIVMSG
48and contains at least three field: A timestamp (see above), a channel
49where the event originated (enclosed in square brackets) and an event
50source (enclosed in parentheses).
51Additionally, the
52.Pa log
53file format does not use any special suffixes.
54.Sh EXAMPLES
55An example
56.Pa out
57file might looks as follows:
58.Bd -offset 2m -literal
591553375834 [*] bob (user.example.org) has joined #hii
601553375834 [*] topic for #hii is: hii - harmful ii - https://github.com/nmeum/hii
611553375873 (bob) hi!
621553354847 *** alice has kicked bob: important kick message
63.Ed
64.Pp
65An example
66.Pa log
67file might look as follows:
68.Bd -offset 2m -literal
691552167885 [#hii] (alice) bob: hi, how are you doing?
701552168459 [#hii] (alice) did anybody hear anything from bob recently?
711552317088 [bob] (carol) hi!
72.Ed
73.Sh SEE ALSO
74.Xr hii 1
75.Sh CAVEATS
76.Em NOTICE
77commands are not checked for mentions as they are mostly used by bots (e.g. NickServ).
78Highlighting requests for authentication et cetera is not deemed useful.