/
roxterm.1.xml.in
341 lines (320 loc) · 12.3 KB
/
roxterm.1.xml.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!--
Process this file with an XSLT processor: `xsltproc -''-nonet \
/usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
roxterm.xml'. A manual page <package>.<section> will be generated. You
may view the manual page with: nroff -man <package>.<section> | less'.
A typical entry in a Makefile or Makefile.am is:
DB2MAN=/usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl
XP=xsltproc -''-nonet
manpage.1: manpage.dbk
$(XP) $(DB2MAN) $<
The xsltproc binary is found in the xsltproc package. The
XSL files are in docbook-xsl. Please remember that if you
create the nroff version in one of the debian/rules file
targets (such as build), you will need to include xsltproc
and docbook-xsl in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Tony</firstname>">
<!ENTITY dhsurname "<surname>Houghton</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>01 April 2013</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>h@realh.co.uk</email>">
<!ENTITY dhusername "Tony Houghton">
<!ENTITY dhucpackage "<refentrytitle>roxterm</refentrytitle>">
<!ENTITY dhpackage "roxterm">
<!ENTITY product "ROXTerm">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry lang="en">
<refentryinfo>
<address>
&dhemail;
</address>
<author>
<contrib>Developer</contrib>
&dhfirstname; &dhsurname;
</author>
<copyright>
<year>2005-2011</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
<refmiscinfo class="source">&product;</refmiscinfo>
<refmiscinfo class="version">@VERSION@</refmiscinfo>
<refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>terminal emulator</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option>-?</option> | <option>--help</option></arg>
<arg><option>--help-all</option></arg>
<arg><option>--help-gtk</option></arg>
<arg><option>-u</option> | <option>--usage</option></arg>
<arg><option>--geometry=<replaceable>GEOM</replaceable></option></arg>
<arg><option>--appdir=<replaceable>DIR</replaceable></option></arg>
<arg><option>--profile=<replaceable>PROFILE</replaceable></option> |
<option>-p <replaceable>PROFILE</replaceable></option></arg>
<arg><option>--colour-scheme=<replaceable>SCHEME</replaceable></option> |
<option>--color-scheme=<replaceable>SCHEME</replaceable></option> |
<option>-c <replaceable>SCHEME</replaceable></option></arg>
<arg><option>--shortcut-scheme=<replaceable>SCHEME</replaceable></option>
| <option>-s <replaceable>SCHEME</replaceable></option></arg>
<arg><option>--separate</option></arg>
<arg><option>--replace</option></arg>
<arg><option>--fork</option></arg>
<arg><option>--directory=<replaceable>DIR</replaceable></option> |
<option>-d <replaceable>DIR</replaceable></option></arg>
<arg><option>--show-menubar</option></arg>
<arg><option>--hide-menubar</option></arg>
<arg><option>--fullscreen</option><option>-f</option></arg>
<arg><option>--disable-sm</option></arg>
<arg><option>--tab</option></arg>
<arg><option>--zoom=<replaceable>ZOOM</replaceable></option> |
<option>-z <replaceable>ZOOM</replaceable></option></arg>
<arg><option>--title=<replaceable>TITLE</replaceable></option> |
<option>-T <replaceable>TITLE</replaceable></option></arg>
<arg><option>--tab-name=<replaceable>NAME</replaceable></option> |
<option>-n <replaceable>NAME</replaceable></option></arg>
<arg><option>--role=<replaceable>ROLE</replaceable></option></arg>
<arg><option>--execute <replaceable>COMMAND</replaceable></option> |
<option>-e <replaceable>COMMAND</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This manual page documents briefly the
<command>&dhpackage;</command> command.</para>
<para><command>&dhpackage;</command> is a terminal emulator.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>These programs follow the usual &gnu; command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.</para>
<variablelist>
<varlistentry>
<term><option>-?</option>
<option>--help</option>
</term>
<listitem>
<para>Show description of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help-all</option>
</term>
<listitem>
<para>Show all options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help-gtk</option>
</term>
<listitem>
<para>Show all GTK+ options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--usage</option>
</term>
<listitem>
<para>Show summary of usage.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d <replaceable>DIRECTORY</replaceable></option>
<option>--directory=<replaceable>DIRECTORY</replaceable></option>
</term>
<listitem>
<para>Run shell/command in
<replaceable>DIRECTORY</replaceable>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--geometry=<replaceable>GEOMETRY</replaceable></option>
</term>
<listitem>
<para>Set size and/or position of terminal according to X geometry
specification.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--appdir=<replaceable>DIR</replaceable></option>
</term>
<listitem>
<para>Application directory when run as a ROX app.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-menubar</option>
<option>--hide-menubar</option>
</term>
<listitem>
<para>Whether to show or hide the menubar, overriding the profile.
The default is to show it.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--fullscreen</option>
<option>-f</option>
</term>
<listitem>
<para>Make initial terminal window take up the whole screen with
no window furniture.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--disable-sm</option>
</term>
<listitem><para>Disable session management.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--tab</option>
</term>
<listitem>
<para>If possible open the new terminal in an existing window rather
than open a new window. If used in conjunction with
<option>-T</option>/<option>--title</option> the tab will be placed
in an existing window with the same title template if one exists.
This option overrides <option>--zoom</option> and
<option>--fullscreen</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--zoom=<replaceable>ZOOM</replaceable></option>
<option>-z <replaceable>ZOOM</replaceable></option>
</term>
<listitem>
<para>Scale terminal's font by a factor of ZOOM (1.0 is normal
size).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p <replaceable>PROFILE</replaceable></option>
<option>--profile=<replaceable>PROFILE</replaceable></option>
</term>
<listitem>
<para>Use the named profile.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c <replaceable>SCHEME</replaceable></option>
<option>--colour-scheme=<replaceable>SCHEME</replaceable></option>
<option>--color-scheme=<replaceable>SCHEME</replaceable></option>
</term>
<listitem>
<para>Use the named colour scheme.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s <replaceable>SCHEME</replaceable></option>
<option>--shortcut-scheme=<replaceable>SCHEME</replaceable></option>
</term>
<listitem>
<para>Use the named keyboard shortcut scheme.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--title=<replaceable>TITLE</replaceable></option>
<option>-T <replaceable>TITLE</replaceable></option>
</term>
<listitem>
<para>Set window title template. May include "%s" which is substituted
with the full contents of the tab's label.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--tab-name=<replaceable>NAME</replaceable></option>
<option>-n <replaceable>NAME</replaceable></option>
</term>
<listitem>
<para>Set tab name as displayed in its label. May include "%s" which
is substituted with the window title string set by the terminal.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--separate</option>
</term>
<listitem>
<para>Use a separate process for this terminal.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--fork</option>
</term>
<listitem>
<para>Always fork into the background. Usually the first instance
stays in the foreground and subsequent invocations return once they
have asked the master instance to handle their command. This option
causes the master instance to fork itself into the background; the
foreground process returns once the master is ready to handle further
commands.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--replace</option>
</term>
<listitem>
<para>Replace any existing instance as ROXTerm D-BUS service
provider.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--role=<replaceable>ROLE</replaceable></option>
</term>
<listitem>
<para>Sets the X window system "role" hint for the window
being created.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-e</option>
<option>--execute</option>
</term>
<listitem>
<para>Execute remainder of the command line inside the terminal. Must
be the final option. If there is only one following argument it is
parsed in case it is a command with space-separated arguments that
was passed to roxterm in quotes. If there is more than one argument
they are treated as a command and arguments without parsing.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>The program is documented fully by the HTML file
<filename>file://@htmldir@/en/index.html</filename>.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; &dhemail;.
Permission is granted to copy, distribute and/or modify this document
under the terms of the &gnu; General Public License, Version 2 or any
later version published by the Free Software Foundation.
</para>
<para>
On Debian systems, the complete text of the GNU General Public
License can be found in /usr/share/common-licenses/GPL.
</para>
</refsect1>
</refentry>