From d1385398d393ee6b3c9f1a7af4a7f6849981daa0 Mon Sep 17 00:00:00 2001 From: idk Date: Fri, 14 Sep 2018 01:02:47 -0400 Subject: [PATCH] update docs, add streaming library to checklist --- Makefile | 8 +++++++- README.md.asc | 16 ++++++++-------- USAGE.md | 8 +++++++- 3 files changed, 22 insertions(+), 10 deletions(-) diff --git a/Makefile b/Makefile index 66a2984..29df64b 100644 --- a/Makefile +++ b/Makefile @@ -113,8 +113,14 @@ gendoc: example-config: @echo "example config - valid for both ephsite and samcat" >> USAGE.md @echo "==================================================" >> USAGE.md + @echo "Options are still being added, pretty much as fast as I can put them" >> USAGE.md + @echo "in. For up-to-the-minute options, see [the checklist](config/CHECKLIST.md)" >> USAGE.md @echo "" >> USAGE.md - @echo "(ephsite will only use top-level options)" >> USAGE.md + @echo "(ephsite will only use top-level options, but they can be labeled or" >> USAGE.md + @echo "unlabeled)" >> USAGE.md + @echo "(samcatd treats the first set of options it sees as the default, and" >> USAGE.md + @echo "does not start tunnels based on unlabeled options unless passed the" >> USAGE.md + @echo "-s flag.)" >> USAGE.md @echo "" >> USAGE.md @echo '```' >> USAGE.md cat etc/sam-forwarder/tunnels.ini >> USAGE.md diff --git a/README.md.asc b/README.md.asc index f341981..1108c53 100644 --- a/README.md.asc +++ b/README.md.asc @@ -75,12 +75,12 @@ I'm eventually going to make the manager implement net.Conn. This won't be exposed in the default application probably though, but rather as a library. -----BEGIN PGP SIGNATURE----- -iQEzBAEBCAAdFiEEcNIGBzi++AUjrK/311wDs5teFOEFAlubPtAACgkQ11wDs5te -FOEbIQf/SkKfTiBHltlwRjdm20y+lP6TI3WpntK/jFREXa5cwOVGXI5HjpWs9Me7 -4227XWlVbT63TTcbBOU+4Z0YDKJ5pJDE0o2HJgBR7sS8GuDivHqNnI+QEBPIYPnr -83ec1HsjaK5MarKlQyu3SI7muySOk08CkpFx5KgZX8AsBxhmEOwUpentOgmAG4Os -OCLFUWrMSojv6iDeq4BpOgbfJc0vKNMJZACgCQoGNQGSpSNnE1xBhVXZIecM3lmw -95ltEqQMb9FXFLy/QFbkG1I2hCXyAeNxA0MX+33MtVR3y6Zj1qHUEs5zIoi4aKnb -NbL85wNCFoDkVxmak+N7RjHy48Q51Q== -=QYge +iQEzBAEBCAAdFiEEcNIGBzi++AUjrK/311wDs5teFOEFAlubQPYACgkQ11wDs5te +FOGFvAf9GNiZzx2UsgRLoleOJDcS3oOyJJYkUcQZaCg2d+tuap5BPMnPAbB/xtAr +6jKy/oKyDlh4PaFsYcX9wzc452A9o3FF/k2jdVE72G+/u9BppMOhv/zCyQP0fu88 +LpJk0QM344l8JXZiA9gDoFcDDEalBzmKK55aOfeOeqTkNggtmdL8f4QQGg0wN2JL +CvgMjjhv7hTNKEqsUskUU3vW89wK/W+ycyg2n261diDBRPqO2nR0WrcowDxc956E +aUnOATKPgwNscrukbIVCb8OnQj+3VeUjh1rbi5vnZTiB9TdT2EfWKuTWqHlc2vFn +QTsRkFss02kkg4y0osMuzAG2V0EyZg== +=uv2c -----END PGP SIGNATURE----- diff --git a/USAGE.md b/USAGE.md index 3907d6b..6e884ec 100644 --- a/USAGE.md +++ b/USAGE.md @@ -160,8 +160,14 @@ Usage of ./bin/samcatd: example config - valid for both ephsite and samcat ================================================== +Options are still being added, pretty much as fast as I can put them +in. For up-to-the-minute options, see [the checklist](config/CHECKLIST.md) -(ephsite will only use top-level options) +(ephsite will only use top-level options, but they can be labeled or +unlabeled) +(samcatd treats the first set of options it sees as the default, and +does not start tunnels based on unlabeled options unless passed the +-s flag.) ```