"Fossies" - the Fresh Open Source Software Archive

Member "xtermcontrol-3.8/doc/xtermcontrol.roff" (15 Feb 2020, 8076 Bytes) of package /linux/privat/xtermcontrol-3.8.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "xtermcontrol.roff": 3.7_vs_3.8.

A hint: This file contains one or more very long lines, so maybe it is better readable using the pure text view mode that shows the contents as wrapped lines within the browser window.


    1 .SH NAME
    2 xtermcontrol \- dynamic control of XFree86 xterm properties.
    3 .\"
    4 .\"   "SYNOPSIS"
    5 .\"
    6 .SH SYNOPSIS
    7 .B xtermcontrol
    8 .RI [OPTIONS] ...
    9 .\"
   10 .\"   "DESCRIPTION"
   11 .\"
   12 .SH DESCRIPTION
   13 .B xtermcontrol
   14 makes it easy to change colors, title, font and geometry of a running XFree86 
   15 \fBxterm(1)\fR, as well as to report the current settings of the aforementioned
   16 properties.
   17 
   18 Window manipulations de\-/iconify, raise/lower, maximize/restore and reset
   19 are also supported.
   20 
   21 To complete the feature set; xtermcontrol lets advanced users issue any xterm control
   22 sequence of their choosing.
   23 .br
   24 .\"
   25 .\"   "OPTIONS"
   26 .\"
   27 .SH OPTIONS
   28 .IP "\fB\-\-fg\fR=\fICOLOR\fR"
   29 Set foreground color (see also \fBCOLOR NAMES\fR).
   30 .IP "\fB\-\-bg\fR=\fICOLOR\fR"
   31 Set background color.
   32 .IP "\fB\-\-color\fIN\fR=\fICOLOR\fR"
   33 Set N'th [0-255] color to COLOR, e.g. \-\-color88=COLOR.
   34 .IP "\fB\-\-highlight\fR=\fICOLOR\fR"
   35 Set highlight color.
   36 .IP "\fB\-\-cursor\fR=\fICOLOR\fR"
   37 Set cursor color.
   38 .IP "\fB\-\-mouse\-fg\fR=\fICOLOR\fR"
   39 Set mouse pointer foreground color.
   40 .IP "\fB\-\-mouse\-bg\fR=\fICOLOR\fR"
   41 Set mouse pointer background color.
   42 .IP "\fB\-\-font\fR=\fIFONT\fR"
   43 Set font name (see also \fBFONT NAMES\fR). Alternatively it is possible to specify
   44 a fontmenu index as \'#[0-6]\' or navigate the fontmenu by
   45 relative sizes as \'#+N\' or \'#\-N\', where N is an optional integer.
   46 .IP "\fB\-\-title\fR=\fISTRING\fR"
   47 Set window title. Note that mechanisms like the \fBbash(1)\fR
   48 PROMPT_COMMAND may overwrite the title.
   49 .IP "\fB\-\-geometry\fR=\fIWIDTHxHEIGHT+XOFF+YOFF\fR"
   50 Set size and/or position. Through its control sequences the xterm only
   51 recognize positive \fIXOFF\fR and \fIYOFF\fR offsets, which are pixels relative to the
   52 upper left hand corner of the display. xtermcontrol is therefore unable to
   53 handle negative offsets as described in the \fBX(7x)\fR GEOMETRY SPECIFICATIONS
   54 and therefore truncates negative values to zero.
   55 .IP "\fB\-\-get\-fg\fR"
   56 Report foreground color.
   57 .IP "\fB\-\-get\-bg\fR"
   58 Report background color.
   59 .IP "\fB\-\-get\-color\fIN\fR"
   60 Report N'th [0\-255] color, e.g. \-\-get\-color88.
   61 .IP "\fB\-\-get\-highlight\fR"
   62 Report highlight color.
   63 .IP "\fB\-\-get\-cursor\fR"
   64 Report cursor color.
   65 .IP "\fB\-\-get\-mouse\-fg\fR"
   66 Report mouse pointer foreground color.
   67 .IP "\fB\-\-get\-mouse\-bg\fR"
   68 Report mouse pointer background color.
   69 .IP "\fB\-\-get\-font\fR"
   70 Report font.
   71 .IP "\fB\-\-get\-title\fR"
   72 Report window title.
   73 .IP "\fB\-\-get\-geometry\fR"
   74 Report size and position. The size of the text area is reported in characters and
   75 the position is reported in pixels relative to the upper left hand corner of the display.
   76 .IP "\fB\-\-maximize\fR"
   77 Maximize window.
   78 .IP "\fB\-\-restore\fR"
   79 Restore maximized window.
   80 .IP "\fB\-\-iconify\fR"
   81 Iconify window.
   82 .IP "\fB\-\-de\-iconify\fR"
   83 De\-iconify window.
   84 .IP "\fB\-\-raise\fR"
   85 Raise window.
   86 .IP "\fB\-\-lower\fR"
   87 Lower window.
   88 .IP "\fB\-\-reset\fR"
   89 Full reset.
   90 .IP "\fB\-\-raw\fR=\fICTLSEQS\fR"
   91 Issue raw control sequence (see also \fBXTERM CONTROL SEQUENCES\fR).
   92 .IP "\fB\-\-file\fR=\fIFILE\fR"
   93 Source a configuration \fIFILE\fR (see also \fBCONFIGURATION\fR).
   94 .IP "\fB\-\-force\fR, \fB\-f\fR"
   95 Skip TERM environment variable check.
   96 .IP "\fB\-\-verbose\fR, \fB\-v\fR"
   97 Print verbose reports.
   98 .IP "\fB\-\-help\fR, \fB\-h\fR"
   99 Print help message and exit.
  100 .IP "\fB\-\-version\fR"
  101 Print the version number and exit.
  102 .\"
  103 .\"   "CONFIGURATION"
  104 .\"
  105 .SH CONFIGURATION
  106 The default configuration file ~/.xtermcontrol is sourced if xtermcontrol is run without options or if specifically requested, e.g. 'xtermcontrol \-\-file=~/.xtermcontrol'. 
  107 
  108 Each line in a configuration file is either a comment or contains an attribute.
  109 Attributes consist of a keyword and an associated value:
  110 .nf
  111 .sp
  112       keyword = value # comment
  113 .sp
  114 .fi
  115 The valid keyword/value combinations are:
  116 .nf
  117 .sp
  118       foreground="COLOR"
  119       background="COLOR"
  120       highlight="COLOR"
  121       cursor="COLOR"
  122       mouse\-foreground="COLOR"
  123       mouse\-background="COLOR"
  124       geometry="WIDTHxHEIGHT+XOFF+YOFF"
  125       font="FONT"
  126       color0="COLOR"
  127       color1="COLOR"
  128       color2="COLOR"
  129       color3="COLOR"
  130       color4="COLOR"
  131       color5="COLOR"
  132       color6="COLOR"
  133       color7="COLOR"
  134       color8="COLOR"
  135       color9="COLOR"
  136       color10="COLOR"
  137       color11="COLOR"
  138       color12="COLOR"
  139       color13="COLOR"
  140       color14="COLOR"
  141       color15="COLOR"
  142 .sp
  143 .fi
  144 Whitespace is ignored in attributes unless within a quoted value. The
  145 character \'#\' is taken to begin a comment. Each \'#\'
  146 and all remaining characters on that line is ignored.
  147 .\"
  148 .\"   "FONT NAMES"
  149 .\"
  150 .SH FONT NAMES
  151 xtermcontrol accepts any \fBX(7x)\fR FONT NAMES.
  152 Font names like \'\-adobe\-courier\-medium\-r\-normal\-\-10\-100\-75\-75\-m\-60\-iso8859\-1\' are
  153 very cumbersome to write, so it is convenient to make use of aliases, e.g.
  154 \'fixed\' or \'8x13\', if present in fonts.alias files of the font directories.
  155 .\"
  156 .\"   "COLOR NAMES"
  157 .\"
  158 .SH COLOR NAMES
  159 xtermcontrol accepts any \fBX(7x)\fR COLOR NAMES.
  160 Basically this means that colors are specified by name or rgb value, e.g. \'blue\',
  161 \'rgb:0000/0000/FFFF\' or \'#00F\'. Colors are typically reported by the
  162 xterm in a device-dependent numerical form, e.g. \'rgb:0000/0000/FFFF\'.
  163 Note that old syntax rgb values should always be quoted to avoid \'#\' being
  164 interpreted as the beginning of a comment by the shell (see also \fBFILES\fR).
  165 .\"
  166 .\"   "XTERM CONTROL SEQUENCES"
  167 .\"
  168 .SH XTERM CONTROL SEQUENCES
  169 The secret behind xtermcontrol is xterm control sequences. All the possible
  170 (there are a plethora of them) control sequences are documented in ctlseqs.txt,
  171 found in the \fBxterm(1)\fR distribution (see also \fBFILES\fR). 
  172 .\"
  173 .\"   "XTERM CONTROL SEQUENCES"
  174 .\"
  175 .SH MACOS TERMINAL.APP
  176 The macOS Terminal.app emulates an extended set of the VTxxx series commands, closely resembling dtterm.
  177 Therefore the following subset of xtermcontrol options works as expected:
  178 .nf
  179 .sp
  180       \-\-title
  181       \-\-geometry
  182       \-\-get\-geometry
  183       \-\-maximize
  184       \-\-restore
  185       \-\-iconify
  186       \-\-de\-iconify
  187       \-\-raise
  188       \-\-lower
  189       \-\-reset
  190 .sp
  191 .fi
  192 Color names are ignored, but device-dependent numerical form and rgb values works as expected for
  193 the following subset of xtermcontrol options (see also \fBCOLOR NAMES\fR):
  194 .nf
  195 .sp
  196       \-\-fg
  197       \-\-get\-fg
  198       \-\-bg
  199       \-\-get\-bg
  200       \-\-cursor
  201       \-\-get\-cursor
  202       \-\-mouse-fg
  203       \-\-get\-mouse-fg
  204       \-\-mouse-bg
  205       \-\-get\-mouse-bg
  206 .sp
  207 .fi
  208 .\"
  209 .\"   "BUGS"
  210 .\"
  211 .SH TROUBLESHOOTING
  212 If read/write permissions on the tty's are changed so
  213 that special group membership is required to be able to write to the pseudo terminal,
  214 the easiest workaround is to install xtermcontrol setuid root.
  215 
  216 \fBXterm(1)\fR has three resources, allowWindowOps, allowTitleOps, and
  217 allowFontOps, that enables or disables special operations which xtermcontrol relies on.
  218 If any of these resources are set (or defaults) to 'false' xtermcontrol may hang.
  219 The resources corresponds to xtermcontrol options as:
  220 .nf
  221 .sp
  222    allowWindowOps:
  223       \-\-raise
  224       \-\-lower
  225       \-\-restore
  226       \-\-maximize
  227       \-\-iconify
  228       \-\-de\-iconify
  229       \-\-get\-title
  230       \-\-geometry
  231       \-\-get\-geometry
  232 
  233    allowTitleOps:
  234       \-\-title
  235 
  236    allowFontOps:
  237       \-\-font
  238       \-\-get\-font
  239 .sp
  240 .fi
  241 All three resources can usually be enabled for the current xterm session via a menu; ctrl+rightclick and look for menu item names like 'Allow Window Ops'. To set these resource values persistently you can add the following to either your local ~/.Xdefaults file, or to a system-wide resource file like /etc/X11/app\-defaults/XTerm:
  242 .nf
  243 .sp
  244    *VT100.allowWindowOps: true
  245    *VT100.allowTitleOps: true
  246    *VT100.allowFontOps: true
  247 .sp
  248 .fi
  249 .\"
  250 .\"   "FILES"
  251 .\"
  252 .SH FILES
  253 .IP <XRoot>/X11/rgb.txt
  254 Default rgb color name file location.
  255 .IP ctlseqs.txt
  256 Xterm control sequences documentation. Distributed with xterm from
  257 http://dickey.his.com/xterm/
  258 .\"
  259 .\"   "SEE ALSO"
  260 .\"
  261 .SH "SEE ALSO"
  262 .BR xterm(1),
  263 .B  X(7x)
  264 .\"
  265 .\"   "EOF"
  266 .\"
  267 .SH COPYRIGHT