-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathxiate.1
130 lines (130 loc) · 4.54 KB
/
xiate.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
.TH xiate 1 "2022-11-12" "xiate" "User Commands"
.\" --------------------------------------------------------------------
.SH NAME
xiate \- terminal emulator
.\" --------------------------------------------------------------------
.SH SYNOPSIS
\fBxiate\fP
[\fB\-class\fP \fIclass\fP]
[\fB\-e\fP \fIargs...\fP]
[\fB\-hold\fP]
[\fB\-name\fP \fIname\fP]
[\fB\-title\fP \fItitle\fP]
[\fB\-\-config\fP \fIpath\fP]
[\fB\-\-fontindex\fP \fIindex\fP]
.\" --------------------------------------------------------------------
.SH DESCRIPTION
\fBxiate\fP is a terminal emulator. When you run it, a terminal window
will open.
.\" --------------------------------------------------------------------
.SH OPTIONS
\fBxiate\fP provides some common options which are compatible to
those of \fBxterm\fP(1):
.TP
\fB\-e\fP \fIargs...\fP
Interpret all remaining arguments as an \(lqargument vector\(rq, i.e.
tell \fBxiate\fP what to run. This must be the last option on the
command line.
.TP
\fB\-hold\fP
Don't close the window after the command has finished.
.TP
\fB\-name\fP \fIname\fP
.TQ
\fB\-class\fP \fIclass\fP
Sets the window's instance name and class name. On X11, those end up in
the \fBWM_CLASS\fP property. On Wayland, they're combined as
\fIname\fP\fB.\fP\fIclass\fP into the \fBapp_id\fP attribute.
.TP
\fB\-title\fP \fItitle\fP
Sets the initial window title. Be aware that the title will very likely
be overwritten by child processes.
.P
In addition, the following options are specific to \fBxiate\fP:
.TP
\fB\-\-config\fP \fIpath\fP
Use the given \fIpath\fP to load \fIconfig.ini\fP.
.TP
\fB\-\-fontindex\fP \fIindex\fP
Start up with this font. Fonts are defined in \fIconfig.ini\fP.
\fIindex\fP starts at 0.
.\" --------------------------------------------------------------------
.SH "DEFAULT KEY BINDINGS"
In windows launched by \fBxiate\fP, you can use the following key
bindings. They can be customized using \fIconfig.ini\fP.
.P
.TP
\fBCtrl + Shift + C\fP
Copy currently selected text into clipboard.
.TP
\fBCtrl + Shift + V\fP
Paste from clipboard.
.TP
\fBCtrl + Shift + H\fP
Dumps the terminal history to a file and calls a tool you specified in
\fIconfig.ini\fP. The name of the tool defaults to
\fBxiate-history-handler\fP and it will be looked for in your
$\fPPATH\fP.
.TP
\fBCtrl + Shift + N\fP
Switch to next configured font. Wraps around to first font at the end.
Fonts are defined in \fIconfig.ini\fP. This also resets the font size.
.TP
\fBCtrl + Shift + P\fP
Switch to previous configured font. Wraps around to last font at the
end.
.TP
\fBCtrl + Shift + I\fP
Zoom in, i.e. increase font size.
.TP
\fBCtrl + Shift + O\fP
Zoom out, i.e. decrease font size.
.TP
\fBCtrl + Shift + R\fP
Reset font size.
.TP
\fBRight mouse button\fP
When hovering over links, you can use this button to invoke your link
handler. The name of this tool is defined in \fIconfig.ini\fP. It
defaults to \fBxiate-link-handler\fP and it will be looked for in your
$\fPPATH\fP. \fBargv[1]\fP will be set to \fBexplicit\fP for explicit
hyperlinks or to \fBmatched\fP if a link has been detected via the
regular expression (also see the comments in \fIconfig.example.ini\fP).
\fBargv[2]\fP will contain the actual link.
.\" --------------------------------------------------------------------
.SH "EXIT STATUS"
\fBxiate\fP will exit with \fB0\fP if the child program running in the
terminal has exited cleanly. It will exit with \fB1\fP if there was any
error, or if the child exited with a non-zero exit code, or if the user
forcibly closed the terminal window.
.P
It is not possible to get the child's original exit code, because you
can't tell it apart from internal xiate errors anyway.
.\" --------------------------------------------------------------------
.SH ENVIRONMENT
.P
.TP
.B DISPLAY
Points to the X11 display on which to open terminal windows.
.\" --------------------------------------------------------------------
.SH FILES
.TP
$\fIXDG_CONFIG_HOME\fP/xiate/config.ini
Default path to optional configuration file. \fBxiate\fP comes with an
example file \fIconfig.example.ini\fP, which documents all available
options.
.\" --------------------------------------------------------------------
.SH LICENSE
\fBxiate\fP is released under the MIT license. See the accompanying
\fILICENSE\fP file.
.\" --------------------------------------------------------------------
.SH HISTORY
\fBxiate\fP was originally written by Peter Hofmann. The project was
started in September 2015.
.\" --------------------------------------------------------------------
.SH "SEE ALSO"
Other terminal emulators include:
.BR sakura (1),
.BR st (1),
.BR urxvt (1),
.BR xterm (1).