xtitle.1: Long-missing manual page.

Please don't use this program.

diff --git a/Makefile.am b/Makefile.am
index b613caaab0c0e3c5cec071000b4b17c8651efbe2..79da5b49789ff387d4337e82741d0f487e83c85f 100644 (file)
--- 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 (file)
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, <mdw@distorted.org.uk>