man7.org > Linux > man-pages

Linux/UNIX system programming training

auparse_set_escape_mode(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | AUTHOR | COLOPHON 

AUPARSE_SET_ESCAPE_MODE(3)   Linux Audit API   AUPARSE_SET_ESCAPE_MODE(3)

NAME         top

       auparse_set_escape_mode - choose escape method

SYNOPSIS         top

       #include <auparse.h>

       void auparse_set_escape_mode(auparse_state_t *au, auparse_esc_t
       mode);

DESCRIPTION         top

       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         top

       None

SEE ALSO         top

       auparse_interpret_field(3).

AUTHOR         top

       Steve Grubb

COLOPHON         top

       This page is part of the audit (Linux Audit) project.  Information
       about the project can be found at 
       ⟨http://people.redhat.com/sgrubb/audit/⟩.  If you have a bug report
       for this manual page, send it to linux-audit@redhat.com.  This
       page was obtained from the project's upstream Git repository
       ⟨https://github.com/linux-audit/audit-userspace.git⟩ on
       2025-02-02.  (At that time, the date of the most recent commit
       that was found in the repository was 2025-01-31.)  If you discover
       any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a
       mail to man-pages@man7.org

Red Hat                         July 2016      AUPARSE_SET_ESCAPE_MODE(3)

Pages that refer to this page: auparse_interpret_field(3)

HTML rendering created 2025-02-02 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI