summaryrefslogtreecommitdiffstats
path: root/man/gnome-terminal.xml
blob: 94f3cc582eb4c1283cd56862ea18808feafa1b17 (plain)
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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
<?xml version="1.0" encoding="UTF-8"?>
<!--
  Copyright © 2020 Red Hat, Inc.

  This program is free software; you can redistribute it and/or modify
  it under the terms of either:

  * the GNU General Public License as published by the Free
    Software Foundation; either version 3 of the License, or (at your
    option) any later version.

  or

  * the GNU Free Documentation License version 1.3 as published by the
    Free Software Foundation; with no Invariant Sections, no Front-Cover
    Texts, and no Back-Cover Texts.

  or both in parallel, as here.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License and the GNU Free Documentation License
  for more details.

  You should have received a copy of the GNU General Public License and
  of the GNU Free Documentation License along with this program.
  If not, see <https://www.gnu.org/licenses/>.
-->
<refentry id="gnome-terminal.1">
  <refentryinfo>
    <title>gnome-terminal</title>
    <date>June 2020</date>
    <productname>GNOME</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>gnome-terminal</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class="manual">User Commands</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>gnome-terminal</refname>
    <refpurpose>A terminal emulator for GNOME</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>gnome-terminal</command>
      <group rep="repeat"><replaceable>OPTION</replaceable></group>
      <group>-- <replaceable>PROGRAM</replaceable> <group rep="repeat"><replaceable>ARG</replaceable></group></group>
    </cmdsynopsis>
  </refsynopsisdiv>


  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      <command>gnome-terminal</command> is a terminal emulator application for
      accessing a UNIX shell environment which can be used to run programs
      available on your system. It supports several profiles, multiple tabs and
      implements several keyboard shortcuts.
    </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      <varlistentry>
        <term><option>--help, -h</option></term>
        <listitem>
          <para>
            Show a brief overview of all the options.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help-all</option></term>
        <listitem>
          <para>
            Show all the options in detail.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help-gtk</option></term>
        <listitem>
          <para>
            Show all the GTK options.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help-terminal</option></term>
        <listitem>
          <para>
            Show all the options to select between new terminal tabs or
            windows.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help-terminal-options</option></term>
        <listitem>
          <para>
            Show all the options to change the attributes of terminals
            regardless of whether they are in separate tabs or windows.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help-window-options</option></term>
        <listitem>
          <para>
            Show all the options to change the attributes of windows
            containing terminals.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--load-config=FILE</option></term>
        <listitem>
          <para>
            Restore the application to a previously saved state by loading it
            from a configuration file.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--preferences</option></term>
        <listitem>
          <para>
            Show the preferences window.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--print-environment, -p</option></term>
        <listitem>
          <para>
            Print the environment variables to interact with newly created
            terminals.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--quiet, -q</option></term>
        <listitem>
          <para>
            Suppress diagnostics.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--verbose, -v</option></term>
        <listitem>
          <para>
            Increase diagnostic verbosity.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--tab</option></term>
        <listitem>
          <para>
            Open a new tab containing a terminal in the last-opened window with
            the default profile.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--window</option></term>
        <listitem>
          <para>
            Open a new window with a tab containing a terminal with the default
            profile.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--command, -e=COMMAND</option></term>
        <listitem>
          <para>
            Split the argument to this option into a program and arguments
            in the same way a shell would, and execute the resulting
            command-line inside the terminal.
          </para>
          <para>
            This option is deprecated. Instead, use <option>--</option>
            to terminate the options, and put the program and arguments to
            execute after it: for example, instead of
            <userinput>gnome-terminal -e "python3 -q"</userinput>, prefer to use
            <userinput>gnome-terminal -- python3 -q</userinput>.
          </para>
          <para>
            Note that the <replaceable>COMMAND</replaceable> is not run via
            a shell: it is split into words and executed as a program. If
            shell syntax is required, use the form
            <userinput>gnome-terminal -- sh -c '...'</userinput>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--execute PROGRAM [ARGS], -x PROGRAM [ARGS]</option></term>
        <listitem>
          <para>
            Stop parsing options at this point, and interpret all
            subsequent options as a program and arguments to execute
            inside the terminal.
          </para>
          <para>
            This option is deprecated: use <option>--</option> instead.
            For example, instead of
            <userinput>gnome-terminal -x python3 -q</userinput>, prefer to use
            <userinput>gnome-terminal -- python3 -q</userinput>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--fd=FD</option></term>
        <listitem>
          <para>
            Forward file descriptor.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--profile=PROFILE-NAME</option></term>
        <listitem>
          <para>
            Use the given profile instead of the default profile.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--title, -t=TITLE</option></term>
        <listitem>
          <para>
            Set the initial terminal title.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--wait</option></term>
        <listitem>
          <para>
            Wait until the terminal's child exits.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--working-directory=DIRNAME</option></term>
        <listitem>
          <para>
            Set the terminal's working directory.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--zoom=ZOOM</option></term>
        <listitem>
          <para>
            Set the terminal's zoom factor. 1.0 is normal size.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--active</option></term>
        <listitem>
          <para>
            Set the last specified tab as the active one in its window.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--full-screen</option></term>
        <listitem>
          <para>
            Full-screen the window.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--geometry=GEOMETRY</option></term>
        <listitem>
          <para>
            Set the window size as COLSxROWS+X+Y. For example, 80x24 or
            80x24+200+200.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--hide-menubar</option></term>
        <listitem>
          <para>
            Turn off the menubar for the window.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--show-menubar</option></term>
        <listitem>
          <para>
            Turn on the menubar for the window.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--maximize</option></term>
        <listitem>
          <para>
            Maximize the window.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--role=ROLE</option></term>
        <listitem>
          <para>
            Set the X window role.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--class=CLASS</option></term>
        <listitem>
          <para>
            Program class as used by the window manager.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--display=DISPLAY</option></term>
        <listitem>
          <para>
            X display to use.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--g-fatal-warnings</option></term>
        <listitem>
          <para>
            Make all warnings fatal.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--gdk-debug=FLAGS</option></term>
        <listitem>
          <para>
            GDK debugging flags to set.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--gdk-no-debug=FLAGS</option></term>
        <listitem>
          <para>
            GDK debugging flags to unset.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--gtk-debug=FLAGS</option></term>
        <listitem>
          <para>
            GTK debugging flags to set.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--gtk-no-debug=FLAGS</option></term>
        <listitem>
          <para>
            GTK debugging flags to unset.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--gtk-module=MODULES</option></term>
        <listitem>
          <para>
            Load additional GTK modules.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--name=NAME</option></term>
        <listitem>
          <para>
            Program name as used by the window manager.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>BUGS</title>
    <para>
      Please read
      <ulink url="https://wiki.gnome.org/Apps/Terminal/ReportingBugs"></ulink>
      on how to report bugs.
    </para>
  </refsect1>

  <refsect1>
    <title>EXAMPLES</title>
    <para>
      To run a terminal containing an interactive Python prompt:
      <literallayout>
        gnome-terminal --title=Python -- python3 -q
      </literallayout>
    </para>
    <para>
      To interpret shell syntax in a terminal, either write it in a
      separate shell script, or use <literal>sh -c</literal>:
      <literallayout>
        gnome-terminal -- sh -c 'if [ "$(id -u)" = 0 ]; then ...'
      </literallayout>
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      For further information, visit the website
      <ulink url="https://wiki.gnome.org/Apps/Terminal"></ulink>. There's a
      list of frequently asked questions at
      <ulink url="https://wiki.gnome.org/Apps/Terminal/FAQ"></ulink>.
    </para>
  </refsect1>
</refentry>