1termyctl(1) General Commands Manual termyctl(1)
2
6 termyctl - Set or clear TermySequence session attributes
7
10 termyctl [options] [command] [arg]
11
14 termyctl is used to set and clear various useful attributes from within
15 a TermySequence terminal session. The effects of setting these
16 attributes will vary depending on the specific client program being
17 used.
18 termyctl also provides an interface to check the status of and adjust
20 "per-session" environment variables whose values depend on the termi‐
21 nal's current owning client. DISPLAY and SSH_AUTH_SOCK are examples of
22 environment variables typically managed in this way. Which variables
23 are considered per-session is controlled by the client program, typi‐
24 cally via terminal profile settings.
25
28 check-env
29 Check the status of per-session environment variables, if any.
30 The output consists of a list of variable names along with the
31 value that each variable should have (according to the termi‐
32 nal's current ownership), the value that the multiplexer server
33 believes the variable to have (based on when the environment was
34 last reset), and the value that the variable actually has.
35 fix-env
38 Print a set of shell assignment statements which adjust the
39 environment to correspond to the environment of the connected
40 client which currently owns the terminal. A reset-env command
41 will also be included if necessary. The output of this command
42 is suitable for evaluation by the shell using eval.
43 reset-env
46 Inform the multiplexer that the terminal's environment has been
47 updated to match the environment of the connected client which
48 currently owns the terminal. This command should not be run
49 unless the environment has in fact been updated. A call to this
50 command will be included in the output of fix-env when appropri‐
51 ate.
52 set-icon name
55 Set an icon name for the terminal session. If the client sup‐
56 ports this attribute, the corresponding icon will be displayed
57 with the terminal thumbnail or otherwise associated with the
58 terminal.
59 clear-icon
62 Unset the custom icon name for the terminal session, which will
63 cause the client to revert to its default behavior for the ter‐
64 minal icon. Note that setting the empty string is the same as
65 clearing the icon; to force display of no icon in qtermy(1), set
66 the name "none".
67 set-badge format
70 Set the badge format for the terminal session. This is a text
71 string which may optionally contain attribute names of the form
72 "\(name)", which will be expanded to the attribute's value
73 dynamically. Quote the text if it contains spaces. Setting the
74 empty string indicates that no badge should be displayed.
75 The TermySequence protocol specifies many useful attributes that
77 can be displayed in terminal badges, and custom attributes can
78 be set as well. The client may have a means of inspecting the
79 available attributes, such as the "View Terminal Information"
80 action within qtermy(1).
81 clear-badge
84 Unset the custom badge for the terminal session, which will
85 cause the client to revert to its default behavior for the ter‐
86 minal badge.
87 set-layout spec
90 This is a qtermy(1)-specific option which sets the layout of the
91 terminal viewport and its supporting widgets. The argument is a
92 comma-separated list of numbers (without spaces) where each num‐
93 ber refers to a specific widget:
94 0) the terminal viewport itself
96 1) marks widget
97 2) plain scroll bar
98 3) minimap widget
99 4) timing widget
100 The letter "s" may be placed between numbers in the list to
102 request a separator line. A minus sign in front of a number will
103 place the widget at the given location but hide it. Example:
104 "-4,1,s,0,-2,3"
105 clear-layout
108 Unset the custom layout for the terminal session, which will
109 cause the client to revert to the default layout.
110 set-fills spec
113 This is a qtermy(1)-specific option which sets column fills
114 (vertical lines) at specific column positions in the terminal
115 viewport. The argument is a comma-separated list of fill defini‐
116 tions, each taking the form "<column>[:<color>]" where column is
117 the column number at which to place the fill, and color is a
118 256-color palette index in the range 0 to 255. If color is omit‐
119 ted, the terminal foreground color is used. Example: "78,80:9"
120 clear-fills
123 Unset custom column fills for the terminal session, which will
124 cause the client to revert to the default fills.
125
128 --help Print basic help
129 --version
132 Print version information
133 --man Attempt to show this man page
136
139 When using qtermy(1) it is possible to manage these settings strictly
140 on the client side using settings profiles. This script is provided for
141 completeness.
142 termyctl is a wrapper script that uses termy-query(1). to set the ses‐
144 sion attributes. The escape sequences used are specific to TermySe‐
145 quence. Running this script under other terminal emulators will have
146 undefined results.
147
150 termy-server(1), qtermy(1)
151 TermySequence - https://termysequence.io
152TermySequence™ March 2018 termyctl(1)