xref: /minix/games/banner/banner.6 (revision 9f988b79)
1.\"	$NetBSD: banner.6,v 1.18 2012/02/26 21:06:59 wiz Exp $
2.\"
3.\" Copyright (c) 1980, 1993, 1995
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"	@(#)banner.6	8.2 (Berkeley) 4/29/95
31.\"
32.Dd February 26, 2012
33.Dt BANNER 6
34.Os
35.Sh NAME
36.Nm banner
37.Nd print large banners
38.Sh SYNOPSIS
39.Nm
40.Op Fl w Ar width
41.Op Ar message
42.Sh DESCRIPTION
43.Nm
44prints a large, high quality banner on standard output.
45If
46.Ar message
47is omitted, one line of standard input is read for it.
48A prompt is written to standard error in case standard input is
49connected to a terminal.
50.Pp
51If
52.Fl w
53is given, the output is scrunched down from a width of 132 (the default) to
54.Ar width ,
55suitable for a narrow terminal.
56.Pp
57The output should be printed on paper of the appropriate width,
58with no breaks between the pages.
59.Sh EXIT STATUS
60.Ex -std
61.Sh EXAMPLES
62The following command will print the current date as a banner on
63standard output, using a width of 80:
64.Pp
65.Dl "/usr/games/banner -w 80 `date`"
66.Sh SEE ALSO
67.Xr banner 1 ,
68.Xr lpr 1
69.Sh AUTHORS
70.An Mark Horton
71.Sh BUGS
72Several ASCII characters are not defined, notably \*[Lt], \*[Gt], [, ], \e,
73^, _, {, }, |, and ~.  Also, the characters ", ', and \*[Am] are funny
74looking (but in a useful way.)
75.Pp
76The
77.Fl w
78option is implemented by skipping some rows and columns.
79The smaller it gets, the grainier the output.
80Sometimes it runs letters together.
81