xref: /freebsd/usr.bin/banner/banner.6 (revision 06c3fb27)
1.\" Copyright (c) 1980, 1993, 1995
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd June 21, 2021
29.Dt BANNER 6
30.Os
31.Sh NAME
32.Nm banner
33.Nd print large banner on printer
34.Sh SYNOPSIS
35.Nm
36.Op Fl d
37.Op Fl t
38.Op Fl w Ar width
39.Ar message ...
40.Sh DESCRIPTION
41.Nm Banner
42prints a large, high quality banner on the standard output.
43If the message is omitted, it prompts for and reads one line of its
44standard input.
45.Pp
46The output should be printed on paper of the appropriate width,
47with no breaks between the pages.
48.Pp
49The following options are available:
50.Bl -tag -width indent
51.It Fl d
52Enable debug.
53.It Fl t
54Enable trace.
55.It Fl w Ar width
56Change the output from a width of 132 to
57.Ar width ,
58suitable for a narrow terminal.
59.El
60.Sh HISTORY
61The
62.Nm
63utility first appeared in
64.At v6 .
65.Sh AUTHORS
66.An Mark Horton
67.Sh BUGS
68Several
69.Tn ASCII
70characters are not defined, notably <, >, [, ], \\,
71^, _, {, }, |, and ~.
72Also, the characters ", ', and & are funny looking (but in a useful way.)
73.Pp
74The
75.Fl w
76option is implemented by skipping some rows and columns.
77The smaller it gets, the grainier the output.
78Sometimes it runs letters together.
79.Pp
80Messages are limited to 1024 characters in length.
81