From 1061ce42a7d89aac0e104a464eaa7529f9210c44 Mon Sep 17 00:00:00 2001 From: Hofi Date: Wed, 3 Jun 2026 12:42:53 +0200 Subject: [PATCH] usertty: add escaping option description Signed-off-by: Hofi --- _data/excluded_titles.yml | 1 + doc/_admin-guide/070_Destinations/350_usertty.md | 13 ++++++++++--- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/_data/excluded_titles.yml b/_data/excluded_titles.yml index 4c29f63e..653a2d2d 100644 --- a/_data/excluded_titles.yml +++ b/_data/excluded_titles.yml @@ -15,3 +15,4 @@ - 'values' - 'urls' - 'prefix' +- 'Steps' diff --git a/doc/_admin-guide/070_Destinations/350_usertty.md b/doc/_admin-guide/070_Destinations/350_usertty.md index 021f2302..27cb8137 100644 --- a/doc/_admin-guide/070_Destinations/350_usertty.md +++ b/doc/_admin-guide/070_Destinations/350_usertty.md @@ -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)); }; ```