kernel: Fix a -Wundef warning.
[dragonfly.git] / libexec / talkd / talkd.8
blob836839fa40e06c6f68fc24e68e8088f7ee6dec27
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. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)talkd.8     8.2 (Berkeley) 12/11/93
29 .\" $FreeBSD: src/libexec/talkd/talkd.8,v 1.3.2.2 2001/08/16 10:44:21 ru Exp $
30 .\"
31 .Dd December 11, 1993
32 .Dt TALKD 8
33 .Os
34 .Sh NAME
35 .Nm talkd
36 .Nd remote user communication server
37 .Sh SYNOPSIS
38 .Nm
39 .Sh DESCRIPTION
40 .Nm Talkd
41 is the server that notifies a user that someone else wants to
42 initiate a conversation.
43 It acts as a repository of invitations, responding to requests
44 by clients wishing to rendezvous to hold a conversation.
45 In normal operation, a client, the caller,
46 initiates a rendezvous by sending a
47 .Tn CTL_MSG
48 to the server of
49 type
50 .Tn LOOK_UP
51 (see
52 .In protocols/talkd.h ) .
53 This causes the server to search its invitation
54 tables to check if an invitation currently exists for the caller
55 (to speak to the callee specified in the message).
56 .Pp
57 If the lookup fails,
58 the caller then sends an
59 .Tn ANNOUNCE
60 message causing the server to
61 broadcast an announcement on the callee's login ports requesting contact.
62 .Pp
63 When the callee responds, the local server uses the
64 recorded invitation to respond with the appropriate rendezvous
65 address and the caller and callee client programs establish a
66 stream connection through which the conversation takes place.
67 .Sh SEE ALSO
68 .Xr talk 1 ,
69 .Xr write 1
70 .Sh HISTORY
71 The
72 .Nm
73 command appeared in
74 .Bx 4.3 .