Updated Documentation Page
This commit is contained in:
63
ct.1
63
ct.1
@@ -1,25 +1,62 @@
|
||||
.TH "Threaded Network Chat" 1
|
||||
.TH CT 1
|
||||
|
||||
.SH NAME
|
||||
\fBct\fR - Threaded Network Chat
|
||||
ct \- simple threaded network chat program
|
||||
|
||||
.SH SYNOPSIS
|
||||
.SY
|
||||
./ct # start as server
|
||||
|
||||
./ct # start as client
|
||||
|
||||
/quit # while program running
|
||||
.YS
|
||||
.B ct
|
||||
.br
|
||||
.B ct client
|
||||
|
||||
.SH DESCRIPTION
|
||||
.LP
|
||||
\fBct\fR is a simple terminal-based chat application that allows communication
|
||||
between two users over a network connection. The program operates in either
|
||||
server or client mode.
|
||||
|
||||
.LP
|
||||
This program is meant to run as two instances. One for a "host" or "server" user
|
||||
to initiate a session and the other for a "client" user to join the host.
|
||||
When run without arguments, the program starts in server mode and listens for
|
||||
incoming connections on port 8888. When run with the \fBclient\fR argument, the
|
||||
program connects to a server running on localhost.
|
||||
|
||||
.LP
|
||||
Messages are sent as buffered plain text with minimal processing, if any.
|
||||
The interface is text-based and uses the ncurses library to display a scrolling
|
||||
chat log and an input area. Messages entered by the user are sent over the
|
||||
network and recorded in a local log file.
|
||||
|
||||
.LP
|
||||
The program is intialized in server mode and waits for a client the send a message in the textbox
|
||||
All messages are transmitted as plain text with minimal processing.
|
||||
|
||||
.SH MODES
|
||||
.TP
|
||||
.B Server Mode
|
||||
Default mode. Starts a server and waits for a client to connect. Messages are
|
||||
logged to \fBserver.txt\fR.
|
||||
|
||||
.TP
|
||||
.B Client Mode
|
||||
Activated by running \fBct client\fR. Connects to a server at 127.0.0.1 on port
|
||||
8888. Messages are logged to \fBclient.txt\fR.
|
||||
|
||||
.SH COMMANDS
|
||||
.TP
|
||||
.B /quit
|
||||
Exit the program.
|
||||
|
||||
.SH FILES
|
||||
.TP
|
||||
.B server.txt
|
||||
Log file used in server mode.
|
||||
|
||||
.TP
|
||||
.B client.txt
|
||||
Log file used in client mode.
|
||||
|
||||
.SH NOTES
|
||||
.LP
|
||||
This program currently supports a single client-server connection.
|
||||
|
||||
.LP
|
||||
The program must be run in two separate instances: one as server and one as
|
||||
client.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user