TerminalOptions

public struct TerminalOptions

Configuration options for the terminal at startup, these values are only read at startup

  • Desired number of columns at startup (default 80)

    Declaration

    Swift

    public var cols: Int

  • Desired number of rows at startup (default 25)

    Declaration

    Swift

    public var rows: Int

  • Controls whether a Line-Feed character will also behave like a carriage return (true) or not (false). defaults to false)

    Declaration

    Swift

    public var convertEol: Bool

  • Desired value for the terminal name, defaults to xterm-color

    Declaration

    Swift

    public var termName: String

  • The desired startup cursor style, this merely sets an internal variable, it is the view job to render it

    Declaration

    Swift

    public var cursorStyle: CursorStyle

  • Deprecated? The new accessibility work will make this useless

    Declaration

    Swift

    public var screenReaderMode: Bool

  • Size of the scrollback buffer, defaults to 500 lines

    Declaration

    Swift

    public var scrollback: Int

  • Default size of the tabs, defaults to 8

    Declaration

    Swift

    public var tabStopWidth: Int

  • Whether to report that sixel support is present

    Declaration

    Swift

    public var enableSixelReported: Bool

  • Default options

    Declaration

    Swift

    public static let `default`: TerminalOptions

  • Undocumented

    Declaration

    Swift

    public init(cols: Int = Self.default.cols, rows: Int = Self.default.rows, convertEol: Bool = Self.default.convertEol, termName: String = Self.default.termName, cursorStyle: CursorStyle = Self.default.cursorStyle, screenReaderMode: Bool = Self.default.screenReaderMode, scrollback: Int = Self.default.scrollback, tabStopWidth: Int = Self.default.tabStopWidth,
            enableSixelReported: Bool = Self.default.enableSixelReported)