---
name: "auparse_set_escape_mode"
section: "3"
platform: "linux"
package: "audit"
version: "4.2.1-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/auparse_set_escape_mode"
---

# auparse\_set\_escape\_mode(3)

choose escape method

## NAME

auparse\_set\_escape\_mode - choose escape method

## SYNOPSIS

**#include \<auparse.h\>**

**void auparse\_set\_escape\_mode(auparse\_state\_t \****au,***auparse\_esc\_t"***mode);"*

## DESCRIPTION

auparse\_set\_escape\_mode is used to set the escaping method that will be used to output interpreted text. The choices for the mode variable are:

- **AUPARSE\_ESC\_RAW**

  No escaping of any kind is done.

- **AUPARSE\_ESC\_TTY**

  Escape TTY control characters so that they are harmless to display on a terminal. When any control character is found, they are displayed as octal numbers. This is the default mode that the auparse library is initialized with.

- **AUPARSE\_ESC\_SHELL**

  Besides escaping control characters, this will escape some characters that can cause problems when used with shell scripting. Any escaped control characters are displayed as octal numbers. Other escaped characters are proceeded with a backslash. The additional characters it escapes are: " ' \` $ \\

- **AUPARSE\_ESC\_SHELL\_QUOTE**

  Similar to *AUPARSE\_ESC\_SHELL* but expands the character set to include shell operators. Any escaped control characters are displayed as octal numbers. Other escaped characters are proceeded with a backslash. The additional characters it escapes include: ; '  " \` # $ & \* ? \[ \] \< \> { } \\

## RETURN VALUE

None

## SEE ALSO

[**auparse\_interpret\_field**(3)](/auparse_interpret_field/3.md).

## AUTHOR

Steve Grubb
