summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorBoris Faure <billiob@gmail.com>2013-11-16 15:27:18 +0100
committerBoris Faure <billiob@gmail.com>2013-11-16 15:27:18 +0100
commit1619b744f3bf2df6aae88a7f0bae331e12b4e60e (patch)
treecbd3a5534f61c8644f87b0601e399b220c250047 /man
parent4f05397bd59442b0dc4c3473b80165cd123732b1 (diff)
update man page
Diffstat (limited to 'man')
-rw-r--r--man/terminology.195
1 files changed, 46 insertions, 49 deletions
diff --git a/man/terminology.1 b/man/terminology.1
index 62d04ee..2b65d8f 100644
--- a/man/terminology.1
+++ b/man/terminology.1
@@ -1,16 +1,13 @@
1.\" Manpage for Terminology 1.\" Manpage for Terminology
2.TH man 1 "18 Apr 2013" "0.3" "Terminology man page" 2.TH man 1 "18 Nov 2013" "0.4" "Terminology man page"
3.SH NAME 3.SH NAME
4Terminology \- Terminal Emulator written with EFL (Enligthenment Foundation Libraries). 4Terminology \- Terminal Emulator written with EFL (Enligthenment Foundation Libraries).
5.SH SYNOPSIS 5.SH SYNOPSIS
6.B terminology [options] 6.B terminology [options]
7.SH DESCRIPTION 7.SH DESCRIPTION
8This is an EFL terminal emulator with some extra bells and whistles. 8This is an EFL terminal emulator with some extra bells and whistles.
9It's brand new and was only started near the begining of June 2012, so
10expecting it to do everything a mature terminal emulator does is a bit
11premature, but considering it's young age, it does a lot.
12It has many features including split terminal support, support for tabs, preview 9It has many features including split terminal support, support for tabs, preview
13icons for files 10icons for files and so on...
14.SH OPTIONS 11.SH OPTIONS
15. 12.
16.TP 13.TP
@@ -39,12 +36,12 @@ Terminal geometry to use (eg 80x24 or 80x24+50+20 etc.).
39Type: STR. 36Type: STR.
40. 37.
41.TP 38.TP
42.B \-n=NAME, \-\-name=NAME 39.B \-n=NAME, \-\-name=NAME
43Set window name. 40Set window name.
44Type: STR. 41Type: STR.
45. 42.
46.TP 43.TP
47.B \-r=ROLE, \-\-role=ROLE 44.B \-r=ROLE, \-\-role=ROLE
48Set window role. 45Set window role.
49Type: STR. 46Type: STR.
50. 47.
@@ -59,7 +56,7 @@ Set icon name.
59Type: STR. 56Type: STR.
60. 57.
61.TP 58.TP
62.B \-f=FONT, \-\-font=FONT 59.B \-f=FONT, \-\-font=FONT
63Set font (NAME/SIZE for scalable, NAME for bitmap. 60Set font (NAME/SIZE for scalable, NAME for bitmap.
64Type: STR. 61Type: STR.
65. 62.
@@ -88,15 +85,15 @@ Set visual bell mode.
88Type: BOOL. 85Type: BOOL.
89. 86.
90.TP 87.TP
91.B \-F, \-\-fullscreen 88.B \-F, \-\-fullscreen
92Go into the fullscreen mode from start. 89Go into the fullscreen mode from start.
93. 90.
94.TP 91.TP
95.B \-I, \-\-iconic 92.B \-I, \-\-iconic
96Go into an iconic state from the start. 93Go into an iconic state from the start.
97. 94.
98.TP 95.TP
99.B \-B, \-\-borderless 96.B \-B, \-\-borderless
100Become a borderless managed window. 97Become a borderless managed window.
101. 98.
102.TP 99.TP
@@ -104,15 +101,15 @@ Become a borderless managed window.
104Become an override-redirect window. 101Become an override-redirect window.
105. 102.
106.TP 103.TP
107.B \-M, \-\-maximized 104.B \-M, \-\-maximized
108Become maximized from the start. 105Become maximized from the start.
109. 106.
110.TP 107.TP
111.B \-W, \-\-nowm 108.B \-W, \-\-nowm
112Terminology is run without a wm. 109Terminology is run without a wm.
113. 110.
114.TP 111.TP
115.B \-H, \-\-hold 112.B \-H, \-\-hold
116Don't exit when the command process exits. 113Don't exit when the command process exits.
117. 114.
118.TP 115.TP
@@ -128,7 +125,7 @@ Set TERM to \fBxterm-256color\fP instead of \fBxterm\fP.
128Show program version. 125Show program version.
129. 126.
130.TP 127.TP
131.B \-C, \-\-copyright 128.B \-C, \-\-copyright
132Show copyright. 129Show copyright.
133. 130.
134.TP 131.TP
@@ -142,75 +139,75 @@ Show this message.
142.SH CONTROLS / SHORTCUTS 139.SH CONTROLS / SHORTCUTS
143. 140.
144.TP 141.TP
145.B Shift+PgUp 142.B Shift+PgUp
146Scroll terminology one page up 143Scroll terminology one page up
147. 144.
148.TP 145.TP
149.B Shift+PgDn 146.B Shift+PgDn
150Scroll terminology one page down 147Scroll terminology one page down
151. 148.
152.TP 149.TP
153.B Shift+Insert 150.B Shift+Insert
154Paste Clipboard (ctrl+v/c) selection 151Paste Clipboard (ctrl+v/c) selection
155. 152.
156.TP 153.TP
157.B Shift+Ctrl+Insert 154.B Shift+Ctrl+Insert
158Paste Primary (highlight) selection 155Paste Primary (highlight) selection
159. 156.
160.TP 157.TP
161.B Shift+Keypad\-Plus 158.B Shift+Keypad\-Plus
162Font size up by one unit. 159Font size up by one unit.
163. 160.
164.TP 161.TP
165.B Shift+Keypad\-Minus 162.B Shift+Keypad\-Minus
166Font size down by one unit. 163Font size down by one unit.
167. 164.
168.TP 165.TP
169.B Shift+Keypad\-Multiply 166.B Shift+Keypad\-Multiply
170Reset font size to 10. 167Reset font size to 10.
171. 168.
172.TP 169.TP
173.B Shift+Keypad\-Divide 170.B Shift+Keypad\-Divide
174Copy highlight to Clipboard (same as ctrl+c in gui apps). 171Copy highlight to Clipboard (same as ctrl+c in gui apps).
175. 172.
176.TP 173.TP
177.B Ctrl+PgUp 174.B Ctrl+PgUp
178Switch focus to previous terminal inside a window (when using splits). 175Switch focus to previous terminal inside a window (when using splits).
179. 176.
180.TP 177.TP
181.B Ctrl+PgDn 178.B Ctrl+PgDn
182Switch focus to next terminal inside a window (when using splits). 179Switch focus to next terminal inside a window (when using splits).
183. 180.
184.TP 181.TP
185.B Ctrl+Shift+t 182.B Ctrl+Shift+t
186Create a new terminal on top of current inside window (tabs). 183Create a new terminal on top of current inside window (tabs).
187. 184.
188.TP 185.TP
189.B Ctrl+Shift+Home 186.B Ctrl+Shift+Home
190Bring up "tab" switcher. 187Bring up "tab" switcher.
191. 188.
192.TP 189.TP
193.B Ctrl+Shift+PgUp 190.B Ctrl+Shift+PgUp
194Split terminal horizontally (one terminal above the other). 191Split terminal horizontally (one terminal above the other).
195. 192.
196.TP 193.TP
197.B Ctrl+Shift+PgDn 194.B Ctrl+Shift+PgDn
198Split terminal vertically (one terminal to the left of the other). 195Split terminal vertically (one terminal to the left of the other).
199. 196.
200.TP 197.TP
201.B Alt+Home 198.B Alt+Home
202Enter command mode (enter commands to control terminology itself) 199Enter command mode (enter commands to control terminology itself)
203. 200.
204.TP 201.TP
205.B Alt+Return 202.B Alt+Return
206Paste primary selection. 203Paste primary selection.
207. 204.
208.TP 205.TP
209.B Ctrl+Shift+c 206.B Ctrl+Shift+c
210Copy current selection to clipboard. 207Copy current selection to clipboard.
211. 208.
212.TP 209.TP
213.B Ctrl+Shift+v 210.B Ctrl+Shift+v
214Paste current clipboard selection. 211Paste current clipboard selection.
215. 212.
216.TP 213.TP
@@ -264,18 +261,18 @@ Decrease font size. Note that it works on scalable fonts only.
264Display big font size (10x20 bitmap, or size 20 with scalable). 261Display big font size (10x20 bitmap, or size 20 with scalable).
265. 262.
266.TP 263.TP
267.B gNxM 264.B gNxM
268Make terminal NxM chars in size (if possible). e.g. g80x48 g40x20. 265Make terminal NxM chars in size (if possible). e.g. g80x48 g40x20.
269If just one number is provided, it will use the following shortcuts: 266If just one number is provided, it will use the following shortcuts:
270g0=80x24; g1=80x40; g2=80x60; g3=80x80; g4=120x24; g5=120x40; g6=120x60; 267g0=80x24; g1=80x40; g2=80x60; g3=80x80; g4=120x24; g5=120x40; g6=120x60;
271g7=120x80; g8=120x120 268g7=120x80; g8=120x120
272. 269.
273.TP 270.TP
274.B b 271.B b
275Reset the background (no media) 272Reset the background (no media)
276. 273.
277.TP 274.TP
278.B bPATH 275.B bPATH
279Set the background media to an absolute file PATH 276Set the background media to an absolute file PATH
280 277
281.SH EXTENDED ESCAPES FOR TERMINOLOGY: 278.SH EXTENDED ESCAPES FOR TERMINOLOGY:
@@ -289,7 +286,7 @@ i.e.
289 4 \\000 char (nul byte or 0x00 to indicate end of sequence) 286 4 \\000 char (nul byte or 0x00 to indicate end of sequence)
290e.g. 287e.g.
291 echo \-n '\\033}Hello world\000' 288 echo \-n '\\033}Hello world\000'
292 289
293.B Commands: 290.B Commands:
294 291
295any values inside square brackets [] are to be replaced by some 292any values inside square brackets [] are to be replaced by some
@@ -337,33 +334,33 @@ is[CW;H;FULL\-PATH\-OR\-URL]
337 where C is the replace character to be identified in later text 334 where C is the replace character to be identified in later text
338 where W is the width in character cells (up to 511). 335 where W is the width in character cells (up to 511).
339 where H is the height in character cells (up to 511). 336 where H is the height in character cells (up to 511).
340 337
341 note that this escape alone has no effect. it indicates a future 338 note that this escape alone has no effect. it indicates a future
342 intention of inserting media into the terminal. the terminal will 339 intention of inserting media into the terminal. the terminal will
343 EXPECT a grid of WxH "replace characters" to follow, with each 340 EXPECT a grid of WxH "replace characters" to follow, with each
344 sequence of such replace characters bebung with a 'ib' escape command 341 sequence of such replace characters bebung with a 'ib' escape command
345 and ending with an 'ie' escape command. 342 and ending with an 'ie' escape command.
346 343
347 the FULL\-PATH\-OR\-URL for all the i commands (is, ic, if, it) may 344 the FULL\-PATH\-OR\-URL for all the i commands (is, ic, if, it) may
348 be of the form: 345 be of the form:
349 346
350 /full/path/to/file.png 347 /full/path/to/file.png
351 348
352 OR 349 OR
353 350
354 /full/path/to/link\n/full/path/to/file.png 351 /full/path/to/link\n/full/path/to/file.png
355 352
356 where a newline character separates a URI for a link and a full 353 where a newline character separates a URI for a link and a full
357 path to a file to display in the region. the link is the 354 path to a file to display in the region. the link is the
358 destination URI when a user may clikc on the given media image. 355 destination URI when a user may clikc on the given media image.
359 356
360 example: 357 example:
361 358
362 printf("\\\033}is#5;3;%s\000" 359 printf("\\\033}is#5;3;%s\000"
363 "\\\033}ib#####\\\033}ie\\\n" 360 "\\\033}ib#####\\\033}ie\\\n"
364 "\\\033}ib#####\\\033}ie\\\n" 361 "\\\033}ib#####\\\033}ie\\\n"
365 "\\\033}ib#####\\\033}ie\\\n", "/tmp/icon.png"); 362 "\\\033}ib#####\\\033}ie\\\n", "/tmp/icon.png");
366 363
367 note that '#' is the replace character, and later '#' chars if inside 364 note that '#' is the replace character, and later '#' chars if inside
368 begin/end escapes, will be replaced by the given media indicated 365 begin/end escapes, will be replaced by the given media indicated
369 in the insert media escape. 366 in the insert media escape.
@@ -391,9 +388,9 @@ ie
391 = end media replace sequence run 388 = end media replace sequence run
392 389
393.SH BUGS 390.SH BUGS
394If you find a bug or for known issues/bugs/feature requests please email 391If you find a bug or for known issues/bugs/feature requests please email
395enlightenment-devel@lists.sourceforge.net or visit the place where all the hard 392enlightenment-devel@lists.sourceforge.net or visit the place where all the hard
396work is done http://phab.enlightenment.org/ 393work is done http://phab.enlightenment.org/
397 394
398.SH AUTHOR 395.SH AUTHOR
399Terminology was writtern by Carsten Haitzler <raster@rasterman.com> and others. See 396Terminology was writtern by Carsten Haitzler <raster@rasterman.com> and others. See