freebsd-skq/usr.bin/banner/banner.6

.\" Copyright (c) 1980, 1993, 1995
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	From: @(#)banner.6	8.2 (Berkeley) 4/29/95
.\" $FreeBSD$
.\"
.Dd May 26, 2020
.Dt BANNER 6
.Os
.Sh NAME
.Nm banner
.Nd print large banner on printer
.Sh SYNOPSIS
.Nm
.Op Fl d
.Op Fl t
.Op Fl w Ar width
.Ar message ...
.Sh DESCRIPTION
.Nm Banner
prints a large, high quality banner on the standard output.
If the message is omitted, it prompts for and reads one line of its
standard input.
.Pp
The output should be printed on paper of the appropriate width,
with no breaks between the pages.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl d
Enable debug.
.It Fl t
Enable trace.
.It Fl w Ar width
Change the output from a width of 132 to
.Ar width ,
suitable for a narrow terminal.
.El
.Sh HISTORY
The
.Nm
utility first appeared in
.Bx 4.4 .
.Sh AUTHORS
.An Mark Horton
.Sh BUGS
Several
.Tn ASCII
characters are not defined, notably <, >, [, ], \\,
^, _, {, }, |, and ~.
Also, the characters ", ', and & are funny looking (but in a useful way.)
.Pp
The
.Fl w
option is implemented by skipping some rows and columns.
The smaller it gets, the grainier the output.
Sometimes it runs letters together.
.Pp
Messages are limited to 1024 characters in length.
Import Lite2's src/usr.bin/banner. The man page is still on the vendor branch and this import converts it to mdoc format. 1997-07-06 03:28:40 +00:00			`.\" Copyright (c) 1980, 1993, 1995`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
Fix the .Dd line. PR: docs/3275 1997-08-23 15:49:52 +00:00			`.\" From: @(#)banner.6 8.2 (Berkeley) 4/29/95`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
Add HISTORY sections to banner(6), basename(1), limits(1) and vmstat(8) Reviewed by: bcr (mentor) Approved by: bcr (mentor) MFC after: 7 days Differential Revision: https://reviews.freebsd.org/D25019 2020-06-18 13:19:56 +00:00			`.Dd May 26, 2020`
Import Lite2's src/usr.bin/banner. The man page is still on the vendor branch and this import converts it to mdoc format. 1997-07-06 03:28:40 +00:00			`.Dt BANNER 6`
			`.Os`
			`.Sh NAME`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`.Nm banner`
Import Lite2's src/usr.bin/banner. The man page is still on the vendor branch and this import converts it to mdoc format. 1997-07-06 03:28:40 +00:00			`.Nd print large banner on printer`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Add -d and -t flags to usage. Add usage(). 2000-03-26 14:30:51 +00:00			`.Op Fl d`
			`.Op Fl t`
			`.Op Fl w Ar width`
Import Lite2's src/usr.bin/banner. The man page is still on the vendor branch and this import converts it to mdoc format. 1997-07-06 03:28:40 +00:00			`.Ar message ...`
			`.Sh DESCRIPTION`
			`.Nm Banner`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`prints a large, high quality banner on the standard output.`
Import Lite2's src/usr.bin/banner. The man page is still on the vendor branch and this import converts it to mdoc format. 1997-07-06 03:28:40 +00:00			`If the message is omitted, it prompts for and reads one line of its`
			`standard input.`
			`.Pp`
			`The output should be printed on paper of the appropriate width,`
			`with no breaks between the pages.`
Add -d and -t flags to usage. Add usage(). 2000-03-26 14:30:51 +00:00			`.Pp`
			`The following options are available:`
			`.Bl -tag -width indent`
			`.It Fl d`
			`Enable debug.`
			`.It Fl t`
			`Enable trace.`
			`.It Fl w Ar width`
			`Change the output from a width of 132 to`
			`.Ar width ,`
			`suitable for a narrow terminal.`
			`.El`
Add HISTORY sections to banner(6), basename(1), limits(1) and vmstat(8) Reviewed by: bcr (mentor) Approved by: bcr (mentor) MFC after: 7 days Differential Revision: https://reviews.freebsd.org/D25019 2020-06-18 13:19:56 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`utility first appeared in`
			`.Bx 4.4 .`
Sort sections. 2005-01-18 13:43:56 +00:00			`.Sh AUTHORS`
			`.An Mark Horton`
Import Lite2's src/usr.bin/banner. The man page is still on the vendor branch and this import converts it to mdoc format. 1997-07-06 03:28:40 +00:00			`.Sh BUGS`
Add -d and -t flags to usage. Add usage(). 2000-03-26 14:30:51 +00:00			`Several`
			`.Tn ASCII`
			`characters are not defined, notably <, >, [, ], \\,`
Import Lite2's src/usr.bin/banner. The man page is still on the vendor branch and this import converts it to mdoc format. 1997-07-06 03:28:40 +00:00			`^, _, {, }, \|, and ~.`
			`Also, the characters ", ', and & are funny looking (but in a useful way.)`
			`.Pp`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`The`
Import Lite2's src/usr.bin/banner. The man page is still on the vendor branch and this import converts it to mdoc format. 1997-07-06 03:28:40 +00:00			`.Fl w`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`option is implemented by skipping some rows and columns.`
			`The smaller it gets, the grainier the output.`
			`Sometimes it runs letters together.`
Document message length limit. 2005-01-25 22:24:04 +00:00			`.Pp`
			`Messages are limited to 1024 characters in length.`