From ec61f016e478ec1430c6364a499e2359eac4e939 Mon Sep 17 00:00:00 2001 From: Andrew Pamment Date: Wed, 7 Feb 2018 07:00:39 +1000 Subject: [PATCH] fill out tic documentation --- docs/docs/guide/files/tic.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/docs/guide/files/tic.md b/docs/docs/guide/files/tic.md index c2d52b7..60cc4d9 100644 --- a/docs/docs/guide/files/tic.md +++ b/docs/docs/guide/files/tic.md @@ -1,6 +1,6 @@ # Tic File Processing -TODO. +To process tic files, you have a script that binkd calls when it receives a TIC file. The script simply starts the ticproc utility with an ini file that defines the settings and areas. ## Example ticproc.sh @@ -18,4 +18,22 @@ TODO. [SOME_AREA] Database = /path/to/MagickaBBS/somearea.sq3 File Path = /path/to/MagickaBBS/files/somearea - Password = SECRET \ No newline at end of file + Password = SECRET + +In the main section the options include: + +**Ignore Password** Set this to true to ignore any passwords and import files regardless. Use this only if you are importing from the secure inbound directory. + +**Ignore Case** Ignore the case used in the filename specified in the TIC file. This is useful for working with windows generated tic files which may send the file with a different case filename as what is listed in the tic file. + +**Inbound Directory** The place to look for inbound tic files and their referenced files. + +**Bad Files Directory** A directory to put any inbound files that collide with already existing files (and are not to be replaced). + +After the main section, each area is defined into sections with the section name being the name of the file area. + +**Database** The full path and name of the database to import the files into. They will be automatically approved. + +**File Path** Where to put the actual files. + +**Password** Password in the TIC file for this area.