1ROXTERM(1) User Commands ROXTERM(1)
2
6 roxterm - terminal emulator
7
9 roxterm [-? | --help] [--help-all] [--help-gtk] [-u | --usage]
10 [--geometry=GEOM | -g GEOM] [--appdir=DIR]
11 [--profile=PROFILE | -p PROFILE]
12 [--colour-scheme=SCHEME | --color-scheme=SCHEME | -c SCHEME]
13 [--shortcut-scheme=SCHEME | -s SCHEME] [--separate] [--replace]
14 [--fork] [--directory=DIR | -d DIR] [--show-menubar]
15 [--hide-menubar] [--fullscreen-f] [--disable-sm] [--tab]
16 [--zoom=ZOOM | -z ZOOM] [--title=TITLE | -T TITLE]
17 [--tab-name=NAME | -n NAME] [--role=ROLE]
18 [--execute COMMAND | -e COMMAND]
19
21 This manual page documents briefly the roxterm command.
22 roxterm is a terminal emulator.
24
26 These programs follow the usual GNU command line syntax, with long
27 options starting with two dashes (`-'). A summary of options is
28 included below.
29 -? --help
31 Show description of options.
32 --help-all
34 Show all options.
35 --help-gtk
37 Show all GTK+ options.
38 --usage
40 Show summary of usage.
41 -d DIRECTORY --directory=DIRECTORY
43 Run shell/command in DIRECTORY.
44 -g COLUMNSxROWS --geometry=COLUMNSxROWS
46 Set size of terminal.
47 --appdir=DIR
49 Application directory when run as a ROX app.
50 --show-menubar --hide-menubar
52 Whether to show or hide the menubar, overriding the profile. The
53 default is to show it.
54 --fullscreen -f
56 Make initial terminal window take up the whole screen with no
57 window furniture.
58 --tab
60 If possible open the new terminal in an existing window rather than
61 open a new window. If used in conjunction with -T/--title the tab
62 will be placed in an existing window with the same title template
63 if one exists. This option overrides --zoom and --fullscreen.
64 --zoom=ZOOM -z ZOOM
66 Scale terminal's font by a factor of ZOOM (1.0 is normal size).
67 -p PROFILE --profile=PROFILE
69 Use the named profile.
70 -c SCHEME --colour-scheme=SCHEME --color-scheme=SCHEME
72 Use the named colour scheme.
73 -s SCHEME --shortcut-scheme=SCHEME
75 Use the named keyboard shortcut scheme.
76 --title=TITLE -T TITLE
78 Set window title template. May include "%s" which is substituted
79 with the full contents of the tab's label, "%n" which is
80 substituted by the number of tabs, and "%t" which is substituted by
81 the current tab number.
82 --tab-name=NAME -n NAME
84 Set tab name as displayed in its label. May include "%s" which is
85 substituted with the window title string set by the terminal, "%n"
86 which is substituted by the number of tabs, and "%t" which is
87 substituted by the current tab number.
88 --separate
90 Use a separate process for this terminal.
91 --fork
93 Always fork into the background. Usually the first instance stays
94 in the foreground and subsequent invocations return once they have
95 asked the master instance to handle their command. This option
96 causes the master instance to fork itself into the background; the
97 foreground process returns once the master is ready to handle
98 further commands.
99 --replace
101 Replace any existing instance as ROXTerm D-BUS service provider.
102 --role=ROLE
104 Set the WM_WINDOW_ROLE property on the window. This can be used to
105 uniquely identify a window across sessions, or in selecting
106 configuration resources by window managers.
107 -e --execute
109 Execute remainder of the command line inside the terminal. Must be
110 the final option. If there is only one following argument it is
111 parsed in case it is a command with space-separated arguments that
112 was passed to roxterm in quotes. If there is more than one argument
113 they are treated as a command and arguments without parsing.
114
116 The following environment variables are set or used by roxterm:
117 COLORTERM
119 This is set to "truecolor" by VTE if the window supports 16 million
120 colors.
121 EDITOR
123 The name of the editor. Defaults to "gedit", "kate", "gvim",
124 "emacs", whichever appears first in PATH.
125 LANG
127 The language of the help URI. This defaults to "en".
128 ROXTERM_ID
130 The unique identity of the roxterm D-Bus instance.
131 ROXTERM_NUM
133 The number of toplevel windows which are managed by this roxterm
134 process.
135 ROXTERM_PID
137 The process identifier of roxterm.
138 TERM
140 The name of the terminfo description, which is xterm-256color.
141 VTE_VERSION
143 The version number of the VTE library.
144 WINDOWID
146 The decimal X Window ID of the toplevel roxterm window. Only
147 supported in an X environment.
148 XDG_CONFIG_HOME
150 Where to save roxterm sessions. Defaults to ~/.config. Sessions are
151 saved under $XDG_CONFIG_HOME/roxterm.sourceforge.net/UserSessions/.
152
154 The program is documented fully by the HTML file
155 file:///usr/share/doc/roxterm/en/index.html.
156
158 This manual page was written by Tony Houghton <h@realh.co.uk>.
159 Permission is granted to copy, distribute and/or modify this document
160 under the terms of the GNU General Public License, Version 2 or any
161 later version published by the Free Software Foundation.
162 On Debian systems, the complete text of the GNU General Public License
164 can be found in /usr/share/common-licenses/GPL.
165
167 Tony Houghton
168 Developer
169
171 Copyright © 2005-2015 Tony Houghton
172ROXTerm 01 April 2013 ROXTERM(1)