From 00bc259fa8cf42887c4c631c69db9c746bb93367 Mon Sep 17 00:00:00 2001 From: June McEnroe Date: Fri, 12 Oct 2018 15:07:33 -0400 Subject: Replace torus.7 with torus.1 --- README | 62 ++++++++++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 48 insertions(+), 14 deletions(-) (limited to 'README') diff --git a/README b/README index e7f3e3b..c4f2494 100644 --- a/README +++ b/README @@ -1,22 +1,56 @@ -TORUS(7) FreeBSD Miscellaneous Information Manual TORUS(7) +torus(1) FreeBSD General Commands Manual torus(1) NAME - torus – welcome to ascii.town! + server, client, image, meta, merge – collaborative ASCII art + +SYNOPSIS + server [-d data] [-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. + + -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. - torus.h Shared structures and message protocol. - server.c Maps torus.dat and listens on torus.sock. - client.c curses(3) client. - help.h Tile data for help page. - image.c Renders PNGs of tiles. - meta.c Exports metadata from data file to CSV. - merge.c Interactively merges two data files. - snapshot.sh Snapshots data file, appropriate for cron. + help.h contains tile data for the help page and can be generated from the + first tile of torus.dat. - sshd_config Anonymous login to chroot(8)'d client. - index.html Friendly directions. - default8x16.psfu Bitmap font from kbd: http://kbd-project.org. + default8x16.psfu is taken from kbd: http://kbd-project.org. -Causal Agency October 10, 2018 Causal Agency +Causal Agency October 12, 2018 Causal Agency -- cgit 1.4.1 Add The Rosewater RedemptionJune McEnroe Remembering how to read 2021. 2021-01-29Use int when checking for EOFJune McEnroe 2021-01-28Move gpl.c and agpl.c templates out of etcJune McEnroe 2021-01-27Set para and sect for mdocJune McEnroe Copied from the OpenBSD defaults. 2021-01-26Use First state to match keyword at beginning of lineJune McEnroe Otherwise keywords at the beginnings of lines with preceeding whitespace are not matched. 2021-01-25Install vi on Linux and nvi on macOSJune McEnroe 2021-01-25Use vi and lessJune McEnroe I haven't used neovim in a couple weeks by now, so I may as well commit this. 2021-01-20Use mtags for sh in source-filterJune McEnroe 2021-01-20Generate tags for sh files in mtagsJune McEnroe Only matches functions declared at the beginnings of lines, but I'm fine with that. 2021-01-20Add messy sh lexerJune McEnroe Surprisingly seems to work for everything I looked at in my repos. 2021-01-20Add all target to git.causal.agency MakefileJune McEnroe 2021-01-20Remove Lua supportJune McEnroe Lua support is unused and the dlsym fwrite/write hacks horrify me. Clean it up. 2021-01-20Fix tests for diff spansJune McEnroe 2021-01-20Avoid matching ':' in make tagsJune McEnroe Otherwise a :: rule includes one of the ':'s in the tag name. 2021-01-19Prefer tag matches not preceded by [[:alnum:]]June McEnroe Otherwise the "id" in "void" matches for "void id". 2021-01-19Escape \ and / in mtags search patternsJune McEnroe 2021-01-20Use mtags in source-filterJune McEnroe 2021-01-19Add mtags to generate tags for make and mdocJune McEnroe 2021-01-19Map tags to IDs using only [[:alnum:]-._]June McEnroe 2021-01-19Don't use a pager if reading standard inputJune McEnroe 2021-01-19Support BSD make syntax and match *.amJune McEnroe These don't really go together, but... 2021-01-19Match tab following escaped newline in make assignmentsJune McEnroe Otherwise it ends up going into Shell state. 2021-01-18Allow matching lexers using first input lineJune McEnroe