Configuration options that may be passed when creating a new guac_terminal. More...

#include <terminal.h>

Data Fields
bool	disable_copy
	Whether copying from the terminal clipboard should be blocked.

int	max_scrollback
	The maximum number of rows to allow within the scrollback buffer.

char *	font_name
	The name of the font to use when rendering glyphs.

int	font_size
	The size of each glyph, in points.

int	dpi
	The DPI of the display.

int	width
	The width of the terminal, in pixels.

int	height
	The height of the terminal, in pixels.

char *	color_scheme
	The name of the color scheme to use.

int	backspace
	The integer ASCII code to send when backspace is pressed in the terminal.

Detailed Description

Configuration options that may be passed when creating a new guac_terminal.

Note that guac_terminal_options should not be instantiated directly - to create a new options struct, use guac_terminal_options_create.

Field Documentation

◆ color_scheme

char* guac_terminal_options::color_scheme

The name of the color scheme to use.

This string must be in the format accepted by guac_terminal_parse_color_scheme().

◆ disable_copy

bool guac_terminal_options::disable_copy

Whether copying from the terminal clipboard should be blocked.

If set, the contents of the terminal can still be copied, but will be usable only within the terminal itself. The clipboard contents will not be automatically streamed to the client.

◆ dpi

int guac_terminal_options::dpi

The DPI of the display.

The given font size will be adjusted to produce glyphs at the given DPI.

◆ max_scrollback

int guac_terminal_options::max_scrollback

The maximum number of rows to allow within the scrollback buffer.

The user may still alter the size of the scrollback buffer using terminal codes, however the size can never exceed the maximum size given here. Note that this space is shared with the display, with the scrollable area actually only containing the given number of rows less the number of rows currently displayed, and sufficient buffer space will always be allocated to represent the display area of the terminal regardless of the value given here.

The documentation for this struct was generated from the following file: