NetBSD/libexec/talkd/talkd.8

.\"	$NetBSD: talkd.8,v 1.11 2010/03/22 19:01:49 joerg Exp $
.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)talkd.8	8.2 (Berkeley) 12/11/93
.\"
.Dd March 23, 2004
.Dt NTALKD 8
.Os
.Sh NAME
.Nm ntalkd ,
.Nm talkd
.Nd remote user communication server
.Sh SYNOPSIS
.Nm
.Op Fl dl
.Sh DESCRIPTION
.Nm
is the server that notifies a user that someone else wants to
initiate a conversation.
It acts as a repository of invitations, responding to requests
by clients wishing to rendezvous to hold a conversation.
.Pp
In normal operation, a client, the caller,
initiates a rendezvous by sending a
.Tn CTL_MSG
to the server of
type
.Tn LOOK_UP
.Po
see
.In protocols/talkd.h
.Pc .
This causes the server to search its invitation
tables to check if an invitation currently exists for the caller
(to speak to the callee specified in the message).
If the lookup fails,
the caller then sends an
.Tn ANNOUNCE
message causing the server to
broadcast an announcement on the callee's login ports requesting contact.
.Pp
When the callee responds, the local server uses the
recorded invitation to respond with the appropriate rendezvous
address and the caller and callee client programs establish a
stream connection through which the conversation takes place.
.Sh OPTIONS
.Nm
supports the following options:
.Bl -tag -width 12345
.It Fl d
The
.Fl d
option turns on debugging logging.
.It Fl l
The
.Fl l
option turns on accounting logging for
.Nm
via the
.Xr syslogd 8
service.
.El
.Sh FILES
.Pa /usr/libexec/ntalkd
.Sh SEE ALSO
.Xr talk 1 ,
.Xr write 1 ,
.Xr syslog 3 ,
.Xr syslogd 8
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.3 .
.Pp
The original talkd program was coded improperly,
in a machine and byte-order dependent fashion.
When this was corrected, it required a protocol
change, which necessitated a different daemon to
handle it, thus
.Nm
or
.Qq new
talk daemon.
The old daemon has long since been removed,
but the detritus remain.
Use .In instead of .Aq Pa for header files. 2010-03-22 21:58:31 +03:00			`.\" $NetBSD: talkd.8,v 1.11 2010/03/22 19:01:49 joerg Exp $`
Merge in lite-2 1997-06-29 22:01:12 +04:00			`.\" Copyright (c) 1983, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22284, verified by myself. 2003-08-07 13:46:37 +04:00			`.\" 3. Neither the name of the University nor the names of its contributors`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
Merge in lite-2 1997-06-29 22:01:12 +04:00			`.\" @(#)talkd.8 8.2 (Berkeley) 12/11/93`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
Add FILES section to document where the daemon is. Add some paragraph breaks to make the man page more readable. Add the history of the talkd -> ntalkd change as I recall it to the HISTORY section. All of this to answer PR 13433 2004-03-24 08:32:42 +03:00			`.Dd March 23, 2004`
Fix the Document Title of manual page so it our official name (ntalkd). Install so first file installed matches this correct manual page name. (Both manual pages are still installed. And only ntalkd binary is installed. So no change.) 2008-09-27 08:41:20 +04:00			`.Dt NTALKD 8`
More and more .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Many more to come. 1999-03-22 21:25:43 +03:00			`.Os`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh NAME`
Add FILES section to document where the daemon is. Add some paragraph breaks to make the man page more readable. Add the history of the talkd -> ntalkd change as I recall it to the HISTORY section. All of this to answer PR 13433 2004-03-24 08:32:42 +03:00			`.Nm ntalkd ,`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Nm talkd`
			`.Nd remote user communication server`
			`.Sh SYNOPSIS`
Fix .Nm usage. 1997-10-20 06:53:32 +04:00			`.Nm`
- clean up some more cruft - support "talkd -l" for extra (syslog(3)) logging - fix error in previous announce.c change - use getopt - add (missing) -d and -l descriptions to man page 1998-07-04 23:31:05 +04:00			`.Op Fl dl`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh DESCRIPTION`
Fix .Nm usage. 1997-10-20 06:53:32 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`is the server that notifies a user that someone else wants to`
			`initiate a conversation.`
Merge in lite-2 1997-06-29 22:01:12 +04:00			`It acts as a repository of invitations, responding to requests`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`by clients wishing to rendezvous to hold a conversation.`
Add FILES section to document where the daemon is. Add some paragraph breaks to make the man page more readable. Add the history of the talkd -> ntalkd change as I recall it to the HISTORY section. All of this to answer PR 13433 2004-03-24 08:32:42 +03:00			`.Pp`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`In normal operation, a client, the caller,`
			`initiates a rendezvous by sending a`
			`.Tn CTL_MSG`
			`to the server of`
			`type`
			`.Tn LOOK_UP`
Add FILES section to document where the daemon is. Add some paragraph breaks to make the man page more readable. Add the history of the talkd -> ntalkd change as I recall it to the HISTORY section. All of this to answer PR 13433 2004-03-24 08:32:42 +03:00			`.Po`
			`see`
Use .In instead of .Aq Pa for header files. 2010-03-22 21:58:31 +03:00			`.In protocols/talkd.h`
Add FILES section to document where the daemon is. Add some paragraph breaks to make the man page more readable. Add the history of the talkd -> ntalkd change as I recall it to the HISTORY section. All of this to answer PR 13433 2004-03-24 08:32:42 +03:00			`.Pc .`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`This causes the server to search its invitation`
			`tables to check if an invitation currently exists for the caller`
			`(to speak to the callee specified in the message).`
			`If the lookup fails,`
			`the caller then sends an`
			`.Tn ANNOUNCE`
			`message causing the server to`
			`broadcast an announcement on the callee's login ports requesting contact.`
Add FILES section to document where the daemon is. Add some paragraph breaks to make the man page more readable. Add the history of the talkd -> ntalkd change as I recall it to the HISTORY section. All of this to answer PR 13433 2004-03-24 08:32:42 +03:00			`.Pp`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`When the callee responds, the local server uses the`
			`recorded invitation to respond with the appropriate rendezvous`
			`address and the caller and callee client programs establish a`
			`stream connection through which the conversation takes place.`
- clean up some more cruft - support "talkd -l" for extra (syslog(3)) logging - fix error in previous announce.c change - use getopt - add (missing) -d and -l descriptions to man page 1998-07-04 23:31:05 +04:00			`.Sh OPTIONS`
			`.Nm`
			`supports the following options:`
			`.Bl -tag -width 12345`
			`.It Fl d`
			`The`
			`.Fl d`
			`option turns on debugging logging.`
			`.It Fl l`
			`The`
			`.Fl l`
			`option turns on accounting logging for`
			`.Nm`
			`via the`
			`.Xr syslogd 8`
			`service.`
			`.El`
Add FILES section to document where the daemon is. Add some paragraph breaks to make the man page more readable. Add the history of the talkd -> ntalkd change as I recall it to the HISTORY section. All of this to answer PR 13433 2004-03-24 08:32:42 +03:00			`.Sh FILES`
			`.Pa /usr/libexec/ntalkd`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SEE ALSO`
			`.Xr talk 1 ,`
- clean up some more cruft - support "talkd -l" for extra (syslog(3)) logging - fix error in previous announce.c change - use getopt - add (missing) -d and -l descriptions to man page 1998-07-04 23:31:05 +04:00			`.Xr write 1 ,`
			`.Xr syslog 3 ,`
syslogd(8), not syslog(8). 2001-04-04 13:56:56 +04:00			`.Xr syslogd 8`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`command appeared in`
			`.Bx 4.3 .`
Add FILES section to document where the daemon is. Add some paragraph breaks to make the man page more readable. Add the history of the talkd -> ntalkd change as I recall it to the HISTORY section. All of this to answer PR 13433 2004-03-24 08:32:42 +03:00			`.Pp`
			`The original talkd program was coded improperly,`
			`in a machine and byte-order dependent fashion.`
			`When this was corrected, it required a protocol`
			`change, which necessitated a different daemon to`
			`handle it, thus`
			`.Nm`
			`or`
			`.Qq new`
			`talk daemon.`
			`The old daemon has long since been removed,`
			`but the detritus remain.`