summaryrefslogtreecommitdiff
path: root/ratox.1
diff options
context:
space:
mode:
authorpranomostro <pranomestro@gmail.com>2017-02-16 20:50:20 +0100
committerpranomostro <pranomestro@gmail.com>2017-02-18 01:49:43 +0100
commite66d4bff86cb9e4832c98968f1751097ed57ede0 (patch)
treec6488bc2f9344b65992b5ae6ba79d8170d3bd990 /ratox.1
parent0c97a43e51d3960d9d296438701c4e37f5472f77 (diff)
Update documentation with group-chats.
Diffstat (limited to 'ratox.1')
-rw-r--r--ratox.124
1 files changed, 24 insertions, 0 deletions
diff --git a/ratox.1 b/ratox.1
index 07053ef..a59e04f 100644
--- a/ratox.1
+++ b/ratox.1
@@ -58,6 +58,10 @@ Status message slot.
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).
+They behave like request FIFOs.
.El
.Ss Friend slots
Each friend is represented with a folder in the base-directory named after
@@ -107,6 +111,26 @@ Send a text message by piping data to this FIFO.
.It Ar text_out
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
+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.
+.It Ar leave
+Write to this file to leave the conference.
+.It Ar title_in
+Write here to change the title of the conference.
+.It Ar title_out
+Contains the title of the conference.
+.It Ar text_in
+Echo \fBmessage\fR to send a text message to the conference.
+.It Ar text_out
+Contains the messages send in the conference so far.
+.El
.Ss Misc files
.Bl -tag -width 13n
.It Ar id