commit 61b7678f395b3570c400f31fcec2122da8446b1c
parent d7e52c6ce98f00f985818d80e657daef0f3acd53
Author: sin <sin@2f30.org>
Date: Fri, 10 Mar 2017 14:28:14 +0000
Manpage fixes
Diffstat:
| M | ratox.1 | | | 38 | +++++++++++++++++--------------------- |
1 file changed, 17 insertions(+), 21 deletions(-)
diff --git a/ratox.1 b/ratox.1
@@ -14,7 +14,7 @@
.Sh DESCRIPTION
.Nm
is a client implementation of the tox protocol providing only FIFOs, files
-and folders as interfaces.
+and directories as interfaces.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl 4 6
@@ -22,7 +22,7 @@ Use IPv4/IPv6 only.
.It Fl E e
Enable/Disable save file encryption.
.It Fl T t
-Enable/Disable TCP mode. Avoiding UDP in tox implies certain security
+Enable/Disable TCP mode. Avoiding UDP in tox implies certain security
considerations.
.It Fl P p
Enable/Disable TCP HTTP/SOCKS5 proxy as specified in \fIconfig.h\fR.
@@ -31,41 +31,41 @@ Path of the file to load a profile from or create a new one in.
.El
.Sh CONFIGURATION
.Nm
-is configured with \fIconfig.h\fR at compile-time. Apart from command line
+is configured with \fIconfig.h\fR at compile-time. Apart from command line
options and other parameters it contains the list of DHT-nodes.
.Pp
If there is a mismatch between save file status and encryption setting,
.Nm
writes the save file according to the latter.
.Sh INTERFACE
-A \fIslot\fR is a set of FIFOs, files and folders interfacing a single
+A \fIslot\fR is a set of FIFOs, files and directories interfacing a single
parameter. The set of slots makes up the \fIinterface\fR.
.Ss Global slots
-Global slots are folders containing an \fBin\fR FIFO, \fBout\fR and
+Global slots are directories containing an \fBin\fR FIFO, \fBout\fR and
\fBerr\fR file or directory respectively.
The slot parameter is set by piping data to \fBin\fR and accessed
-with \fBout\fR. Any errors are reported in \fBerr\fR.
+with \fBout\fR. Any errors are reported in \fBerr\fR.
.Bl -tag -width 13n
.It Ar name/
Name slot.
.It Ar nospam/
Nospam slot (8 digit hexadecimal).
.It Ar state/
-State slot (none | away | busy).
+State slot (\fBavailable\fR | \fBaway\fR | \fBbusy\fR).
.It Ar status/
Status message slot.
.It Ar request/
-Request slot. Send a friend request by piping the Tox ID to \fBin\fR. Incoming
-requests are listed as FIFOs in \fBout/\fR. Echo \fB1\fR | \fB0\fR to
+Request slot. Send a friend request by piping the Tox ID to \fBin\fR. Incoming
+requests are listed as FIFOs in \fBout/\fR. Echo \fB1\fR | \fB0\fR to
accept | reject them.
.It Ar conf/
-Conference management slot. A conference is created by writing it's title to in. Invites
-to conferences are FIFOs in \fBout/\fR. Their name is id_cookie (the cookie is random data).
+Conference management slot. A conference is created by writing its title to \fBin\fR. Invites
+to conferences are FIFOs in \fBout/\fR. Their name is id_cookie (the cookie is random data).
They behave like request FIFOs.
.El
.Ss Friend slots
-Each friend is represented with a folder in the base-directory named after
-their Tox ID without its nospam-value. Each folder contains slots to
+Each friend is represented with a directory in the base-directory named after
+their Tox ID without its nospam-value. Each directory contains slots to
interface with the friend.
.Bl -tag -width 13n
.It Ar call_in
@@ -74,28 +74,24 @@ Initiate a call by piping data to this FIFO.
Answer an incoming call by opening it for reading.
.It Ar call_state
Reports the call state (\fBnone\fR | \fBpending\fR | \fBactive\fR).
-.El
The sample format is \fBmono signed 16-bit little
endian at 48kHz\fR.
The call is \fBterminated\fR if
.Nm
receives both an EPIPE trying to read from call_in
and ENXIO trying to open call_out for writing.
-.Bl -tag -width 13n
.It Ar file_in
Initiate a file transfer by piping data to this FIFO.
.It Ar file_out
Accept an incoming file transfer by opening it for reading.
.It Ar file_pending
Contains the incoming filename if transfer is pending, empty otherwise.
-.El
Given
.Nm
can't know how much data a given pipe is going to provide, it
will send until the pipe is drained or EPIPE received.
That's why it's possible to stream arbitrary data, including
audio and video transmissions, even to other clients.
-.Bl -tag -width 13n
.It Ar name
Contains the friend's name.
.It Ar online
@@ -103,7 +99,7 @@ Contains the friend's online status (\fB1\fR | \fB0\fR).
.It Ar remove
Echo \fB1\fR to remove the friend.
.It Ar state
-Contains the friend's state (\fBnone\fR | \fBaway\fR | \fBbusy\fR)
+Contains the friend's state (\fBavailable\fR | \fBaway\fR | \fBbusy\fR)
.It Ar status
Contains the friend's status message.
.It Ar text_in
@@ -112,14 +108,14 @@ Send a text message by piping data to this FIFO.
Contains text messages from the friend.
.El
.Ss Conference slots
-Each conference is represented with a folder in the directory named after the
-8-digit conference number. The files in the conference folder are an interface
+Each conference is represented with a directory in the directory named after the
+8-digit conference number. The files in the conference directory are an interface
for the respective conference.
.Bl -tag -width 13n
.It Ar members
Contains a list of members of the conference.
.It Ar invite
-Write the ID of a friend to this FIFO to invite him to the conference.
+Write the Tox ID of a friend to this FIFO to invite him to the conference.
.It Ar leave
Write to this file to leave the conference.
.It Ar title_in
