`SimpleFileWriter`
Write status updates to a text file (A bit like the NSCA server does)

# `SimpleFileWriter` — SimpleFileWriter

Write status updates to a text file (A bit like the NSCA server does)

Commands (Overview):

TODO: Add a list of all external commands (this is not check commands)

Configuration (Overview):

Common Keys:

Path / Section | Key | Description
--- | --- | ---
`/settings/writers/file` | `channel` | CHANNEL
`/settings/writers/file` | `file` | FILE TO WRITE TO
`/settings/writers/file` | `syntax` | MESSAGE SYNTAX

## / settings/ writers/ file

`/settings/writers/file` (SimpleFileWriter)

FILE WRITER

> Section for simple file writer module (SimpleFileWriter.dll).

> Key | Default Value | Description
> --- | --- | ---
> `channel` | FILE | CHANNEL
> `file` | output.txt | FILE TO WRITE TO
> `syntax` | ${alias-or-command} ${result} ${message} | MESSAGE SYNTAX

> Sample:

>     # FILE WRITER
>     # Section for simple file writer module (SimpleFileWriter.dll).
>     [/settings/writers/file]
>     channel=FILE
>     file=output.txt
>     syntax=${alias-or-command} ${result} ${message}

> `channel` (SimpleFileWriter, /settings/writers/file)

>   CHANNEL

>   The channel to listen to.

>   Path: /settings/writers/file

>   Key: channel

>   Default value: FILE

>   Used by: `SimpleFileWriter`

>   Sample:

>       [/settings/writers/file]
>       # CHANNEL
>       channel=FILE

> `file` (SimpleFileWriter, /settings/writers/file)

>   FILE TO WRITE TO

>   The filename to write output to.

>   Path: /settings/writers/file

>   Key: file

>   Default value: output.txt

>   Used by: `SimpleFileWriter`

>   Sample:

>       [/settings/writers/file]
>       # FILE TO WRITE TO
>       file=output.txt

> `syntax` (SimpleFileWriter, /settings/writers/file)

>   MESSAGE SYNTAX

>   The syntax of the message to write to the line.
>   Can be any arbitrary string as well as include any of the following special keywords:${command} = The command name, ${host} the host, ${channel} the recieving channel, ${alias} the alias for the command, ${alias-or-command} = alias if set otherweise command, ${message} = the message data (no escape), ${result} = The result status (number).

>   Path: /settings/writers/file

>   Key: syntax

>   Default value: ${alias-or-command} ${result} ${message}

>   Used by: `SimpleFileWriter`

>   Sample:

>       [/settings/writers/file]
>       # MESSAGE SYNTAX
>       syntax=${alias-or-command} ${result} ${message}

comments powered by Disqus