# readMode

Selects a built-in method for detecting multi-line messages (0–2).

This parameter applies to imfile: Text File Input Module.

Name:

  readMode

Scope:

  input

Type:

  integer

Default:

  0

Required?:

  no

Introduced:

  at least 5.x, possibly earlier

## Description

Provides support for processing some standard types of multi-line messages. It is less flexible than `startmsg.regex` or `endmsg.regex` but offers higher performance. `readMode`, `startmsg.regex` and `endmsg.regex` cannot all be defined for the same input. The value ranges from 0 to 2:

- 0 – line based (default; each line is a new message)

- 1 – paragraph (blank line separates log messages)

- 2 – indented (lines starting with a space or tab belong to the previous message)

## Input usage

    input(type="imfile"
          File="/var/log/example.log"
          Tag="example"
          readMode="0")

### Legacy names (for reference)

Historic names/directives for compatibility. Do not use in new configs.

- `$InputFileReadMode` — maps to readMode (status: legacy)

## See also

See also imfile: Text File Input Module.

Support: rsyslog Assistant | GitHub Discussions | GitHub Issues: rsyslog source project

Contributing: Source & docs: rsyslog source project

© 2008–2025 Rainer Gerhards and others. Licensed under the Apache License 2.0.