enlightenment/terminology
enlightenment
/
terminology
9
6
Fork 7
Code Issues 7 Pull Requests Projects Releases Wiki Activity

update man page

This commit is contained in:
Boris Faure 2013-11-16 15:27:18 +01:00
parent 4f05397bd5
commit 1619b744f3
1 changed files with 46 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
man/terminology.1
View File

@ -1,16 +1,13 @@
.\" Manpage for Terminology .\" Manpage for Terminology
.TH man 1 "18 Apr 2013" "0.3" "Terminology man page" .TH man 1 "18 Nov 2013" "0.4" "Terminology man page"
.SH NAME .SH NAME
Terminology \- Terminal Emulator written with EFL (Enligthenment Foundation Libraries). Terminology \- Terminal Emulator written with EFL (Enligthenment Foundation Libraries).
.SH SYNOPSIS .SH SYNOPSIS
.B terminology [options] .B terminology [options]
.SH DESCRIPTION .SH DESCRIPTION
This is an EFL terminal emulator with some extra bells and whistles. This is an EFL terminal emulator with some extra bells and whistles.
It's brand new and was only started near the begining of June 2012, so
expecting it to do everything a mature terminal emulator does is a bit
premature, but considering it's young age, it does a lot.
It has many features including split terminal support, support for tabs, preview It has many features including split terminal support, support for tabs, preview
icons for files icons for files and so on...
.SH OPTIONS .SH OPTIONS
. .
.TP .TP
@ -39,12 +36,12 @@ Terminal geometry to use (eg 80x24 or 80x24+50+20 etc.).
Type: STR. Type: STR.
. .
.TP .TP
.B \-n=NAME, \-\-name=NAME .B \-n=NAME, \-\-name=NAME
Set window name. Set window name.
Type: STR. Type: STR.
. .
.TP .TP
.B \-r=ROLE, \-\-role=ROLE .B \-r=ROLE, \-\-role=ROLE
Set window role. Set window role.
Type: STR. Type: STR.
. .
@ -59,7 +56,7 @@ Set icon name.
Type: STR. Type: STR.
. .
.TP .TP
.B \-f=FONT, \-\-font=FONT .B \-f=FONT, \-\-font=FONT
Set font (NAME/SIZE for scalable, NAME for bitmap. Set font (NAME/SIZE for scalable, NAME for bitmap.
Type: STR. Type: STR.
. .
@ -88,15 +85,15 @@ Set visual bell mode.
Type: BOOL. Type: BOOL.
. .
.TP .TP
.B \-F, \-\-fullscreen .B \-F, \-\-fullscreen
Go into the fullscreen mode from start. Go into the fullscreen mode from start.
. .
.TP .TP
.B \-I, \-\-iconic .B \-I, \-\-iconic
Go into an iconic state from the start. Go into an iconic state from the start.
. .
.TP .TP
.B \-B, \-\-borderless .B \-B, \-\-borderless
Become a borderless managed window. Become a borderless managed window.
. .
.TP .TP
@ -104,15 +101,15 @@ Become a borderless managed window.
Become an override-redirect window. Become an override-redirect window.
. .
.TP .TP
.B \-M, \-\-maximized .B \-M, \-\-maximized
Become maximized from the start. Become maximized from the start.
. .
.TP .TP
.B \-W, \-\-nowm .B \-W, \-\-nowm
Terminology is run without a wm. Terminology is run without a wm.
. .
.TP .TP
.B \-H, \-\-hold .B \-H, \-\-hold
Don't exit when the command process exits. Don't exit when the command process exits.
. .
.TP .TP
@ -128,7 +125,7 @@ Set TERM to \fBxterm-256color\fP instead of \fBxterm\fP.
Show program version. Show program version.
. .
.TP .TP
.B \-C, \-\-copyright .B \-C, \-\-copyright
Show copyright. Show copyright.
. .
.TP .TP
@ -142,75 +139,75 @@ Show this message.
.SH CONTROLS / SHORTCUTS .SH CONTROLS / SHORTCUTS
. .
.TP .TP
.B Shift+PgUp .B Shift+PgUp
Scroll terminology one page up Scroll terminology one page up
. .
.TP .TP
.B Shift+PgDn .B Shift+PgDn
Scroll terminology one page down Scroll terminology one page down
. .
.TP .TP
.B Shift+Insert .B Shift+Insert
Paste Clipboard (ctrl+v/c) selection Paste Clipboard (ctrl+v/c) selection
. .
.TP .TP
.B Shift+Ctrl+Insert .B Shift+Ctrl+Insert
Paste Primary (highlight) selection Paste Primary (highlight) selection
. .
.TP .TP
.B Shift+Keypad\-Plus .B Shift+Keypad\-Plus
Font size up by one unit. Font size up by one unit.
. .
.TP .TP
.B Shift+Keypad\-Minus .B Shift+Keypad\-Minus
Font size down by one unit. Font size down by one unit.
. .
.TP .TP
.B Shift+Keypad\-Multiply .B Shift+Keypad\-Multiply
Reset font size to 10. Reset font size to 10.
. .
.TP .TP
.B Shift+Keypad\-Divide .B Shift+Keypad\-Divide
Copy highlight to Clipboard (same as ctrl+c in gui apps). Copy highlight to Clipboard (same as ctrl+c in gui apps).
. .
.TP .TP
.B Ctrl+PgUp .B Ctrl+PgUp
Switch focus to previous terminal inside a window (when using splits). Switch focus to previous terminal inside a window (when using splits).
. .
.TP .TP
.B Ctrl+PgDn .B Ctrl+PgDn
Switch focus to next terminal inside a window (when using splits). Switch focus to next terminal inside a window (when using splits).
. .
.TP .TP
.B Ctrl+Shift+t .B Ctrl+Shift+t
Create a new terminal on top of current inside window (tabs). Create a new terminal on top of current inside window (tabs).
. .
.TP .TP
.B Ctrl+Shift+Home .B Ctrl+Shift+Home
Bring up "tab" switcher. Bring up "tab" switcher.
. .
.TP .TP
.B Ctrl+Shift+PgUp .B Ctrl+Shift+PgUp
Split terminal horizontally (one terminal above the other). Split terminal horizontally (one terminal above the other).
. .
.TP .TP
.B Ctrl+Shift+PgDn .B Ctrl+Shift+PgDn
Split terminal vertically (one terminal to the left of the other). Split terminal vertically (one terminal to the left of the other).
. .
.TP .TP
.B Alt+Home .B Alt+Home
Enter command mode (enter commands to control terminology itself) Enter command mode (enter commands to control terminology itself)
. .
.TP .TP
.B Alt+Return .B Alt+Return
Paste primary selection. Paste primary selection.
. .
.TP .TP
.B Ctrl+Shift+c .B Ctrl+Shift+c
Copy current selection to clipboard. Copy current selection to clipboard.
. .
.TP .TP
.B Ctrl+Shift+v .B Ctrl+Shift+v
Paste current clipboard selection. Paste current clipboard selection.
. .
.TP .TP
@ -264,18 +261,18 @@ Decrease font size. Note that it works on scalable fonts only.
Display big font size (10x20 bitmap, or size 20 with scalable). Display big font size (10x20 bitmap, or size 20 with scalable).
. .
.TP .TP
.B gNxM .B gNxM
Make terminal NxM chars in size (if possible). e.g. g80x48 g40x20. Make terminal NxM chars in size (if possible). e.g. g80x48 g40x20.
If just one number is provided, it will use the following shortcuts: If just one number is provided, it will use the following shortcuts:
g0=80x24; g1=80x40; g2=80x60; g3=80x80; g4=120x24; g5=120x40; g6=120x60; g0=80x24; g1=80x40; g2=80x60; g3=80x80; g4=120x24; g5=120x40; g6=120x60;
g7=120x80; g8=120x120 g7=120x80; g8=120x120
. .
.TP .TP
.B b .B b
Reset the background (no media) Reset the background (no media)
. .
.TP .TP
.B bPATH .B bPATH
Set the background media to an absolute file PATH Set the background media to an absolute file PATH
.SH EXTENDED ESCAPES FOR TERMINOLOGY: .SH EXTENDED ESCAPES FOR TERMINOLOGY:
@ -289,7 +286,7 @@ i.e.
4 \\000 char (nul byte or 0x00 to indicate end of sequence) 4 \\000 char (nul byte or 0x00 to indicate end of sequence)
e.g. e.g.
echo \-n '\\033}Hello world\000' echo \-n '\\033}Hello world\000'
.B Commands: .B Commands:
any values inside square brackets [] are to be replaced by some any values inside square brackets [] are to be replaced by some
@ -337,33 +334,33 @@ is[CW;H;FULL\-PATH\-OR\-URL]
where C is the replace character to be identified in later text where C is the replace character to be identified in later text
where W is the width in character cells (up to 511). where W is the width in character cells (up to 511).
where H is the height in character cells (up to 511). where H is the height in character cells (up to 511).
note that this escape alone has no effect. it indicates a future note that this escape alone has no effect. it indicates a future
intention of inserting media into the terminal. the terminal will intention of inserting media into the terminal. the terminal will
EXPECT a grid of WxH "replace characters" to follow, with each EXPECT a grid of WxH "replace characters" to follow, with each
sequence of such replace characters bebung with a 'ib' escape command sequence of such replace characters bebung with a 'ib' escape command
and ending with an 'ie' escape command. and ending with an 'ie' escape command.
the FULL\-PATH\-OR\-URL for all the i commands (is, ic, if, it) may the FULL\-PATH\-OR\-URL for all the i commands (is, ic, if, it) may
be of the form: be of the form:
/full/path/to/file.png /full/path/to/file.png
OR OR
/full/path/to/link\n/full/path/to/file.png /full/path/to/link\n/full/path/to/file.png
where a newline character separates a URI for a link and a full where a newline character separates a URI for a link and a full
path to a file to display in the region. the link is the path to a file to display in the region. the link is the
destination URI when a user may clikc on the given media image. destination URI when a user may clikc on the given media image.
example: example:
printf("\\\033}is#5;3;%s\000" printf("\\\033}is#5;3;%s\000"
"\\\033}ib#####\\\033}ie\\\n" "\\\033}ib#####\\\033}ie\\\n"
"\\\033}ib#####\\\033}ie\\\n" "\\\033}ib#####\\\033}ie\\\n"
"\\\033}ib#####\\\033}ie\\\n", "/tmp/icon.png"); "\\\033}ib#####\\\033}ie\\\n", "/tmp/icon.png");
note that '#' is the replace character, and later '#' chars if inside note that '#' is the replace character, and later '#' chars if inside
begin/end escapes, will be replaced by the given media indicated begin/end escapes, will be replaced by the given media indicated
in the insert media escape. in the insert media escape.
@ -391,9 +388,9 @@ ie
= end media replace sequence run = end media replace sequence run
.SH BUGS .SH BUGS
If you find a bug or for known issues/bugs/feature requests please email If you find a bug or for known issues/bugs/feature requests please email
enlightenment-devel@lists.sourceforge.net or visit the place where all the hard enlightenment-devel@lists.sourceforge.net or visit the place where all the hard
work is done http://phab.enlightenment.org/ work is done http://phab.enlightenment.org/
.SH AUTHOR .SH AUTHOR
Terminology was writtern by Carsten Haitzler <raster@rasterman.com> and others. See Terminology was writtern by Carsten Haitzler <raster@rasterman.com> and others. See