Better prompt
[iomenu.git] / io-ii.1
blob47d4a99c0af3089a095dbbbabc11881a2d2d0e5d
1 .Dd $Mdocdate: October 30 2016$
2 .Dt IO-II 1
3 .Os
4 .Sh NAME
6 .Nm io-ii
7 .Nd ii wrapper script using iomenu
9 .Sh SYNOPSIS
11 .Nm io-ii
13 .Sh DESCRIPTION
15 .Nm
16 is an interactive interface for the ii irc client.  It handles multiple
17 channel, keybindings, and prevent input from being mixed with the output.
18 .Pp
19 Simply launch it, follow what is prompted, and it should work.
20 .Pp
21 This is an interactive interface for the
22 .Xr ii 1
23 irc client using
24 .Xr iomenu 1
25 to switch channel and connect to server.
26 .Pp
27 It then require the
28 .Xr ii 1
29 binary - the back-end - that you can replace with any FIFO-based chat client,
30 that has the following file structure:
32 .Bd -literal
33 ~/.cache/irc        default root directory
34
35 ├ irc.freenode.net  managed by "ii -s irc.freenode.net"
36 │ │
37 │ ├ #emacs          channel directory
38 │ │ ├ in
39 │ │ └ out           where you get log from #emacs
40 │ │
41 │ └ #vim
42 │   ├ in            where to write messages to #vim
43 │   └ out
44
45 └ irc.oftc.net      managed by "ii -s irc.oftc.net"
46   │
47   └ #suckless
48     ├ in            FIFO file descriptor aka a named pipe
49     └ out           regular file
50 .Ed
51 .Pp
52 One ii command has to be started per server, and every instance will keep
53 running in the background, so you can quit the interface and keep ii running,
54 and come back later, without interrupting the connection.
55 .Pp
56 The supported irc commands are those supported by
57 .Xr ii 1
58 so you can refer to its manual.
60 .Sh KEY BINDINGS
62 .Bl -tag
63 .It Ctrl + N/P
64 Prompt for another channel to switch to.
65 .It Ctrl + S
66 Prompt for a server.
67 .It Ctrl + C
68 Quit the interface, but not the ii instances.
69 .It Ctrl + M
70 .It Enter
71 Send a message to current channel
73 .It Ctrl + L
74 Open the current channel in a pager.
76 .It Ctrl + U
77 Clear current input.
79 .It Ctrl + W
80 Clear last word from current input.
81 .El
83 .Sh SEE ALSO
85 .Xr ii 1
86 .Xr iomenu 1
88 .Sh AUTHORS
90 .Nm io-ii
91 is made by
92 .An Josuah Demangeon Aq mail@josuah.net