| 1 | .TH xtitle 1 "29 March 2012" "Mark Wooding" "Toys" |
| 2 | .SH NAME |
| 3 | xtitle \- set or read an xterm title string |
| 4 | .SH SYNOPSIS |
| 5 | .B xtitle |
| 6 | .RB [ \-q ] |
| 7 | .br |
| 8 | .B xtitle |
| 9 | .I string |
| 10 | \&... |
| 11 | .SH DESCRIPTION |
| 12 | The |
| 13 | .B xtitle |
| 14 | program sets or reads the title string of an |
| 15 | .BR xterm (1) |
| 16 | or compatible terminal emulator. |
| 17 | .PP |
| 18 | Without |
| 19 | .BR \-q , |
| 20 | concatenate the |
| 21 | .IR string s |
| 22 | provided on the command line |
| 23 | with spaces between them, |
| 24 | and set the result as the title string. |
| 25 | .PP |
| 26 | With |
| 27 | .BR \-q , |
| 28 | read the current title and |
| 29 | write it to standard output |
| 30 | followed by a newline. |
| 31 | .PP |
| 32 | If standard input is a terminal then |
| 33 | .B xtitle |
| 34 | will use it |
| 35 | (writing to file descriptor 0!); |
| 36 | otherwise it will open |
| 37 | .B /dev/tty |
| 38 | and use that. |
| 39 | .SH BUGS |
| 40 | .B xtitle |
| 41 | makes no attempt to determine whether its terminal is in fact |
| 42 | .B xterm |
| 43 | or something compatible. |
| 44 | .PP |
| 45 | In |
| 46 | .B \-q |
| 47 | mode, |
| 48 | if the terminal doesn't understand the necessary control sequence, |
| 49 | or the feature has been disabled for (quite sensible) security reasons, |
| 50 | then |
| 51 | .B xtitle |
| 52 | will wait forever for the title string to appear. |
| 53 | .SH AUTHOR |
| 54 | Mark Wooding, <mdw@distorted.org.uk> |