Skip to content

usertty: add escaping option description #320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HofiOne merged 1 commit into from
Jun 4, 2026
Merged

usertty: add escaping option description #320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _data/excluded_titles.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
- 'values'
- 'urls'
- 'prefix'
- 'Steps'
13 changes: 10 additions & 3 deletions doc/_admin-guide/070_Destinations/350_usertty.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,18 @@ asterisk **\*** to specify every user currently logged in to the system.
usertty(username);
```

The usertty() does not have any further options nor does it support
templates.
The usertty() does not support templates, and has a single optional parameter.

## escaping()

| Accepted values: | `yes`, `no` |
| Default: | `no` |

*Description:* If this parameter is set to `yes`, {{ site.product.short_name }} escapes the message part of the
usertty() output using the default template-escaping rules.

### Example: Using the usertty() driver

```config
destination d_usertty { usertty("root"); };
destination d_usertty { usertty("root" escaping(yes)); };
```