about summary refs log tree commit diff homepage
path: root/README
blob: 67c4dcc8eca760d490d00bcd1cae3779f305dfa5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
torus(1)                FreeBSD General Commands Manual               torus(1)

NAME
     server, client, image, meta, merge – collaborative ASCII art

SYNOPSIS
     server [-d data] [-p pidfile] [-s sock]
     client [-h] [-s sock]
     image [-d data] [-f font] [-x x] [-y y]
     meta
     merge data1 data2 data3

DESCRIPTION
     server maps a data file and listens on a UNIX-domain socket to
     synchronize events between clients.

     client connects to a UNIX-domain socket and presents a curses(3)
     interface.

     image renders a tile from a data file using a PSF2 font to PNG on
     standard output.

     meta extracts metadata from a data file on standard input to CSV on
     standard ouput.  The CSV fields are tileX, tileY, createTime,
     modifyCount, modifyTime, accessCount, accessTime.

     merge interactively merges two data files data1 and data2 into data3.
     Differing tiles are presented in a curses(3) interface and are chosen by
     typing a or b.

     The arguments are as follows:

     -d data
             Set path to data file.  The default path is torus.dat.

     -f font
             Set path to PSF2 font.  The default path is default8x16.psfu.

     -h      Write help page data to standard output and exit.

     -p pidfile
             Daemonize and write PID to pidfile.  Only available on FreeBSD.

     -s sock
             Set path to UNIX-domain socket.  The default path is torus.sock.

     -x x -y y
             Set tile coordinates to render.  The default coordinates are
             32,32.

IMPLEMENTATION NOTES
     This software targets FreeBSD and Darwin.

     help.h contains tile data for the help page and can be generated from the
     first tile of torus.dat.

     default8x16.psfu is taken from kbd: http://kbd-project.org.

Causal Agency                  October 12, 2018                  Causal Agency
d>Sandbox pounce with pledge(2)June McEnroe 2020-08-27Sandbox calico with pledge(2) and unveil(2)June McEnroe 2020-08-27Add support for OpenBSDJune McEnroe 2020-08-27Remove rc scriptsJune McEnroe 2020-08-27contrib/palaver: Fix documented database pathJune McEnroe 2020-08-27contrib/palaver: Remove rc scriptJune McEnroe 2020-08-27contrib/palaver: Fix database search and creationJune McEnroe 2020-08-27contrib/palaver: Use pounce's XDG directoryJune McEnroe 2020-08-27contrib/palaver: Only allow HTTPSJune McEnroe 2020-08-25Support the pounce_env rc variableJune McEnroe 2020-08-25Remove deprecated option namesJune McEnroe 2020-08-25Document configuration and data file searchJune McEnroe 2020-08-24Use dataOpen for save fileJune McEnroe 2020-08-24Use configOpen to load localCAJune McEnroe 2020-08-24Use configPath to load client cert/privJune McEnroe 2020-08-24Use configOpen in getopt_configJune McEnroe 2020-08-24Import xdg.c from catgirlJune McEnroe 2020-08-23Replace “RAND_bytes” by “getentropy”Issam E. Maghni 2020-08-16contrib/palaver: Add no message preview flagsJune McEnroe 2020-08-13contrib/palaver: Don't set channel for PMsJune McEnroe 2020-08-13Fix unintended interception of NICK after registrationJune McEnroe 2020-08-12Add Additional Components section to READMEJune McEnroe 2020-08-12Document -L / palaver optionJune McEnroe 2020-08-11contrib/palaver: Document service configurationJune McEnroe 2020-08-11contrib/palaver: Add install target and rc scriptJune McEnroe 2020-08-11contrib/palaver: Implement command and notificationsJune McEnroe