OS Manuals

/usr/bin/xterm

X Terminal Emulator

From xterm 412-r2 (os), captured 2026-11-05 by running xterm -help (exit 0). permalink

XTerm(412) usage:
    xterm [-options ...] [-e command args]

where options include:
    -/+132                       turn on/off 80/132 column switching
    -C                           intercept console messages
    -Sccn                        slave mode on "ttycc", file descriptor "n"
    -T string                    title name for window
    -/+ah                        turn on/off always highlight
    -/+ai                        turn off/on active icon
    -/+aw                        turn on/off auto wraparound
    -b number                    internal border in pixels
    -baudrate rate               set line-speed (default 38400)
    -/+bc                        turn on/off text cursor blinking
    -bcf milliseconds            time text cursor is off when blinking
    -bcn milliseconds            time text cursor is on when blinking
    -bd color                    border color
    -/+bdc                       turn off/on display of bold as color
    -bg color                    background color
    -bw number                   border width in pixels
    -/+cb                        turn on/off cut-to-beginning-of-line inhibit
    -cc classrange               specify additional character classes
    -/+cjk_width                 turn on/off legacy CJK width convention
    -class string                class string (XTerm)
    -/+cm                        turn off/on ANSI color mode
    -/+cn                        turn on/off cut newline inhibit
    -cr color                    text cursor color
    -/+cu                        turn on/off curses emulation
    -/+dc                        turn off/on dynamic color selection
    -display displayname         X server to contact
    -e command args ...          command to execute
    -/+emoji_width               turn on/off Emoji VS15/VS16 width convention
    -fa pattern                  FreeType font-selection pattern
    -fb fontname                 bold text font
    -/+fbb                       turn on/off normal/bold font comparison inhibit
    -/+fbx                       turn off/on linedrawing characters
    -fc fontmenu                 start with named fontmenu choice
    -fd pattern                  FreeType Doublesize font-selection pattern
    -fg color                    foreground color
    -fi fontname                 icon font for active icon
    -fn fontname                 normal text font
    -fs size                     FreeType font-size
    -/+fullscreen                turn on/off fullscreen on startup
    -fw fontname                 doublewidth text font
    -fwb fontname                doublewidth bold text font
    -fx fontname                 XIM fontset
    %geom                        Tek window geometry
    #geom                        icon window geometry
    -geometry geom               size (in characters) and position
    -help                        print out this message
    -/+hm                        turn on/off selection-color override
    -/+hold                      turn on/off logic that retains window after exit
    -iconic                      start iconic
    -/+ie                        turn on/off initialization of 'erase' from pty
    -/+im                        use insert mode for TERMCAP
    -into windowId               use the window id given to -into as the parent window rather than the default root window
    -/+itc                       turn off/on display of italic as color
    -/+j                         turn on/off jump scroll
    -/+k8                        turn on/off C1-printable classification
    -kt keyboardtype             set keyboard type: tcap sun vt220
    -/+l                         turn on/off logging
    -/+lc                        turn on/off locale mode using luit
    -lcc path                    filename of locale converter (/usr/bin/luit)
    -leftbar                     force scrollbar left
    -lf filename                 logging filename (use '-' for standard out)
    -/+ls                        turn on/off login shell
    -/+maximized                 turn on/off maximize on startup
    -/+mb                        turn on/off margin bell
    -mc milliseconds             multiclick time in milliseconds
    -/+mesg                      forbid/allow messages
    -/+mk_width                  turn on/off simple width convention
    -ms color                    pointer color
    -n string                    icon name for window
    -name string                 client instance, icon, and title strings
    -nb number                   margin bell in characters from right end
    -/+nomap                     turn off/on initial mapping of window
    -/+nul                       turn off/on display of underlining
    -/+pc                        turn on/off PC-style bold colors
    -pf fontname                 cursor font for text area pointer
    -/+pob                       turn on/off pop on bell
    -/+rca                       turn on/off cursor-adjustment on resizing
    -report-charclass            report "charClass" after initialization
    -report-colors               report colors as they are allocated
    -report-fonts                report fonts as loaded to stdout
    -report-icons                report title/icon updates
    -report-xres                 report X resources for VT100 widget
    -rightbar                    force scrollbar right (default left)
    -/+rv                        turn on/off reverse video
    -/+rvc                       turn off/on display of reverse as color
    -/+rw                        turn on/off reverse wraparound
    -/+s                         turn on/off multiscroll
    -/+samename                  turn on/off the no-flicker option for title and icon name
    -/+sb                        turn on/off scrollbar
    -selbg color                 selection background color
    -selfg color                 selection foreground color
    -/+sf                        turn on/off Sun Function Key escape codes
    -sh number                   scale line-height values by the given number
    -/+si                        turn on/off scroll-on-tty-output inhibit
    -/+sk                        turn on/off scroll-on-keypress
    -sl number                   number of scrolled lines to save
    -/+sm                        turn on/off the session-management support
    -/+sp                        turn on/off Sun/PC Function/Keypad mapping
    -/+t                         turn on/off Tek emulation window
    -ti termid                   terminal identifier
    -title string                title string
    -tm string                   terminal mode keywords and characters
    -tn name                     TERM environment variable name
    -/+u8                        turn on/off UTF-8 mode (implies wide-characters)
    -/+uc                        turn on/off underline cursor
    -/+ulc                       turn off/on display of underline as color
    -/+ulit                      turn off/on display of underline as italics
    -/+ut                        turn on/off utmp support
    -/+vb                        turn on/off visual bell
    -version                     print the version number
    -/+wc                        turn on/off wide-character mode
    -/+wf                        turn on/off wait for map before command exec
    -xrm resourcestring          additional resource specifications
    -ziconbeep percent           beep and flag icon of window having hidden output

Fonts should be fixed width and, if both normal and bold are specified, should
have the same size.  If only a normal font is specified, it will be used for
both normal and bold text (by doing overstriking).  The -e option, if given,
must appear at the end of the command line, otherwise the user's default shell
will be started.  Options that start with a plus sign (+) restore the default.
Options (126)
OptionDescriptionSource
-CThis option indicates that this window should receive console output.help + man
-SccnThis option allows xterm to be used as an input and output channel for an existing program and is sometimes used in specialized applications.help + man
-T stringThis option specifies the title for xterm's windows.help + man
-b numberThis option specifies the size of the inner border (the distance between the outer edge of the characters and the window border) in pixels.help + man
-baudrate rateSet the line-speed, used to test the behavior of applications that use the line-speed when optimizing their output to the screen.help + man
-bcf millisecondsSet the amount of time text cursor is off when blinking via the cursorOffTime resource.help + man
-bcn millisecondsSet the amount of time text cursor is on when blinking via the cursorOnTime resource.help + man
-bd colorThis option specifies the color to use for the border of the window.help + man
-bg colorThis option specifies the color to use for the background of the window.help + man
-bw numberThis option specifies the width in pixels of the border surrounding the window.help + man
-cc classrangespecify additional character classeshelp
-class stringThis option allows you to override xterm's resource class.help + man
-cr colorThis option specifies the color to use for text cursor.help + man
-display displaynameThis option specifies the X server to contact;help + man
-e commandcommand to executehelp
-fa patternThis option sets the pattern for fonts selected from the FreeType library if support for that library was compiled into xterm.help + man
-fb fontnameThis option specifies a font to be used when displaying bold text.help + man
-fc fontmenuSpecify the initial font chosen from the font menu.help + man
-fd patternThis option sets the pattern for double-width fonts selected from the FreeType library if support for that library was compiled into xterm.help + man
-fg colorThis option specifies the color to use for displaying text.help + man
-fi fontnameThis option sets the font for active icons if that feature was compiled into xterm.help + man
-fn fontnameThis option specifies the font to be used for displaying normal text.help + man
-fs sizeThis option sets the pointsize for fonts selected from the FreeType library if support for that library was compiled into xterm.help + man
-fw fontnameThis option specifies the font to be used for displaying wide text.help + man
-fwb fontnameThis option specifies the font to be used for displaying bold wide text.help + man
-fx fontnameThis option specifies the font to be used for displaying the preedit string in the “OverTheSpot” input method.help + man
-geometry geomThis option specifies the preferred size and position of the VTxxx window;help + man
-helpThis causes xterm to print out a verbose message describing its options, one per line.help + man
-iconicThis option indicates that xterm should ask the window manager to start it as an icon rather than as the normal window.help + man
-into windowIdGiven an X window identifier (an integer, which can be hexadecimal, octal or decimal according to whether it begins with "0x", "0" or neither), xterm will reparent its top-level shell widget to that…help + man
-kt keyboardtypeThis option sets the keyboardType resource.help + man
-lcc pathFile name for the encoding converter from/to locale encodings and UTF-8 which is used with -lc option or locale resource.help + man
-leftbarForce scrollbar to the left side of VT100 screen.help + man
-lf filenamelogging filename (use '-' for standard out)help + man
-mc millisecondsThis option specifies the maximum time between multi-click selections.help + man
-ms colorThis option specifies the color to be used for the pointer cursor.help + man
-n stringThis option specifies the icon name for xterm's windows.help + man
-name stringThis option specifies the application name under which resources are to be obtained, rather than the default executable file name.help + man
-nb numberThis option specifies the number of characters from the right end of a line at which the margin bell, if enabled, will ring.help + man
-pf fontnameThis option specifies the font to be used for the pointer.help + man
-report-charclassPrint a report to the standard output showing information about the character-classes which can be altered using the charClass resource.help + man
-report-colorsPrint a report to the standard output showing information about colors as xterm allocates them.help + man
-report-fontsPrint a report to the standard output showing information about fonts which are loaded.help + man
-report-iconsPrint a report to the standard output showing information about pixmap-icons which are loaded.help + man
-report-xresPrint a report to the standard output showing the values of boolean, numeric or string X resources for the VT100 widget when initialization is complete.help + man
-rightbarForce scrollbar to the right side of VT100 screen.help + man
-selbg colorThis option specifies the color to use for the background of selected text.help + man
-selfg colorThis option specifies the color to use for selected text.help + man
-sh numberscale line-height values by the given number.help + man
-sl numberThis option specifies the number of lines to save that have been scrolled off the top of the screen.help + man
-ti termidSpecify the name used by xterm to select the correct response to terminal ID queries.help + man
-title stringThis option specifies the window title string, which may be displayed by window managers if the user so chooses.help + man
-tm stringThis option specifies a series of terminal setting keywords followed by the characters that should be bound to those functions, similar to the stty(1) program.help + man
-tn nameThis option specifies the name of the terminal type to be set in the TERM environment variable.help + man
-versionThis causes xterm to print a version number to the standard output, and then exit.help + man
-xrm resourcestringThis option specifies a resource string to be used.help + man
-ziconbeep percentbeep and flag icon of window having hidden outputhelp + man
-132Normally, the VT102 DECCOLM escape sequence that switches between 80 and 132 column mode is ignored. (in the manual page but not in --help)man
-ahThis option indicates that xterm should always highlight the text cursor. (in the manual page but not in --help)man
-aiThis option disables active icon support if that feature was compiled into xterm. (in the manual page but not in --help)man
-awThis option indicates that auto-wraparound should be allowed, and is equivalent to setting the vt100 resource autoWrap to “true”. (in the manual page but not in --help)man
-barcThis option, corresponding to the cursorBar resource, makes the cursor a bar instead of a box. (in the manual page but not in --help)man
-bcTurn on text cursor blinking. (in the manual page but not in --help)man
-bdcSet the vt100 resource colorBDMode to “false”, disabling the display of characters with bold attribute as color. (in the manual page but not in --help)man
-cbSet the vt100 resource cutToBeginningOfLine to “false”. (in the manual page but not in --help)man
-cjk_widthSet the cjkWidth resource to “true”. (in the manual page but not in --help)man
-cmThis option disables recognition of ANSI color-change escape sequences. (in the manual page but not in --help)man
-cnThis option indicates that newlines should not be cut in line-mode selections. (in the manual page but not in --help)man
-cuThis option indicates that xterm should work around a bug in the more(1) program that causes it to incorrectly display lines that are exactly the width of the window and are followed by a line… (in the manual page but not in --help)man
-dcThis option disables the escape sequence to change dynamic colors: the vt100 foreground and background colors, its text cursor color, the pointer cursor foreground and background colors, the… (in the manual page but not in --help)man
-emoji_widthSet the emojiWidth resource to “true”. (in the manual page but not in --help)man
-en encodingThis option determines the encoding on which xterm runs. (in the manual page but not in --help)man
-fbbThis option indicates that xterm should compare normal and bold fonts bounding boxes to ensure they are compatible. (in the manual page but not in --help)man
-fbxThis option indicates that xterm should not assume that the normal and bold fonts have VT100 line-drawing characters. (in the manual page but not in --help)man
-fullscreenThis option indicates that xterm should ask the window manager to let it use the full-screen for display, e.g., without window decorations. (in the manual page but not in --help)man
-hc color(see -selbg). (in the manual page but not in --help)man
-hfThis option indicates that HP function key escape codes should be generated for function keys. (in the manual page but not in --help)man
-hmTells xterm to use highlightTextColor and highlightColor to override the reversed foreground/background colors in a selection. (in the manual page but not in --help)man
-holdTurn on the hold resource, i.e., xterm will not immediately destroy its window when the shell command completes. (in the manual page but not in --help)man
-ieTurn on the ptyInitialErase resource, i.e., use the pseudo-terminal's sense of the stty(1) erase value. (in the manual page but not in --help)man
-imTurn on the useInsertMode resource, which forces use of insert mode by adding appropriate entries to the TERMCAP environment variable. (in the manual page but not in --help)man
-itcSet the vt100 resource colorITMode to “false”, disabling the display of characters with italic attribute as color. (in the manual page but not in --help)man
-jThis option indicates that xterm should do jump scrolling. (in the manual page but not in --help)man
-jfWhen doing jump-scrolling or related indexing, e.g., carriage returns, xterm will defer flushing screen-updates, to improve speed. (in the manual page but not in --help)man
-k8This option sets the allowC1Printable resource. (in the manual page but not in --help)man
-lTurn logging on, unless disabled by the logInhibit resource. (in the manual page but not in --help)man
-lcTurn on support of various encodings according to the users' locale setting, i.e., LC_ALL, LC_CTYPE, or LANG environment variables. (in the manual page but not in --help)man
-lsThis option indicates that the shell that is started in the xterm window will be a login shell (i.e., the first character of argv[0] will be a dash, indicating to the shell that it should read the… (in the manual page but not in --help)man
-maximizedThis option indicates that xterm should ask the window manager to maximize its layout on startup. (in the manual page but not in --help)man
-mbThis option indicates that xterm should ring a margin bell when the user types near the right end of a line. (in the manual page but not in --help)man
-mesgTurn off the messages resource, i.e., disallow write access to the terminal. (in the manual page but not in --help)man
-mk_widthSet the mkWidth resource to “true”. (in the manual page but not in --help)man
-nomapThis option disables the initial mapping of the terminal window. (in the manual page but not in --help)man
-nulThis option disables the display of underlining. (in the manual page but not in --help)man
-pcThis option enables the PC-style use of bold colors (see boldColors resource). (in the manual page but not in --help)man
-pobThis option indicates that the window should be raised whenever a Control-G is received. (in the manual page but not in --help)man
-rcaThis option enables cursor position adjustment during resize. (in the manual page but not in --help)man
-rvcThis option disables the display of characters with reverse attribute as color. (in the manual page but not in --help)man
-rwThis option indicates that reverse-wraparound should be allowed. (in the manual page but not in --help)man
-sThis option indicates that xterm may scroll asynchronously, meaning that the screen does not have to be kept completely up to date while scrolling. (in the manual page but not in --help)man
-samenameDoes not send title and icon name change requests when the request would have no effect: the name is not changed. (in the manual page but not in --help)man
-sbThis option indicates that some number of lines that are scrolled off the top of the window should be saved and that a scrollbar should be displayed so that those lines can be viewed. (in the manual page but not in --help)man
-sfThis option indicates that Sun function key escape codes should be generated for function keys. (in the manual page but not in --help)man
-siThis option indicates that output to a window should not automatically reposition the screen to the bottom of the scrolling region. (in the manual page but not in --help)man
-skThis option indicates that pressing a key while using the scrollbar to review previous lines of text should cause the window to be repositioned automatically in the normal position at the bottom of… (in the manual page but not in --help)man
-smThis option, corresponding to the sessionMgt resource, indicates that xterm should set up session manager callbacks. (in the manual page but not in --help)man
-spThis option indicates that Sun/PC keyboard should be assumed, providing mapping for keypad “+” to “,”, and CTRL-F1 to F13, CTRL-F2 to F14, etc. (in the manual page but not in --help)man
-tThis option indicates that xterm should start in Tektronix mode, rather than in VTxxx mode. (in the manual page but not in --help)man
-tbThis option, corresponding to the toolBar resource, indicates that xterm should display a toolbar (or menubar) at the top of its window. (in the manual page but not in --help)man
-u8This option sets the utf8 resource. (in the manual page but not in --help)man
-ucThis option, corresponding to the cursorUnderLine resource, makes the cursor underlined instead of a box. (in the manual page but not in --help)man
-ulcThis option disables the display of characters with underline attribute as color rather than with underlining. (in the manual page but not in --help)man
-ulitThis option, corresponding to the italicULMode resource, disables the display of characters with underline attribute as italics rather than with underlining. (in the manual page but not in --help)man
-utThis option indicates that xterm should not write a record into the system utmp log file. (in the manual page but not in --help)man
-vbThis option indicates that a visual bell is preferred over an audible one. (in the manual page but not in --help)man
-wcThis option sets the wideChars resource. (in the manual page but not in --help)man
-wfThis option indicates that xterm should wait for the window to be mapped the first time before starting the subprocess so that the initial terminal size settings and environment variables are correct. (in the manual page but not in --help)man
-rThis option indicates that reverse video should be simulated by swapping the foreground and background colors. (in the manual page but not in --help)man
-w numberThis option specifies the width in pixels of the border surrounding the window. (in the manual page but not in --help)man
-font fontThis is the same as -fn. (in the manual page but not in --help)man
-rvThis option indicates that reverse video should be simulated by swapping the foreground and background colors. (in the manual page but not in --help)man
-backgroundfor “-bg” (in the manual page but not in --help)man
-bordercolorfor “-bc” (in the manual page but not in --help)man
-borderwidthfor “-bw” (in the manual page but not in --help)man
-foregroundfor “-fg” (in the manual page but not in --help)man
-reversefor “-rv” (in the manual page but not in --help)man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.