~vcs-imports/tilda/trunk

« back to all changes in this revision

Viewing changes to data/man/tilda.1.in

  • Committer: Sebastian Geiger
  • Date: 2023-11-12 20:29:34 UTC
  • Revision ID: git-v1:9f2f64c9317c640fa833205b5ae1dfceac402b83
update man page

This aligns the format of the tilda.1 man page with the recommendations
in man(7) and man-pages(7).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "TILDA" "1" "Feb 2020" "tilda @VERSION@" "User Commands"
 
1
.\" Copyright (c) 2021, Sebastian Geiger (lanoxx@gmx.net)
 
2
.\"
 
3
.\" Copyright (c) 2012, Davide Truffa <davide@catoblepa.org>
 
4
.\"
 
5
.\" %%%LICENSE_START(VERBATIM)
 
6
.\" Permission is granted to make and distribute verbatim copies of this
 
7
.\" manual provided the copyright notice and this permission notice are
 
8
.\" preserved on all copies.
 
9
.\"
 
10
.\" Permission is granted to copy and distribute modified versions of
 
11
.\" this manual under the conditions for verbatim copying, provided that
 
12
.\" the entire resulting derived work is distributed under the terms of
 
13
.\" a permission notice identical to this one.
 
14
.\"
 
15
.\" Since the Linux kernel and libraries are constantly changing, this
 
16
.\" manual page may be incorrect or out-of-date.  The author(s) assume.
 
17
.\" no responsibility for errors or omissions, or for damages resulting.
 
18
.\" from the use of the information contained herein.  The author(s) may.
 
19
.\" not have taken the same level of care in the production of this.
 
20
.\" manual, which is licensed free of charge, as they might when working.
 
21
.\" professionally.
 
22
.\"
 
23
.\" Formatted or processed versions of this manual, if unaccompanied by
 
24
.\" the source, must acknowledge the copyright and authors of this work.
 
25
.\" %%%LICENSE_END
 
26
.TH "TILDA" "1" "Nov 2021" "tilda @VERSION@" "User Commands"
2
27
.SH "NAME"
3
28
tilda \- a highly configurable terminal emulator
 
29
.SH "SYNOPSIS"
 
30
tilda [\fB\-b|\-\-background\-color\fR \fIcolor\fR] [\fB\-c|\-\-command\fR \fIcommand\fR] [\fB\-h|\-\-hidden\fR] [\fB\-f|\-\-font\fR \fIfont\fR] [\fB\-g|\-\-config-file\fR \fIfile\fR] [\fB\-l|\-\-lines\fR \fIfile\fR] [\fB\-s|\-\-scrollbar\fR] [\fB\-w|\-\-working\-dir\fR \fIdir\fR] [\fB\-x|\-\-x\-pos\fR \fIx_pos\fR] [\fB\-y|\-\-y\-pos\fR \fIy_pos\fR] [\fB\-t|\-\-background\-alpha\fR \fIalpha\fR] [\fB\-C|\-\-config\fR] [\fB\-\-display\fR \fIdisplay\fR]
 
31
.PP
 
32
tilda \fB--version\fR
 
33
.PP
 
34
tilda \fB--help\fR
4
35
.SH "DESCRIPTION"
5
 
\fBTilda\fR is a terminal emulator which is highly configurable. The main distinguishing feature of tilda is that it
 
36
.BR Tilda
 
37
is a terminal emulator which is highly configurable. The main distinguishing feature of tilda is that it
6
38
uses a configurable shortcut to show and hide the tilda window. This allows users to quickly switch between tilda
7
39
and other windows only through keyboard shortcuts. When tilda is hidden it will move
8
40
outside of the screen until a shortcut is pressed again to show the tilda window. The behaviour of
19
51
must be registered using the desktop environment to send a DBus action to show
20
52
or hide the tilda window.
21
53
.PP
22
 
.SS "Usage:"
23
 
.IP
24
 
tilda [OPTION...]
 
54
.SH "OPTIONS"
25
55
.SS "Help Options:"
26
56
.TP
27
57
\fB\-?\fR, \fB\-\-help\fR
28
58
Show help options
29
59
.SS "Application Options:"
30
60
.TP
31
 
\fB\-b\fR, \fB\-\-background\-color\fR
32
 
Set the background color
 
61
\fB\-b\fR, \fB\-\-background\-color\fR \fIcolor\fR
 
62
Set the background \fIcolor\fR. The value can be either a standard color name from X11 or a hexadecimal value (i.e., #rgb, #rrggbb, etc.).
33
63
.TP
34
 
\fB\-c\fR, \fB\-\-command\fR
35
 
Run a command at startup
 
64
\fB\-c\fR, \fB\-\-command\fR \fIcommand\fR
 
65
Run a \fIcommand\fR at startup instead of the default shell.
36
66
.TP
37
67
\fB\-h\fR, \fB\-\-hidden\fR
38
 
Start Tilda hidden
39
 
.TP
40
 
\fB\-f\fR, \fB\-\-font\fR
41
 
Set the font to the following string
42
 
.TP
43
 
\fB\-l\fR, \fB\-\-lines\fR
44
 
Scrollback Lines
 
68
Start Tilda hidden.
 
69
.TP
 
70
\fB\-f\fR, \fB\-\-font\fR \fIfont\fR
 
71
Set the font to the Pango FontDescription specified in \fIfont\fR. Defaults to "Monospace 11".
 
72
.TP
 
73
\fB\-l\fR, \fB\-\-lines\fR \fIlines\fR
 
74
The the scrollback buffer size to a maximum of \fIlines\fR.
45
75
.TP
46
76
\fB\-s\fR, \fB\-\-scrollbar\fR
47
 
Use Scrollbar
 
77
Show a scrollbar at the side of the terminal.
48
78
.TP
49
79
\fB\-v\fR, \fB\-\-version\fR
50
 
Print the version, then exit
51
 
.TP
52
 
\fB\-w\fR, \fB\-\-working\-dir\fR
53
 
Set Initial Working Directory
54
 
.TP
55
 
\fB\-x\fR, \fB\-\-x\-pos\fR
56
 
X Position
57
 
.TP
58
 
\fB\-y\fR, \fB\-\-y\-pos\fR
59
 
Y Position
60
 
.TP
61
 
\fB\-t\fR, \fB\-\-background-alpha\fR
62
 
Opaqueness: 0\-100%
 
80
Print the version, then exit.
 
81
.TP
 
82
\fB\-w\fR, \fB\-\-working\-dir\fR \fIdir\fR
 
83
Set initial working directory to \fIdir\fR.
 
84
.TP
 
85
\fB\-x\fR, \fB\-\-x\-pos\fR \fIx_pos\fR
 
86
Set the X position of the tilda terminal window to \fIx_pos\fR.
 
87
.TP
 
88
\fB\-y\fR, \fB\-\-y\-pos\fR \fIy_pos\fR
 
89
Set the Y position of the tilda terminal window to \fIy_pos\fR.
 
90
.TP
 
91
\fB\-t\fR, \fB\-\-background-alpha\fR \fIalpha\fR
 
92
Set the terminal windows transparency to \fIalpha\fR (i.e., 0\-100%). Higher values
 
93
increase the level of transparency.
63
94
.TP
64
95
\fB\-C\fR, \fB\-\-config\fR
65
 
Show Configuration Wizard
 
96
Show the configuration wizard.
66
97
.TP
67
98
\fB\-\-display\fR=\fIDISPLAY\fR
68
 
X display to use
 
99
Set the X display to use (i.e., :0, :0.0, etc.).
69
100
.TP
70
101
\fB\-\-dbus\fR
71
 
Enables DBus support (see DBus).
72
 
.SH "DBus"
 
102
Enables DBus support (see \fIDBus\fR).
 
103
.SH "NOTES"
 
104
.SS DBus
73
105
Each Tilda process registers its own D-Bus name, so it is possible to
74
106
run multiple tilda processes each with their own config file and control
75
107
them separately via D-Bus.
102
134
.PP
103
135
For each additional tilda instance the bus name and object path will
104
136
be incremented by one (e.g. Actions1, Actions2, etc.).
105
 
.SH "COPYRIGHT"
106
 
Copyright \(co 2021 Sebastian Geiger (lanoxx@gmx.net)
107
 
.br
108
 
Copyright \(co 2005,2008 Tristan Sloughter (sloutri@iit.edu)
109
 
.br
110
 
Copyright \(co 2005,2008 Ira W. Snyder (tilda@irasnyder.com)
111
 
.br
112
 
Copyright \(co 2007,2008 Ken Dreyer (kdreyer@chicagolug.org)
113
 
.PP
114
 
This program comes with ABSOLUTELY NO WARRANTY.
115
 
This is free software, and you are welcome to redistribute it
116
 
under certain conditions. See the file COPYING for details.
117
137
.SH "BUGS"
118
138
Please report bugs via Github at https://github.com/lanoxx/tilda/issues
119
 
.SH "AUTHOR"
120
 
This man page was originally written by Davide Truffa <davide@catoblepa.org>
121
 
and is currently being maintained by Sebastian Geiger <lanoxx@gmx.net>.
 
139
.SH "SEE ALSO"
 
140
For further information visit the project repository or have a look at the
 
141
wiki: https://github.com/lanoxx/tilda/wiki