A manual page for wrapper(1) has been added.
[iii.git] / wrapper.1
blobd3414031831f9d147653af9f7c5a406ca5d59f7d
1 .Dd $Mdocdate$
2 .Dt WRAPPER 1
3 .Os
4 .Sh NAME
5 .Nm wrapper
6 .Nd wraps
7 .Xr ii 1
8 and allows execution on connect.
9 .Sh SYNOPSIS
10 .Nm
11 .Op Fl i Ar ii arg
12 .Op Fl s Ar sh arg
13 .Ar -- host1 port1
14 .Op Ar host2 port2 ...
15 .Sh DESCRIPTION
16 The
17 .Nm
18 utility randomly selects one pair of
19 .Ar hosts
20 and
21 .Ar ports
22 before it passes the pair as arguments to
23 .Xr ii 1 
24 using
25 .Xr system 3 .
26 Additional arguments can be given to
27 .Xr ii 1
28 by specifying them in
29 .Ar ii arg .
30 In case
31 .Xr ii 1
32 exits, this procedure is done all over again.
35 .Ar sh arg
36 is given,
37 .Nm
38 forks and then initializes
39 .Xr ii 1 .
40 The child process sleeps for 60 seconds (default) before passing
41 .Ar sh arg
43 .Xr system 3 .
44 This is useful in order to, for example, authenticate with NickServ or rejoin
45 IRC channels after a disconnection.
46 .Sh SEE ALSO
47 .Xr ii 1 ,
48 .Xr sh 1 ,
49 .Xr fork 3 ,
50 .Xr sleep 3 ,
51 .Xr system 3
52 .Sh CAVEATS
53 Notice that
54 .Xr sh 1
55 meta-characters must be escaped in both
56 .Ar ii arg
57 and
58 .Ar sh arg
59 and that the
60 .Fl s
61 and
62 .Fl p
63 flags of
64 .Xr ii 1
65 have no effect in
66 .Ar ii arg .
68 To prevent
69 .Xr ii 1
70 from choosing different server directories as connections are made to various
71 .Ar hosts ,
72 pass it the
73 .Fl d
74 flag. The argument of the flag will override this part of the file path.