From 2a317ad012b45a95e9bee3e1747dd0100e73c07b Mon Sep 17 00:00:00 2001 From: Sam Hocevar Date: Fri, 10 Nov 2006 08:54:04 +0000 Subject: [PATCH] * Add a manual page. --- Makefile.am | 2 +- configure.ac | 1 + doc/Makefile.am | 6 ++ doc/toilet.1 | 152 ++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 160 insertions(+), 1 deletion(-) create mode 100644 doc/Makefile.am create mode 100644 doc/toilet.1 diff --git a/Makefile.am b/Makefile.am index 528c50b..6d433e2 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,5 +1,5 @@ -SUBDIRS = src tools fonts +SUBDIRS = src tools fonts doc DIST_SUBDIRS = $(SUBDIRS) EXTRA_DIST = bootstrap diff --git a/configure.ac b/configure.ac index 4e8ebd3..82769c0 100644 --- a/configure.ac +++ b/configure.ac @@ -76,5 +76,6 @@ AC_OUTPUT([ src/Makefile tools/Makefile fonts/Makefile + doc/Makefile ]) diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..83612b4 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,6 @@ +# $Id: Makefile.am 871 2006-09-25 15:58:33Z sam $ + +EXTRA_DIST = $(man_MANS) + +man_MANS = toilet.1 + diff --git a/doc/toilet.1 b/doc/toilet.1 new file mode 100644 index 0000000..d15c5b7 --- /dev/null +++ b/doc/toilet.1 @@ -0,0 +1,152 @@ +.TH toilet 1 "2006-11-10" "libcaca" +.SH NAME +TOIlet \- display large colourful characters +.SH SYNOPSIS +.B toilet +[ +.B \-htv +] [ +.B \-d +.I fontdirectory +] +.PD 0 +.IP +.PD +[ +.B \-f +.I fontfile +] [ +.B \-F +.I filter +] [ +.B \-w +.I outputwidth +] +.PD 0 +.IP +.PD +[ +.B \-I +.I infocode +] [ +.B \-E +.I format +] [ +.I message +] +.RI +.SH DESCRIPTION +.B TOIlet +prints text using large characters made of smaller characters. It is similar +in many ways to +.B FIGlet +with additional features such as Unicode handling, colour fonts, filters +and various export formats. +.RI +.SH USAGE +.B TOIlet +either reads its input from the command line or from the standard input. +.RI +.SH OPTIONS +.TP +.B \-f, \-\-font +Use the given font instead of the default value. Fonts are +.B .flf +or +.B .tlf +files stored in the +.B /usr/share/figlet +directory. There is also a special built-in font called +.I term +that serves as a fallback if no font is available. +.TP +.B \-d, \-\-directory +Specify the directory in which to look for fonts. The default value is set +at build time and usually defaults to +.B /usr/share/figlet. +.TP +.B \-w, \-\-width +Set the output width. By default, +.B TOIlet +will wrap its output at 80 character columns. +.TP +.B \-t, \-\-termwidth +Set the output width to the terminal width. +.TP +.B \-F, \-\-filter +.PD 0 +.TP +.B \-F, \-\-filter list +.TP +.B \-\-gay, \-\-metal +.PD +Specify a list of filters to be applied to the output. +.I +is a colon-separated list of filters such as +.I crop:rotate:gay +and the special argument +.I list +outputs a list of available filters. + +.B \-\-gay +and +.B \-\-metal +are shortcuts to commonly used filters that are guaranteed to exist. Several +.B \-F +flags can also be specified on the command line, in which case filters will +be applied in order of appearance. +.TP +.B \-E, \-\-export +.PD 0 +.TP +.B \-E, \-\-export list +.TP +.B \-\-irc, \-\-html +.PD +Specify the output format. By default, +.B TOIlet +will output UTF-8 text using ANSI colour codes suitable for most terminals +such as XTerm or rxvt. +.I +is the name of the export format as recognised by libcucul. The special +argument +.I list +outputs a list of available export formats. + +.B \-\-irc +and +.B \-\-html +are shortcuts to commonly used export formats that are guaranteed to exist. +.TP +.B \-h, \-\-help +Display a short help message and exit. +.TP +.B \-I, \-\-infocode +Print a +.B FIGlet +infocode. This flag is only here for +.B FIGlet +compatibility, see the +.B figlet +manpage for more information about it. +.TP +.B \-v, \-\-version +Output version information and exit. +.RI +.SH EXAMPLES +toilet Hello World + +toilet Hello | toilet + +tail -f /var/log/messages | toilet -f term --gay +.RI +.SH BUGS +.B FIGlet +compatibility is not complete yet. +.RI +.SH AUTHOR +.B TOIlet +and this manual page were written by Sam Hocevar . There is a +webpage available at http://libcaca.zoy.org/toilet.html +.SH SEE ALSO +figlet(6)