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

Minor manpage improvements 

Summary:
- Add basic man page for ty helpers
- Fix terminology(1) header

paramaters -> parameters

Double escape \n

Reviewers: billiob

Subscribers: rvandegrift

Tags: #terminology

Differential Revision: https://phab.enlightenment.org/D7356
This commit is contained in:
Ross Vandegrift 2018-11-26 21:21:37 +01:00 committed by Boris Faure
parent ce7407662e
commit 6327d714aa
10 changed files with 85 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
man/meson.build
View File

@ -1 +1,9 @@
install_man('terminology.1')
install_man('terminology-helpers.1')
install_man('tyls.1')
install_man('tyalpha.1')
install_man('tybg.1')
install_man('tycat.1')
install_man('typop.1')
install_man('tyq.1')
install_man('tysend.1')

49
man/terminology-helpers.1 Normal file
View File

@ -0,0 +1,49 @@
.\" Manpage for terminology helpers
.TH TERMINOLOGY-HELPERS 1 "May 5 2018"
.SH NAME
terminiology-helpers \- programs that enhance
.B terminology(1)
.SH SYNOPSIS
.TP
.B tyls [-h] [-a] [-s|-m] FILE1 [FILE2 ...]
List directory contents with bells and whistles
.
.TP
.B tyalpha [-h][-p] on|off|<opacity level>
Set transparency level of the background
.
.TP
.B tybg [-h] [-p] [FILE1 FILE2 ...]
Change the background image
.
.TP
.B tycat [-h] [-s|-f|-c] [-g <width>x<height>] FILE1 [FILE2 ...]
Display inline a media file or a URI
.
.TP
.B typop [-h] FILE1 [FILE2 ...]
Display in a popup a media file or a URI
.
.TP
.B tyq [-h] FILE1 [FILE2 ...]
Queue media files or URI to be popped up
.
.TP
.B tysend [-h] FILE1 [FILE2 ...]
Send files to the terminal (useful through ssh)
.SH DESCRIPTION
.PP
Terminology provides a number of companion tools to control advanced
behavior. They allow in-line and popup display of media files,
enhanced file listing, and control over visual appearance.
The escape codes used to implement these behaviors are documented in
.B EXTENDED ESCAPES FOR TERMINOLOGY
section of
.BR terminology (1).
.SH SEE ALSO
.BR terminology (1),
.SH AUTHOR
Terminology was written by Carsten Haitzler <raster@rasterman.com> and others. It is maintained by Boris Faure <boris@fau.re> and others. See AUTHORS file for other contributors.

42
man/terminology.1
View File

@ -1,5 +1,5 @@
.\" Manpage for Terminology
.TH man 1 "23 Nov 2018" "1.3.0" "Terminology man page"
.TH TERMINOLOGY 1 "23 Nov 2018" "1.3.0" "Terminology man page"
.SH NAME
Terminology \- Terminal Emulator written with EFL (Enlightenment Foundation Libraries).
.SH SYNOPSIS
@ -524,17 +524,17 @@ or
\fBic[CW;H;FULL\-PATH\-OR\-URL]\fP
insert CENTERED media (centered in cell area). Otherwise
paramaters are identical to the \fBis\fP command, but
parameters are identical to the \fBis\fP command, but
retains aspect and is padded by blank space.
\fBif[CW;H;FULL\-PATH\-OR\-URL]\fP
insert FILLED media (fill in cell area). Otherwise paramaters
insert FILLED media (fill in cell area). Otherwise parameters
are identical to the \fBis\fP command but ensures the entire
area is filled like a background even if media goes beyond
cell bounds and is clipped.
\fBit[CW;H;FULL\-PATH\-OR\-URL]\fP
insert THUMB media (thumbnail cell area). Otherwise paramaters
insert THUMB media (thumbnail cell area). Otherwise parameters
are identical to the \fBis\fP command, but uses thumbnail
generation to make a fast to load but low resolution version
(cached) of the media.
@ -564,16 +564,16 @@ or
;CHID\\ndrag,step\\nPART NAME\\nVAL1\\nVAL2
;CHID\\drag,set\\nPART NAME\\nVAL1\\nVAL2
signal;CHID\\nSIGNAL STRING\\nSOURCE STRING
message;CHID\nOPCODE ID\nstring\\nSTRING1
message;CHID\nOPCODE ID\nint\\nINT1
message;CHID\nOPCODE ID\nfloat\\nFLOAT1
message;CHID\nOPCODE ID\nstring_set\\nSTRING1\\nSTRING2\\nSTRING3...
message;CHID\nOPCODE ID\nint_set\\nINT1\\nINT2\\nINT3...
message;CHID\nOPCODE ID\nfloat_set\\nFLOAT1\\nFLOAT2\\nFLOAT3...
message;CHID\nOPCODE ID\nstring_int\\nSTRING1\\nINT1
message;CHID\nOPCODE ID\nstring_float\\nSTRING1\\nFLOAT1
message;CHID\nOPCODE ID\nstring_int_set\\nSTRING1\\nINT1\\nINT2\\nINT3...
message;CHID\nOPCODE ID\nstring_float_set\\nSTRING1\\nFLOAT1\\nFLOAT2\\nFLOAT3...
message;CHID\\nOPCODE ID\\nstring\\nSTRING1
message;CHID\\nOPCODE ID\\nint\\nINT1
message;CHID\\nOPCODE ID\\nfloat\\nFLOAT1
message;CHID\\nOPCODE ID\\nstring_set\\nSTRING1\\nSTRING2\\nSTRING3...
message;CHID\\nOPCODE ID\\nint_set\\nINT1\\nINT2\\nINT3...
message;CHID\\nOPCODE ID\\nfloat_set\\nFLOAT1\\nFLOAT2\\nFLOAT3...
message;CHID\\nOPCODE ID\\nstring_int\\nSTRING1\\nINT1
message;CHID\\nOPCODE ID\\nstring_float\\nSTRING1\\nFLOAT1
message;CHID\\nOPCODE ID\\nstring_int_set\\nSTRING1\\nINT1\\nINT2\\nINT3...
message;CHID\\nOPCODE ID\\nstring_float_set\\nSTRING1\\nFLOAT1\\nFLOAT2\\nFLOAT3...
\fBiC[CHID]\\n[cmd1][\\r\\n][cmd2][\\r\\n][cmd3]...\fP
send a COMMAND (\fBcmd1, cmd2, cmd3\fP etc.) to an existing named
@ -611,13 +611,13 @@ or
\fBstring\fP: \fBSTRING1\fP
\fBint\fP: \fBINT1\fP
\fBfloat\fP: \fBFLOAT1\fP
\fBstring_set\fP: \fBSTRING1\nSTRING2\nSTRING3...\fP
\fBint_set\fP: \fBINT1\nINT2\nINT3...\fP
\fBfloat_set\fP: \fBFLOAT1\nFLOAT2\nFLOAT3...\fP
\fBstring_int\fP: \fBSTRING1\nINT1\fP
\fBstring_float\fP: \fBSTRING1\nFLOAT1\fP
\fBstring_int_set\fP: \fBSTRING1\nINT1\nINT2\nINT3...\fP
\fBstring_float_set\fP: \fBSTRING1\nFLOAT1\nFLOAT2\nFLOAT3...\fP
\fBstring_set\fP: \fBSTRING1\\nSTRING2\\nSTRING3...\fP
\fBint_set\fP: \fBINT1\\nINT2\\nINT3...\fP
\fBfloat_set\fP: \fBFLOAT1\\nFLOAT2\\nFLOAT3...\fP
\fBstring_int\fP: \fBSTRING1\\nINT1\fP
\fBstring_float\fP: \fBSTRING1\\nFLOAT1\fP
\fBstring_int_set\fP: \fBSTRING1\\nINT1\\nINT2\\nINT3...\fP
\fBstring_float_set\fP: \fBSTRING1\\nFLOAT1\\nFLOAT2\\nFLOAT3...\fP
\fBib\fP
begin media replace sequence run.

1
man/tyalpha.1 Normal file
View File

@ -0,0 +1 @@
.so man1/terminology-helpers.1

1
man/tybg.1 Normal file
View File

@ -0,0 +1 @@
.so man1/terminology-helpers.1

1
man/tycat.1 Normal file
View File

@ -0,0 +1 @@
.so man1/terminology-helpers.1

1
man/tyls.1 Normal file
View File

@ -0,0 +1 @@
.so man1/terminology-helpers.1

1
man/typop.1 Normal file
View File

@ -0,0 +1 @@
.so man1/terminology-helpers.1

1
man/tyq.1 Normal file
View File

@ -0,0 +1 @@
.so man1/terminology-helpers.1

1
man/tysend.1 Normal file
View File

@ -0,0 +1 @@
.so man1/terminology-helpers.1