diff options
-rw-r--r-- | Makefile.am | 2 | ||||
-rw-r--r-- | configure.ac | 1 | ||||
-rw-r--r-- | man/Makefile.am | 2 | ||||
-rw-r--r-- | man/terminology.1 | 392 |
4 files changed, 396 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am index 596e117..e026a3c 100644 --- a/Makefile.am +++ b/Makefile.am | |||
@@ -1,6 +1,6 @@ | |||
1 | ACLOCAL_AMFLAGS = -I m4 | 1 | ACLOCAL_AMFLAGS = -I m4 |
2 | 2 | ||
3 | SUBDIRS = src data | 3 | SUBDIRS = src data man |
4 | 4 | ||
5 | MAINTAINERCLEANFILES = \ | 5 | MAINTAINERCLEANFILES = \ |
6 | Makefile.in \ | 6 | Makefile.in \ |
diff --git a/configure.ac b/configure.ac index 4d0611f..eeb2e75 100644 --- a/configure.ac +++ b/configure.ac | |||
@@ -71,6 +71,7 @@ data/images/Makefile | |||
71 | data/fonts/Makefile | 71 | data/fonts/Makefile |
72 | data/themes/Makefile | 72 | data/themes/Makefile |
73 | data/themes/images/Makefile | 73 | data/themes/images/Makefile |
74 | man/Makefile | ||
74 | ]) | 75 | ]) |
75 | 76 | ||
76 | AC_OUTPUT | 77 | AC_OUTPUT |
diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..923851a --- /dev/null +++ b/man/Makefile.am | |||
@@ -0,0 +1,2 @@ | |||
1 | man1_MANS = terminology.1 | ||
2 | EXTRA_DIST = terminology.1 | ||
diff --git a/man/terminology.1 b/man/terminology.1 new file mode 100644 index 0000000..851e6fe --- /dev/null +++ b/man/terminology.1 | |||
@@ -0,0 +1,392 @@ | |||
1 | .\" Manpage for Terminology | ||
2 | .TH man 1 "27 Mar 2013" "0.3" "Terminology man page" | ||
3 | .SH NAME | ||
4 | Terminology \- Terminal Emulator written with EFL (Enligthenment Foundation Libraries). | ||
5 | .SH SYNOPSIS | ||
6 | .B terminology [options] | ||
7 | .SH DESCRIPTION | ||
8 | This is an EFL terminal emulator with some extra bells and whistles. | ||
9 | It's brand new and was only started near the begining of June 2012, so | ||
10 | expecting it to do everything a mature terminal emulator does is a bit | ||
11 | premature, but considering it's young age, it does a lot. | ||
12 | It has many features including split terminal support, support for tabs, preview | ||
13 | icons for files | ||
14 | .SH OPTIONS | ||
15 | . | ||
16 | .TP | ||
17 | .B \-e, \-\-exec <cmnd> | ||
18 | Specify command to execute. | ||
19 | Defaults to $SHELL (or passwd shel or /bin/sh) | ||
20 | . | ||
21 | .TP | ||
22 | .B \-d=CURRENT-DIRECTORY, \-\-current\-directory=CURRENT-DIRECTORY | ||
23 | Change to directory for execution of terminal command. | ||
24 | Type: STR. | ||
25 | . | ||
26 | .TP | ||
27 | .B \-t=THEME, \-\-theme=THEME | ||
28 | Use the named edje theme or path to theme file. | ||
29 | Type: STR. | ||
30 | . | ||
31 | .TP | ||
32 | .B \-b=BACKGROUND, \-\-background=BACKGROUND | ||
33 | Use the named file as a background wallpaper for terminology. | ||
34 | Type: STR. | ||
35 | . | ||
36 | .TP | ||
37 | .B \-g=GEOMETRY, \-\-geometry=GEOMETRY | ||
38 | Terminal geometry to use (eg 80x24 or 80x24+50+20 etc.). | ||
39 | Type: STR. | ||
40 | . | ||
41 | .TP | ||
42 | .B \-n=NAME, \-\-name=NAME | ||
43 | Set window name. | ||
44 | Type: STR. | ||
45 | . | ||
46 | .TP | ||
47 | .B \-r=ROLE, \-\-role=ROLE | ||
48 | Set window role. | ||
49 | Type: STR. | ||
50 | . | ||
51 | .TP | ||
52 | .B \-T=TITLE, \-\-title=TITLE | ||
53 | Set window title. | ||
54 | Type: STR. | ||
55 | . | ||
56 | .TP | ||
57 | .B \-i=ICON\-NAME, \-\-icon-name=ICON\-NAME | ||
58 | Set icon name. | ||
59 | Type: STR. | ||
60 | . | ||
61 | .TP | ||
62 | .B \-f=FONT, \-\-font=FONT | ||
63 | Set font (NAME/SIZE for scalable, NAME for bitmap. | ||
64 | Type: STR. | ||
65 | . | ||
66 | .TP | ||
67 | .B \-v=VIDEO\-MODULE, \-\-video-module=VIDEO\-MODULE | ||
68 | Set emotion module to use. Choices are: auto, gstreamer, xine, generic. | ||
69 | . | ||
70 | .Tp | ||
71 | .B \-l=LOGIN, \-\-login=LOGIN | ||
72 | Run the shell as a login shell. | ||
73 | Type: BOOL. | ||
74 | . | ||
75 | .TP | ||
76 | .B \-m=VIDEO\-MUTE, \-\-video-mute=VIDEO\-MUTE | ||
77 | Set mute mode for video playback. | ||
78 | Type: BOOL. | ||
79 | . | ||
80 | .TP | ||
81 | .B \-c=CURSOR\-BLINK, \-\-cursor-blink=CURSOR\-BLINK | ||
82 | Set cursor blink mode. | ||
83 | Type: BOOL. | ||
84 | . | ||
85 | .TP | ||
86 | .B \-G=VISUAL\-BELL, \-\-visual\-bell=VISUAL\-BELL | ||
87 | Set visual bell mode. | ||
88 | Type: BOOL. | ||
89 | . | ||
90 | .TP | ||
91 | .B \-F, \-\-fullscreen | ||
92 | Go into the fullscreen mode from start. | ||
93 | . | ||
94 | .TP | ||
95 | .B \-I, \-\-iconic | ||
96 | Go into an iconic state from the start. | ||
97 | . | ||
98 | .TP | ||
99 | .B \-B, \-\-borderless | ||
100 | Become a borderless managed window. | ||
101 | . | ||
102 | .TP | ||
103 | .B \-O, \-\-override | ||
104 | Become an override-redirect window. | ||
105 | . | ||
106 | .TP | ||
107 | .B \-M, \-\-maximized | ||
108 | Become maximized from the start. | ||
109 | . | ||
110 | .TP | ||
111 | .B \-W, \-\-nowm | ||
112 | Terminology is run without a wm. | ||
113 | . | ||
114 | .TP | ||
115 | .B \-H, \-\-hold | ||
116 | Don't exit when the command process exits. | ||
117 | . | ||
118 | .TP | ||
119 | .B \-s, \-\-single | ||
120 | Force single executable if multi-instance is enabled.. | ||
121 | . | ||
122 | .TP | ||
123 | .B \-V, \-\-version | ||
124 | Show program version. | ||
125 | . | ||
126 | .TP | ||
127 | .B \-C, \-\-copyright | ||
128 | Show copyright. | ||
129 | . | ||
130 | .TP | ||
131 | .B \-L, \-\-license | ||
132 | Show license. | ||
133 | . | ||
134 | .TP | ||
135 | .B \-h, \-\-help | ||
136 | Show this message. | ||
137 | |||
138 | .SH CONTROLS / SHORTCUTS | ||
139 | . | ||
140 | .TP | ||
141 | .B Shift+PgUp | ||
142 | Scroll terminology one page up | ||
143 | . | ||
144 | .TP | ||
145 | .B Shift+PgDn | ||
146 | Scroll terminology one page down | ||
147 | . | ||
148 | .TP | ||
149 | .B Shift+Insert | ||
150 | Paste Clipboard (ctrl+v/c) selection | ||
151 | . | ||
152 | .TP | ||
153 | .B Shift+Ctrl+Insert | ||
154 | Paste Primary (highlight) selection | ||
155 | . | ||
156 | .TP | ||
157 | .B Shift+Keypad\-Plus | ||
158 | Font size up by one unit. | ||
159 | . | ||
160 | .TP | ||
161 | .B Shift+Keypad\-Minus | ||
162 | Font size down by one unit. | ||
163 | . | ||
164 | .TP | ||
165 | .B Shift+Keypad\-Multiply | ||
166 | Reset font size to 10. | ||
167 | . | ||
168 | .TP | ||
169 | .B Shift+Keypad\-Divide | ||
170 | Copy highlight to Clipboard (same as ctrl+c in gui apps). | ||
171 | . | ||
172 | .TP | ||
173 | .B Ctrl+PgUp | ||
174 | Switch focus to previous terminal inside a window (when using splits). | ||
175 | . | ||
176 | .TP | ||
177 | .B Ctrl+PgDn | ||
178 | Switch focus to next terminal inside a window (when using splits). | ||
179 | . | ||
180 | .TP | ||
181 | .B Ctrl+Shift+t | ||
182 | Create a new terminal on top of current inside window (tabs). | ||
183 | . | ||
184 | .TP | ||
185 | .B Ctrl+Shift+Home | ||
186 | Bring up "tab" switcher. | ||
187 | . | ||
188 | .TP | ||
189 | .B Ctrl+Shift+PgUp | ||
190 | Split terminal horizontally (one terminal above the other). | ||
191 | . | ||
192 | .TP | ||
193 | .B Ctrl+Shift+PgDn | ||
194 | Split terminal vertically (one terminal to the left of the other). | ||
195 | . | ||
196 | .TP | ||
197 | .B Alt+Home | ||
198 | Enter command mode (enter commands to control terminology itself) | ||
199 | . | ||
200 | .TP | ||
201 | .B Alt+Return | ||
202 | Paste primary selection. | ||
203 | . | ||
204 | .TP | ||
205 | .B Ctrl+Shift+c | ||
206 | Copy current selection to clipboard. | ||
207 | . | ||
208 | .TP | ||
209 | .B Ctrl+Shift+v | ||
210 | Paste current clipboard selection. | ||
211 | |||
212 | .SH MOUSE CONTROLS | ||
213 | . | ||
214 | .TP | ||
215 | .B Right mouse click | ||
216 | Bring up controls menus. | ||
217 | . | ||
218 | .TP | ||
219 | .B Middle mouse click | ||
220 | Paste highlight selection. | ||
221 | . | ||
222 | .TP | ||
223 | .B Left mouse click/drag | ||
224 | Make a selection highlight. | ||
225 | . | ||
226 | .TP | ||
227 | .B Ctrl + Left mouse click/drag | ||
228 | Make a block selection. | ||
229 | . | ||
230 | .TP | ||
231 | .B Wheel | ||
232 | Scroll up or down in history. | ||
233 | . | ||
234 | .TP | ||
235 | .B Ctrl + Wheel | ||
236 | Zoom font size up/down. | ||
237 | |||
238 | .SH COMMAND MODE COMMANDS | ||
239 | To enter command mode in terminology press Alt+Home. Currently command mode | ||
240 | understands the following commands: | ||
241 | . | ||
242 | .TP | ||
243 | .B f | ||
244 | Reset font to default setting saved in config. | ||
245 | . | ||
246 | .TP | ||
247 | .B f+ | ||
248 | Increase font size. Note that it works on scalable fonts only. | ||
249 | . | ||
250 | .TP | ||
251 | .B f\- | ||
252 | Decrease font size. Note that it works on scalable fonts only. | ||
253 | . | ||
254 | .TP | ||
255 | .B fb | ||
256 | Display big font size (10x20 bitmap, or size 20 with scalable). | ||
257 | . | ||
258 | .TP | ||
259 | .B gNxM | ||
260 | Make terminal NxM chars in size (if possible). e.g. g80x48 g40x20. | ||
261 | If just one number is provided, it will use the following shortcuts: | ||
262 | g0=80x24; g1=80x40; g2=80x60; g3=80x80; g4=120x24; g5=120x40; g6=120x60; | ||
263 | g7=120x80; g8=120x120 | ||
264 | . | ||
265 | .TP | ||
266 | .B b | ||
267 | Reset the background (no media) | ||
268 | . | ||
269 | .TP | ||
270 | .B bPATH | ||
271 | Set the background media to an absolute file PATH | ||
272 | |||
273 | .SH EXTENDED ESCAPES FOR TERMINOLOGY: | ||
274 | . | ||
275 | .TP | ||
276 | .B [\\\033][}][COMMAND][\\\000] | ||
277 | i.e. | ||
278 | 1. ESC char (\\033 or 0x1b) | ||
279 | 2. } char | ||
280 | 3... sequence of UTF8 chars other than nul (\\000 or 0x00). | ||
281 | 4 \\000 char (nul byte or 0x00 to indicate end of sequence) | ||
282 | e.g. | ||
283 | echo \-n '\\033}Hello world\000' | ||
284 | |||
285 | .B Commands: | ||
286 | |||
287 | any values inside square brackets [] are to be replaced by some | ||
288 | content (numbers, strings, paths, url's etc.). example: | ||
289 | |||
290 | aa[PATH\-OF\-FILE] should be come something like: | ||
291 | aa/tmp/file.png | ||
292 | or aa[true/false] should become something like: | ||
293 | aatrue | ||
294 | or | ||
295 | aafalse | ||
296 | |||
297 | \-\-\- | ||
298 | |||
299 | pn[FULL\-PATH\-OR\-URL] | ||
300 | = popup the given media file/url now | ||
301 | |||
302 | pq[FULL\-PATH\-OR\-URL] | ||
303 | = quque a popup for the given media file/url | ||
304 | |||
305 | bt[FULL\-PATH\-OR\-URL] | ||
306 | = set the terminal background media file/url temporarily | ||
307 | |||
308 | bp[FULL\-PATH\-OR\-URL] | ||
309 | = set the terminal background media file/url permanently | ||
310 | |||
311 | at[on/true/yes/off/false/no] | ||
312 | = set the terminal alpha state to be on, or off temporarily | ||
313 | |||
314 | ap[on/true/yes/off/false/no] | ||
315 | = set the terminal alpha state to be on, or off permanently | ||
316 | |||
317 | qs | ||
318 | = query grid and font size. stdin will have written to it: | ||
319 | W;H;FW;FH\n | ||
320 | where W is the width of the terminal grid in characters | ||
321 | where H is the height of the terminal grid in characters | ||
322 | where FW is the width of 1 character cell in pixels | ||
323 | where FH is the height of 1 character cell in pixels | ||
324 | |||
325 | is[CW;H;FULL\-PATH\-OR\-URL] | ||
326 | = insert STRETCHED media (where image will stretch to fill the cell area) | ||
327 | and define expected cell area to be W cells wide and H cells high, | ||
328 | with the image/media/url. | ||
329 | where C is the replace character to be identified in later text | ||
330 | where W is the width in character cells (up to 511). | ||
331 | where H is the height in character cells (up to 511). | ||
332 | |||
333 | note that this escape alone has no effect. it indicates a future | ||
334 | intention of inserting media into the terminal. the terminal will | ||
335 | EXPECT a grid of WxH "replace characters" to follow, with each | ||
336 | sequence of such replace characters bebung with a 'ib' escape command | ||
337 | and ending with an 'ie' escape command. | ||
338 | |||
339 | the FULL\-PATH\-OR\-URL for all the i commands (is, ic, if, it) may | ||
340 | be of the form: | ||
341 | |||
342 | /full/path/to/file.png | ||
343 | |||
344 | OR | ||
345 | |||
346 | /full/path/to/link\n/full/path/to/file.png | ||
347 | |||
348 | where a newline character separates a URI for a link and a full | ||
349 | path to a file to display in the region. the link is the | ||
350 | destination URI when a user may clikc on the given media image. | ||
351 | |||
352 | example: | ||
353 | |||
354 | printf("\\\033}is#5;3;%s\000" | ||
355 | "\\\033}ib#####\\\033}ie\\\n" | ||
356 | "\\\033}ib#####\\\033}ie\\\n" | ||
357 | "\\\033}ib#####\\\033}ie\\\n", "/tmp/icon.png"); | ||
358 | |||
359 | note that '#' is the replace character, and later '#' chars if inside | ||
360 | begin/end escapes, will be replaced by the given media indicated | ||
361 | in the insert media escape. | ||
362 | |||
363 | ic[CW;H;FULL\-PATH\-OR\-URL] | ||
364 | = insert CENTERED media (centered in cell area). otherwise paramaters are | ||
365 | identical to the "is" command, but retains aspect and is padded by | ||
366 | blank space. | ||
367 | |||
368 | if[CW;H;FULL\-PATH\-OR\-URL] | ||
369 | = insert FILLED media (fill in cell area). otherwise paramaters are | ||
370 | identical to the "is" command but ensures the entire area is | ||
371 | filled like a background even if media goes beyond cell bounds and is | ||
372 | clipped. | ||
373 | |||
374 | it[CW;H;FULL\-PATH\-OR\-URL] | ||
375 | = insert THUMB media (thumbnail cell area). otherwise paramaters are | ||
376 | identical to the "is" command, but uses thumbnail generation to | ||
377 | make a fast to load but low resolution version (cached) of the media. | ||
378 | |||
379 | ib | ||
380 | = begin media replace sequence run | ||
381 | |||
382 | ie | ||
383 | = end media replace sequence run | ||
384 | |||
385 | .SH BUGS | ||
386 | If you find a bug or for known issues/bugs/feature requests please email | ||
387 | enlightenment-devel@lists.sourceforge.net or visit the place where all the hard | ||
388 | work is done http://phab.enlightenment.org/ | ||
389 | |||
390 | .SH AUTHOR | ||
391 | Terminology was writtern by Carsten Haitzler <raster@rasterman.com> and others. See | ||
392 | AUTHORS file for other contributors. | ||