From 0f581568f662310ff4a32e3d43016fff268d10bd Mon Sep 17 00:00:00 2001 From: Mark Wooding Date: Sun, 6 Mar 2016 21:48:31 +0000 Subject: [PATCH] xtitle.1: Long-missing manual page. Please don't use this program. --- Makefile.am | 2 +- xtitle.1 | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+), 1 deletion(-) create mode 100644 xtitle.1 diff --git a/Makefile.am b/Makefile.am index b613caa..79da5b4 100644 --- a/Makefile.am +++ b/Makefile.am @@ -58,7 +58,7 @@ dist_man_MANS += getpass.1 ## xtitle bin_PROGRAMS += xtitle xtitle_SOURCES = xtitle.c -## !UNDOCUMENTED +dist_man_MANS += xtitle.1 ## pause if HAVE_MLIB diff --git a/xtitle.1 b/xtitle.1 new file mode 100644 index 0000000..f651688 --- /dev/null +++ b/xtitle.1 @@ -0,0 +1,54 @@ +.TH xtitle 1 "29 March 2012" "Mark Wooding" "Toys" +.SH NAME +xtitle \- set or read an xterm title string +.SH SYNOPSIS +.B xtitle +.RB [ \-q ] +.br +.B xtitle +.I string +\&... +.SH DESCRIPTION +The +.B xtitle +program sets or reads the title string of an +.BR xterm (1) +or compatible terminal emulator. +.PP +Without +.BR \-q , +concatenate the +.IR string s +provided on the command line +with spaces between them, +and set the result as the title string. +.PP +With +.BR \-q , +read the current title and +write it to standard output +followed by a newline. +.PP +If standard input is a terminal then +.B xtitle +will use it +(writing to file descriptor 0!); +otherwise it will open +.B /dev/tty +and use that. +.SH BUGS +.B xtitle +makes no attempt to determine whether its terminal is in fact +.B xterm +or something compatible. +.PP +In +.B \-q +mode, +if the terminal doesn't understand the necessary control sequence, +or the feature has been disabled for (quite sensible) security reasons, +then +.B xtitle +will wait forever for the title string to appear. +.SH AUTHOR +Mark Wooding, -- 2.11.0