| 1 | \cfg{man-identity}{pterm}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite} |
| 2 | |
| 3 | \H{pterm-manpage} Man page for pterm |
| 4 | |
| 5 | \S{pterm-manpage-name} NAME |
| 6 | |
| 7 | pterm \- yet another X terminal emulator |
| 8 | |
| 9 | \S{pterm-manpage-synopsis} SYNOPSIS |
| 10 | |
| 11 | \c pterm [ options ] |
| 12 | \e bbbbb iiiiiii |
| 13 | |
| 14 | \S{pterm-manpage-description} DESCRIPTION |
| 15 | |
| 16 | \cw{pterm} is a terminal emulator for X. It is based on a port of |
| 17 | the terminal emulation engine in the Windows SSH client PuTTY. |
| 18 | |
| 19 | \S{pterm-manpage-options} OPTIONS |
| 20 | |
| 21 | The command-line options supported by \cw{pterm} are: |
| 22 | |
| 23 | \dt \cw{\-e} \e{command} [ \e{arguments} ] |
| 24 | |
| 25 | \dd Specify a command to be executed in the new terminal. Everything on |
| 26 | the command line after this option will be passed straight to the |
| 27 | \cw{execvp} system call; so if you need the command to redirect its |
| 28 | input or output, you will have to use \cw{sh}: |
| 29 | |
| 30 | \lcont{ |
| 31 | |
| 32 | \c pterm -e sh -c 'mycommand < inputfile' |
| 33 | |
| 34 | } |
| 35 | |
| 36 | \dt \cw{\-\-display} \e{display\-name} |
| 37 | |
| 38 | \dd Specify the X display on which to open \cw{pterm}. (Note this |
| 39 | option has a double minus sign, even though none of the others do. |
| 40 | This is because this option is supplied automatically by GTK. |
| 41 | Sorry.) |
| 42 | |
| 43 | \dt \cw{\-name} \e{font-name} |
| 44 | |
| 45 | \dd Specify the name under which \cw{pterm} looks up X resources. |
| 46 | Normally it will look them up as (for example) \cw{pterm.Font}. If |
| 47 | you specify \q{\cw{\-name xyz}}, it will look them up as |
| 48 | \cw{xyz.Font} instead. This allows you to set up several different |
| 49 | sets of defaults and choose between them. |
| 50 | |
| 51 | \dt \cw{\-fn} \e{font-name} |
| 52 | |
| 53 | \dd Specify the font to use for normal text displayed in the terminal. |
| 54 | |
| 55 | \dt \cw{\-fb} \e{font-name} |
| 56 | |
| 57 | \dd Specify the font to use for bold text displayed in the terminal. If |
| 58 | the \cw{BoldAsColour} resource is set to 1 (the default), bold text |
| 59 | will be displayed in different colours instead of a different font, |
| 60 | so this option will be ignored. If \cw{BoldAsColour} is set to 0 |
| 61 | and you do not specify a bold font, \cw{pterm} will overprint the |
| 62 | normal font to make it look bolder. |
| 63 | |
| 64 | \dt \cw{\-fw} \e{font-name} |
| 65 | |
| 66 | \dd Specify the font to use for double-width characters (typically |
| 67 | Chinese, Japanese and Korean text) displayed in the terminal. |
| 68 | |
| 69 | \dt \cw{\-fwb} \e{font-name} |
| 70 | |
| 71 | \dd Specify the font to use for bold double-width characters |
| 72 | (typically Chinese, Japanese and Korean text). Like \cw{-fb}, this |
| 73 | will be ignored unless the \cw{BoldAsColour} resource is set to 0. |
| 74 | |
| 75 | \dt \cw{\-geometry} \e{geometry} |
| 76 | |
| 77 | \dd Specify the size of the terminal, in rows and columns of text. See |
| 78 | \e{X(7)} for more information on the syntax of geometry |
| 79 | specifications. |
| 80 | |
| 81 | \dt \cw{\-sl} \e{lines} |
| 82 | |
| 83 | \dd Specify the number of lines of scrollback to save off the top of the |
| 84 | terminal. |
| 85 | |
| 86 | \dt \cw{\-fg} \e{colour} |
| 87 | |
| 88 | \dd Specify the foreground colour to use for normal text. |
| 89 | |
| 90 | \dt \cw{\-bg} \e{colour} |
| 91 | |
| 92 | \dd Specify the background colour to use for normal text. |
| 93 | |
| 94 | \dt \cw{\-bfg} \e{colour} |
| 95 | |
| 96 | \dd Specify the foreground colour to use for bold text, if the |
| 97 | \cw{BoldAsColour} resource is set to 1 (the default). |
| 98 | |
| 99 | \dt \cw{\-bbg} \e{colour} |
| 100 | |
| 101 | \dd Specify the foreground colour to use for bold reverse-video text, if |
| 102 | the \cw{BoldAsColour} resource is set to 1 (the default). (This |
| 103 | colour is best thought of as the bold version of the background |
| 104 | colour; so it only appears when text is displayed \e{in} the |
| 105 | background colour.) |
| 106 | |
| 107 | \dt \cw{\-cfg} \e{colour} |
| 108 | |
| 109 | \dd Specify the foreground colour to use for text covered by the cursor. |
| 110 | |
| 111 | \dt \cw{\-cbg} \e{colour} |
| 112 | |
| 113 | \dd Specify the background colour to use for text covered by the cursor. |
| 114 | In other words, this is the main colour of the cursor. |
| 115 | |
| 116 | \dt \cw{\-title} \e{title} |
| 117 | |
| 118 | \dd Specify the initial title of the terminal window. (This can be |
| 119 | changed under control of the server.) |
| 120 | |
| 121 | \dt \cw{\-ut\-} or \cw{+ut} |
| 122 | |
| 123 | \dd Tells \cw{pterm} not to record your login in the \cw{utmp}, |
| 124 | \cw{wtmp} and \cw{lastlog} system log files; so you will not show |
| 125 | up on \cw{finger} or \cw{who} listings, for example. |
| 126 | |
| 127 | \dt \cw{\-ut} |
| 128 | |
| 129 | \dd Tells \cw{pterm} to record your login in \cw{utmp}, \cw{wtmp} and |
| 130 | \cw{lastlog}: this is the opposite of \cw{\-ut\-}. This is the |
| 131 | default option: you will probably only need to specify it explicitly |
| 132 | if you have changed the default using the \cw{StampUtmp} resource. |
| 133 | |
| 134 | \dt \cw{\-ls\-} or \cw{+ls} |
| 135 | |
| 136 | \dd Tells \cw{pterm} not to execute your shell as a login shell. |
| 137 | |
| 138 | \dt \cw{\-ls} |
| 139 | |
| 140 | \dd Tells \cw{pterm} to execute your shell as a login shell: this is |
| 141 | the opposite of \cw{\-ls\-}. This is the default option: you will |
| 142 | probably only need to specify it explicitly if you have changed the |
| 143 | default using the \cw{LoginShell} resource. |
| 144 | |
| 145 | \dt \cw{\-sb\-} or \cw{+sb} |
| 146 | |
| 147 | \dd Tells \cw{pterm} not to display a scroll bar. |
| 148 | |
| 149 | \dt \cw{\-sb} |
| 150 | |
| 151 | \dd Tells \cw{pterm} to display a scroll bar: this is the opposite of |
| 152 | \cw{\-sb\-}. This is the default option: you will probably only need |
| 153 | to specify it explicitly if you have changed the default using the |
| 154 | \cw{ScrollBar} resource. |
| 155 | |
| 156 | \dt \cw{\-log} \e{filename} |
| 157 | |
| 158 | \dd This option makes \cw{pterm} log all the terminal output to a file |
| 159 | as well as displaying it in the terminal. |
| 160 | |
| 161 | \dt \cw{\-cs} \e{charset} |
| 162 | |
| 163 | \dd This option specifies the character set in which \cw{pterm} should |
| 164 | assume the session is operating. This character set will be used to |
| 165 | interpret all the data received from the session, and all input you |
| 166 | type or paste into \cw{pterm} will be converted into this character |
| 167 | set before being sent to the session. |
| 168 | |
| 169 | \lcont{ Any character set name which is valid in a MIME header (and |
| 170 | supported by \cw{pterm}) should be valid here (examples are |
| 171 | \q{\cw{ISO-8859-1}}, \q{\cw{windows-1252}} or \q{\cw{UTF-8}}). Also, |
| 172 | any character encoding which is valid in an X logical font |
| 173 | description should be valid (\q{\cw{ibm-cp437}}, for example). |
| 174 | |
| 175 | \cw{pterm}'s default behaviour is to use the same character encoding |
| 176 | as its primary font. If you supply a Unicode (\cw{iso10646-1}) font, |
| 177 | it will default to the UTF-8 character set. |
| 178 | |
| 179 | Character set names are case-insensitive. |
| 180 | } |
| 181 | |
| 182 | \dt \cw{\-nethack} |
| 183 | |
| 184 | \dd Tells \cw{pterm} to enable NetHack keypad mode, in which the |
| 185 | numeric keypad generates the NetHack \c{hjklyubn} direction keys. |
| 186 | This enables you to play NetHack with the numeric keypad without |
| 187 | having to use the NetHack \c{number_pad} option (which requires you |
| 188 | to press \q{\cw{n}} before any repeat count). So you can move with |
| 189 | the numeric keypad, and enter repeat counts with the normal number |
| 190 | keys. |
| 191 | |
| 192 | \dt \cw{\-xrm} \e{resource-string} |
| 193 | |
| 194 | \dd This option specifies an X resource string. Useful for setting |
| 195 | resources which do not have their own command-line options. For |
| 196 | example: |
| 197 | |
| 198 | \lcont{ |
| 199 | |
| 200 | \c pterm -xrm 'ScrollbarOnLeft: 1' |
| 201 | |
| 202 | } |
| 203 | |
| 204 | \dt \cw{\-help}, \cw{\-\-help} |
| 205 | |
| 206 | \dd Display a message summarizing the available options. |
| 207 | |
| 208 | \S{pterm-manpage-x-resources} X RESOURCES |
| 209 | |
| 210 | \cw{pterm} can be more completely configured by means of X |
| 211 | resources. All of these resources are of the form \cw{pterm.FOO} for |
| 212 | some \cw{FOO}; you can make \cw{pterm} look them up under another |
| 213 | name, such as \cw{xyz.FOO}, by specifying the command-line option |
| 214 | \q{\cw{\-name xyz}}. |
| 215 | |
| 216 | \dt \cw{pterm.CloseOnExit} |
| 217 | |
| 218 | \dd This option should be set to 0, 1 or 2; the default is 2. It |
| 219 | controls what \cw{pterm} does when the process running inside it |
| 220 | terminates. When set to 2 (the default), \cw{pterm} will close its |
| 221 | window as soon as the process inside it terminates. When set to 0, |
| 222 | \cw{pterm} will print the process's exit status, and the window |
| 223 | will remain present until a key is pressed (allowing you to inspect |
| 224 | the scrollback, and copy and paste text out of it). |
| 225 | |
| 226 | \lcont{ |
| 227 | |
| 228 | When this setting is set to 1, \cw{pterm} will close |
| 229 | immediately if the process exits cleanly (with an exit status of |
| 230 | zero), but the window will stay around if the process exits with a |
| 231 | non-zero code or on a signal. This enables you to see what went |
| 232 | wrong if the process suffers an error, but not to have to bother |
| 233 | closing the window in normal circumstances. |
| 234 | |
| 235 | } |
| 236 | |
| 237 | \dt \cw{pterm.WarnOnClose} |
| 238 | |
| 239 | \dd This option should be set to either 0 or 1; the default is 1. |
| 240 | When set to 1, \cw{pterm} will ask for confirmation before closing |
| 241 | its window when you press the close button. |
| 242 | |
| 243 | \dt \cw{pterm.TerminalType} |
| 244 | |
| 245 | \dd This controls the value set in the \cw{TERM} environment |
| 246 | variable inside the new terminal. The default is \q{\cw{xterm}}. |
| 247 | |
| 248 | \dt \cw{pterm.BackspaceIsDelete} |
| 249 | |
| 250 | \dd This option should be set to either 0 or 1; the default is 1. |
| 251 | When set to 0, the ordinary Backspace key generates the Backspace |
| 252 | character (\cw{^H}); when set to 1, it generates the Delete |
| 253 | character (\cw{^?}). Whichever one you set, the terminal device |
| 254 | inside \cw{pterm} will be set up to expect it. |
| 255 | |
| 256 | \dt \cw{pterm.RXVTHomeEnd} |
| 257 | |
| 258 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 259 | it is set to 1, the Home and End keys generate the control sequences |
| 260 | they would generate in the \cw{rxvt} terminal emulator, instead of |
| 261 | the more usual ones generated by other emulators. |
| 262 | |
| 263 | \dt \cw{pterm.LinuxFunctionKeys} |
| 264 | |
| 265 | \dd This option can be set to any number between 0 and 5 inclusive; |
| 266 | the default is 0. The modes vary the control sequences sent by the |
| 267 | function keys; for more complete documentation, it is probably |
| 268 | simplest to try each option in \q{\cw{pterm \-e cat}}, and press the |
| 269 | keys to see what they generate. |
| 270 | |
| 271 | \dt \cw{pterm.NoApplicationKeys} |
| 272 | |
| 273 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 274 | set to 1, it stops the server from ever switching the numeric keypad |
| 275 | into application mode (where the keys send function-key-like |
| 276 | sequences instead of numbers or arrow keys). You probably only need |
| 277 | this if some application is making a nuisance of itself. |
| 278 | |
| 279 | \dt \cw{pterm.NoApplicationCursors} |
| 280 | |
| 281 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 282 | set to 1, it stops the server from ever switching the cursor keys |
| 283 | into application mode (where the keys send slightly different |
| 284 | sequences). You probably only need this if some application is |
| 285 | making a nuisance of itself. |
| 286 | |
| 287 | \dt \cw{pterm.NoMouseReporting} |
| 288 | |
| 289 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 290 | set to 1, it stops the server from ever enabling mouse reporting |
| 291 | mode (where mouse clicks are sent to the application instead of |
| 292 | controlling cut and paste). |
| 293 | |
| 294 | \dt \cw{pterm.NoRemoteResize} |
| 295 | |
| 296 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 297 | set to 1, it stops the server from being able to remotely control |
| 298 | the size of the \cw{pterm} window. |
| 299 | |
| 300 | \dt \cw{pterm.NoAltScreen} |
| 301 | |
| 302 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 303 | set to 1, it stops the server from using the \q{alternate screen} |
| 304 | terminal feature, which lets full-screen applications leave the |
| 305 | screen exactly the way they found it. |
| 306 | |
| 307 | \dt \cw{pterm.NoRemoteWinTitle} |
| 308 | |
| 309 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 310 | set to 1, it stops the server from remotely controlling the title of |
| 311 | the \cw{pterm} window. |
| 312 | |
| 313 | \dt \cw{pterm.NoRemoteQTitle} |
| 314 | |
| 315 | \dd This option should be set to either 0 or 1; the default is 1. When |
| 316 | set to 1, it stops the server from remotely requesting the title of |
| 317 | the \cw{pterm} window. |
| 318 | |
| 319 | \lcont{ |
| 320 | This feature is a \e{POTENTIAL SECURITY HAZARD}. If a malicious |
| 321 | application can write data to your terminal (for example, if you |
| 322 | merely \cw{cat} a file owned by someone else on the server |
| 323 | machine), it can change your window title (unless you have disabled |
| 324 | this using the \cw{NoRemoteWinTitle} resource) and then use this |
| 325 | service to have the new window title sent back to the server as if |
| 326 | typed at the keyboard. This allows an attacker to fake keypresses |
| 327 | and potentially cause your server-side applications to do things you |
| 328 | didn't want. Therefore this feature is disabled by default, and we |
| 329 | recommend you do not turn it on unless you \e{really} know what |
| 330 | you are doing. |
| 331 | } |
| 332 | |
| 333 | \dt \cw{pterm.NoDBackspace} |
| 334 | |
| 335 | \dd This option should be set to either 0 or 1; the default is 0. |
| 336 | When set to 1, it disables the normal action of the Delete (\cw{^?}) |
| 337 | character when sent from the server to the terminal, which is to |
| 338 | move the cursor left by one space and erase the character now under |
| 339 | it. |
| 340 | |
| 341 | \dt \cw{pterm.ApplicationCursorKeys} |
| 342 | |
| 343 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 344 | set to 1, the default initial state of the cursor keys are |
| 345 | application mode (where the keys send function-key-like sequences |
| 346 | instead of numbers or arrow keys). When set to 0, the default state |
| 347 | is the normal one. |
| 348 | |
| 349 | \dt \cw{pterm.ApplicationKeypad} |
| 350 | |
| 351 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 352 | set to 1, the default initial state of the numeric keypad is |
| 353 | application mode (where the keys send function-key-like sequences |
| 354 | instead of numbers or arrow keys). When set to 0, the default state |
| 355 | is the normal one. |
| 356 | |
| 357 | \dt \cw{pterm.NetHackKeypad} |
| 358 | |
| 359 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 360 | set to 1, the numeric keypad operates in NetHack mode. This is |
| 361 | equivalent to the \cw{\-nethack} command-line option. |
| 362 | |
| 363 | \dt \cw{pterm.Answerback} |
| 364 | |
| 365 | \dd This option controls the string which the terminal sends in |
| 366 | response to receiving the \cw{^E} character (\q{tell me about |
| 367 | yourself}). By default this string is \q{\cw{PuTTY}}. |
| 368 | |
| 369 | \dt \cw{pterm.HideMousePtr} |
| 370 | |
| 371 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 372 | it is set to 1, the mouse pointer will disappear if it is over the |
| 373 | \cw{pterm} window and you press a key. It will reappear as soon as |
| 374 | you move it. |
| 375 | |
| 376 | \dt \cw{pterm.WindowBorder} |
| 377 | |
| 378 | \dd This option controls the number of pixels of space between the text |
| 379 | in the \cw{pterm} window and the window frame. The default is 1. |
| 380 | You can increase this value, but decreasing it to 0 is not |
| 381 | recommended because it can cause the window manager's size hints to |
| 382 | work incorrectly. |
| 383 | |
| 384 | \dt \cw{pterm.CurType} |
| 385 | |
| 386 | \dd This option should be set to either 0, 1 or 2; the default is 0. |
| 387 | When set to 0, the text cursor displayed in the window is a |
| 388 | rectangular block. When set to 1, the cursor is an underline; when |
| 389 | set to 2, it is a vertical line. |
| 390 | |
| 391 | \dt \cw{pterm.BlinkCur} |
| 392 | |
| 393 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 394 | it is set to 1, the text cursor will blink when the window is active. |
| 395 | |
| 396 | \dt \cw{pterm.Beep} |
| 397 | |
| 398 | \dd This option should be set to either 0 or 2 (yes, 2); the default |
| 399 | is 0. When it is set to 2, \cw{pterm} will respond to a bell |
| 400 | character (\cw{^G}) by flashing the window instead of beeping. |
| 401 | |
| 402 | \dt \cw{pterm.BellOverload} |
| 403 | |
| 404 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 405 | it is set to 1, \cw{pterm} will watch out for large numbers of |
| 406 | bells arriving in a short time and will temporarily disable the bell |
| 407 | until they stop. The idea is that if you \cw{cat} a binary file, |
| 408 | the frantic beeping will mostly be silenced by this feature and will |
| 409 | not drive you crazy. |
| 410 | |
| 411 | \lcont{ |
| 412 | The bell overload mode is activated by receiving N bells in time T; |
| 413 | after a further time S without any bells, overload mode will turn |
| 414 | itself off again. |
| 415 | |
| 416 | Bell overload mode is always deactivated by any keypress in the |
| 417 | terminal. This means it can respond to large unexpected streams of |
| 418 | data, but does not interfere with ordinary command-line activities |
| 419 | that generate beeps (such as filename completion). |
| 420 | } |
| 421 | |
| 422 | \dt \cw{pterm.BellOverloadN} |
| 423 | |
| 424 | \dd This option counts the number of bell characters which will activate |
| 425 | bell overload if they are received within a length of time T. The |
| 426 | default is 5. |
| 427 | |
| 428 | \dt \cw{pterm.BellOverloadT} |
| 429 | |
| 430 | \dd This option specifies the time period in which receiving N or more |
| 431 | bells will activate bell overload mode. It is measured in |
| 432 | microseconds, so (for example) set it to 1000000 for one second. The |
| 433 | default is 2000000 (two seconds). |
| 434 | |
| 435 | \dt \cw{pterm.BellOverloadS} |
| 436 | |
| 437 | \dd This option specifies the time period of silence required to turn |
| 438 | off bell overload mode. It is measured in microseconds, so (for |
| 439 | example) set it to 1000000 for one second. The default is 5000000 |
| 440 | (five seconds of silence). |
| 441 | |
| 442 | \dt \cw{pterm.ScrollbackLines} |
| 443 | |
| 444 | \dd This option specifies how many lines of scrollback to save above the |
| 445 | visible terminal screen. The default is 200. This resource is |
| 446 | equivalent to the \cw{\-sl} command-line option. |
| 447 | |
| 448 | \dt \cw{pterm.DECOriginMode} |
| 449 | |
| 450 | \dd This option should be set to either 0 or 1; the default is 0. It |
| 451 | specifies the default state of DEC Origin Mode. (If you don't know |
| 452 | what that means, you probably don't need to mess with it.) |
| 453 | |
| 454 | \dt \cw{pterm.AutoWrapMode} |
| 455 | |
| 456 | \dd This option should be set to either 0 or 1; the default is 1. It |
| 457 | specifies the default state of auto wrap mode. When set to 1, very |
| 458 | long lines will wrap over to the next line on the terminal; when set |
| 459 | to 0, long lines will be squashed against the right-hand edge of the |
| 460 | screen. |
| 461 | |
| 462 | \dt \cw{pterm.LFImpliesCR} |
| 463 | |
| 464 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 465 | set to 1, the terminal will return the cursor to the left side of |
| 466 | the screen when it receives a line feed character. |
| 467 | |
| 468 | \dt \cw{pterm.WinTitle} |
| 469 | |
| 470 | \dd This resource is the same as the \cw{\-T} command-line option: |
| 471 | it controls the initial title of the window. The default is |
| 472 | \q{\cw{pterm}}. |
| 473 | |
| 474 | \dt \cw{pterm.TermWidth} |
| 475 | |
| 476 | \dd This resource is the same as the width part of the \cw{\-geometry} |
| 477 | command-line option: it controls the number of columns of text in |
| 478 | the window. The default is 80. |
| 479 | |
| 480 | \dt \cw{pterm.TermHeight} |
| 481 | |
| 482 | \dd This resource is the same as the width part of the \cw{\-geometry} |
| 483 | command-line option: it controls the number of columns of text in |
| 484 | the window. The defaults is 24. |
| 485 | |
| 486 | \dt \cw{pterm.Font} |
| 487 | |
| 488 | \dd This resource is the same as the \cw{\-fn} command-line option: it |
| 489 | controls the font used to display normal text. The default is |
| 490 | \q{\cw{fixed}}. |
| 491 | |
| 492 | \dt \cw{pterm.BoldFont} |
| 493 | |
| 494 | \dd This resource is the same as the \cw{\-fb} command-line option: it |
| 495 | controls the font used to display bold text when \cw{BoldAsColour} |
| 496 | is turned off. The default is unset (the font will be bolded by |
| 497 | printing it twice at a one-pixel offset). |
| 498 | |
| 499 | \dt \cw{pterm.WideFont} |
| 500 | |
| 501 | \dd This resource is the same as the \cw{\-fw} command-line option: it |
| 502 | controls the font used to display double-width characters. The |
| 503 | default is unset (double-width characters cannot be displayed). |
| 504 | |
| 505 | \dt \cw{pterm.WideBoldFont} |
| 506 | |
| 507 | \dd This resource is the same as the \cw{\-fwb} command-line option: it |
| 508 | controls the font used to display double-width characters in bold, |
| 509 | when \cw{BoldAsColour} is turned off. The default is unset |
| 510 | (double-width characters are displayed in bold by printing them |
| 511 | twice at a one-pixel offset). |
| 512 | |
| 513 | \dt \cw{pterm.ShadowBoldOffset} |
| 514 | |
| 515 | \dd This resource can be set to an integer; the default is \-1. It |
| 516 | specifies the offset at which text is overprinted when using |
| 517 | \q{shadow bold} mode. The default (1) means that the text will be |
| 518 | printed in the normal place, and also one character to the right; |
| 519 | this seems to work well for most X bitmap fonts, which have a blank |
| 520 | line of pixels down the right-hand side. For some fonts, you may |
| 521 | need to set this to \-1, so that the text is overprinted one pixel |
| 522 | to the left; for really large fonts, you may want to set it higher |
| 523 | than 1 (in one direction or the other). |
| 524 | |
| 525 | \dt \cw{pterm.BoldAsColour} |
| 526 | |
| 527 | \dd This option should be set to either 0 or 1; the default is 1. It |
| 528 | specifies the default state of auto wrap mode. When set to 1, bold |
| 529 | text is shown by displaying it in a brighter colour; when set to 0, |
| 530 | bold text is shown by displaying it in a heavier font. |
| 531 | |
| 532 | \dt \cw{pterm.Colour0}, \cw{pterm.Colour1}, ..., \cw{pterm.Colour21} |
| 533 | |
| 534 | \dd These options control the various colours used to display text |
| 535 | in the \cw{pterm} window. Each one should be specified as a triple |
| 536 | of decimal numbers giving red, green and blue values: so that black |
| 537 | is \q{\cw{0,0,0}}, white is \q{\cw{255,255,255}}, red is |
| 538 | \q{\cw{255,0,0}} and so on. |
| 539 | |
| 540 | \lcont{ |
| 541 | |
| 542 | Colours 0 and 1 specify the foreground colour and its bold |
| 543 | equivalent (the \cw{\-fg} and \cw{\-bfg} command-line options). |
| 544 | Colours 2 and 3 specify the background colour and its bold |
| 545 | equivalent (the \cw{\-bg} and \cw{\-bbg} command-line options). |
| 546 | Colours 4 and 5 specify the text and block colours used for the |
| 547 | cursor (the \cw{\-cfg} and \cw{\-cbg} command-line options). Each |
| 548 | even number from 6 to 20 inclusive specifies the colour to be used |
| 549 | for one of the ANSI primary colour specifications (black, red, |
| 550 | green, yellow, blue, magenta, cyan, white, in that order); the odd |
| 551 | numbers from 7 to 21 inclusive specify the bold version of each |
| 552 | colour, in the same order. The defaults are: |
| 553 | |
| 554 | \c pterm.Colour0: 187,187,187 |
| 555 | \c pterm.Colour1: 255,255,255 |
| 556 | \c pterm.Colour2: 0,0,0 |
| 557 | \c pterm.Colour3: 85,85,85 |
| 558 | \c pterm.Colour4: 0,0,0 |
| 559 | \c pterm.Colour5: 0,255,0 |
| 560 | \c pterm.Colour6: 0,0,0 |
| 561 | \c pterm.Colour7: 85,85,85 |
| 562 | \c pterm.Colour8: 187,0,0 |
| 563 | \c pterm.Colour9: 255,85,85 |
| 564 | \c pterm.Colour10: 0,187,0 |
| 565 | \c pterm.Colour11: 85,255,85 |
| 566 | \c pterm.Colour12: 187,187,0 |
| 567 | \c pterm.Colour13: 255,255,85 |
| 568 | \c pterm.Colour14: 0,0,187 |
| 569 | \c pterm.Colour15: 85,85,255 |
| 570 | \c pterm.Colour16: 187,0,187 |
| 571 | \c pterm.Colour17: 255,85,255 |
| 572 | \c pterm.Colour18: 0,187,187 |
| 573 | \c pterm.Colour19: 85,255,255 |
| 574 | \c pterm.Colour20: 187,187,187 |
| 575 | \c pterm.Colour21: 255,255,255 |
| 576 | |
| 577 | } |
| 578 | |
| 579 | \dt \cw{pterm.RectSelect} |
| 580 | |
| 581 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 582 | set to 0, dragging the mouse over several lines selects to the end |
| 583 | of each line and from the beginning of the next; when set to 1, |
| 584 | dragging the mouse over several lines selects a rectangular region. |
| 585 | In each case, holding down Alt while dragging gives the other |
| 586 | behaviour. |
| 587 | |
| 588 | \dt \cw{pterm.MouseOverride} |
| 589 | |
| 590 | \dd This option should be set to either 0 or 1; the default is 1. When |
| 591 | set to 1, if the application requests mouse tracking (so that mouse |
| 592 | clicks are sent to it instead of doing selection), holding down |
| 593 | Shift will revert the mouse to normal selection. When set to 0, |
| 594 | mouse tracking completely disables selection. |
| 595 | |
| 596 | \dt \cw{pterm.Printer} |
| 597 | |
| 598 | \dd This option is unset by default. If you set it, then |
| 599 | server-controlled printing is enabled: the server can send control |
| 600 | sequences to request data to be sent to a printer. That data will be |
| 601 | piped into the command you specify here; so you might want to set it |
| 602 | to \q{\cw{lpr}}, for example, or \q{\cw{lpr \-Pmyprinter}}. |
| 603 | |
| 604 | \dt \cw{pterm.ScrollBar} |
| 605 | |
| 606 | \dd This option should be set to either 0 or 1; the default is 1. When |
| 607 | set to 0, the scrollbar is hidden (although Shift-PageUp and |
| 608 | Shift-PageDown still work). This is the same as the \cw{\-sb} |
| 609 | command-line option. |
| 610 | |
| 611 | \dt \cw{pterm.ScrollbarOnLeft} |
| 612 | |
| 613 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 614 | set to 1, the scrollbar will be displayed on the left of the |
| 615 | terminal instead of on the right. |
| 616 | |
| 617 | \dt \cw{pterm.ScrollOnKey} |
| 618 | |
| 619 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 620 | set to 1, any keypress causes the position of the scrollback to be |
| 621 | reset to the very bottom. |
| 622 | |
| 623 | \dt \cw{pterm.ScrollOnDisp} |
| 624 | |
| 625 | \dd This option should be set to either 0 or 1; the default is 1. When |
| 626 | set to 1, any activity in the display causes the position of the |
| 627 | scrollback to be reset to the very bottom. |
| 628 | |
| 629 | \dt \cw{pterm.LineCodePage} |
| 630 | |
| 631 | \dd This option specifies the character set to be used for the session. |
| 632 | This is the same as the \cw{\-cs} command-line option. |
| 633 | |
| 634 | \dt \cw{pterm.NoRemoteCharset} |
| 635 | |
| 636 | \dd This option disables the terminal's ability to change its character |
| 637 | set when it receives escape sequences telling it to. You might need |
| 638 | to do this to interoperate with programs which incorrectly change |
| 639 | the character set to something they think is sensible. |
| 640 | |
| 641 | \dt \cw{pterm.BCE} |
| 642 | |
| 643 | \dd This option should be set to either 0 or 1; the default is 1. When |
| 644 | set to 1, the various control sequences that erase parts of the |
| 645 | terminal display will erase in whatever the current background |
| 646 | colour is; when set to 0, they will erase in black always. |
| 647 | |
| 648 | \dt \cw{pterm.BlinkText} |
| 649 | |
| 650 | \dd This option should be set to either 0 or 1; the default is 0. When |
| 651 | set to 1, text specified as blinking by the server will actually |
| 652 | blink on and off; when set to 0, \cw{pterm} will use the less |
| 653 | distracting approach of making the text's background colour bold. |
| 654 | |
| 655 | \dt \cw{pterm.StampUtmp} |
| 656 | |
| 657 | \dd This option should be set to either 0 or 1; the default is 1. When |
| 658 | set to 1, \cw{pterm} will log the login in the various system log |
| 659 | files. This resource is equivalent to the \cw{\-ut} command-line |
| 660 | option. |
| 661 | |
| 662 | \dt \cw{pterm.LoginShell} |
| 663 | |
| 664 | \dd This option should be set to either 0 or 1; the default is 1. When |
| 665 | set to 1, \cw{pterm} will execute your shell as a login shell. This |
| 666 | resource is equivalent to the \cw{\-ls} command-line option. |
| 667 | |
| 668 | \S{pterm-manpage-bugs} BUGS |
| 669 | |
| 670 | Most of the X resources have silly names. (Historical reasons from |
| 671 | PuTTY, mostly.) |