Shape up asf to be better usable on DragonFly
[dragonfly.git] / libexec / talkd / talkd.8
1 .\" Copyright (c) 1983, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)talkd.8     8.2 (Berkeley) 12/11/93
33 .\" $FreeBSD: src/libexec/talkd/talkd.8,v 1.3.2.2 2001/08/16 10:44:21 ru Exp $
34 .\" $DragonFly: src/libexec/talkd/talkd.8,v 1.2 2003/06/17 04:27:08 dillon Exp $
35 .\"
36 .Dd December 11, 1993
37 .Dt TALKD 8
38 .Os
39 .Sh NAME
40 .Nm talkd
41 .Nd remote user communication server
42 .Sh SYNOPSIS
43 .Nm
44 .Sh DESCRIPTION
45 .Nm Talkd
46 is the server that notifies a user that someone else wants to
47 initiate a conversation.
48 It acts as a repository of invitations, responding to requests
49 by clients wishing to rendezvous to hold a conversation.
50 In normal operation, a client, the caller,
51 initiates a rendezvous by sending a
52 .Tn CTL_MSG
53 to the server of
54 type
55 .Tn LOOK_UP
56 (see
57 .Aq Pa protocols/talkd.h ) .
58 This causes the server to search its invitation
59 tables to check if an invitation currently exists for the caller
60 (to speak to the callee specified in the message).
61 .Pp
62 If the lookup fails,
63 the caller then sends an
64 .Tn ANNOUNCE
65 message causing the server to
66 broadcast an announcement on the callee's login ports requesting contact.
67 .Pp
68 When the callee responds, the local server uses the
69 recorded invitation to respond with the appropriate rendezvous
70 address and the caller and callee client programs establish a
71 stream connection through which the conversation takes place.
72 .Sh SEE ALSO
73 .Xr talk 1 ,
74 .Xr write 1
75 .Sh HISTORY
76 The
77 .Nm
78 command appeared in
79 .Bx 4.3 .