xref: /freebsd/usr.bin/banner/banner.6 (revision 1d733bbc0d41e6891dec18a336780629d403fa60)
1630d2a93SBruce Evans.\" Copyright (c) 1980, 1993, 1995
2630d2a93SBruce Evans.\"	The Regents of the University of California.  All rights reserved.
3630d2a93SBruce Evans.\"
4630d2a93SBruce Evans.\" Redistribution and use in source and binary forms, with or without
5630d2a93SBruce Evans.\" modification, are permitted provided that the following conditions
6630d2a93SBruce Evans.\" are met:
7630d2a93SBruce Evans.\" 1. Redistributions of source code must retain the above copyright
8630d2a93SBruce Evans.\"    notice, this list of conditions and the following disclaimer.
9630d2a93SBruce Evans.\" 2. Redistributions in binary form must reproduce the above copyright
10630d2a93SBruce Evans.\"    notice, this list of conditions and the following disclaimer in the
11630d2a93SBruce Evans.\"    documentation and/or other materials provided with the distribution.
12fbbd9655SWarner Losh.\" 3. Neither the name of the University nor the names of its contributors
13630d2a93SBruce Evans.\"    may be used to endorse or promote products derived from this software
14630d2a93SBruce Evans.\"    without specific prior written permission.
15630d2a93SBruce Evans.\"
16630d2a93SBruce Evans.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17630d2a93SBruce Evans.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18630d2a93SBruce Evans.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19630d2a93SBruce Evans.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20630d2a93SBruce Evans.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21630d2a93SBruce Evans.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22630d2a93SBruce Evans.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23630d2a93SBruce Evans.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24630d2a93SBruce Evans.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25630d2a93SBruce Evans.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26630d2a93SBruce Evans.\" SUCH DAMAGE.
27630d2a93SBruce Evans.\"
281b659bfeSJoerg Wunsch.\"	From: @(#)banner.6	8.2 (Berkeley) 4/29/95
29c3aac50fSPeter Wemm.\" $FreeBSD$
30630d2a93SBruce Evans.\"
31*1d733bbcSGordon Bergling.Dd May 26, 2020
32630d2a93SBruce Evans.Dt BANNER 6
33630d2a93SBruce Evans.Os
34630d2a93SBruce Evans.Sh NAME
35630d2a93SBruce Evans.Nm banner
36630d2a93SBruce Evans.Nd print large banner on printer
37630d2a93SBruce Evans.Sh SYNOPSIS
388fe908efSRuslan Ermilov.Nm
39eb257e6eSPhilippe Charnier.Op Fl d
40eb257e6eSPhilippe Charnier.Op Fl t
41eb257e6eSPhilippe Charnier.Op Fl w Ar width
42630d2a93SBruce Evans.Ar message ...
43630d2a93SBruce Evans.Sh DESCRIPTION
44630d2a93SBruce Evans.Nm Banner
45630d2a93SBruce Evansprints a large, high quality banner on the standard output.
46630d2a93SBruce EvansIf the message is omitted, it prompts for and reads one line of its
47630d2a93SBruce Evansstandard input.
48630d2a93SBruce Evans.Pp
49630d2a93SBruce EvansThe output should be printed on paper of the appropriate width,
50630d2a93SBruce Evanswith no breaks between the pages.
51eb257e6eSPhilippe Charnier.Pp
52eb257e6eSPhilippe CharnierThe following options are available:
53eb257e6eSPhilippe Charnier.Bl -tag -width indent
54eb257e6eSPhilippe Charnier.It Fl d
55eb257e6eSPhilippe CharnierEnable debug.
56eb257e6eSPhilippe Charnier.It Fl t
57eb257e6eSPhilippe CharnierEnable trace.
58eb257e6eSPhilippe Charnier.It Fl w Ar width
59eb257e6eSPhilippe CharnierChange the output from a width of 132 to
60eb257e6eSPhilippe Charnier.Ar width ,
61eb257e6eSPhilippe Charniersuitable for a narrow terminal.
62eb257e6eSPhilippe Charnier.El
63*1d733bbcSGordon Bergling.Sh HISTORY
64*1d733bbcSGordon BerglingThe
65*1d733bbcSGordon Bergling.Nm
66*1d733bbcSGordon Berglingutility first appeared in
67*1d733bbcSGordon Bergling.Bx 4.4 .
686c7216dfSRuslan Ermilov.Sh AUTHORS
696c7216dfSRuslan Ermilov.An Mark Horton
70630d2a93SBruce Evans.Sh BUGS
71eb257e6eSPhilippe CharnierSeveral
72eb257e6eSPhilippe Charnier.Tn ASCII
73eb257e6eSPhilippe Charniercharacters are not defined, notably <, >, [, ], \\,
74630d2a93SBruce Evans^, _, {, }, |, and ~.
75630d2a93SBruce EvansAlso, the characters ", ', and & are funny looking (but in a useful way.)
76630d2a93SBruce Evans.Pp
77630d2a93SBruce EvansThe
78630d2a93SBruce Evans.Fl w
79630d2a93SBruce Evansoption is implemented by skipping some rows and columns.
80630d2a93SBruce EvansThe smaller it gets, the grainier the output.
81630d2a93SBruce EvansSometimes it runs letters together.
82a7a223c3STim J. Robbins.Pp
83a7a223c3STim J. RobbinsMessages are limited to 1024 characters in length.
84