]> Sergey Matveev's repositories - mmc.git/blob - doc/usage.texi
870fae1b28853db71b3bf636c33de74f97532140
[mmc.git] / doc / usage.texi
1 @node Usage
2 @unnumbered Usage
3
4 @enumerate
5
6 @item Get the @url{git://git.stargrave.org/mmc.git, source code} and
7 compile Go programs in @file{cmd} subdirectory.
8
9 @example
10 for c (cmd/rd cmd/mmc cmd/sb cmd/ch-leave) @{ pushd $c ; go build ; popd @}
11 @end example
12
13 @item Create and change to the directory where the state will be kept.
14
15 @item Place your MM's credentials to @env{$NETRC} (@file{~/.netrc} by
16 default). For example
17 @code{machine mm.invalid login stargrave@@mm.invalid password PASSWORD}.
18
19 @item Set @env{$MMC_ENTRYPOINT} environment variable to your entrypoint.
20
21 @item Run @command{cmd/start} and you should see started @command{tmux}
22 with split window, running @command{cmd/mmc} and list of user statuses.
23
24 @item By pressing @code{Prefix+c}, list of available users/channels is
25 shown inside @command{fzf}. Choose the desired one.
26
27 @item A new window (if it did not exist) will appear with the history of
28 messages and a part where you can type you message inside
29 @command{rlwrap}. You can call external editor (for multiline messages)
30 with @code{Ctrl-^} key by default in that utility.
31
32 @item Each time new message appears in the window, bell character is
33 sent, alerting the @command{tmux} and (depending on your configuration)
34 probably your running terminal.
35
36 @item If message is edited or deleted, then @code{[EDIT]}/@code{[DEL]}
37 prefix is prepended. If message contains appended files, then
38 @code{[FILE] FILEID} message is shown.
39
40 @item By pressing @code{Prefix+d} you will close the window.
41
42 @item By pressing @code{Prefix+S}, list of available files is shown
43 inside @command{fzf}, just to quickly display it.
44
45 @item Status change and typing notifications are shown as a short-lived
46 message at the bottom of the screen.
47
48 @item If you want to send file to the user/channel, then send
49 @code{/FILE /path/to/file} message.
50
51 @item If you want to download some file, then you can invoke
52 @command{cmd/download FILEID} utility, that will save the file to
53 @file{FILEID.tar} archive in current directory.
54
55 @item After you just logged in, @command{cmd/mmc} checks for new
56 messages since you were offline, if any messages were in the state's
57 history. So some windows could be automatically opened because of new
58 messages.
59
60 @item By pressing @code{Prefix+Q} you will destroy the whole session and
61 quit @command{tmux}.
62
63 @item @command{cmd/mmc} heartbeats server each minute to tell that you
64 are online, preventing you becoming away.
65
66 @item You can preliminary fill your history:
67
68 @example
69 for c (users/*(/) chans/*(/)) cmd/sb/all $c
70 @end example
71
72 @end enumerate