bbs/magicka
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fill out tic documentation

Browse Source
This commit is contained in:
Andrew Pamment 2018-02-07 07:00:39 +10:00
parent c668908e95
commit ec61f016e4
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/docs/guide/files/tic.md
View File

@ -1,6 +1,6 @@
# Tic File Processing # 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 ## Example ticproc.sh
@ -18,4 +18,22 @@ TODO.
[SOME_AREA] [SOME_AREA]
Database = /path/to/MagickaBBS/somearea.sq3 Database = /path/to/MagickaBBS/somearea.sq3
File Path = /path/to/MagickaBBS/files/somearea File Path = /path/to/MagickaBBS/files/somearea
Password = SECRET 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.