From c922c7b64fcf2bbf0d514d6fc9dd674ac1fc75cc Mon Sep 17 00:00:00 2001 From: Andrew Pamment Date: Tue, 6 Feb 2018 18:38:28 +1000 Subject: [PATCH] more documentation --- docs/docs/guide/files/config.md | 19 +++++++++++++++++++ docs/docs/guide/files/tic.md | 19 +++++++++++++++++++ 2 files changed, 38 insertions(+) diff --git a/docs/docs/guide/files/config.md b/docs/docs/guide/files/config.md index e69de29..f1d216b 100644 --- a/docs/docs/guide/files/config.md +++ b/docs/docs/guide/files/config.md @@ -0,0 +1,19 @@ +# File Area Setup + +## Example Config + + [main] + Visible Sec Level = 10 + + [Area One] + Database = area_one + Download Sec Level = 10 + Upload Sec Level = 99 + Upload Path = /path/to/MagickaBBS/files/area_one + + [Area Two] + Database = area_two + Download Sec Level = 10 + Upload Sec Level = 99 + Upload Path = /path/to/MagickaBBS/files/area_two + diff --git a/docs/docs/guide/files/tic.md b/docs/docs/guide/files/tic.md index e69de29..746d549 100644 --- a/docs/docs/guide/files/tic.md +++ b/docs/docs/guide/files/tic.md @@ -0,0 +1,19 @@ +# Tic File Processing + +## Example ticproc.sh + + #!/bin/sh + /path/to/MagickaBBS/utils/ticproc/ticproc /path/to/MagickaBBS/utils/ticproc/ticproc.ini + +## Example ticproc.ini + + [main] + Ignore Password = true + Ignore Case = false + Inbound Directory = /path/to/MagickaBBS/ftn/in_sec + Bad Files Directory = /path/to/MagickaBBS/ftn/tic_bad + + [FSX_INFO] + Database = /path/to/MagickaBBS/somearea.sq3 + File Path = /path/to/MagickaBBS/files/somearea + Password = SECRET \ No newline at end of file